File: help.el.html

This code implements GNU Emacs's built-in help system, the one invoked by M-x help-for-help.

Defined variables (23)

describe-bindings-outlineNon-nil enables outlines in the output buffer of ‘describe-bindings’.
describe-bindings-outline-rulesVisibility rules for outline sections of ‘describe-bindings’.
describe-bindings-show-prefix-commandsNon-nil means show prefix commands in the output of ‘describe-bindings’.
help-buffer-under-preparationWhether a *Help* buffer is being prepared.
help-enable-auto-loadWhether Help commands can perform autoloading.
help-enable-autoloadWhether Help commands can perform autoloading.
help-for-help-buffer-nameName of the ‘help-for-help’ buffer.
help-link-key-to-documentationNon-nil means link keys to their command in *Help* buffers.
help-mapKeymap for characters following the Help key.
help-quick-sectionsData structure for ‘help-quick’.
help-quick-use-mapKeymap that ‘help-quick’ should use to lookup bindings.
help-return-methodWhat to do to "exit" the help buffer.
help-uni-confusablesAn alist of confusable characters to give hints about.
help-uni-confusables-regexpRegexp matching any character listed in ‘help-uni-confusables’.
help-window-keep-selectedIf non-nil, navigation commands in the *Help* buffer will reuse the window.
help-window-old-frameFrame selected at the time ‘with-help-window’ is invoked.
help-window-point-markerMarker to override default ‘window-point’ in help windows.
help-window-selectNon-nil means select help window for viewing.
resize-temp-buffer-window-inhibitNon-nil means ‘resize-temp-buffer-window’ should not resize.
temp-buffer-max-heightMaximum height of a window displaying a temporary buffer.
temp-buffer-max-widthMaximum width of a window displaying a temporary buffer.
temp-buffer-resize-modeNon-nil if Temp-Buffer-Resize mode is enabled.
temp-buffer-resize-mode-hookHook run after entering or leaving ‘temp-buffer-resize-mode’.

Defined functions (73)

cheat-sheet()
describe-bindings(&optional PREFIX BUFFER)
describe-copying()
describe-distribution()
describe-function--helper(FUNC BUF)
describe-gnu-project()
describe-key(KEY-LIST &optional BUFFER)
describe-key--helper(KEY-LIST BUF)
describe-key-briefly(&optional KEY-LIST INSERT BUFFER)
describe-map(MAP &optional PREFIX TRANSL PARTIAL SHADOW NOMENU MENTION-SHADOW BUFFER)
describe-map--align-section(COLUMNS)
describe-map--fill-columns(COLUMNS WIDTH)
describe-map-tree(STARTMAP &optional PARTIAL SHADOW PREFIX TITLE NO-MENU TRANSL ALWAYS-TITLE MENTION-SHADOW BUFFER)
describe-minor-mode(MINOR-MODE)
describe-minor-mode-from-indicator(INDICATOR &optional EVENT)
describe-minor-mode-from-symbol(SYMBOL)
describe-no-warranty()
describe-prefix-bindings()
function-called-at-point()
help--analyze-key(KEY UNTRANSLATED &optional BUFFER)
help--append-keystrokes-help(STR)
help--binding-locus(KEY POSITION)
help--binding-undefined-p(DEFN)
help--describe-command(DEFINITION &optional TRANSLATION)
help--describe-map-compare(A B)
help--describe-map-tree(STARTMAP &optional PARTIAL SHADOW PREFIX TITLE NO-MENU TRANSL ALWAYS-TITLE MENTION-SHADOW BUFFER)
help--describe-translation(DEFINITION &optional TRANSLATION)
help--docstring-quote(STRING)
help--filter-info-list(INFO-LIST I)
help--for-help-make-commands(COMMANDS)
help--for-help-make-sections(SECTIONS)
help--key-binding-keymap(KEY &optional ACCEPT-DEFAULT NO-REMAP POSITION)
help--key-description-fontified(KEYS &optional PREFIX)
help--make-usage(FUNCTION ARGLIST)
help--make-usage-docstring(FN ARGLIST)
help--read-key-sequence(&optional NO-MOUSE-MOVEMENT)
help--shadow-lookup(KEYMAP KEY ACCEPT-DEFAULT REMAP)
help--window-setup(BUFFER CALLBACK)
help-add-fundoc-usage(DOCSTRING ARGLIST)
help-command-error-confusable-suggestions(DATA CONTEXT SIGNAL)
help-for-help()
help-for-help-internal()
help-form-show()
help-function-arglist(DEF &optional PRESERVE-NAMES)
help-key()
help-key-description(KEY UNTRANSLATED)
help-make-usage(FUNCTION ARGLIST)
help-print-return-message(&optional FUNCTION)
help-quick()
help-quick-toggle()
help-quit()
help-split-fundoc(DOCSTRING DEF &optional SECTION)
help-uni-confusable-suggestions(STRING)
help-window-display-message(QUIT-PART WINDOW &optional SCROLL)
help-window-setup(WINDOW &optional VALUE)
lookup-minor-mode-from-indicator(INDICATOR)
resize-temp-buffer-window(&optional WINDOW)
search-forward-help-for-help()
substitute-command-keys(STRING &optional NO-FACE INCLUDE-MENUS)
substitute-quotes(STRING)
temp-buffer-resize-mode(&optional ARG)
view-echo-area-messages()
view-emacs-FAQ()
view-emacs-debugging()
view-emacs-news(&optional VERSION)
view-emacs-problems()
view-emacs-todo(&optional ARG)
view-external-packages()
view-help-file(FILE &optional DIR)
view-lossage()
view-order-manuals()
where-is(DEFINITION &optional INSERT)
with-help-window(BUFFER-OR-NAME &rest BODY)

Defined faces (1)

help-for-help-headerFace used for headers in the ‘help-for-help’ buffer.