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

Documentation

Display local help in the echo area.

This 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.

A numeric argument ARG prevents display of a message in case there is no help. While ARG can be used interactively, it is mainly meant for use from Lisp.

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 arg)
  "Display local help in the echo area.
This 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.

A numeric argument ARG prevents display of a message in case
there is no help.  While ARG can be used interactively, it is
mainly meant for use from Lisp."
  (interactive "P")
  (let ((help (help-at-pt-kbd-string)))
    (if help
	(message "%s" (substitute-command-keys help))
      (if (not arg) (message "No local help at point")))))