File: help-mode.el.html

Defines help-mode, which is the mode used by *Help* buffers, and associated support machinery, such as adding hyperlinks, etc.,

Defined variables (20)

describe-symbol-backendsList of providers of information about symbols.
help-back-labelLabel to use by ‘help-make-xrefs’ for the go-back reference.
help-clean-buttonsIf non-nil, remove quotes around link buttons.
help-forward-labelLabel to use by ‘help-make-xrefs’ for the go-forward reference.
help-mode-abbrev-tableAbbrev table for ‘help-mode’.
help-mode-hookHook run by ‘help-mode’.
help-mode-mapKeymap for Help mode.
help-mode-menuMenu for Help mode.
help-mode-syntax-tableSyntax table used in ‘help-mode’.
help-xref-customization-group-regexpRegexp matching doc string references to a customization group.
help-xref-followingNon-nil when following a help cross-reference.
help-xref-forward-stackA stack used to navigate help forwards after using the back button.
help-xref-info-regexpRegexp matching doc string references to an Info node.
help-xref-man-regexpRegexp matching doc string references to a man page.
help-xref-mule-regexpRegexp matching doc string references to MULE-related keywords.
help-xref-stackA stack of ways by which to return to help buffers after following xrefs.
help-xref-stack-forward-itemAn item for ‘help-go-back’ to push onto ‘help-xref-forward-stack’.
help-xref-stack-itemAn item for ‘help-follow-symbol’ to push onto ‘help-xref-stack’.
help-xref-symbol-regexpRegexp matching doc string references to symbols.
help-xref-url-regexpRegexp matching doc string references to a URL.

Defined functions (33)

help-bookmark-jump(BOOKMARK)
help-bookmark-make-record()
help-buffer()
help-button-action(BUTTON)
help-customize()
help-do-xref(POS FUNCTION ARGS)
help-follow()
help-follow-mouse()
help-follow-symbol(&optional POS)
help-function-def--button-function(FUN &optional FILE TYPE)
help-go-back()
help-go-forward()
help-goto-info()
help-goto-lispref-info()
help-goto-next-page()
help-goto-previous-page()
help-insert-string(STRING)
help-insert-xref-button(STRING TYPE &rest ARGS)
help-make-xrefs(&optional BUFFER)
help-mode()
help-mode--add-function-link(STR FUN)
help-mode-context-menu(MENU CLICK)
help-mode-finish()
help-mode-menu(ARG1)
help-mode-revert-buffer(IGNORE-AUTO NOCONFIRM)
help-mode-setup()
help-setup-xref(ITEM INTERACTIVE-P)
help-view-source()
help-xref-button(MATCH-NUMBER TYPE &rest ARGS)
help-xref-go-back(BUFFER)
help-xref-go-forward(BUFFER)
help-xref-interned(SYMBOL &optional BUFFER FRAME)
help-xref-on-pp(FROM TO)

Defined faces (0)