chickadee » apropos » apropos

apropos PATTERN #!key macros? sort case-insensitive? raw? base split internal? imported?procedure

Displays information about symbols matching PATTERN in the toplevel environment.

PATTERN
A symbol, string, irregex, irregex-sre, (quote symbol), (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.
MACROS?
Either #t to include macros, or #f to skip them. Default is #f.
CASE-INSENSITIVE?
Either #t to use match case-insensitivity for the PATTERN or #f to be case-sensitive. Default is #f.
SORT
Either #:name for an symbol sort, #:module for an module symbol sort, or #:type for a type+indentifier sort, or #f for unsorted. Default is #:type.
SPLIT
Either #:name for an symbol match, #:module for an module match, or #f for any. Default is #f.
RAW?
Do not strip identifier symbols. The default is #f. Use #:raw? #t when apropos is suspected of hiding information.
BASE
fixnum in 2..16. The default is 10. BASE is used to convert a number to a string PATTERN. Of dubious utility. But can fix the situation of entering a hex number, say #x1c, for the pattern using the REPL and matching against 28!
INTERNAL?
Either #t to include internal "modules", or #f to ignore. The default is #f.
IMPORTED?
Either #t for only imported identifiers, or #f for global symbols. The default is #f.