Function: display-local-help

display-local-help is an autoloaded, interactive and byte-compiled function defined in help-at-pt.el.gz.

Signature

(display-local-help &optional INHIBIT-WARNING DESCRIBE-BUTTON)

Documentation

Display local help in the echo area.

This command, by default, displays a short help message, namely the string produced by the kbd-help property at point. If kbd-help does not produce a string, but the help-echo property does, then that string is printed instead.

The string is passed through substitute-command-keys before it is displayed.

If INHIBIT-WARNING is non-nil, this prevents display of a message in case there is no help.

If DESCRIBE-BUTTON in non-nil (interactively, the prefix arg), and there's a button/widget at point, pop a buffer describing that button/widget instead.

View in manual

Probably introduced at or before Emacs version 22.1.

Key Bindings

Source Code

;; Defined in /usr/src/emacs/lisp/help-at-pt.el.gz
;;;###autoload
(defun display-local-help (&optional inhibit-warning describe-button)
  "Display local help in the echo area.
This command, by default, displays a short help message, namely
the string produced by the `kbd-help' property at point.  If
`kbd-help' does not produce a string, but the `help-echo'
property does, then that string is printed instead.

The string is passed through `substitute-command-keys' before it
is displayed.

If INHIBIT-WARNING is non-nil, this prevents display of a message
in case there is no help.

If DESCRIBE-BUTTON in non-nil (interactively, the prefix arg), and
there's a button/widget at point, pop a buffer describing that
button/widget instead."
  (interactive (list nil current-prefix-arg))
  (let ((help (help-at-pt-kbd-string)))
    (cond
     ((and describe-button (button-at (point)))
      (button-describe))
     ((and describe-button (widget-at (point)))
      (widget-describe))
     (help
      (message "%s" (substitute-command-keys help)))
     ((not inhibit-warning)
      (message "No local help at point")))))