File: help-fns.el.html

This file contains those help commands which are complicated, and which may not be used in every session. For example describe-function will probably be heavily used when doing elisp programming, but not if just editing C files. Simpler help commands are in help.el

Defined variables (19)

describe-function-orig-bufferBuffer that was current when ‘describe-function’ was invoked.
describe-mode-outlineNon-nil enables outlines in the output buffer of ‘describe-mode’.
describe-widget-functionsA list of functions for ‘describe-widget’ to call.
help-definition-prefixesRadix-tree representation replacing ‘definition-prefixes’.
help-display-function-typeWhether to display type specifiers of functions in "*Help*" buffers.
help-downcase-argumentsIf non-nil, argument names in *Help* buffers are downcased.
help-enable-completion-auto-loadWhether completion for Help commands can perform autoloading.
help-enable-completion-autoloadWhether completion for Help commands can perform autoloading.
help-enable-symbol-autoloadPerform autoload if docs are missing from autoload objects.
help-enable-variable-value-editingIf non-nil, allow editing variable values in *Help* buffers.
help-fns--activated-functionsInternal variable let-bound to help functions that have triggered.
help-fns--edit-value-mode-abbrev-tableAbbrev table for ‘help-fns--edit-value-mode’.
help-fns--edit-value-mode-hookHook run after entering ‘help-fns--edit-value-mode’.
help-fns--edit-value-mode-mapKeymap for ‘help-fns--edit-value-mode’.
help-fns--edit-value-mode-syntax-tableSyntax table for ‘help-fns--edit-value-mode’.
help-fns-describe-face-functionsList of functions to run in help buffer in ‘describe-face’.
help-fns-describe-function-functionsList of functions to run in help buffer in ‘describe-function’.
help-fns-describe-variable-functionsList of functions to run in help buffer in ‘describe-variable’.
keymap-name-historyHistory for input to ‘describe-keymap’.

Defined functions (73)

describe-categories(&optional BUFFER)
describe-command(COMMAND)
describe-face(FACE &optional FRAME)
describe-function(FUNCTION)
describe-function-1(FUNCTION)
describe-keymap(KEYMAP)
describe-mode(&optional BUFFER)
describe-mode--minor-modes(MODES &optional GLOBAL)
describe-symbol(SYMBOL &optional BUFFER FRAME)
describe-syntax(&optional BUFFER)
describe-variable(VARIABLE &optional BUFFER FRAME)
describe-variable-custom-version-info(VARIABLE &optional TYPE)
describe-widget(&optional POS)
doc-file-to-info(FILE)
doc-file-to-man(FILE)
find-lisp-object-file-name(OBJECT TYPE &optional ALSO-C-SOURCE)
help--load-prefixes(PREFIXES)
help--loaded-p(FILE)
help--symbol-class(S)
help--symbol-completion-table(STRING PRED ACTION)
help--symbol-completion-table-affixation(COMPLETIONS)
help-C-file-name(SUBR-OR-VAR KIND)
help-definition-prefixes()
help-describe-category-set(VALUE)
help-do-arg-highlight(DOC ARGS &optional USAGE-P)
help-find-source()
help-fns--analyze-function(FUNCTION)
help-fns--autoloaded-p(FUNCTION)
help-fns--compiler-macro(FUNCTION)
help-fns--customize-variable(VARIABLE &optional TEXT)
help-fns--customize-variable-version(VARIABLE)
help-fns--describe-function-or-command-prompt(&optional WANT-COMMAND)
help-fns--disabled(FUNCTION)
help-fns--display-function(FUNCTION)
help-fns--edit-value-mode()
help-fns--editable-variable(START END VARIABLE VALUE BUFFER)
help-fns--face-attributes(FACE FRAME)
help-fns--face-custom-version-info(FACE FRAME)
help-fns--first-release(SYMBOL)
help-fns--first-release-regexp(SYMBOL)
help-fns--generalized-variable(FUNCTION)
help-fns--globalized-minor-mode(FUNCTION)
help-fns--insert-bindings(KEYS)
help-fns--insert-menu-bindings(MENUS HEADING)
help-fns--interactive-only(FUNCTION)
help-fns--key-bindings(FUNCTION)
help-fns--mention-first-release(OBJECT)
help-fns--mention-shortdoc-groups(OBJECT)
help-fns--most-relevant-active-keymap()
help-fns--obsolete(FUNCTION)
help-fns--parent-mode(FUNCTION)
help-fns--run-describe-functions(FUNCTIONS &rest ARGS)
help-fns--side-effects(FUNCTION)
help-fns--signature(FUNCTION DOC REAL-DEF REAL-FUNCTION BUFFER)
help-fns--var-alias(VARIABLE)
help-fns--var-aliases(VARIABLE)
help-fns--var-bufferlocal(VARIABLE)
help-fns--var-file-local(VARIABLE)
help-fns--var-ignored-local(VARIABLE)
help-fns--var-obsolete(VARIABLE)
help-fns--var-risky(VARIABLE)
help-fns--var-safe-local(VARIABLE)
help-fns--var-watchpoints(VARIABLE)
help-fns-edit-mode-cancel()
help-fns-edit-mode-done(&optional KILL)
help-fns-edit-variable()
help-fns-find-keymap-name(KEYMAP)
help-fns-function-description-header(FUNCTION)
help-fns-function-name(FUNCTION)
help-fns-short-filename(FILENAME)
help-highlight-arg(ARG)
help-highlight-arguments(USAGE DOC &rest ARGS)
variable-at-point(&optional ANY-SYMBOL)

Defined faces (0)