File: apropos.el.html

The ideas for this package were derived from the C code in src/keymap.c and elsewhere.

The idea for super-apropos is based on the original implementation by Lynn Slater <lrs@esl.com>.

History: Fixed bug, current-local-map can return nil. Change, doesn't calculate key-bindings unless needed. Added super-apropos capability, changed print functions. Made fast-apropos and super-apropos share code. Sped up fast-apropos again. Added apropos-do-all option. Added fast-command-apropos. Changed doc strings to comments for helping functions. Made doc file buffer read-only, buried it. Only call substitute-command-keys if do-all set.

Optionally use configurable faces to make the output more legible. Differentiate between command, function and macro. Apropos-command (ex command-apropos) does cmd and optionally user var. Apropos shows all 3 aspects of symbols (fn, var and plist) Apropos-documentation (ex super-apropos) now finds all it should. New apropos-value snoops through all values and optionally plists. Reading DOC file doesn't load nroff. Added hypertext following of documentation, mouse-2 on variable gives value
  from buffer in active window.

Defined variables (20)

apropos--currentList of current Apropos function followed by its arguments.
apropos-accumulatorAlist of symbols already found in current apropos run.
apropos-all-wordsCurrent list of words and synonyms.
apropos-all-words-regexpRegexp matching ‘apropos-all-words’.
apropos-compact-layoutIf non-nil, use a single line per binding.
apropos-do-allNon-nil means apropos commands will search more extensively.
apropos-documentation-sort-by-scoresNon-nil means sort matches by scores; best match is shown first.
apropos-files-scannedList of elc files already scanned in current run of ‘apropos-documentation’.
apropos-match-faceFace for matching text in Apropos documentation/value, or nil for none.
apropos-mode-abbrev-tableAbbrev table for ‘apropos-mode’.
apropos-mode-hookHook run when mode is turned on.
apropos-mode-mapKeymap used in Apropos mode.
apropos-mode-syntax-tableSyntax table for ‘apropos-mode’.
apropos-multi-typeIf non-nil, this apropos query concerns multiple types.
apropos-patternApropos pattern as entered by user.
apropos-pattern-quotedApropos pattern passed through ‘regexp-quote’.
apropos-regexpRegexp used in current apropos run.
apropos-sort-by-scoresNon-nil means sort matches by scores; best match is shown first.
apropos-synonymsList of synonyms known by apropos.
apropos-wordsCurrent list of apropos words extracted from ‘apropos-pattern’.

Defined functions (43)

apropos(PATTERN &optional DO-ALL)
apropos--documentation-add(SYMBOL DOC POS)
apropos--documentation-add-from-elc(FILE DEFS)
apropos--map-preloaded-atoms(F)
apropos--preamble(TEXT)
apropos--revert-buffer(IGNORE-AUTO NOCONFIRM)
apropos-calc-scores(STR WORDS)
apropos-command(PATTERN &optional DO-ALL VAR-PREDICATE)
apropos-describe-plist(SYMBOL)
apropos-documentation(PATTERN &optional DO-ALL)
apropos-documentation-internal(DOC)
apropos-documentation-property(SYMBOL PROPERTY RAW)
apropos-false-hit-str(STR)
apropos-false-hit-symbol(SYMBOL)
apropos-follow()
apropos-format-plist(PL SEP &optional COMPARE)
apropos-function(PATTERN)
apropos-library(FILE)
apropos-library-button(SYM)
apropos-local-value(PATTERN &optional BUFFER)
apropos-local-variable(PATTERN &optional BUFFER)
apropos-mode()
apropos-next-label-button(POS)
apropos-next-symbol()
apropos-parse-pattern(PATTERN &optional MULTILINE-P)
apropos-previous-symbol()
apropos-print(DO-KEYS SPACING &optional TEXT NOSUBST)
apropos-print-doc(APROPOS-ITEM I TYPE DO-KEYS)
apropos-read-pattern(SUBJECT)
apropos-safe-documentation(FUNCTION)
apropos-score-doc(DOC)
apropos-score-str(STR)
apropos-score-symbol(SYMBOL &optional WEIGHT)
apropos-symbol-button-display-help(BUTTON)
apropos-symbols-internal(SYMBOLS KEYS &optional TEXT)
apropos-true-hit(STR WORDS)
apropos-true-hit-doc(DOC)
apropos-user-option(PATTERN &optional DO-ALL)
apropos-value(PATTERN &optional DO-ALL)
apropos-value-internal(PREDICATE SYMBOL FUNCTION)
apropos-variable(PATTERN &optional DO-NOT-ALL)
apropos-words-to-regexp(WORDS WILD)
command-apropos(PATTERN &optional DO-ALL VAR-PREDICATE)

Defined faces (3)

apropos-keybindingFace for lists of keybinding in Apropos output.
apropos-propertyFace for property name in Apropos output, or nil for none.
apropos-symbolFace for the symbol name in Apropos output.