help.el 19 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.")

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

Eric S. Raymond's avatar
Eric S. Raymond committed
41
(define-key help-map (char-to-string help-char) 'help-for-help)
Richard M. Stallman's avatar
Richard M. Stallman committed
42 43 44 45 46
(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)
47
(define-key help-map "\C-p" 'describe-project)
Richard M. Stallman's avatar
Richard M. Stallman committed
48 49 50 51 52 53 54 55 56 57 58
(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
59 60
(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
61 62 63 64 65 66 67 68

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

69
(define-key help-map "p" 'finder-by-keyword)
70 71
(autoload 'finder-by-keyword "finder"
  "Find packages matching a given keyword." t)
72

Richard M. Stallman's avatar
Richard M. Stallman committed
73 74 75 76 77 78 79 80
(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
81 82 83 84 85 86
(define-key help-map "q" 'help-quit)

(defun help-quit ()
  (interactive)
  nil)

Richard M. Stallman's avatar
Richard M. Stallman committed
87 88 89 90 91 92 93 94 95 96
(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
97
      (setq buffer-auto-save-file-name nil)
Jim Blandy's avatar
Jim Blandy committed
98
      (insert-file-contents (expand-file-name "TUTORIAL" data-directory))
Richard M. Stallman's avatar
Richard M. Stallman committed
99 100 101 102
      (goto-char (point-min))
      (search-forward "\n<<")
      (beginning-of-line)
      (delete-region (point) (progn (end-of-line) (point)))
103
      (let ((n (- (window-height (selected-window))
Richard M. Stallman's avatar
Richard M. Stallman committed
104
		  (count-lines (point-min) (point))
105
		  6)))
106
	(if (< n 12)
107 108 109 110 111 112
	    (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
113 114 115 116 117 118
      (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: ")
119 120 121 122 123 124 125
  ;; 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))
126
	 (read-event)))
Richard M. Stallman's avatar
Richard M. Stallman committed
127 128 129 130 131 132 133 134 135 136 137 138
  (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))
139 140 141
       (let ((first-message
	      (cond ((or (member (buffer-name standard-output)
				 special-display-buffer-names)
142 143
			 (assoc (buffer-name standard-output)
				special-display-buffer-names)
144 145 146 147
			 (let (found
			       (tail special-display-regexps)
			       (name (buffer-name standard-output)))
			   (while (and tail (not found))
148 149 150 151
			     (if (or (and (consp (car taiul))
					  (string-match (car (car tail)) name))
				     (and (stringp (car tail))
					  (string-match (car tail) name)))
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
				 (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
178 179 180 181

(defun describe-key (key)
  "Display documentation of the function invoked by KEY.  KEY is a string."
  (interactive "kDescribe key: ")
182 183 184 185 186 187 188 189
  ;; 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
190 191 192 193 194 195 196 197 198 199 200
  (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"))
	(print-help-return-message)))))

201 202
(defun describe-mode ()
  "Display documentation of current major mode and minor modes.
Richard M. Stallman's avatar
Richard M. Stallman committed
203
For this to work correctly for a minor mode, the mode's indicator variable
204
\(listed in `minor-mode-alist') must also be a function whose documentation
Richard M. Stallman's avatar
Richard M. Stallman committed
205
describes the minor mode."
206
  (interactive)
Richard M. Stallman's avatar
Richard M. Stallman committed
207
  (with-output-to-temp-buffer "*Help*"
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
    (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
233
    (princ mode-name)
234
    (princ " mode:\n")
Richard M. Stallman's avatar
Richard M. Stallman committed
235 236 237 238 239 240 241 242 243 244
    (princ (documentation major-mode))
    (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
245
   (expand-file-name "DISTRIB" data-directory)))
Richard M. Stallman's avatar
Richard M. Stallman committed
246 247 248 249 250

(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
251
   (expand-file-name "COPYING" data-directory))
Richard M. Stallman's avatar
Richard M. Stallman committed
252 253
  (goto-char (point-min)))

254 255 256 257 258 259 260
(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
261 262 263 264 265 266 267 268
(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)))

269
(defun describe-prefix-bindings ()
270 271 272
  "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."
273 274 275 276 277 278 279 280 281
  (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)))
282 283
;; Make C-h after a prefix, when not specifically bound, 
;; run describe-prefix-bindings.
284 285
(setq prefix-help-command 'describe-prefix-bindings)

Richard M. Stallman's avatar
Richard M. Stallman committed
286 287 288
(defun view-emacs-news ()
  "Display info on recent changes to Emacs."
  (interactive)
Jim Blandy's avatar
Jim Blandy committed
289
  (find-file-read-only (expand-file-name "NEWS" data-directory)))
Richard M. Stallman's avatar
Richard M. Stallman committed
290 291 292 293 294

(defun view-lossage ()
  "Display last 100 input keystrokes."
  (interactive)
  (with-output-to-temp-buffer "*Help*"
295 296 297 298 299 300 301 302
    (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
303 304 305 306 307 308 309 310
    (save-excursion
      (set-buffer standard-output)
      (goto-char (point-min))
      (while (progn (move-to-column 50) (not (eobp)))
	(search-forward " " nil t)
	(insert "\n")))
    (print-help-return-message)))

Richard M. Stallman's avatar
Richard M. Stallman committed
311
(defalias 'help 'help-for-help)
312
(make-help-screen help-for-help
313
  "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:"
314
  "You have typed \\[help-command], the help character.  Type a Help option:
Richard M. Stallman's avatar
Richard M. Stallman committed
315 316
\(Use \\<help-map>\\[scroll-up] or \\[scroll-down] to scroll through this text.
Type \\<help-map>\\[help-quit] to exit the Help command.)
Richard M. Stallman's avatar
Richard M. Stallman committed
317

318 319 320
a  command-apropos.  Give a substring, and see a list of commands
	(functions interactively callable) that contain
	that substring.  See also the  apropos  command.
321 322
b  describe-bindings.  Display table of all key bindings.
c  describe-key-briefly.  Type a command key sequence;
323
	it prints the function name that sequence runs.
324
f  describe-function.  Type a function name and get documentation of it.
325 326
C-f Info-goto-emacs-command-node.  Type a function name;
	it takes you to the Info node for that command.
327 328
i  info. The  info  documentation reader.
k  describe-key.  Type a command key sequence;
329 330 331
	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.
332 333
l  view-lossage.  Shows last 100 characters you typed.
m  describe-mode.  Print documentation of current major mode,
334
	which describes the commands peculiar to it.
335 336 337 338 339
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;
340
	it displays the variable's documentation and value.
341
w  where-is.  Type command name; it prints which keystrokes
342
	invoke that command.
Richard M. Stallman's avatar
Richard M. Stallman committed
343 344 345
C-c print Emacs copying permission (General Public License).
C-d print Emacs ordering information.
C-n print news of recent Emacs changes.
346
C-p print information about the GNU project.
Richard M. Stallman's avatar
Richard M. Stallman committed
347
C-w print information on absence of warranty for GNU Emacs."
348
  help-map)
Richard M. Stallman's avatar
Richard M. Stallman committed
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371

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

372 373 374 375 376 377 378 379 380
(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
381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397
(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 ")))
398 399
      (princ (cond ((or (stringp def)
			(vectorp def))
400
		    "a keyboard macro")
Richard M. Stallman's avatar
Richard M. Stallman committed
401
		   ((subrp def)
402
		    (concat beg "built-in function"))
Jim Blandy's avatar
Jim Blandy committed
403
		   ((byte-code-function-p def)
404
		    (concat beg "compiled Lisp function"))
Richard M. Stallman's avatar
Richard M. Stallman committed
405
		   ((symbolp def)
406
		    (format "alias for `%s'" def))
Richard M. Stallman's avatar
Richard M. Stallman committed
407
		   ((eq (car-safe def) 'lambda)
408
		    (concat beg "Lisp function"))
Richard M. Stallman's avatar
Richard M. Stallman committed
409
		   ((eq (car-safe def) 'macro)
410
		    "a Lisp macro")
Richard M. Stallman's avatar
Richard M. Stallman committed
411
		   ((eq (car-safe def) 'mocklisp)
412
		    "a mocklisp function")
Richard M. Stallman's avatar
Richard M. Stallman committed
413
		   ((eq (car-safe def) 'autoload)
414
		    (format "%s autoloaded Lisp %s"
415
			    (if (commandp def) "an interactive" "an")
Richard M. Stallman's avatar
Richard M. Stallman committed
416
			    (if (nth 4 def) "macro" "function")
417 418 419
;;; Including the file name made this line too long.
;;;			    (nth 1 def)
			    ))
Richard M. Stallman's avatar
Richard M. Stallman committed
420
		   (t "")))
421 422 423 424 425 426
      (let ((file (describe-function-find-file function)))
	(if file
	    (progn
	      (princ " in `")
	      (princ file)
	      (princ ".el'"))))
427
      (princ ".")
428
      (terpri)
429 430 431 432 433 434 435 436 437 438 439 440 441 442
      (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))))
443
      (if (documentation function)
444 445
	  (progn (terpri)
		 (princ (documentation function)))
446
	(princ "not documented"))
447
      )
Richard M. Stallman's avatar
Richard M. Stallman committed
448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
    (print-help-return-message)
    ;; Return the text we displayed.
    (save-excursion (set-buffer standard-output) (buffer-string))))

(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)
    (princ "'s value is ")
    (if (not (boundp variable))
        (princ "void.")
      (prin1 (symbol-value variable)))
480 481 482 483 484 485 486 487 488 489 490
    (terpri)
    (let ((locals (buffer-local-variables))
	  is-local)
      (while locals
	(if (or (eq variable (car locals))
		(eq variable (car-safe (car locals))))
	    (setq is-local t locals nil))
	(setq locals (cdr locals)))
      (if is-local
	  (princ (format "Local in buffer %s\n" (buffer-name)))))
    (terpri)
Richard M. Stallman's avatar
Richard M. Stallman committed
491 492 493 494 495 496 497 498 499 500
    (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)
    ;; Return the text we displayed.
    (save-excursion (set-buffer standard-output) (buffer-string))))

501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
(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
521 522 523 524 525 526 527 528 529
(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))))
530
    (if (apropos string t 'commandp t)
531
	(and message (message message)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554

(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
555 556

;;; help.el ends here