Variable: embark-auto-prefix-help-mode

embark-auto-prefix-help-mode is a customizable variable defined in embark.el.

Value

nil

Documentation

Non-nil if Embark-Auto-Prefix-Help mode is enabled.

See the embark-auto-prefix-help-mode(var)/embark-auto-prefix-help-mode(fun) command for a description of this minor mode. Setting this variable directly does not take effect; either customize it (see the info node (emacs)Easy Customization) or call the function embark-auto-prefix-help-mode(var)/embark-auto-prefix-help-mode(fun).

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)))