Function: embark-auto-prefix-help-mode

embark-auto-prefix-help-mode is an autoloaded, interactive and byte-compiled function defined in embark.el.

Signature

(embark-auto-prefix-help-mode &optional ARG)

Documentation

Global minor mode to automatically provide prefix help.

This global minor mode will automatically prompt you for a command to run under the key binding prefix you have typed, if you pause for a number of seconds (given by embark-auto-prefix-help-delay). This functionality is similar to that of the which-key package, which comes with Emacs 30 and later.

If you do sometimes want this kind of help remembering commands under a prefix, but do not want it to occur automatically after a delay, you can have it instead appear when pressing help-char (C-h by default) after a prefix, by setting:

(setq prefix-help-command #='embark-prefix-help-command)

This is a global minor mode. If called interactively, toggle the Embark-Auto-Prefix-Help mode mode. If the prefix argument is positive, enable the mode, and if it is zero or negative, disable the mode.

If called from Lisp, toggle the mode if ARG is toggle. Enable the mode if ARG is nil, omitted, or is a positive number. Disable the mode if ARG is a negative number.

To check whether the minor mode is enabled in the current buffer, evaluate (default-value \=embark-auto-prefix-help-mode)'.

The mode's hook is called both when the mode is enabled and when it is disabled.

Key Bindings

Source Code

;; Defined in ~/.emacs.d/elpa/embark-20260610.302/embark.el
;;;###autoload
(define-minor-mode embark-auto-prefix-help-mode
  "Global minor mode to automatically provide prefix help.

This global minor mode will automatically prompt you for a command to
run under the key binding prefix you have typed, if you pause for a
number of seconds (given by `embark-auto-prefix-help-delay').  This
functionality is similar to that of the which-key package, which comes
with Emacs 30 and later.

If you do sometimes want this kind of help remembering commands under a
prefix, but do not want it to occur automatically after a delay, you can
have it instead appear when pressing `help-char' (C-h by default) after
a prefix, by setting:

\(setq prefix-help-command #\='embark-prefix-help-command)"
  :lighter " eaph"
  :global t
  (if embark-auto-prefix-help-mode
      (setq embark--backup-prefix-help-command prefix-help-command
            prefix-help-command #'embark-prefix-help-command
            embark--auto-prefix-help-timer
            (run-with-idle-timer embark-auto-prefix-help-delay t
                                 #'embark--auto-prefix-help))
    (cancel-timer embark--auto-prefix-help-timer)
    (setq prefix-help-command embark--backup-prefix-help-command)))