help.el 23.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
;; 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
Erik Naggum's avatar
Erik Naggum committed
21 22 23
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Richard M. Stallman's avatar
Richard M. Stallman committed
24

25 26
;;; Commentary:

27
;; This code implements GNU Emacs' on-line help system, the one invoked by
28 29
;;`M-x help-for-help'.

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

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

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

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

Eric S. Raymond's avatar
Eric S. Raymond committed
42
(define-key global-map (char-to-string help-char) 'help-command)
43 44
(define-key global-map [help] 'help-command)
(define-key global-map [f1] 'help-command)
Richard M. Stallman's avatar
Richard M. Stallman committed
45 46
(fset 'help-command help-map)

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

66 67
(define-key help-map "F" 'view-emacs-FAQ)

Richard M. Stallman's avatar
Richard M. Stallman committed
68
(define-key help-map "i" 'info)
Jim Blandy's avatar
Jim Blandy committed
69 70
(define-key help-map "\C-f" 'Info-goto-emacs-command-node)
(define-key help-map "\C-k" 'Info-goto-emacs-key-command-node)
71
(define-key help-map "\C-i" 'word-help)
Richard M. Stallman's avatar
Richard M. Stallman committed
72 73 74 75 76 77 78 79

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

80
(define-key help-map "p" 'finder-by-keyword)
81 82
(autoload 'finder-by-keyword "finder"
  "Find packages matching a given keyword." t)
83

Richard M. Stallman's avatar
Richard M. Stallman committed
84 85 86 87 88 89 90 91
(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
92 93
(define-key help-map "q" 'help-quit)

Simon Marshall's avatar
Simon Marshall committed
94
(defvar help-font-lock-keywords
95 96 97 98 99 100
  (eval-when-compile
    (let ((name-char "[-+a-zA-Z0-9_*]") (sym-char "[-+a-zA-Z0-9_:*]"))
      (list
       ;;
       ;; The symbol itself.
       (list (concat "\\`\\(" name-char "+\\)\\(\\(:\\)\\|\\('\\)\\)")
101 102
	     '(1 (if (match-beginning 3)
		     font-lock-function-name-face
103
		   font-lock-variable-name-face)))
104 105 106 107 108 109 110
       ;;
       ;; Words inside `' which tend to be symbol names.
       (list (concat "`\\(" sym-char sym-char "+\\)'")
	     1 'font-lock-reference-face t)
       ;;
       ;; CLisp `:' keywords as references.
       (list (concat "\\<:" sym-char "+\\>") 0 'font-lock-reference-face t))))
Simon Marshall's avatar
Simon Marshall committed
111 112
  "Default expressions to highlight in Help mode.")

Karl Heuer's avatar
Karl Heuer committed
113 114 115 116 117 118 119 120 121 122
(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)
Simon Marshall's avatar
Simon Marshall committed
123
  (make-local-variable 'font-lock-defaults)
124
  (setq font-lock-defaults '(help-font-lock-keywords))
125
  (view-mode)
Karl Heuer's avatar
Karl Heuer committed
126 127
  (run-hooks 'help-mode-hook))

Richard M. Stallman's avatar
Richard M. Stallman committed
128 129 130 131
(defun help-quit ()
  (interactive)
  nil)

Richard M. Stallman's avatar
Richard M. Stallman committed
132 133 134 135 136 137 138 139 140 141
(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
142
      (setq buffer-auto-save-file-name nil)
Jim Blandy's avatar
Jim Blandy committed
143
      (insert-file-contents (expand-file-name "TUTORIAL" data-directory))
Richard M. Stallman's avatar
Richard M. Stallman committed
144 145 146 147
      (goto-char (point-min))
      (search-forward "\n<<")
      (beginning-of-line)
      (delete-region (point) (progn (end-of-line) (point)))
148
      (let ((n (- (window-height (selected-window))
Richard M. Stallman's avatar
Richard M. Stallman committed
149
		  (count-lines (point-min) (point))
150
		  6)))
151
	(if (< n 12)
152 153 154 155 156 157
	    (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
158 159 160 161 162 163
      (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: ")
164 165 166 167 168 169 170
  ;; 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))
171
	 (read-event)))
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
  (save-excursion
    (let ((modifiers (event-modifiers (aref key 0)))
	  window position)
      ;; For a mouse button event, go to the button it applies to
      ;; to get the right key bindings.  And go to the right place
      ;; in case the keymap depends on where you clicked.
      (if (or (memq 'click modifiers) (memq 'down modifiers)
	      (memq 'drag modifiers))
	  (setq window (posn-window (event-start (aref key 0)))
		position (posn-point (event-start (aref key 0)))))
      (if (windowp window)
	  (progn
	    (set-buffer (window-buffer window))
	    (goto-char position)))
      ;; Ok, now look up the key and name the command.
      (let ((defn (key-binding key)))
	(if (or (null defn) (integerp defn))
	    (message "%s is undefined" (key-description key))
	  (message (if (windowp window)
		       "%s at that spot runs the command %s"
		     "%s runs the command %s")
		   (key-description key)
		   (if (symbolp defn) defn (prin1-to-string defn))))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
195 196 197 198 199 200

(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))
201
       (let ((first-message
202
	      (cond ((special-display-p (buffer-name standard-output))
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
		     ;; 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.
		     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 "  " "")
222 223
		   ;; If the help buffer will go in a separate frame,
		   ;; it's no use mentioning a command to scroll, so don't.
224
		   (if (special-display-p (buffer-name standard-output))
225
		       nil
226
		     (if (same-window-p (buffer-name standard-output))
227 228 229 230
			 ;; Say how to scroll this window.
			 (substitute-command-keys
			  "\\[scroll-up] to scroll the help.")
		       ;; Say how to scroll some other window.
231
		       (substitute-command-keys
232
			"\\[scroll-other-window] to scroll the help."))))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
233 234 235 236

(defun describe-key (key)
  "Display documentation of the function invoked by KEY.  KEY is a string."
  (interactive "kDescribe key: ")
237 238 239 240 241 242 243 244
  ;; 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)))
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
  (save-excursion
    (let ((modifiers (event-modifiers (aref key 0)))
	  window position)
      ;; For a mouse button event, go to the button it applies to
      ;; to get the right key bindings.  And go to the right place
      ;; in case the keymap depends on where you clicked.
      (if (or (memq 'click modifiers) (memq 'down modifiers)
	      (memq 'drag modifiers))
	  (setq window (posn-window (event-start (aref key 0)))
		position (posn-point (event-start (aref key 0)))))
      (if (windowp window)
	  (progn
	    (set-buffer (window-buffer window))
	    (goto-char position)))
      (let ((defn (key-binding key)))
	(if (or (null defn) (integerp defn))
	    (message "%s is undefined" (key-description key))
	  (with-output-to-temp-buffer "*Help*"
	    (princ (key-description key))
	    (if (windowp window)
		(princ " at that spot"))
	    (princ " runs the command ")
	    (prin1 defn)
	    (princ ":\n")
269 270 271 272 273
	    (let ((doc (documentation defn)))
	      (if doc
		  (progn (terpri)
			 (princ doc))
		(princ "not documented")))
274 275 276 277
	    (save-excursion
	      (set-buffer standard-output)
	      (help-mode))
	    (print-help-return-message)))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
278

279 280
(defun describe-mode ()
  "Display documentation of current major mode and minor modes.
Richard M. Stallman's avatar
Richard M. Stallman committed
281
For this to work correctly for a minor mode, the mode's indicator variable
282
\(listed in `minor-mode-alist') must also be a function whose documentation
Richard M. Stallman's avatar
Richard M. Stallman committed
283
describes the minor mode."
284
  (interactive)
Richard M. Stallman's avatar
Richard M. Stallman committed
285
  (with-output-to-temp-buffer "*Help*"
286
    (let ((minor-modes minor-mode-alist)
287
	  (first t))
288 289
      (while minor-modes
	(let* ((minor-mode (car (car minor-modes)))
290
	       (indicator (car (cdr (car minor-modes)))))
291 292 293
	  ;; Document a minor mode if it is listed in minor-mode-alist,
	  ;; bound locally in this buffer, non-nil, and has a function
	  ;; definition.
294
	  (if (and (symbol-value minor-mode)
295 296 297 298 299 300 301 302 303
		   (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)))
304 305 306 307
		(if first
		    (princ "The minor modes are described first,
followed by the major mode, which is described on the last page.\n\f\n"))
		(setq first nil)
308 309 310 311 312
		(princ (format "%s minor mode (%s):\n"
			       pretty-minor-mode
			       (if indicator
				   (format "indicator%s" indicator)
				 "no indicator")))
313
		(princ (documentation minor-mode))
314
		(princ "\n\f\n"))))
315
	(setq minor-modes (cdr minor-modes))))
Richard M. Stallman's avatar
Richard M. Stallman committed
316
    (princ mode-name)
317
    (princ " mode:\n")
Richard M. Stallman's avatar
Richard M. Stallman committed
318
    (princ (documentation major-mode))
319 320 321
    (save-excursion
      (set-buffer standard-output)
      (help-mode))
Richard M. Stallman's avatar
Richard M. Stallman committed
322 323 324 325 326 327 328 329 330
    (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
331
   (expand-file-name "DISTRIB" data-directory)))
Richard M. Stallman's avatar
Richard M. Stallman committed
332 333 334 335 336

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

340 341 342 343 344 345 346
(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
347 348 349 350 351 352 353 354
(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)))

355
(defun describe-prefix-bindings ()
356 357 358
  "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."
359
  (interactive)
360 361 362 363 364 365 366 367 368 369
  (let* ((key (this-command-keys)))
    (describe-bindings
     (if (stringp key)
	 (substring key 0 (1- (length key)))
       (let ((prefix (make-vector (1- (length key)) nil))
	     (i 0))
	 (while (< i (length prefix))
	   (aset prefix i (aref key i))
	   (setq i (1+ i)))
	 prefix)))))
370 371
;; Make C-h after a prefix, when not specifically bound, 
;; run describe-prefix-bindings.
372 373
(setq prefix-help-command 'describe-prefix-bindings)

Richard M. Stallman's avatar
Richard M. Stallman committed
374 375 376
(defun view-emacs-news ()
  "Display info on recent changes to Emacs."
  (interactive)
Jim Blandy's avatar
Jim Blandy committed
377
  (find-file-read-only (expand-file-name "NEWS" data-directory)))
Richard M. Stallman's avatar
Richard M. Stallman committed
378

379 380 381 382 383
(defun view-emacs-FAQ ()
  "Display the Emacs Frequently Asked Questions (FAQ) file."
  (interactive)
  (find-file-read-only (expand-file-name "FAQ" data-directory)))

Richard M. Stallman's avatar
Richard M. Stallman committed
384 385 386 387
(defun view-lossage ()
  "Display last 100 input keystrokes."
  (interactive)
  (with-output-to-temp-buffer "*Help*"
388 389 390 391 392 393 394 395
    (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
396 397 398 399 400
    (save-excursion
      (set-buffer standard-output)
      (goto-char (point-min))
      (while (progn (move-to-column 50) (not (eobp)))
	(search-forward " " nil t)
401 402
	(insert "\n"))
      (help-mode))
Richard M. Stallman's avatar
Richard M. Stallman committed
403 404
    (print-help-return-message)))

Richard M. Stallman's avatar
Richard M. Stallman committed
405
(defalias 'help 'help-for-help)
406
(make-help-screen help-for-help
407
  "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:"
408
  "You have typed \\[help-command], the help character.  Type a Help option:
409
\(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
410

411 412 413
a  command-apropos.  Give a substring, and see a list of commands
	(functions interactively callable) that contain
	that substring.  See also the  apropos  command.
414 415
b  describe-bindings.  Display table of all key bindings.
c  describe-key-briefly.  Type a command key sequence;
416
	it prints the function name that sequence runs.
417
f  describe-function.  Type a function name and get documentation of it.
418 419
C-f Info-goto-emacs-command-node.  Type a function name;
	it takes you to the Info node for that command.
420
F  view-emacs-FAQ.  Shows emacs frequently asked questions file.
421 422
i  info. The  info  documentation reader.
k  describe-key.  Type a command key sequence;
423 424 425
	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.
426 427
l  view-lossage.  Shows last 100 characters you typed.
m  describe-mode.  Print documentation of current major mode,
428
	which describes the commands peculiar to it.
429 430 431 432 433
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;
434
	it displays the variable's documentation and value.
435
w  where-is.  Type command name; it prints which keystrokes
436
	invoke that command.
Richard M. Stallman's avatar
Richard M. Stallman committed
437 438 439
C-c print Emacs copying permission (General Public License).
C-d print Emacs ordering information.
C-n print news of recent Emacs changes.
440
C-p print information about the GNU project.
Richard M. Stallman's avatar
Richard M. Stallman committed
441
C-w print information on absence of warranty for GNU Emacs."
442
  help-map)
Richard M. Stallman's avatar
Richard M. Stallman committed
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458

;; 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 ()
459 460 461 462 463 464 465 466 467 468 469 470
	  (let ((stab (syntax-table)))
	    (unwind-protect
		(save-excursion
		  (set-syntax-table emacs-lisp-mode-syntax-table)
		  (or (not (zerop (skip-syntax-backward "_w")))
		      (eq (char-syntax (following-char)) ?w)
		      (eq (char-syntax (following-char)) ?_)
		      (forward-sexp -1))
		  (skip-chars-forward "'")
		  (let ((obj (read (current-buffer))))
		    (and (symbolp obj) (fboundp obj) obj)))
	      (set-syntax-table stab)))
Richard M. Stallman's avatar
Richard M. Stallman committed
471 472
	(error nil))))

473 474 475 476 477 478 479 480 481
(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
482 483 484 485 486 487 488 489 490 491 492 493
(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)))))
494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
  (if function
      (with-output-to-temp-buffer "*Help*"
	(prin1 function)
	(princ ": ")
	(let* ((def (symbol-function function))
	       file-name
	       (beg (if (commandp def) "an interactive " "a ")))
	  (princ (cond ((or (stringp def)
			    (vectorp def))
			"a keyboard macro")
		       ((subrp def)
			(concat beg "built-in function"))
		       ((byte-code-function-p def)
			(concat beg "compiled Lisp function"))
		       ((symbolp def)
			(format "alias for `%s'" def))
		       ((eq (car-safe def) 'lambda)
			(concat beg "Lisp function"))
		       ((eq (car-safe def) 'macro)
			"a Lisp macro")
		       ((eq (car-safe def) 'mocklisp)
			"a mocklisp function")
		       ((eq (car-safe def) 'autoload)
			(setq file-name (nth 1 def))
			(format "%s autoloaded Lisp %s"
				(if (commandp def) "an interactive" "an")
				(if (nth 4 def) "macro" "function")
				))
		       (t "")))
	  (or file-name
	      (setq file-name (describe-function-find-file function)))
	  (if file-name
	      (progn
		(princ " in `")
		;; We used to add .el to the file name,
		;; but that's completely wrong when the user used load-file.
		(princ file-name)
		(princ "'")))
	  (princ ".")
	  (terpri)
	  (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))))
	  (let ((doc (documentation function)))
	    (if doc
		(progn (terpri)
		       (princ doc))
	      (princ "not documented"))))
	(print-help-return-message)
	(save-excursion
	  (set-buffer standard-output)
	  (help-mode)
	  ;; Return the text we displayed.
	  (buffer-string)))
    (message "You didn't specify a function")))

;; We return 0 if we can't find a variable to return.
Richard M. Stallman's avatar
Richard M. Stallman committed
562 563
(defun variable-at-point ()
  (condition-case ()
564 565 566 567 568 569 570 571 572 573
      (let ((stab (syntax-table)))
	(unwind-protect
	    (save-excursion
	      (set-syntax-table emacs-lisp-mode-syntax-table)
	      (or (not (zerop (skip-syntax-backward "_w")))
		  (eq (char-syntax (following-char)) ?w)
		  (eq (char-syntax (following-char)) ?_)
		  (forward-sexp -1))
	      (skip-chars-forward "'")
	      (let ((obj (read (current-buffer))))
574 575
		(or (and (symbolp obj) (boundp obj) obj)
		    0)))
576
	  (set-syntax-table stab)))
577
    (error 0)))
Richard M. Stallman's avatar
Richard M. Stallman committed
578 579 580 581 582 583 584 585

(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)
586
     (setq val (completing-read (if (symbolp v)
Richard M. Stallman's avatar
Richard M. Stallman committed
587 588 589 590 591
				    (format "Describe variable (default %s): " v)
				  "Describe variable: ")
				obarray 'boundp t))
     (list (if (equal val "")
	       v (intern val)))))
592
  (if (symbolp variable)
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
      (let (valvoid)
	(with-output-to-temp-buffer "*Help*"
	  (prin1 variable)
	  (if (not (boundp variable))
	      (progn
		(princ " is void")
		(terpri)
		(setq valvoid t))
	    (princ "'s value is ")
	    (terpri)
	    (pp (symbol-value variable))
	    (terpri))
	  (if (local-variable-p variable)
	      (progn
		(princ (format "Local in buffer %s; " (buffer-name)))
		(if (not (default-boundp variable))
		    (princ "globally void")
		  (princ "global value is ")
		  (terpri)
		  (pp (default-value variable)))
		(terpri)))
	  (terpri)
	  (save-current-buffer
	    (set-buffer standard-output)
	    (if (> (count-lines (point-min) (point-max)) 10)
		(progn
		  (goto-char (point-min))
		  (if valvoid
		      (forward-line 1)
		    (forward-sexp 1)
		    (delete-region (point) (progn (end-of-line) (point)))
		    (insert "'s value is shown below.\n\n")
		    (save-excursion
		      (insert "\n\nValue:"))))))
	  (princ "Documentation:")
	  (terpri)
	  (let ((doc (documentation-property variable 'variable-documentation)))
	    (princ (or doc "not documented as a variable.")))
	  (print-help-return-message)
	  (save-excursion
	    (set-buffer standard-output)
	    (help-mode)
	    ;; Return the text we displayed.
	    (buffer-string))))
637
    (message "You did not specify a variable")))
Richard M. Stallman's avatar
Richard M. Stallman committed
638

639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
(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)

659
(defun locate-library (library &optional nosuffix path interactive-call)
660
  "Show the precise file name of Emacs library LIBRARY.
Richard M. Stallman's avatar
Richard M. Stallman committed
661 662 663
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'
664 665 666 667
to the specified name LIBRARY.

If the optional third arg PATH is specified, that list of directories
is used instead of `load-path'."
668 669 670 671 672 673
  (interactive (list (read-string "Locate library: ")
		     nil nil
		     t))
  (let (result)
    (catch 'answer
      (mapcar
674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697
       (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
		     (setq result try)
		     (throw 'answer try)))))
	  (if nosuffix
	      '("")
	    (let ((basic '(".elc" ".el" ""))
		  (compressed '(".Z" ".gz" "")))
	      ;; If autocompression mode is on,
	      ;; consider all combinations of library suffixes
	      ;; and compression suffixes.
	      (if (rassq 'jka-compr-handler file-name-handler-alist)
		  (apply 'nconc
			 (mapcar (lambda (compelt)
				   (mapcar (lambda (baselt)
					     (concat baselt compelt))
					   basic))
				 compressed))
		basic)))))
698 699 700 701 702 703
       (or path load-path)))
    (and interactive-call
	 (if result
	     (message "Library is file %s" result)
	   (message "No library %s in search path" library)))
    result))
Eric S. Raymond's avatar
Eric S. Raymond committed
704 705

;;; help.el ends here