(index ("apropos" 0) ("apropos-list" 2034) ("apropos-information-list" 2244) ("apropos-default-options" 2845) ("apropos-interning" 3042))
(def (sig (procedure "(apropos PATTERN #!key macros? qualified? sort case-insensitive? raw? base split)" (id apropos))) (p "Displays information about symbols matching " (tt "PATTERN") " in the toplevel environment.") (dl (dt (tt "PATTERN")) (dd "A " (tt "symbol") ", " (tt "string") ", " (tt "irregex") ", " (tt "irregex-sre") ", " (tt "(quote symbol)") ", " (tt "(quote string)") ". When unquoted symbol or string substring matching is performed. When quoted the string value is taken as an irregex regular expression string for use with search. Should " (tt "PATTERN") " be a namespace qualified symbol the namespace will be dropped before conversion to a regular-expression.") (dt (tt "MACROS?")) (dd "Either " (tt "#t") " to include macros, or " (tt "#f") " to skip them. Default is " (tt "#f") ".") (dt (tt "QUALIFIED?")) (dd "Either " (tt "#t") " to include qualified symbols or " (tt "#f") " to skip them. Default is " (tt "#f") ".") (dt (tt "CASE-INSENSITIVE?")) (dd "Either " (tt "#t") " to use match case-insensitivity for the " (tt "PATTERN") " or " (tt "#f") " to be case-sensitive. Default is " (tt "#f") ".") (dt (tt "SORT")) (dd "Either " (tt "#:name") " for an symbol sort, " (tt "#:module") " for an module symbol sort, or " (tt "#:type") " for a type+indentifier sort, or " (tt "#f") " for unsorted. Default is " (tt "#:type") ".") (dt (tt "SPLIT")) (dd "Either " (tt "#:name") " for an symbol match, " (tt "#:module") " for an module match, or " (tt "#f") " for any. Default is " (tt "#f") ".") (dt (tt "RAW")) (dd "Do not strip identifier symbols. The default is " (tt "#f") ". Use " (tt "#:raw? #t") " when " (i "apropos") " is suspected of hiding information.") (dt (tt "BASE")) (dd (tt "fixnum") " in " (tt "2..16") ". The default is " (tt "10") ". " (tt "BASE") " is used to convert a " (tt "number") " to a string " (tt "PATTERN") ". Of dubious utility. But can " (i "fix") " the situation of entering a hex number, say " (tt "#x1c") ", for the pattern using the REPL and matching against " (tt "28") "!")))
(def (sig (procedure "(apropos-list PATTERN #!key macros? qualified? case-insensitive? raw? base) => list" (id apropos-list))) (p "Like " (tt "apropos") " but returns an, unsorted, list of matching symbols."))
(def (sig (procedure "(apropos-information-list PATTERN #!key macros? qualified? sort case-insensitive? raw? base) => list" (id apropos-information-list))) (p "Like " (tt "apropos") " but returns a list key'ed by " (tt "(MODULE . NAME)") ".") (p (tt "MODULE") " is the module symbol or " (tt "||") " for the null module.") (p (tt "NAME") " is the base symbol.") (p "The associated information is either:") (dl (dt (tt "'macro")) (dt (tt "'keyword")) (dt (tt "'variable")) (dt (tt "'procedure")) (dt (tt "'(procedure . <lambda-list-specification>)")) (dt (tt "'(procedure . <core procedure name>)"))))
(def (sig (parameter "(apropos-default-options [OPTIONS]) -> list" (id apropos-default-options))) (p (tt "OPTIONS") " is an " (tt "apropos") " #!key argument list.") (p "Default " (tt "'()") "."))
(def (sig (parameter "(apropos-interning [FLAG]) -> boolean" (id apropos-interning))) (p "Use " (tt "string->symbol") " - " (tt "#t") " - or " (tt "string->uninterned-symbol") " - " (tt "#f") ".") (p "Default " (tt "#t") "."))
