summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRichard M. Stallman <rms@gnu.org>2005-11-14 04:46:16 +0000
committerRichard M. Stallman <rms@gnu.org>2005-11-14 04:46:16 +0000
commitda93d895fab482f4230c5e30ed4376a13968f9b4 (patch)
tree71f213c6858bbf9ab6001ce09b76e24f60610f7c
parent59a3e0708be2f072c52fcaceb3912db7179f1f54 (diff)
downloademacs-da93d895fab482f4230c5e30ed4376a13968f9b4.tar.gz
(help-for-help-internal): Improve doc of C-h a.
-rw-r--r--lisp/help.el20
1 files changed, 11 insertions, 9 deletions
diff --git a/lisp/help.el b/lisp/help.el
index 2e3d092b3eb..5141c06981a 100644
--- a/lisp/help.el
+++ b/lisp/help.el
@@ -190,9 +190,9 @@ If FUNCTION is nil, it applies `message', thus displaying the message."
"You have typed %THIS-KEY%, the help character. Type a Help option:
\(Use SPC or DEL to scroll through this text. Type \\<help-map>\\[help-quit] to exit the Help command.)
-a apropos-command. Give a pattern (a list or words or a regexp), and see a
- list of commands (functions that are interactively callable)
- that matches the pattern. See also the apropos command.
+a command-apropos. Give a list of words or a regexp, to get a list of
+ commands whose names match (they contain two or more of the words,
+ or a match for the regexp). See also the apropos command.
b describe-bindings. Display table of all key bindings.
c describe-key-briefly. Type a command key sequence;
it prints the function name that sequence runs.
@@ -611,13 +611,15 @@ the last key hit are used."
(defun describe-key (key &optional untranslated up-event)
"Display documentation of the function invoked by KEY.
-KEY should be a key sequence--when calling from a program,
-pass a string or a vector.
-If non-nil UNTRANSLATED is a vector of the untranslated events.
-It can also be a number in which case the untranslated events from
-the last key hit are used."
+KEY can be any kind of a key sequence; it can include keyboard events,
+mouse events, and/or menu events. When calling from a program,
+pass KEY as a string or a vector.
+
+If non-nil, UNTRANSLATED is a vector of the correspondinguntranslated events.
+It can also be a number, in which case the untranslated events from
+the last key sequence entered are used."
;; UP-EVENT is the up-event that was discarded by reading KEY, or nil.
- (interactive "kDescribe key: \np\nU")
+ (interactive "kDescribe key (or click or menu item): \np\nU")
(if (numberp untranslated)
(setq untranslated (this-single-command-raw-keys)))
(save-excursion