File: info.el.html

Note that nowadays we expect Info files to be made using makeinfo.

In particular we make these assumptions:
 - a menu item MAY contain colons but not colon-space ": "
 - a menu item ending with ": " (but not ":: ") is an index entry
 - a node name MAY NOT contain a colon
This distinction is to support indexing of computer programming language terms that may contain ":" but not ": ".

The commands in this file should start either with "Info-" or with
"info-". The capitalized version is for commands that are bound to
keys, and therefore are unlikely to be invoked by name via "M-x"; the lower-case version is for commands invoked by name. This arrangement makes completion of "info-" commands work better, because the "Info-" commands (of which there are a lot) don't get in the way. Please adhere to this convention when you add commands here.

Defined variables (61)

Info--current-index-alternativeCurrent displayed index alternative.
Info--dont-hide-referencesManuals and nodes where ‘Info-hide-note-references’ should be ignored.
Info-additional-directory-listList of additional directories to search for Info documentation files.
Info-apropos-fileInfo file name of the virtual manual for matches of ‘info-apropos’.
Info-apropos-nodesAlist of cached apropos matched nodes.
Info-breadcrumbs-depthDepth of breadcrumbs to display.
Info-current-fileInfo file that Info is now looking at, or nil.
Info-current-file-completionsCached completion list for current Info file.
Info-current-nodeName of node that Info is now looking at, or nil.
Info-current-node-virtualNon-nil if the current Info node is virtual.
Info-current-subfileInfo subfile that is actually in the *info* buffer now.
Info-default-directory-listDefault list of directories to search for Info documentation files.
Info-directory-listList of directories to search for Info documentation files.
Info-enable-active-nodesNon-nil allows Info to execute Lisp code associated with nodes.
Info-file-attributesAlist of file attributes of visited Info files.
Info-file-completionsCached completion alist of visited Info files.
Info-file-list-for-emacsList of Info files that describe Emacs commands.
Info-file-supports-index-cookiesNon-nil if current Info file supports index cookies.
Info-file-supports-index-cookies-listList of Info files with information about index cookies support.
Info-finder-fileInfo file name of the virtual Info keyword finder manual.
Info-fontify-maximum-menu-sizeMaximum size of menu to fontify if ‘font-lock-mode’ is non-nil.
Info-fontify-visited-nodesNon-nil to fontify references to visited nodes in ‘info-xref-visited’ face.
Info-hide-note-referencesIf non-nil, hide the tag and section reference in *note and * menu items.
Info-historyStack of Info nodes user has visited.
Info-history-forwardStack of Info nodes user has visited with ‘Info-history-back’ command.
Info-history-listList of all Info nodes user has visited.
Info-history-skip-intermediate-nodesNon-nil means don’t record intermediate Info nodes to the history.
Info-index-alternativesList of possible matches for last ‘Info-index’ command.
Info-index-nodesAlist of cached index node names of visited Info files.
Info-isearch-searchIf non-nil, isearch in Info searches through multiple nodes.
Info-link-keymapKeymap to put on Info links.
Info-menu-entry-name-reRegexp that matches a menu entry name up to but not including the colon.
Info-minibuf-historyHistory for ‘Info-read-node-name’.
Info-mode-hookHook run when activating Info Mode.
Info-mode-line-node-keymapKeymap to put on the Info node name in the mode line.
Info-mode-mapKeymap containing Info commands.
Info-mode-menuMenu for Info files.
Info-mode-syntax-tableSyntax table used in ‘Info-mode’.
Info-node-spec-reRegexp to match the text after a : until the terminating ‘.’.
Info-point-locPoint location within a selected node.
Info-refill-paragraphsIf non-nil, attempt to refill paragraphs with hidden references.
Info-scroll-prefer-subnodesIf non-nil, SPC in a menu visits subnodes.
Info-search-case-foldThe value of ‘case-fold-search’ from previous ‘Info-search’ command.
Info-search-historyThe history list for ‘Info-search’.
Info-search-whitespace-regexpIf non-nil, regular expression to match a sequence of whitespace chars.
Info-selection-hookHook run when an Info node is selected as the current node.
Info-speedbar-key-mapKeymap used when in the Info display mode.
Info-speedbar-menu-itemsAdditional menu-items to add to speedbar frame.
Info-standaloneNon-nil if Emacs was started solely as an Info browser.
Info-streamline-headingsList of elements (RE . NAME) to merge headings matching RE to NAME.
Info-suffix-listList of file name suffixes and associated decoding commands.
Info-tag-table-bufferBuffer used for indirect tag tables.
Info-tag-table-markerMarker pointing at beginning of current Info file’s tag table.
Info-toc-nodesAlist of cached parent-children node information in visited Info files.
Info-url-alistAlist telling ‘Info-mode’ where manuals are accessible online.
Info-use-header-lineNon-nil means to put the beginning-of-node links in an Emacs header-line.
Info-virtual-filesList of definitions of virtual Info files.
Info-virtual-index-nodesAlist of cached matched index search nodes.
Info-virtual-nodesList of definitions of virtual Info nodes.
Info-warn-on-index-alternatives-wrapWarn when wrapping to the beginning/end when displaying index alternatives.
info-symbols-and-replacementsA list of Unicode symbols used in Info files and their ASCII translations.

Defined functions (148)

Info--default-directory-list()
Info--record-tag-table(NODENAME)
Info--search-loop(REGEXP BOUND BACKWARD)
Info-apropos-find-file(FILENAME &optional NOERROR)
Info-apropos-find-node(FILENAME NODENAME &optional NO-GOING-BACK)
Info-apropos-matches(STRING &optional REGEXP)
Info-apropos-toc-nodes(FILENAME)
Info-backward-node()
Info-bookmark-jump(BMK)
Info-bookmark-make-record()
Info-build-node-completions(&optional FILENAME)
Info-check-pointer(ITEM)
Info-context-menu(MENU CLICK)
Info-copy-current-node-name(&optional ARG)
Info-desktop-buffer-misc-data(DESKTOP-DIRNAME)
Info-directory()
Info-directory-find-file(FILENAME &optional NOERROR)
Info-directory-find-node(FILENAME NODENAME &optional NO-GOING-BACK)
Info-directory-toc-nodes(FILENAME)
Info-display-images-node()
Info-exit(&optional KILL WINDOW)
Info-extract-menu-counting(COUNT &optional NO-DETAIL)
Info-extract-menu-item(MENU-ITEM)
Info-extract-menu-node-name(&optional MULTI-LINE INDEX-NODE)
Info-extract-pointer(NAME &optional ERRORNAME)
Info-file-supports-index-cookies(&optional FILE)
Info-final-node()
Info-find-emacs-command-nodes(COMMAND)
Info-find-file(FILENAME &optional NOERROR NO-POP-TO-DIR)
Info-find-in-tag-table(MARKER REGEXP &optional STRICT-CASE)
Info-find-in-tag-table-1(MARKER REGEXP CASE-FOLD)
Info-find-index-name(NAME)
Info-find-node(FILENAME NODENAME &optional NO-GOING-BACK STRICT-CASE NOERROR)
Info-find-node-2(FILENAME NODENAME &optional NO-GOING-BACK STRICT-CASE)
Info-find-node-in-buffer(REGEXP &optional STRICT-CASE)
Info-find-node-in-buffer-1(REGEXP CASE-FOLD)
Info-finder-find-file(FILENAME &optional NOERROR)
Info-finder-find-node(FILENAME NODENAME &optional NO-GOING-BACK)
Info-follow-nearest-node(&optional FORK)
Info-follow-reference(FOOTNOTENAME &optional FORK)
Info-following-node-name-re(&optional ALLOWEDCHARS)
Info-fontify-node()
Info-forward-node(&optional NOT-DOWN NOT-UP NO-ERROR)
Info-get-token(POS START ALL &optional ERRORSTRING)
Info-goto-emacs-command-node(COMMAND)
Info-goto-emacs-key-command-node(KEY)
Info-goto-index()
Info-goto-node(NODENAME &optional FORK STRICT-CASE)
Info-goto-node-web(NODE)
Info-help()
Info-hide-cookies-node()
Info-history()
Info-history-back()
Info-history-back-menu(E)
Info-history-find-file(FILENAME &optional NOERROR)
Info-history-find-node(FILENAME NODENAME &optional NO-GOING-BACK)
Info-history-forward()
Info-history-forward-menu(E)
Info-history-menu(E NAME HISTORY COMMAND)
Info-history-toc-nodes(FILENAME)
Info-index(TOPIC)
Info-index-next(NUM)
Info-index-node(&optional NODE FILE)
Info-index-nodes(&optional FILE)
Info-install-speedbar-variables()
Info-isearch-filter(BEG-FOUND FOUND)
Info-isearch-pop-state(CMD FILE NODE)
Info-last()
Info-last-menu-item()
Info-last-preorder()
Info-menu(MENU-ITEM &optional FORK)
Info-menu-update()
Info-mode()
Info-mode-menu(ARG1)
Info-mouse-follow-link(CLICK)
Info-mouse-follow-nearest-node(CLICK)
Info-mouse-scroll-down(E)
Info-mouse-scroll-up(E)
Info-next()
Info-next-menu-item()
Info-next-preorder()
Info-next-reference(&optional RECUR COUNT)
Info-next-reference-or-link(PAT PROP)
Info-no-error(&rest BODY)
Info-node-at-bob-matching(REGEXP)
Info-node-description(FILE)
Info-nth-menu-item()
Info-on-current-buffer(&optional NODENAME)
Info-prev()
Info-prev-reference(&optional RECUR COUNT)
Info-prev-reference-or-link(PAT PROP)
Info-read-node-name(PROMPT &optional DEFAULT)
Info-read-node-name-1(STRING PREDICATE CODE)
Info-read-node-name-2(DIRS SUFFIXES STRING PRED ACTION)
Info-read-subfile(NODEPOS)
Info-restore-desktop-buffer(DESKTOP-BUFFER-FILE-NAME DESKTOP-BUFFER-NAME DESKTOP-BUFFER-MISC)
Info-restore-point(HL)
Info-revert-buffer-function(IGNORE-AUTO NOCONFIRM)
Info-revert-find-node(FILENAME NODENAME)
Info-scroll-down()
Info-scroll-up()
Info-search(REGEXP &optional BOUND NOERROR COUNT DIRECTION)
Info-search-backward(REGEXP &optional BOUND NOERROR COUNT)
Info-search-case-sensitively()
Info-search-next()
Info-select-node()
Info-speedbar-browser()
Info-speedbar-buttons(BUFFER)
Info-speedbar-expand-node(TEXT TOKEN INDENT)
Info-speedbar-fetch-file-nodes(NODESPEC)
Info-speedbar-goto-node(TEXT NODE INDENT)
Info-speedbar-hierarchy-buttons(DIRECTORY DEPTH &optional NODE)
Info-split-parameter-string(PARAMETER-STRING)
Info-summary()
Info-toc()
Info-toc-build(FILE)
Info-toc-find-node(FILENAME NODENAME &optional NO-GOING-BACK)
Info-toc-insert(NODES NODE-LIST LEVEL CURR-FILE)
Info-toc-nodes(FILENAME)
Info-top-node()
Info-try-follow-nearest-node(&optional FORK)
Info-undefined()
Info-unescape-quotes(VALUE)
Info-up(&optional SAME-FILE)
Info-url-for-node(NODE)
Info-virtual-call(VIRTUAL-FUN &rest ARGS)
Info-virtual-file-p(FILENAME)
Info-virtual-fun(OP FILENAME NODENAME)
Info-virtual-index(TOPIC)
Info-virtual-index-find-node(FILENAME NODENAME &optional NO-GOING-BACK)
info(&optional FILE-OR-NODE BUFFER)
info--filter-manual-names(NAMES)
info--manual-names(VISITED-ONLY)
info--node-canonicalize-whitespace(STRING)
info--prettify-description(DESC)
info-apropos(STRING &optional REGEXP)
info-display-manual(MANUAL)
info-emacs-bug()
info-emacs-manual()
info-file-exists-p(FILENAME)
info-finder(&optional KEYWORDS)
info-initialize()
info-insert-file-contents(FILENAME &optional VISIT)
info-insert-file-contents-1(FILENAME SUFFIX LFN)
info-other-window(&optional FILE-OR-NODE BUFFER)
info-pop-to-buffer(&optional FILE-OR-NODE BUFFER-OR-NAME OTHER-WINDOW)
info-setup(FILE-OR-NODE BUFFER)
info-standalone()

Defined faces (12)

Info-quotedFace used for quoted elements.
info-header-nodeFace for Info nodes in a node header.
info-header-xrefFace for Info cross-references in a node header.
info-index-matchFace used to highlight matches in an index entry.
info-menu-headerFace for headers in Info menus.
info-menu-starFace used to emphasize ‘*’ in an Info menu. The face is assigned to the third, sixth, and ninth ‘*’ for easier orientation. See ‘Info-nth-menu-item’.
info-nodeFace for Info node names.
info-title-1Face for info titles at level 1.
info-title-2Face for info titles at level 2.
info-title-3Face for info titles at level 3.
info-title-4Face for info titles at level 4.
info-xrefFace for unvisited Info cross-references.