Mercurial > emacs
annotate lisp/help.el @ 917:d09aafad0e95
*** empty log message ***
author | Eric S. Raymond <esr@snark.thyrsus.com> |
---|---|
date | Mon, 03 Aug 1992 21:49:55 +0000 |
parents | 5b1c5b4286e7 |
children | 94b50bbd43c3 |
rev | line source |
---|---|
660
08eb386dd0f3
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
444
diff
changeset
|
1 ;;; help.el --- help commands for Emacs |
08eb386dd0f3
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
444
diff
changeset
|
2 |
846
20674ae6bf52
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
811
diff
changeset
|
3 ;; Copyright (C) 1985, 1986 Free Software Foundation, Inc. |
20674ae6bf52
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
811
diff
changeset
|
4 |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
755
diff
changeset
|
5 ;; Maintainer: FSF |
811
e694e0879463
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
807
diff
changeset
|
6 ;; Keywords: help, internal |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
755
diff
changeset
|
7 |
409 | 8 ;; This file is part of GNU Emacs. |
9 | |
10 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
11 ;; it under the terms of the GNU General Public License as published by | |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
755
diff
changeset
|
12 ;; the Free Software Foundation; either version 2, or (at your option) |
409 | 13 ;; any later version. |
14 | |
15 ;; GNU Emacs is distributed in the hope that it will be useful, | |
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 ;; GNU General Public License for more details. | |
19 | |
20 ;; You should have received a copy of the GNU General Public License | |
21 ;; along with GNU Emacs; see the file COPYING. If not, write to | |
22 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. | |
23 | |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
755
diff
changeset
|
24 ;;; Code: |
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
755
diff
changeset
|
25 |
409 | 26 (defvar help-map (make-sparse-keymap) |
27 "Keymap for characters following the Help key.") | |
28 | |
917
d09aafad0e95
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
878
diff
changeset
|
29 (defvar help-key "\C-h" |
d09aafad0e95
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
878
diff
changeset
|
30 "*Key used to invoke electric help.") |
d09aafad0e95
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
878
diff
changeset
|
31 |
d09aafad0e95
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
878
diff
changeset
|
32 (define-key global-map help-key 'help-command) |
409 | 33 (fset 'help-command help-map) |
34 | |
917
d09aafad0e95
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
878
diff
changeset
|
35 (define-key help-map help-key 'help-for-help) |
409 | 36 (define-key help-map "?" 'help-for-help) |
37 | |
38 (define-key help-map "\C-c" 'describe-copying) | |
39 (define-key help-map "\C-d" 'describe-distribution) | |
40 (define-key help-map "\C-w" 'describe-no-warranty) | |
41 (define-key help-map "a" 'command-apropos) | |
42 | |
43 (define-key help-map "b" 'describe-bindings) | |
44 | |
45 (define-key help-map "c" 'describe-key-briefly) | |
46 (define-key help-map "k" 'describe-key) | |
47 | |
48 (define-key help-map "d" 'describe-function) | |
49 (define-key help-map "f" 'describe-function) | |
50 | |
51 (define-key help-map "i" 'info) | |
732 | 52 (define-key help-map "\C-f" 'Info-goto-emacs-command-node) |
53 (define-key help-map "\C-k" 'Info-goto-emacs-key-command-node) | |
409 | 54 |
55 (define-key help-map "l" 'view-lossage) | |
56 | |
57 (define-key help-map "m" 'describe-mode) | |
58 | |
59 (define-key help-map "\C-n" 'view-emacs-news) | |
60 (define-key help-map "n" 'view-emacs-news) | |
61 | |
62 (define-key help-map "s" 'describe-syntax) | |
63 | |
64 (define-key help-map "t" 'help-with-tutorial) | |
65 | |
66 (define-key help-map "w" 'where-is) | |
67 | |
68 (define-key help-map "v" 'describe-variable) | |
69 | |
70 (defun help-with-tutorial () | |
71 "Select the Emacs learn-by-doing tutorial." | |
72 (interactive) | |
73 (let ((file (expand-file-name "~/TUTORIAL"))) | |
74 (delete-other-windows) | |
75 (if (get-file-buffer file) | |
76 (switch-to-buffer (get-file-buffer file)) | |
77 (switch-to-buffer (create-file-buffer file)) | |
78 (setq buffer-file-name file) | |
79 (setq default-directory (expand-file-name "~/")) | |
755 | 80 (setq buffer-auto-save-file-name nil) |
444 | 81 (insert-file-contents (expand-file-name "TUTORIAL" data-directory)) |
409 | 82 (goto-char (point-min)) |
83 (search-forward "\n<<") | |
84 (beginning-of-line) | |
85 (delete-region (point) (progn (end-of-line) (point))) | |
86 (newline (- (window-height (selected-window)) | |
87 (count-lines (point-min) (point)) | |
88 6)) | |
89 (goto-char (point-min)) | |
90 (set-buffer-modified-p nil)))) | |
91 | |
92 (defun describe-key-briefly (key) | |
93 "Print the name of the function KEY invokes. KEY is a string." | |
94 (interactive "kDescribe key briefly: ") | |
95 (let ((defn (key-binding key))) | |
96 (if (or (null defn) (integerp defn)) | |
97 (message "%s is undefined" (key-description key)) | |
98 (message "%s runs the command %s" | |
99 (key-description key) | |
100 (if (symbolp defn) defn (prin1-to-string defn)))))) | |
101 | |
102 (defun print-help-return-message (&optional function) | |
103 "Display or return message saying how to restore windows after help command. | |
104 Computes a message and applies the optional argument FUNCTION to it. | |
105 If FUNCTION is nil, applies `message' to it, thus printing it." | |
106 (and (not (get-buffer-window standard-output)) | |
107 (funcall (or function 'message) | |
108 (concat | |
109 (substitute-command-keys | |
110 (if (one-window-p t) | |
111 (if pop-up-windows | |
112 "Type \\[delete-other-windows] to remove help window." | |
113 "Type \\[switch-to-buffer] RET to remove help window.") | |
114 "Type \\[switch-to-buffer-other-window] RET to restore the other window.")) | |
115 (substitute-command-keys | |
116 " \\[scroll-other-window] to scroll the help."))))) | |
117 | |
118 (defun describe-key (key) | |
119 "Display documentation of the function invoked by KEY. KEY is a string." | |
120 (interactive "kDescribe key: ") | |
121 (let ((defn (key-binding key))) | |
122 (if (or (null defn) (integerp defn)) | |
123 (message "%s is undefined" (key-description key)) | |
124 (with-output-to-temp-buffer "*Help*" | |
125 (prin1 defn) | |
126 (princ ":\n") | |
127 (if (documentation defn) | |
128 (princ (documentation defn)) | |
129 (princ "not documented")) | |
130 (print-help-return-message))))) | |
131 | |
132 (defun describe-mode (&optional minor) | |
133 "Display documentation of current major mode. | |
134 If optional MINOR is non-nil (or prefix argument is given if interactive), | |
135 display documentation of active minor modes as well. | |
136 For this to work correctly for a minor mode, the mode's indicator variable | |
137 (listed in `minor-mode-alist') must also be a function whose documentation | |
138 describes the minor mode." | |
139 (interactive) | |
140 (with-output-to-temp-buffer "*Help*" | |
141 (princ mode-name) | |
142 (princ " Mode:\n") | |
143 (princ (documentation major-mode)) | |
144 (let ((minor-modes minor-mode-alist) | |
145 (locals (buffer-local-variables))) | |
146 (while minor-modes | |
147 (let* ((minor-mode (car (car minor-modes))) | |
148 (indicator (car (cdr (car minor-modes)))) | |
149 (local-binding (assq minor-mode locals))) | |
150 ;; Document a minor mode if it is listed in minor-mode-alist, | |
151 ;; bound locally in this buffer, non-nil, and has a function | |
152 ;; definition. | |
153 (if (and local-binding | |
154 (cdr local-binding) | |
155 (fboundp minor-mode)) | |
156 (progn | |
157 (princ (format "\n\n\n%s minor mode (indicator%s):\n" | |
158 minor-mode indicator)) | |
159 (princ (documentation minor-mode))))) | |
160 (setq minor-modes (cdr minor-modes)))) | |
161 (print-help-return-message))) | |
162 | |
163 ;; So keyboard macro definitions are documented correctly | |
164 (fset 'defining-kbd-macro (symbol-function 'start-kbd-macro)) | |
165 | |
166 (defun describe-distribution () | |
167 "Display info on how to obtain the latest version of GNU Emacs." | |
168 (interactive) | |
169 (find-file-read-only | |
444 | 170 (expand-file-name "DISTRIB" data-directory))) |
409 | 171 |
172 (defun describe-copying () | |
173 "Display info on how you may redistribute copies of GNU Emacs." | |
174 (interactive) | |
175 (find-file-read-only | |
444 | 176 (expand-file-name "COPYING" data-directory)) |
409 | 177 (goto-char (point-min))) |
178 | |
179 (defun describe-no-warranty () | |
180 "Display info on all the kinds of warranty Emacs does NOT have." | |
181 (interactive) | |
182 (describe-copying) | |
183 (let (case-fold-search) | |
184 (search-forward "NO WARRANTY") | |
185 (recenter 0))) | |
186 | |
187 (defun view-emacs-news () | |
188 "Display info on recent changes to Emacs." | |
189 (interactive) | |
444 | 190 (find-file-read-only (expand-file-name "NEWS" data-directory))) |
409 | 191 |
192 (defun view-lossage () | |
193 "Display last 100 input keystrokes." | |
194 (interactive) | |
195 (with-output-to-temp-buffer "*Help*" | |
196 (princ (key-description (recent-keys))) | |
197 (save-excursion | |
198 (set-buffer standard-output) | |
199 (goto-char (point-min)) | |
200 (while (progn (move-to-column 50) (not (eobp))) | |
201 (search-forward " " nil t) | |
202 (insert "\n"))) | |
203 (print-help-return-message))) | |
204 | |
205 (defun help-for-help () | |
917
d09aafad0e95
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
878
diff
changeset
|
206 "You have typed \\[help-for-help], the help character. Type a Help option: |
409 | 207 |
208 A command-apropos. Give a substring, and see a list of commands | |
209 (functions interactively callable) that contain | |
210 that substring. See also the apropos command. | |
211 B describe-bindings. Display table of all key bindings. | |
212 C describe-key-briefly. Type a command key sequence; | |
213 it prints the function name that sequence runs. | |
214 F describe-function. Type a function name and get documentation of it. | |
215 I info. The info documentation reader. | |
216 K describe-key. Type a command key sequence; | |
217 it displays the full documentation. | |
218 L view-lossage. Shows last 100 characters you typed. | |
219 M describe-mode. Print documentation of current major mode, | |
220 which describes the commands peculiar to it. | |
221 N view-emacs-news. Shows emacs news file. | |
222 S describe-syntax. Display contents of syntax table, plus explanations | |
223 T help-with-tutorial. Select the Emacs learn-by-doing tutorial. | |
224 V describe-variable. Type name of a variable; | |
225 it displays the variable's documentation and value. | |
226 W where-is. Type command name; it prints which keystrokes | |
227 invoke that command. | |
228 C-c print Emacs copying permission (General Public License). | |
229 C-d print Emacs ordering information. | |
230 C-n print news of recent Emacs changes. | |
231 C-w print information on absence of warranty for GNU Emacs." | |
232 (interactive) | |
233 (message | |
917
d09aafad0e95
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
878
diff
changeset
|
234 "A B C F I K L M N S T V W C-c C-d C-n C-w. Type \\[help-for-help] again for more help: ") |
409 | 235 (let ((char (read-char))) |
236 (if (or (= char ?\C-h) (= char ??)) | |
237 (save-window-excursion | |
238 (switch-to-buffer "*Help*") | |
239 (delete-other-windows) | |
240 (erase-buffer) | |
241 (insert (documentation 'help-for-help)) | |
242 (goto-char (point-min)) | |
243 (while (memq char '(?\C-h ?? ?\C-v ?\ ?\177 ?\M-v)) | |
244 (if (memq char '(?\C-v ?\ )) | |
245 (scroll-up)) | |
246 (if (memq char '(?\177 ?\M-v)) | |
247 (scroll-down)) | |
248 (message "A B C F I K L M N S T V W C-c C-d C-n C-w%s: " | |
249 (if (pos-visible-in-window-p (point-max)) | |
250 "" " or Space to scroll")) | |
251 (let ((cursor-in-echo-area t)) | |
252 (setq char (read-char)))))) | |
253 (let ((defn (cdr (assq (downcase char) (cdr help-map))))) | |
254 (if defn (call-interactively defn) (ding))))) | |
255 | |
256 | |
257 ;; Return a function which is called by the list containing point. | |
258 ;; If that gives no function, return a function whose name is around point. | |
259 ;; If that doesn't give a function, return nil. | |
260 (defun function-called-at-point () | |
261 (or (condition-case () | |
262 (save-excursion | |
263 (save-restriction | |
264 (narrow-to-region (max (point-min) (- (point) 1000)) (point-max)) | |
265 (backward-up-list 1) | |
266 (forward-char 1) | |
267 (let (obj) | |
268 (setq obj (read (current-buffer))) | |
269 (and (symbolp obj) (fboundp obj) obj)))) | |
270 (error nil)) | |
271 (condition-case () | |
272 (save-excursion | |
273 (forward-sexp -1) | |
274 (skip-chars-forward "'") | |
275 (let ((obj (read (current-buffer)))) | |
276 (and (symbolp obj) (fboundp obj) obj))) | |
277 (error nil)))) | |
278 | |
279 (defun describe-function (function) | |
280 "Display the full documentation of FUNCTION (a symbol)." | |
281 (interactive | |
282 (let ((fn (function-called-at-point)) | |
283 (enable-recursive-minibuffers t) | |
284 val) | |
285 (setq val (completing-read (if fn | |
286 (format "Describe function (default %s): " fn) | |
287 "Describe function: ") | |
288 obarray 'fboundp t)) | |
289 (list (if (equal val "") | |
290 fn (intern val))))) | |
291 (with-output-to-temp-buffer "*Help*" | |
292 (prin1 function) | |
293 (princ ": ") | |
294 (let* ((def (symbol-function function)) | |
295 (beg (if (commandp def) "an interactive " "a "))) | |
296 (princ (cond ((stringp def) "a keyboard macro.") | |
297 ((subrp def) | |
298 (concat beg "built-in function.")) | |
299 ((compiled-function-p def) | |
300 (concat beg "compiled Lisp function.")) | |
301 ((symbolp def) | |
302 (format "alias for `%s'." def)) | |
303 ((eq (car-safe def) 'lambda) | |
304 (concat beg "Lisp function.")) | |
305 ((eq (car-safe def) 'macro) | |
306 "a Lisp macro.") | |
307 ((eq (car-safe def) 'mocklisp) | |
308 "a mocklisp function.") | |
309 ((eq (car-safe def) 'autoload) | |
878
5b1c5b4286e7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
310 (format "%sautoloaded Lisp %s." |
409 | 311 beg |
312 (if (nth 4 def) "macro" "function") | |
878
5b1c5b4286e7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
313 ;;; Including the file name made this line too long. |
5b1c5b4286e7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
314 ;;; (nth 1 def) |
5b1c5b4286e7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
315 )) |
409 | 316 (t ""))) |
317 (terpri)) | |
318 (if (documentation function) | |
319 (princ (documentation function)) | |
320 (princ "not documented")) | |
321 (print-help-return-message) | |
322 ;; Return the text we displayed. | |
323 (save-excursion (set-buffer standard-output) (buffer-string)))) | |
324 | |
325 (defun variable-at-point () | |
326 (condition-case () | |
327 (save-excursion | |
328 (forward-sexp -1) | |
329 (skip-chars-forward "'") | |
330 (let ((obj (read (current-buffer)))) | |
331 (and (symbolp obj) (boundp obj) obj))) | |
332 (error nil))) | |
333 | |
334 (defun describe-variable (variable) | |
335 "Display the full documentation of VARIABLE (a symbol). | |
336 Returns the documentation as a string, also." | |
337 (interactive | |
338 (let ((v (variable-at-point)) | |
339 (enable-recursive-minibuffers t) | |
340 val) | |
341 (setq val (completing-read (if v | |
342 (format "Describe variable (default %s): " v) | |
343 "Describe variable: ") | |
344 obarray 'boundp t)) | |
345 (list (if (equal val "") | |
346 v (intern val))))) | |
347 (with-output-to-temp-buffer "*Help*" | |
348 (prin1 variable) | |
349 (princ "'s value is ") | |
350 (if (not (boundp variable)) | |
351 (princ "void.") | |
352 (prin1 (symbol-value variable))) | |
353 (terpri) (terpri) | |
354 (princ "Documentation:") | |
355 (terpri) | |
356 (let ((doc (documentation-property variable 'variable-documentation))) | |
357 (if doc | |
358 (princ (substitute-command-keys doc)) | |
359 (princ "not documented as a variable."))) | |
360 (print-help-return-message) | |
361 ;; Return the text we displayed. | |
362 (save-excursion (set-buffer standard-output) (buffer-string)))) | |
363 | |
364 (defun command-apropos (string) | |
365 "Like apropos but lists only symbols that are names of commands | |
366 \(interactively callable functions). Argument REGEXP is a regular expression | |
367 that is matched against command symbol names. Returns list of symbols and | |
368 documentation found." | |
369 (interactive "sCommand apropos (regexp): ") | |
370 (let ((message | |
371 (let ((standard-output (get-buffer-create "*Help*"))) | |
372 (print-help-return-message 'identity)))) | |
878
5b1c5b4286e7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
373 (apropos string t 'commandp) |
409 | 374 (and message (message message)))) |
375 | |
376 (defun locate-library (library &optional nosuffix) | |
377 "Show the full path name of Emacs library LIBRARY. | |
378 This command searches the directories in `load-path' like `M-x load-library' | |
379 to find the file that `M-x load-library RET LIBRARY RET' would load. | |
380 Optional second arg NOSUFFIX non-nil means don't add suffixes `.elc' or `.el' | |
381 to the specified name LIBRARY (a la calling `load' instead of `load-library')." | |
382 (interactive "sLocate library: ") | |
383 (catch 'answer | |
384 (mapcar | |
385 '(lambda (dir) | |
386 (mapcar | |
387 '(lambda (suf) | |
388 (let ((try (expand-file-name (concat library suf) dir))) | |
389 (and (file-readable-p try) | |
390 (null (file-directory-p try)) | |
391 (progn | |
392 (message "Library is file %s" try) | |
393 (throw 'answer try))))) | |
394 (if nosuffix '("") '(".elc" ".el" "")))) | |
395 load-path) | |
396 (message "No library %s in search path" library) | |
397 nil)) | |
660
08eb386dd0f3
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
444
diff
changeset
|
398 |
08eb386dd0f3
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
444
diff
changeset
|
399 ;;; help.el ends here |