help.el 23 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)
Richard M. Stallman's avatar
Richard M. Stallman committed
71 72 73 74 75 76 77 78

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

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

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

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

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
131 132 133 134 135 136 137 138 139 140
(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
141
      (setq buffer-auto-save-file-name nil)
Jim Blandy's avatar
Jim Blandy committed
142
      (insert-file-contents (expand-file-name "TUTORIAL" data-directory))
Richard M. Stallman's avatar
Richard M. Stallman committed
143 144 145 146
      (goto-char (point-min))
      (search-forward "\n<<")
      (beginning-of-line)
      (delete-region (point) (progn (end-of-line) (point)))
147
      (let ((n (- (window-height (selected-window))
Richard M. Stallman's avatar
Richard M. Stallman committed
148
		  (count-lines (point-min) (point))
149
		  6)))
150
	(if (< n 12)
151 152 153 154 155 156
	    (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
157 158 159 160 161 162
      (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: ")
163 164 165 166 167 168 169
  ;; 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))
170
	 (read-event)))
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
  (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
194 195 196 197 198 199

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

(defun describe-key (key)
  "Display documentation of the function invoked by KEY.  KEY is a string."
  (interactive "kDescribe key: ")
236 237 238 239 240 241 242 243
  ;; 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)))
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
  (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")
268 269 270 271 272
	    (let ((doc (documentation defn)))
	      (if doc
		  (progn (terpri)
			 (princ doc))
		(princ "not documented")))
273 274 275 276
	    (save-excursion
	      (set-buffer standard-output)
	      (help-mode))
	    (print-help-return-message)))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
277

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

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

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

357
(defun describe-prefix-bindings ()
358 359 360
  "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."
361
  (interactive)
362 363 364 365 366 367 368 369 370 371
  (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)))))
372 373
;; Make C-h after a prefix, when not specifically bound, 
;; run describe-prefix-bindings.
374 375
(setq prefix-help-command 'describe-prefix-bindings)

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

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

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

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

;; 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 ()
461 462 463 464 465 466 467 468 469 470 471 472
	  (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
473 474
	(error nil))))

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

(defun variable-at-point ()
  (condition-case ()
563 564 565 566 567 568 569 570 571 572 573 574
      (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) (boundp obj) obj)))
	  (set-syntax-table stab)))
Richard M. Stallman's avatar
Richard M. Stallman committed
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
    (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))
593 594
        (princ " is void")
      (princ "'s value is ")
Richard M. Stallman's avatar
Richard M. Stallman committed
595
      (prin1 (symbol-value variable)))
596
    (terpri)
597
    (if (local-variable-p variable)
598 599 600 601 602 603 604
	(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)))
605
    (terpri)
Richard M. Stallman's avatar
Richard M. Stallman committed
606 607 608
    (princ "Documentation:")
    (terpri)
    (let ((doc (documentation-property variable 'variable-documentation)))
609
      (princ (or doc "not documented as a variable.")))
Richard M. Stallman's avatar
Richard M. Stallman committed
610
    (print-help-return-message)
611 612 613 614 615
    (save-excursion
      (set-buffer standard-output)
      (help-mode)
      ;; Return the text we displayed.
      (buffer-string))))
Richard M. Stallman's avatar
Richard M. Stallman committed
616

617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
(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)

637
(defun locate-library (library &optional nosuffix path interactive-call)
638
  "Show the precise file name of Emacs library LIBRARY.
Richard M. Stallman's avatar
Richard M. Stallman committed
639 640 641
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'
642 643 644 645
to the specified name LIBRARY.

If the optional third arg PATH is specified, that list of directories
is used instead of `load-path'."
646 647 648 649 650 651
  (interactive (list (read-string "Locate library: ")
		     nil nil
		     t))
  (let (result)
    (catch 'answer
      (mapcar
652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675
       (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)))))
676 677 678 679 680 681
       (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
682 683

;;; help.el ends here