Function: helpful-mode

helpful-mode is an interactive and byte-compiled function defined in helpful.el.

Signature

(helpful-mode)

Documentation

Major mode for *Helpful* buffers.

In addition to any hooks its parent mode special-mode might have run, this mode runs the hook helpful-mode-hook, as the final or penultimate step during initialization.

           helpful-update
- negative-argument
0 digit-argument
1 digit-argument
2 digit-argument
3 digit-argument
4 digit-argument
5 digit-argument
6 digit-argument
7 digit-argument
8 digit-argument
9 digit-argument
< beginning-of-buffer
<backtab> backward-button
> end-of-buffer
? describe-mode
C-x x g helpful-update
DEL scroll-down-command
RET helpful-visit-reference
S-SPC scroll-down-command
SPC scroll-up-command
SPC..~ undefined
TAB forward-button
g helpful-update
g revert-buffer
h describe-mode
n forward-button
p backward-button
q quit-window

Key Bindings

Source Code

;; Defined in ~/.emacs.d/elpa/helpful-20250408.334/helpful.el
(define-derived-mode helpful-mode special-mode "Helpful"
  "Major mode for *Helpful* buffers."
  (add-hook 'xref-backend-functions #'elisp--xref-backend nil t)

  (setq imenu-create-index-function #'helpful--imenu-index)
  ;; Prevent imenu converting "Source Code" to "Source.Code".
  (setq-local imenu-space-replacement " ")

  ;; Enable users to bookmark helpful buffers.
  (set (make-local-variable 'bookmark-make-record-function)
       #'helpful--bookmark-make-record)

  ;; Enable outline support for Emacs 29 and newer
  (unless (< emacs-major-version 29)
    (setq-local outline-search-function #'helpful--outline-function))

  ;; This function should normally only be called once after Org and
  ;; helpful are loaded. To avoid using `eval-after-load' (which is
  ;; only recommended in user init files), the function is called each
  ;; time the major mode is used.
  (helpful--add-support-for-org-links))