help.el 21.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)
42 43
(define-key global-map [help] 'help-command)
(define-key global-map [f1] 'help-command)
Richard M. Stallman's avatar
Richard M. Stallman committed
44 45
(fset 'help-command help-map)

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
67
(define-key help-map "i" 'info)
Jim Blandy's avatar
Jim Blandy committed
68 69
(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
70 71 72 73 74 75 76 77

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

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

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

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

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
130 131 132 133 134 135 136 137 138 139
(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
140
      (setq buffer-auto-save-file-name nil)
Jim Blandy's avatar
Jim Blandy committed
141
      (insert-file-contents (expand-file-name "TUTORIAL" data-directory))
Richard M. Stallman's avatar
Richard M. Stallman committed
142 143 144 145
      (goto-char (point-min))
      (search-forward "\n<<")
      (beginning-of-line)
      (delete-region (point) (progn (end-of-line) (point)))
146
      (let ((n (- (window-height (selected-window))
Richard M. Stallman's avatar
Richard M. Stallman committed
147
		  (count-lines (point-min) (point))
148
		  6)))
149
	(if (< n 12)
150 151 152 153 154 155
	    (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
156 157 158 159 160 161
      (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: ")
162 163 164 165 166 167 168
  ;; 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))
169
	 (read-event)))
Richard M. Stallman's avatar
Richard M. Stallman committed
170 171 172 173 174 175 176 177 178 179 180 181
  (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))
182 183 184
       (let ((first-message
	      (cond ((or (member (buffer-name standard-output)
				 special-display-buffer-names)
185 186
			 (assoc (buffer-name standard-output)
				special-display-buffer-names)
187 188 189 190
			 (let (found
			       (tail special-display-regexps)
			       (name (buffer-name standard-output)))
			   (while (and tail (not found))
Karl Heuer's avatar
Karl Heuer committed
191
			     (if (or (and (consp (car tail))
192 193 194
					  (string-match (car (car tail)) name))
				     (and (stringp (car tail))
					  (string-match (car tail) name)))
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
				 (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 "  " "")
219 220
		   ;; If the help buffer will go in a separate frame,
		   ;; it's no use mentioning a command to scroll, so don't.
221
		   (if (or (member (buffer-name standard-output)
222
				   special-display-buffer-names)
223 224
			   (assoc (buffer-name standard-output)
				  special-display-buffer-names)
225
			   (memq t (mapcar '(lambda (elt)
226 227
					      (if (consp elt)
						  (setq elt (car elt)))
228
					      (string-match elt (buffer-name standard-output)))
229 230 231 232
					   special-display-regexps)))
		       nil
		     (if (or (member (buffer-name standard-output)
				     same-window-buffer-names)
233 234
			     (assoc (buffer-name standard-output)
				    same-window-buffer-names)
235
			     (memq t (mapcar '(lambda (elt)
236 237
						(if (consp elt)
						    (setq elt (car elt)))
238 239 240 241 242 243
						(string-match elt (buffer-name standard-output)))
					     same-window-regexps)))
			 ;; Say how to scroll this window.
			 (substitute-command-keys
			  "\\[scroll-up] to scroll the help.")
		       ;; Say how to scroll some other window.
244
		       (substitute-command-keys
245
			"\\[scroll-other-window] to scroll the help."))))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
246 247 248 249

(defun describe-key (key)
  "Display documentation of the function invoked by KEY.  KEY is a string."
  (interactive "kDescribe key: ")
250 251 252 253 254 255 256 257
  ;; 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
258 259 260 261 262 263 264 265 266
  (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"))
267 268 269
	(save-excursion
	  (set-buffer standard-output)
	  (help-mode))
Richard M. Stallman's avatar
Richard M. Stallman committed
270 271
	(print-help-return-message)))))

272 273
(defun describe-mode ()
  "Display documentation of current major mode and minor modes.
Richard M. Stallman's avatar
Richard M. Stallman committed
274
For this to work correctly for a minor mode, the mode's indicator variable
275
\(listed in `minor-mode-alist') must also be a function whose documentation
Richard M. Stallman's avatar
Richard M. Stallman committed
276
describes the minor mode."
277
  (interactive)
Richard M. Stallman's avatar
Richard M. Stallman committed
278
  (with-output-to-temp-buffer "*Help*"
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
    (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
304
    (princ mode-name)
305
    (princ " mode:\n")
Richard M. Stallman's avatar
Richard M. Stallman committed
306
    (princ (documentation major-mode))
307 308 309
    (save-excursion
      (set-buffer standard-output)
      (help-mode))
Richard M. Stallman's avatar
Richard M. Stallman committed
310 311 312 313 314 315 316 317 318
    (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
319
   (expand-file-name "DISTRIB" data-directory)))
Richard M. Stallman's avatar
Richard M. Stallman committed
320 321 322 323 324

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

328 329 330 331 332 333 334
(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
335 336 337 338 339 340 341 342
(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)))

343
(defun describe-prefix-bindings ()
344 345 346
  "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."
347
  (interactive)
348 349 350 351 352 353 354 355 356 357
  (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)))))
358 359
;; Make C-h after a prefix, when not specifically bound, 
;; run describe-prefix-bindings.
360 361
(setq prefix-help-command 'describe-prefix-bindings)

Richard M. Stallman's avatar
Richard M. Stallman committed
362 363 364
(defun view-emacs-news ()
  "Display info on recent changes to Emacs."
  (interactive)
Jim Blandy's avatar
Jim Blandy committed
365
  (find-file-read-only (expand-file-name "NEWS" data-directory)))
Richard M. Stallman's avatar
Richard M. Stallman committed
366

367 368 369 370 371
(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
372 373 374 375
(defun view-lossage ()
  "Display last 100 input keystrokes."
  (interactive)
  (with-output-to-temp-buffer "*Help*"
376 377 378 379 380 381 382 383
    (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
384 385 386 387 388
    (save-excursion
      (set-buffer standard-output)
      (goto-char (point-min))
      (while (progn (move-to-column 50) (not (eobp)))
	(search-forward " " nil t)
389 390
	(insert "\n"))
      (help-mode))
Richard M. Stallman's avatar
Richard M. Stallman committed
391 392
    (print-help-return-message)))

Richard M. Stallman's avatar
Richard M. Stallman committed
393
(defalias 'help 'help-for-help)
394
(make-help-screen help-for-help
395
  "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:"
396
  "You have typed \\[help-command], the help character.  Type a Help option:
397
\(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
398

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

;; 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
448 449 450 451
	    (or (not (zerop (skip-syntax-backward "_w")))
		(eq (char-syntax (following-char)) ?w)
		(eq (char-syntax (following-char)) ?_)
		(forward-sexp -1))
Richard M. Stallman's avatar
Richard M. Stallman committed
452 453 454 455 456
	    (skip-chars-forward "'")
	    (let ((obj (read (current-buffer))))
	      (and (symbolp obj) (fboundp obj) obj)))
	(error nil))))

457 458 459 460 461 462 463 464 465
(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
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
(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))
482
	   file-name
Richard M. Stallman's avatar
Richard M. Stallman committed
483
	   (beg (if (commandp def) "an interactive " "a ")))
484 485
      (princ (cond ((or (stringp def)
			(vectorp def))
486
		    "a keyboard macro")
Richard M. Stallman's avatar
Richard M. Stallman committed
487
		   ((subrp def)
488
		    (concat beg "built-in function"))
Jim Blandy's avatar
Jim Blandy committed
489
		   ((byte-code-function-p def)
490
		    (concat beg "compiled Lisp function"))
Richard M. Stallman's avatar
Richard M. Stallman committed
491
		   ((symbolp def)
492
		    (format "alias for `%s'" def))
Richard M. Stallman's avatar
Richard M. Stallman committed
493
		   ((eq (car-safe def) 'lambda)
494
		    (concat beg "Lisp function"))
Richard M. Stallman's avatar
Richard M. Stallman committed
495
		   ((eq (car-safe def) 'macro)
496
		    "a Lisp macro")
Richard M. Stallman's avatar
Richard M. Stallman committed
497
		   ((eq (car-safe def) 'mocklisp)
498
		    "a mocklisp function")
Richard M. Stallman's avatar
Richard M. Stallman committed
499
		   ((eq (car-safe def) 'autoload)
500
		    (setq file-name (nth 1 def))
501
		    (format "%s autoloaded Lisp %s"
502
			    (if (commandp def) "an interactive" "an")
Richard M. Stallman's avatar
Richard M. Stallman committed
503
			    (if (nth 4 def) "macro" "function")
504
			    ))
Richard M. Stallman's avatar
Richard M. Stallman committed
505
		   (t "")))
506 507 508 509 510 511 512 513 514
      (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 "'")))
515
      (princ ".")
516
      (terpri)
517 518 519 520 521 522 523 524 525 526 527 528 529 530
      (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))))
531
      (if (documentation function)
532 533
	  (progn (terpri)
		 (princ (documentation function)))
534
	(princ "not documented"))
535
      )
Richard M. Stallman's avatar
Richard M. Stallman committed
536
    (print-help-return-message)
537 538 539 540 541
    (save-excursion
      (set-buffer standard-output)
      (help-mode)
      ;; Return the text we displayed.
      (buffer-string))))
Richard M. Stallman's avatar
Richard M. Stallman committed
542 543 544 545

(defun variable-at-point ()
  (condition-case ()
      (save-excursion
546 547 548 549
	(or (not (zerop (skip-syntax-backward "_w")))
	    (eq (char-syntax (following-char)) ?w)
	    (eq (char-syntax (following-char)) ?_)
	    (forward-sexp -1))
Richard M. Stallman's avatar
Richard M. Stallman committed
550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
	(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))
571 572
        (princ " is void")
      (princ "'s value is ")
Richard M. Stallman's avatar
Richard M. Stallman committed
573
      (prin1 (symbol-value variable)))
574
    (terpri)
575
    (if (local-variable-p variable)
576 577 578 579 580 581 582
	(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)))
583
    (terpri)
Richard M. Stallman's avatar
Richard M. Stallman committed
584 585 586 587 588 589 590
    (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)
591 592 593 594 595
    (save-excursion
      (set-buffer standard-output)
      (help-mode)
      ;; Return the text we displayed.
      (buffer-string))))
Richard M. Stallman's avatar
Richard M. Stallman committed
596

597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616
(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
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
(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
639 640

;;; help.el ends here