/[emacs]/emacs/lisp/help.el
ViewVC logotype

Diff of /emacs/lisp/help.el

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.286 by kfstorm, Sun Nov 13 21:25:13 2005 UTC revision 1.287 by rms, Mon Nov 14 04:46:16 2005 UTC
# Line 190  If FUNCTION is nil, it applies `message' Line 190  If FUNCTION is nil, it applies `message'
190    "You have typed %THIS-KEY%, the help character.  Type a Help option:    "You have typed %THIS-KEY%, the help character.  Type a Help option:
191  \(Use SPC or DEL to scroll through this text.  Type \\<help-map>\\[help-quit] to exit the Help command.)  \(Use SPC or DEL to scroll through this text.  Type \\<help-map>\\[help-quit] to exit the Help command.)
192    
193  a  apropos-command.  Give a pattern (a list or words or a regexp), and see a  a  command-apropos.  Give a list of words or a regexp, to get a list of
194          list of commands (functions that are interactively callable)          commands whose names match (they contain two or more of the words,
195          that matches the pattern.  See also the apropos command.          or a match for the regexp).  See also the  apropos  command.
196  b  describe-bindings.  Display table of all key bindings.  b  describe-bindings.  Display table of all key bindings.
197  c  describe-key-briefly.  Type a command key sequence;  c  describe-key-briefly.  Type a command key sequence;
198          it prints the function name that sequence runs.          it prints the function name that sequence runs.
# Line 611  the last key hit are used." Line 611  the last key hit are used."
611    
612  (defun describe-key (key &optional untranslated up-event)  (defun describe-key (key &optional untranslated up-event)
613    "Display documentation of the function invoked by KEY.    "Display documentation of the function invoked by KEY.
614  KEY should be a key sequence--when calling from a program,  KEY can be any kind of a key sequence; it can include keyboard events,
615  pass a string or a vector.  mouse events, and/or menu events.  When calling from a program,
616  If non-nil UNTRANSLATED is a vector of the untranslated events.  pass KEY as a string or a vector.
617  It can also be a number in which case the untranslated events from  
618  the last key hit are used."  If non-nil, UNTRANSLATED is a vector of the correspondinguntranslated events.
619    It can also be a number, in which case the untranslated events from
620    the last key sequence entered are used."
621    ;; UP-EVENT is the up-event that was discarded by reading KEY, or nil.    ;; UP-EVENT is the up-event that was discarded by reading KEY, or nil.
622    (interactive "kDescribe key: \np\nU")    (interactive "kDescribe key (or click or menu item): \np\nU")
623    (if (numberp untranslated)    (if (numberp untranslated)
624        (setq untranslated (this-single-command-raw-keys)))        (setq untranslated (this-single-command-raw-keys)))
625    (save-excursion    (save-excursion

Legend:
Removed from v.1.286  
changed lines
  Added in v.1.287

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26