help.el 19.6 KB
Newer Older
Eric S. Raymond's avatar
Eric S. Raymond committed
1 2
;;; help.el --- help commands for Emacs

Karl Heuer's avatar
Karl Heuer committed
3
;; Copyright (C) 1985, 1986, 1993, 1994 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

Eric S. Raymond's avatar
Eric S. Raymond committed
5
;; Maintainer: FSF
Eric S. Raymond's avatar
Eric S. Raymond committed
6
;; Keywords: help, internal
Eric S. Raymond's avatar
Eric S. Raymond committed
7

Richard M. Stallman's avatar
Richard M. Stallman committed
8 9 10 11
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
Eric S. Raymond's avatar
Eric S. Raymond committed
12
;; the Free Software Foundation; either version 2, or (at your option)
Richard M. Stallman's avatar
Richard M. Stallman committed
13 14 15 16 17 18 19 20 21 22 23
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.

24 25 26 27 28
;;; Commentary:

;; This code implements GNU Emac's on-line help system, the one invoked by
;;`M-x help-for-help'.

Eric S. Raymond's avatar
Eric S. Raymond committed
29 30
;;; Code:

31 32
;; Get the macro make-help-screen when this is compiled,
;; or run interpreted, but not when the compiled code is loaded.
33
(eval-when-compile (require 'help-macro))
34

Richard M. Stallman's avatar
Richard M. Stallman committed
35 36 37
(defvar help-map (make-sparse-keymap)
  "Keymap for characters following the Help key.")

Karl Heuer's avatar
Karl Heuer committed
38 39 40
(defvar help-mode-map (make-sparse-keymap)
  "Keymap for help mode.")

Eric S. Raymond's avatar
Eric S. Raymond committed
41
(define-key global-map (char-to-string help-char) 'help-command)
Richard M. Stallman's avatar
Richard M. Stallman committed
42 43
(fset 'help-command help-map)

Eric S. Raymond's avatar
Eric S. Raymond committed
44
(define-key help-map (char-to-string help-char) 'help-for-help)
Richard M. Stallman's avatar
Richard M. Stallman committed
45 46 47 48 49
(define-key help-map "?" 'help-for-help)

(define-key help-map "\C-c" 'describe-copying)
(define-key help-map "\C-d" 'describe-distribution)
(define-key help-map "\C-w" 'describe-no-warranty)
50
(define-key help-map "\C-p" 'describe-project)
Richard M. Stallman's avatar
Richard M. Stallman committed
51 52 53 54 55 56 57 58 59 60 61
(define-key help-map "a" 'command-apropos)

(define-key help-map "b" 'describe-bindings)

(define-key help-map "c" 'describe-key-briefly)
(define-key help-map "k" 'describe-key)

(define-key help-map "d" 'describe-function)
(define-key help-map "f" 'describe-function)

(define-key help-map "i" 'info)
Jim Blandy's avatar
Jim Blandy committed
62 63
(define-key help-map "\C-f" 'Info-goto-emacs-command-node)
(define-key help-map "\C-k" 'Info-goto-emacs-key-command-node)
Richard M. Stallman's avatar
Richard M. Stallman committed
64 65 66 67 68 69 70 71

(define-key help-map "l" 'view-lossage)

(define-key help-map "m" 'describe-mode)

(define-key help-map "\C-n" 'view-emacs-news)
(define-key help-map "n" 'view-emacs-news)

72
(define-key help-map "p" 'finder-by-keyword)
73 74
(autoload 'finder-by-keyword "finder"
  "Find packages matching a given keyword." t)
75

Richard M. Stallman's avatar
Richard M. Stallman committed
76 77 78 79 80 81 82 83
(define-key help-map "s" 'describe-syntax)

(define-key help-map "t" 'help-with-tutorial)

(define-key help-map "w" 'where-is)

(define-key help-map "v" 'describe-variable)

Richard M. Stallman's avatar
Richard M. Stallman committed
84 85
(define-key help-map "q" 'help-quit)

Karl Heuer's avatar
Karl Heuer committed
86 87 88 89 90 91 92 93 94 95 96 97
(defun help-mode ()
  "Major mode for viewing help text.
Entry to this mode runs the normal hook `help-mode-hook'.
Commands:
\\{help-mode-map}"
  (interactive)
  (kill-all-local-variables)
  (use-local-map help-mode-map)
  (setq mode-name "Help")
  (setq major-mode 'help-mode)
  (run-hooks 'help-mode-hook))

Richard M. Stallman's avatar
Richard M. Stallman committed
98 99 100 101
(defun help-quit ()
  (interactive)
  nil)

Richard M. Stallman's avatar
Richard M. Stallman committed
102 103 104 105 106 107 108 109 110 111
(defun help-with-tutorial ()
  "Select the Emacs learn-by-doing tutorial."
  (interactive)
  (let ((file (expand-file-name "~/TUTORIAL")))
    (delete-other-windows)
    (if (get-file-buffer file)
	(switch-to-buffer (get-file-buffer file))
      (switch-to-buffer (create-file-buffer file))
      (setq buffer-file-name file)
      (setq default-directory (expand-file-name "~/"))
Jim Blandy's avatar
Jim Blandy committed
112
      (setq buffer-auto-save-file-name nil)
Jim Blandy's avatar
Jim Blandy committed
113
      (insert-file-contents (expand-file-name "TUTORIAL" data-directory))
Richard M. Stallman's avatar
Richard M. Stallman committed
114 115 116 117
      (goto-char (point-min))
      (search-forward "\n<<")
      (beginning-of-line)
      (delete-region (point) (progn (end-of-line) (point)))
118
      (let ((n (- (window-height (selected-window))
Richard M. Stallman's avatar
Richard M. Stallman committed
119
		  (count-lines (point-min) (point))
120
		  6)))
121
	(if (< n 12)
122 123 124 125 126 127
	    (newline n)
	  ;; Some people get confused by the large gap.
	  (newline (/ n 2))
	  (insert "[Middle of page left blank for didactic purposes.  "
		  "Text continues below]")
	  (newline (- n (/ n 2)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
128 129 130 131 132 133
      (goto-char (point-min))
      (set-buffer-modified-p nil))))

(defun describe-key-briefly (key)
  "Print the name of the function KEY invokes.  KEY is a string."
  (interactive "kDescribe key briefly: ")
134 135 136 137 138 139 140
  ;; If this key seq ends with a down event, discard the
  ;; following click or drag event.  Otherwise that would
  ;; erase the message.
  (let ((type (aref key (1- (length key)))))
    (if (listp type) (setq type (car type)))
    (and (symbolp type)
	 (memq 'down (event-modifiers type))
141
	 (read-event)))
Richard M. Stallman's avatar
Richard M. Stallman committed
142 143 144 145 146 147 148 149 150 151 152 153
  (let ((defn (key-binding key)))
    (if (or (null defn) (integerp defn))
        (message "%s is undefined" (key-description key))
      (message "%s runs the command %s"
	       (key-description key)
	       (if (symbolp defn) defn (prin1-to-string defn))))))

(defun print-help-return-message (&optional function)
  "Display or return message saying how to restore windows after help command.
Computes a message and applies the optional argument FUNCTION to it.
If FUNCTION is nil, applies `message' to it, thus printing it."
  (and (not (get-buffer-window standard-output))
154 155 156
       (let ((first-message
	      (cond ((or (member (buffer-name standard-output)
				 special-display-buffer-names)
157 158
			 (assoc (buffer-name standard-output)
				special-display-buffer-names)
159 160 161 162
			 (let (found
			       (tail special-display-regexps)
			       (name (buffer-name standard-output)))
			   (while (and tail (not found))
Karl Heuer's avatar
Karl Heuer committed
163
			     (if (or (and (consp (car tail))
164 165 166
					  (string-match (car (car tail)) name))
				     (and (stringp (car tail))
					  (string-match (car tail) name)))
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
				 (setq found t))
			     (setq tail (cdr tail)))
			   found))
		     ;; If the help output buffer is a special display buffer,
		     ;; don't say anything about how to get rid of it.
		     ;; First of all, the user will do that with the window
		     ;; manager, not with Emacs.
		     ;; Secondly, the buffer has not been displayed yet,
		     ;; so we don't know whether its frame will be selected.
		     ;; Even the message about scrolling the help
		     ;; might be wrong, but it seems worth showing it anyway.
		     nil)
		    ((not (one-window-p t))
		     "Type \\[switch-to-buffer-other-window] RET to restore the other window.")
		    (pop-up-windows
		     "Type \\[delete-other-windows] to remove help window.")
		    (t
		     "Type \\[switch-to-buffer] RET to remove help window."))))
	 (funcall (or function 'message)
		  (concat
		   (if first-message
		       (substitute-command-keys first-message)
		     "")
		   (if first-message "  " "")
		   (substitute-command-keys
		    "\\[scroll-other-window] to scroll the help."))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
193 194 195 196

(defun describe-key (key)
  "Display documentation of the function invoked by KEY.  KEY is a string."
  (interactive "kDescribe key: ")
197 198 199 200 201 202 203 204
  ;; If this key seq ends with a down event, discard the
  ;; following click or drag event.  Otherwise that would
  ;; erase the message.
  (let ((type (aref key (1- (length key)))))
    (if (listp type) (setq type (car type)))
    (and (symbolp type)
	 (memq 'down (event-modifiers type))
	 (read-event)))
Richard M. Stallman's avatar
Richard M. Stallman committed
205 206 207 208 209 210 211 212 213
  (let ((defn (key-binding key)))
    (if (or (null defn) (integerp defn))
        (message "%s is undefined" (key-description key))
      (with-output-to-temp-buffer "*Help*"
	(prin1 defn)
	(princ ":\n")
	(if (documentation defn)
	    (princ (documentation defn))
	  (princ "not documented"))
214 215 216
	(save-excursion
	  (set-buffer standard-output)
	  (help-mode))
Richard M. Stallman's avatar
Richard M. Stallman committed
217 218
	(print-help-return-message)))))

219 220
(defun describe-mode ()
  "Display documentation of current major mode and minor modes.
Richard M. Stallman's avatar
Richard M. Stallman committed
221
For this to work correctly for a minor mode, the mode's indicator variable
222
\(listed in `minor-mode-alist') must also be a function whose documentation
Richard M. Stallman's avatar
Richard M. Stallman committed
223
describes the minor mode."
224
  (interactive)
Richard M. Stallman's avatar
Richard M. Stallman committed
225
  (with-output-to-temp-buffer "*Help*"
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
    (let ((minor-modes minor-mode-alist)
	  (locals (buffer-local-variables)))
      (while minor-modes
	(let* ((minor-mode (car (car minor-modes)))
	       (indicator (car (cdr (car minor-modes))))
	       (local-binding (assq minor-mode locals)))
	  ;; Document a minor mode if it is listed in minor-mode-alist,
	  ;; bound locally in this buffer, non-nil, and has a function
	  ;; definition.
	  (if (and local-binding
		   (cdr local-binding)
		   (fboundp minor-mode))
	      (let ((pretty-minor-mode minor-mode))
		(if (string-match "-mode$" (symbol-name minor-mode))
		    (setq pretty-minor-mode
			  (capitalize
			   (substring (symbol-name minor-mode)
				      0 (match-beginning 0)))))
		(while (and indicator (symbolp indicator))
		  (setq indicator (symbol-value indicator)))
		(princ (format "%s minor mode (indicator%s):\n"
			       pretty-minor-mode indicator))
		(princ (documentation minor-mode))
		(princ "\n\n"))))
	(setq minor-modes (cdr minor-modes))))
Richard M. Stallman's avatar
Richard M. Stallman committed
251
    (princ mode-name)
252
    (princ " mode:\n")
Richard M. Stallman's avatar
Richard M. Stallman committed
253
    (princ (documentation major-mode))
254 255 256
    (save-excursion
      (set-buffer standard-output)
      (help-mode))
Richard M. Stallman's avatar
Richard M. Stallman committed
257 258 259 260 261 262 263 264 265
    (print-help-return-message)))

;; So keyboard macro definitions are documented correctly
(fset 'defining-kbd-macro (symbol-function 'start-kbd-macro))

(defun describe-distribution ()
  "Display info on how to obtain the latest version of GNU Emacs."
  (interactive)
  (find-file-read-only
Jim Blandy's avatar
Jim Blandy committed
266
   (expand-file-name "DISTRIB" data-directory)))
Richard M. Stallman's avatar
Richard M. Stallman committed
267 268 269 270 271

(defun describe-copying ()
  "Display info on how you may redistribute copies of GNU Emacs."
  (interactive)
  (find-file-read-only
Jim Blandy's avatar
Jim Blandy committed
272
   (expand-file-name "COPYING" data-directory))
Richard M. Stallman's avatar
Richard M. Stallman committed
273 274
  (goto-char (point-min)))

275 276 277 278 279 280 281
(defun describe-project ()
  "Display info on the GNU project."
  (interactive)
  (find-file-read-only
   (expand-file-name "GNU" data-directory))
  (goto-char (point-min)))

Richard M. Stallman's avatar
Richard M. Stallman committed
282 283 284 285 286 287 288 289
(defun describe-no-warranty ()
  "Display info on all the kinds of warranty Emacs does NOT have."
  (interactive)
  (describe-copying)
  (let (case-fold-search)
    (search-forward "NO WARRANTY")
    (recenter 0)))

290
(defun describe-prefix-bindings ()
291 292 293
  "Describe the bindings of the prefix used to reach this command.
The prefix described consists of all but the last event
of the key sequence that ran this command."
294 295 296 297 298 299 300 301 302
  (interactive)
  (let* ((key (this-command-keys))
	 (prefix (make-vector (1- (length key)) nil))
	 i)
    (setq i 0)
    (while (< i (length prefix))
      (aset prefix i (aref key i))
      (setq i (1+ i)))
    (describe-bindings prefix)))
303 304
;; Make C-h after a prefix, when not specifically bound, 
;; run describe-prefix-bindings.
305 306
(setq prefix-help-command 'describe-prefix-bindings)

Richard M. Stallman's avatar
Richard M. Stallman committed
307 308 309
(defun view-emacs-news ()
  "Display info on recent changes to Emacs."
  (interactive)
Jim Blandy's avatar
Jim Blandy committed
310
  (find-file-read-only (expand-file-name "NEWS" data-directory)))
Richard M. Stallman's avatar
Richard M. Stallman committed
311 312 313 314 315

(defun view-lossage ()
  "Display last 100 input keystrokes."
  (interactive)
  (with-output-to-temp-buffer "*Help*"
316 317 318 319 320 321 322 323
    (princ (mapconcat (function (lambda (key)
				  (if (or (integerp key)
					  (symbolp key)
					  (listp key))
				      (single-key-description key)
				    (prin1-to-string key nil))))
		      (recent-keys)
		      " "))
Richard M. Stallman's avatar
Richard M. Stallman committed
324 325 326 327 328
    (save-excursion
      (set-buffer standard-output)
      (goto-char (point-min))
      (while (progn (move-to-column 50) (not (eobp)))
	(search-forward " " nil t)
329 330
	(insert "\n"))
      (help-mode))
Richard M. Stallman's avatar
Richard M. Stallman committed
331 332
    (print-help-return-message)))

Richard M. Stallman's avatar
Richard M. Stallman committed
333
(defalias 'help 'help-for-help)
334
(make-help-screen help-for-help
335
  "a b c f C-f i k C-k l m n p s t v w C-c C-d C-n C-w, or ? for more help:"
336
  "You have typed \\[help-command], the help character.  Type a Help option:
337
\(Use SPC or DEL to scroll through this text.  Type \\<help-map>\\[help-quit] to exit the Help command.)
Richard M. Stallman's avatar
Richard M. Stallman committed
338

339 340 341
a  command-apropos.  Give a substring, and see a list of commands
	(functions interactively callable) that contain
	that substring.  See also the  apropos  command.
342 343
b  describe-bindings.  Display table of all key bindings.
c  describe-key-briefly.  Type a command key sequence;
344
	it prints the function name that sequence runs.
345
f  describe-function.  Type a function name and get documentation of it.
346 347
C-f Info-goto-emacs-command-node.  Type a function name;
	it takes you to the Info node for that command.
348 349
i  info. The  info  documentation reader.
k  describe-key.  Type a command key sequence;
350 351 352
	it displays the full documentation.
C-k Info-goto-emacs-key-command-node.  Type a command key sequence;
	it takes you to the Info node for the command bound to that key.
353 354
l  view-lossage.  Shows last 100 characters you typed.
m  describe-mode.  Print documentation of current major mode,
355
	which describes the commands peculiar to it.
356 357 358 359 360
n  view-emacs-news.  Shows emacs news file.
p  finder-by-keyword. Find packages matching a given topic keyword.
s  describe-syntax.  Display contents of syntax table, plus explanations
t  help-with-tutorial.  Select the Emacs learn-by-doing tutorial.
v  describe-variable.  Type name of a variable;
361
	it displays the variable's documentation and value.
362
w  where-is.  Type command name; it prints which keystrokes
363
	invoke that command.
Richard M. Stallman's avatar
Richard M. Stallman committed
364 365 366
C-c print Emacs copying permission (General Public License).
C-d print Emacs ordering information.
C-n print news of recent Emacs changes.
367
C-p print information about the GNU project.
Richard M. Stallman's avatar
Richard M. Stallman committed
368
C-w print information on absence of warranty for GNU Emacs."
369
  help-map)
Richard M. Stallman's avatar
Richard M. Stallman committed
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392

;; Return a function which is called by the list containing point.
;; If that gives no function, return a function whose name is around point.
;; If that doesn't give a function, return nil.
(defun function-called-at-point ()
  (or (condition-case ()
	  (save-excursion
	    (save-restriction
	      (narrow-to-region (max (point-min) (- (point) 1000)) (point-max))
	      (backward-up-list 1)
	      (forward-char 1)
	      (let (obj)
		(setq obj (read (current-buffer)))
		(and (symbolp obj) (fboundp obj) obj))))
	(error nil))
      (condition-case ()
	  (save-excursion
	    (forward-sexp -1)
	    (skip-chars-forward "'")
	    (let ((obj (read (current-buffer))))
	      (and (symbolp obj) (fboundp obj) obj)))
	(error nil))))

393 394 395 396 397 398 399 400 401
(defun describe-function-find-file (function)
  (let ((files load-history)
	file functions)
    (while files
      (if (memq function (cdr (car files)))
	  (setq file (car (car files)) files nil))
      (setq files (cdr files)))
    file))

Richard M. Stallman's avatar
Richard M. Stallman committed
402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
(defun describe-function (function)
  "Display the full documentation of FUNCTION (a symbol)."
  (interactive
   (let ((fn (function-called-at-point))
	 (enable-recursive-minibuffers t)	     
	 val)
     (setq val (completing-read (if fn
				    (format "Describe function (default %s): " fn)
				  "Describe function: ")
				obarray 'fboundp t))
     (list (if (equal val "")
	       fn (intern val)))))
  (with-output-to-temp-buffer "*Help*"
    (prin1 function)
    (princ ": ")
    (let* ((def (symbol-function function))
	   (beg (if (commandp def) "an interactive " "a ")))
419 420
      (princ (cond ((or (stringp def)
			(vectorp def))
421
		    "a keyboard macro")
Richard M. Stallman's avatar
Richard M. Stallman committed
422
		   ((subrp def)
423
		    (concat beg "built-in function"))
Jim Blandy's avatar
Jim Blandy committed
424
		   ((byte-code-function-p def)
425
		    (concat beg "compiled Lisp function"))
Richard M. Stallman's avatar
Richard M. Stallman committed
426
		   ((symbolp def)
427
		    (format "alias for `%s'" def))
Richard M. Stallman's avatar
Richard M. Stallman committed
428
		   ((eq (car-safe def) 'lambda)
429
		    (concat beg "Lisp function"))
Richard M. Stallman's avatar
Richard M. Stallman committed
430
		   ((eq (car-safe def) 'macro)
431
		    "a Lisp macro")
Richard M. Stallman's avatar
Richard M. Stallman committed
432
		   ((eq (car-safe def) 'mocklisp)
433
		    "a mocklisp function")
Richard M. Stallman's avatar
Richard M. Stallman committed
434
		   ((eq (car-safe def) 'autoload)
435
		    (format "%s autoloaded Lisp %s"
436
			    (if (commandp def) "an interactive" "an")
Richard M. Stallman's avatar
Richard M. Stallman committed
437
			    (if (nth 4 def) "macro" "function")
438 439 440
;;; Including the file name made this line too long.
;;;			    (nth 1 def)
			    ))
Richard M. Stallman's avatar
Richard M. Stallman committed
441
		   (t "")))
442 443 444 445
      (let ((file (describe-function-find-file function)))
	(if file
	    (progn
	      (princ " in `")
446 447
	      ;; We used to add .el to the file name,
	      ;; but that's completely wrong when the user used load-file.
448 449
	      (princ file)
	      (princ "'"))))
450
      (princ ".")
451
      (terpri)
452 453 454 455 456 457 458 459 460 461 462 463 464 465
      (let ((arglist (cond ((byte-code-function-p def)
			    (car (append def nil)))
			   ((eq (car-safe def) 'lambda)
			    (nth 1 def))
			   (t t))))
	(if (listp arglist)
	    (progn
	      (princ (cons function
			   (mapcar (lambda (arg)
				     (if (memq arg '(&optional &rest))
					 arg
				       (intern (upcase (symbol-name arg)))))
				   arglist)))
	      (terpri))))
466
      (if (documentation function)
467 468
	  (progn (terpri)
		 (princ (documentation function)))
469
	(princ "not documented"))
470
      )
Richard M. Stallman's avatar
Richard M. Stallman committed
471
    (print-help-return-message)
472 473 474 475 476
    (save-excursion
      (set-buffer standard-output)
      (help-mode)
      ;; Return the text we displayed.
      (buffer-string))))
Richard M. Stallman's avatar
Richard M. Stallman committed
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502

(defun variable-at-point ()
  (condition-case ()
      (save-excursion
	(forward-sexp -1)
	(skip-chars-forward "'")
	(let ((obj (read (current-buffer))))
	  (and (symbolp obj) (boundp obj) obj)))
    (error nil)))

(defun describe-variable (variable)
  "Display the full documentation of VARIABLE (a symbol).
Returns the documentation as a string, also."
  (interactive 
   (let ((v (variable-at-point))
	 (enable-recursive-minibuffers t)
	 val)
     (setq val (completing-read (if v
				    (format "Describe variable (default %s): " v)
				  "Describe variable: ")
				obarray 'boundp t))
     (list (if (equal val "")
	       v (intern val)))))
  (with-output-to-temp-buffer "*Help*"
    (prin1 variable)
    (if (not (boundp variable))
503 504
        (princ " is void")
      (princ "'s value is ")
Richard M. Stallman's avatar
Richard M. Stallman committed
505
      (prin1 (symbol-value variable)))
506
    (terpri)
507
    (if (local-variable-p variable)
508 509 510 511 512 513 514
	(progn
	  (princ (format "Local in buffer %s; " (buffer-name)))
	  (if (not (default-boundp variable))
	      (princ "globally void")
	    (princ "global value is ")
	    (prin1 (default-value variable)))
	  (terpri)))
515
    (terpri)
Richard M. Stallman's avatar
Richard M. Stallman committed
516 517 518 519 520 521 522
    (princ "Documentation:")
    (terpri)
    (let ((doc (documentation-property variable 'variable-documentation)))
      (if doc
	  (princ (substitute-command-keys doc))
	(princ "not documented as a variable.")))
    (print-help-return-message)
523 524 525 526 527
    (save-excursion
      (set-buffer standard-output)
      (help-mode)
      ;; Return the text we displayed.
      (buffer-string))))
Richard M. Stallman's avatar
Richard M. Stallman committed
528

529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
(defun where-is (definition)
  "Print message listing key sequences that invoke specified command.
Argument is a command definition, usually a symbol with a function definition."
  (interactive
   (let ((fn (function-called-at-point))
	 (enable-recursive-minibuffers t)	     
	 val)
     (setq val (completing-read (if fn
				    (format "Where is command (default %s): " fn)
				  "Where is command: ")
				obarray 'fboundp t))
     (list (if (equal val "")
	       fn (intern val)))))
  (let* ((keys (where-is-internal definition overriding-local-map nil nil))
	 (keys1 (mapconcat 'key-description keys ", ")))
    (if (> (length keys1) 0)
	(message "%s is on %s" definition keys1)
      (message "%s is not on any key" definition)))
  nil)

Richard M. Stallman's avatar
Richard M. Stallman committed
549 550 551 552 553 554 555 556 557
(defun command-apropos (string)
  "Like apropos but lists only symbols that are names of commands
\(interactively callable functions).  Argument REGEXP is a regular expression
that is matched against command symbol names.  Returns list of symbols and
documentation found."
  (interactive "sCommand apropos (regexp): ")
  (let ((message
	 (let ((standard-output (get-buffer-create "*Help*")))
	   (print-help-return-message 'identity))))
558
    (if (apropos string t 'commandp t)
559
	(and message (message message)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582

(defun locate-library (library &optional nosuffix)
  "Show the full path name of Emacs library LIBRARY.
This command searches the directories in `load-path' like `M-x load-library'
to find the file that `M-x load-library RET LIBRARY RET' would load.
Optional second arg NOSUFFIX non-nil means don't add suffixes `.elc' or `.el'
to the specified name LIBRARY (a la calling `load' instead of `load-library')."
  (interactive "sLocate library: ")
  (catch 'answer
    (mapcar
     '(lambda (dir)
	(mapcar
	 '(lambda (suf)
	    (let ((try (expand-file-name (concat library suf) dir)))
	      (and (file-readable-p try)
		   (null (file-directory-p try))
		   (progn
		     (message "Library is file %s" try)
		     (throw 'answer try)))))
	 (if nosuffix '("") '(".elc" ".el" ""))))
     load-path)
    (message "No library %s in search path" library)
    nil))
Eric S. Raymond's avatar
Eric S. Raymond committed
583 584

;;; help.el ends here