Mercurial > emacs
annotate lisp/help.el @ 6848:df94ce8c363c
(CFLAGS): Use shell syntax, not Makefile.
author | Karl Heuer <kwzh@gnu.org> |
---|---|
date | Wed, 13 Apr 1994 17:13:42 +0000 |
parents | 4c20c6b1d2c2 |
children | 962a6ffb7b97 |
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 |
2697
05ff97695d32
Require help-macro, not help-screen.
Richard M. Stallman <rms@gnu.org>
parents:
2638
diff
changeset
|
3 ;; Copyright (C) 1985, 1986, 1993 Free Software Foundation, Inc. |
846
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 | |
2315
9e7ec92a4fdf
Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2312
diff
changeset
|
24 ;;; Commentary: |
9e7ec92a4fdf
Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2312
diff
changeset
|
25 |
9e7ec92a4fdf
Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2312
diff
changeset
|
26 ;; This code implements GNU Emac's on-line help system, the one invoked by |
9e7ec92a4fdf
Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2312
diff
changeset
|
27 ;;`M-x help-for-help'. |
9e7ec92a4fdf
Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2312
diff
changeset
|
28 |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
755
diff
changeset
|
29 ;;; Code: |
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
755
diff
changeset
|
30 |
2312
ad7b89a430df
Don't load help-screen at run time if compiled.
Richard M. Stallman <rms@gnu.org>
parents:
2237
diff
changeset
|
31 ;; Get the macro make-help-screen when this is compiled, |
ad7b89a430df
Don't load help-screen at run time if compiled.
Richard M. Stallman <rms@gnu.org>
parents:
2237
diff
changeset
|
32 ;; or run interpreted, but not when the compiled code is loaded. |
2697
05ff97695d32
Require help-macro, not help-screen.
Richard M. Stallman <rms@gnu.org>
parents:
2638
diff
changeset
|
33 (eval-when-compile (require 'help-macro)) |
2237
2670a8f6a42e
Teach this to use help-screen.el.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2134
diff
changeset
|
34 |
409 | 35 (defvar help-map (make-sparse-keymap) |
36 "Keymap for characters following the Help key.") | |
37 | |
919 | 38 (define-key global-map (char-to-string help-char) 'help-command) |
409 | 39 (fset 'help-command help-map) |
40 | |
919 | 41 (define-key help-map (char-to-string help-char) 'help-for-help) |
409 | 42 (define-key help-map "?" 'help-for-help) |
43 | |
44 (define-key help-map "\C-c" 'describe-copying) | |
45 (define-key help-map "\C-d" 'describe-distribution) | |
46 (define-key help-map "\C-w" 'describe-no-warranty) | |
5025
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
47 (define-key help-map "\C-p" 'describe-project) |
409 | 48 (define-key help-map "a" 'command-apropos) |
49 | |
50 (define-key help-map "b" 'describe-bindings) | |
51 | |
52 (define-key help-map "c" 'describe-key-briefly) | |
53 (define-key help-map "k" 'describe-key) | |
54 | |
55 (define-key help-map "d" 'describe-function) | |
56 (define-key help-map "f" 'describe-function) | |
57 | |
58 (define-key help-map "i" 'info) | |
732 | 59 (define-key help-map "\C-f" 'Info-goto-emacs-command-node) |
60 (define-key help-map "\C-k" 'Info-goto-emacs-key-command-node) | |
409 | 61 |
62 (define-key help-map "l" 'view-lossage) | |
63 | |
64 (define-key help-map "m" 'describe-mode) | |
65 | |
66 (define-key help-map "\C-n" 'view-emacs-news) | |
67 (define-key help-map "n" 'view-emacs-news) | |
68 | |
2134
b275e1b50542
Added autoload, binding and menu line for new finder feature (P).
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2079
diff
changeset
|
69 (define-key help-map "p" 'finder-by-keyword) |
3145
6cd314c2ddde
(finder-by-keyword): Autoload from `finder', not `finder.el'.
Richard M. Stallman <rms@gnu.org>
parents:
2955
diff
changeset
|
70 (autoload 'finder-by-keyword "finder") |
2134
b275e1b50542
Added autoload, binding and menu line for new finder feature (P).
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2079
diff
changeset
|
71 |
409 | 72 (define-key help-map "s" 'describe-syntax) |
73 | |
74 (define-key help-map "t" 'help-with-tutorial) | |
75 | |
76 (define-key help-map "w" 'where-is) | |
77 | |
78 (define-key help-map "v" 'describe-variable) | |
79 | |
6580 | 80 (define-key help-map "q" 'help-quit) |
81 | |
82 (defun help-quit () | |
83 (interactive) | |
84 nil) | |
85 | |
409 | 86 (defun help-with-tutorial () |
87 "Select the Emacs learn-by-doing tutorial." | |
88 (interactive) | |
89 (let ((file (expand-file-name "~/TUTORIAL"))) | |
90 (delete-other-windows) | |
91 (if (get-file-buffer file) | |
92 (switch-to-buffer (get-file-buffer file)) | |
93 (switch-to-buffer (create-file-buffer file)) | |
94 (setq buffer-file-name file) | |
95 (setq default-directory (expand-file-name "~/")) | |
755 | 96 (setq buffer-auto-save-file-name nil) |
444 | 97 (insert-file-contents (expand-file-name "TUTORIAL" data-directory)) |
409 | 98 (goto-char (point-min)) |
99 (search-forward "\n<<") | |
100 (beginning-of-line) | |
101 (delete-region (point) (progn (end-of-line) (point))) | |
6419
e5ce725b661d
(help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents:
6079
diff
changeset
|
102 (let ((n (- (window-height (selected-window)) |
409 | 103 (count-lines (point-min) (point)) |
6419
e5ce725b661d
(help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents:
6079
diff
changeset
|
104 6))) |
6433
e50519261181
(help-with-tutorial): Change previous change;
Richard M. Stallman <rms@gnu.org>
parents:
6419
diff
changeset
|
105 (if (< n 12) |
6419
e5ce725b661d
(help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents:
6079
diff
changeset
|
106 (newline n) |
e5ce725b661d
(help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents:
6079
diff
changeset
|
107 ;; Some people get confused by the large gap. |
e5ce725b661d
(help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents:
6079
diff
changeset
|
108 (newline (/ n 2)) |
e5ce725b661d
(help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents:
6079
diff
changeset
|
109 (insert "[Middle of page left blank for didactic purposes. " |
e5ce725b661d
(help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents:
6079
diff
changeset
|
110 "Text continues below]") |
e5ce725b661d
(help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents:
6079
diff
changeset
|
111 (newline (- n (/ n 2))))) |
409 | 112 (goto-char (point-min)) |
113 (set-buffer-modified-p nil)))) | |
114 | |
115 (defun describe-key-briefly (key) | |
116 "Print the name of the function KEY invokes. KEY is a string." | |
117 (interactive "kDescribe key briefly: ") | |
2955
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
118 ;; If this key seq ends with a down event, discard the |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
119 ;; following click or drag event. Otherwise that would |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
120 ;; erase the message. |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
121 (let ((type (aref key (1- (length key))))) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
122 (if (listp type) (setq type (car type))) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
123 (and (symbolp type) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
124 (memq 'down (event-modifiers type)) |
3986
0e5fa7a1ac36
(describe-key-briefly): Don't set `foo'.
Richard M. Stallman <rms@gnu.org>
parents:
3982
diff
changeset
|
125 (read-event))) |
409 | 126 (let ((defn (key-binding key))) |
127 (if (or (null defn) (integerp defn)) | |
128 (message "%s is undefined" (key-description key)) | |
129 (message "%s runs the command %s" | |
130 (key-description key) | |
131 (if (symbolp defn) defn (prin1-to-string defn)))))) | |
132 | |
133 (defun print-help-return-message (&optional function) | |
134 "Display or return message saying how to restore windows after help command. | |
135 Computes a message and applies the optional argument FUNCTION to it. | |
136 If FUNCTION is nil, applies `message' to it, thus printing it." | |
137 (and (not (get-buffer-window standard-output)) | |
138 (funcall (or function 'message) | |
139 (concat | |
140 (substitute-command-keys | |
141 (if (one-window-p t) | |
142 (if pop-up-windows | |
143 "Type \\[delete-other-windows] to remove help window." | |
144 "Type \\[switch-to-buffer] RET to remove help window.") | |
145 "Type \\[switch-to-buffer-other-window] RET to restore the other window.")) | |
146 (substitute-command-keys | |
147 " \\[scroll-other-window] to scroll the help."))))) | |
148 | |
149 (defun describe-key (key) | |
150 "Display documentation of the function invoked by KEY. KEY is a string." | |
151 (interactive "kDescribe key: ") | |
2955
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
152 ;; If this key seq ends with a down event, discard the |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
153 ;; following click or drag event. Otherwise that would |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
154 ;; erase the message. |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
155 (let ((type (aref key (1- (length key))))) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
156 (if (listp type) (setq type (car type))) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
157 (and (symbolp type) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
158 (memq 'down (event-modifiers type)) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
159 (read-event))) |
409 | 160 (let ((defn (key-binding key))) |
161 (if (or (null defn) (integerp defn)) | |
162 (message "%s is undefined" (key-description key)) | |
163 (with-output-to-temp-buffer "*Help*" | |
164 (prin1 defn) | |
165 (princ ":\n") | |
166 (if (documentation defn) | |
167 (princ (documentation defn)) | |
168 (princ "not documented")) | |
169 (print-help-return-message))))) | |
170 | |
171 (defun describe-mode (&optional minor) | |
172 "Display documentation of current major mode. | |
173 If optional MINOR is non-nil (or prefix argument is given if interactive), | |
174 display documentation of active minor modes as well. | |
175 For this to work correctly for a minor mode, the mode's indicator variable | |
3980
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
176 \(listed in `minor-mode-alist') must also be a function whose documentation |
409 | 177 describes the minor mode." |
178 (interactive) | |
179 (with-output-to-temp-buffer "*Help*" | |
180 (princ mode-name) | |
181 (princ " Mode:\n") | |
182 (princ (documentation major-mode)) | |
183 (let ((minor-modes minor-mode-alist) | |
184 (locals (buffer-local-variables))) | |
185 (while minor-modes | |
186 (let* ((minor-mode (car (car minor-modes))) | |
187 (indicator (car (cdr (car minor-modes)))) | |
188 (local-binding (assq minor-mode locals))) | |
189 ;; Document a minor mode if it is listed in minor-mode-alist, | |
190 ;; bound locally in this buffer, non-nil, and has a function | |
191 ;; definition. | |
192 (if (and local-binding | |
193 (cdr local-binding) | |
194 (fboundp minor-mode)) | |
195 (progn | |
196 (princ (format "\n\n\n%s minor mode (indicator%s):\n" | |
197 minor-mode indicator)) | |
198 (princ (documentation minor-mode))))) | |
199 (setq minor-modes (cdr minor-modes)))) | |
200 (print-help-return-message))) | |
201 | |
202 ;; So keyboard macro definitions are documented correctly | |
203 (fset 'defining-kbd-macro (symbol-function 'start-kbd-macro)) | |
204 | |
205 (defun describe-distribution () | |
206 "Display info on how to obtain the latest version of GNU Emacs." | |
207 (interactive) | |
208 (find-file-read-only | |
444 | 209 (expand-file-name "DISTRIB" data-directory))) |
409 | 210 |
211 (defun describe-copying () | |
212 "Display info on how you may redistribute copies of GNU Emacs." | |
213 (interactive) | |
214 (find-file-read-only | |
444 | 215 (expand-file-name "COPYING" data-directory)) |
409 | 216 (goto-char (point-min))) |
217 | |
5025
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
218 (defun describe-project () |
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
219 "Display info on the GNU project." |
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
220 (interactive) |
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
221 (find-file-read-only |
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
222 (expand-file-name "GNU" data-directory)) |
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
223 (goto-char (point-min))) |
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
224 |
409 | 225 (defun describe-no-warranty () |
226 "Display info on all the kinds of warranty Emacs does NOT have." | |
227 (interactive) | |
228 (describe-copying) | |
229 (let (case-fold-search) | |
230 (search-forward "NO WARRANTY") | |
231 (recenter 0))) | |
232 | |
3980
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
233 (defun describe-prefix-bindings () |
3982
e50f7b531c7f
(describe-prefix-bindings): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
3980
diff
changeset
|
234 "Describe the bindings of the prefix used to reach this command. |
e50f7b531c7f
(describe-prefix-bindings): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
3980
diff
changeset
|
235 The prefix described consists of all but the last event |
e50f7b531c7f
(describe-prefix-bindings): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
3980
diff
changeset
|
236 of the key sequence that ran this command." |
3980
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
237 (interactive) |
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
238 (let* ((key (this-command-keys)) |
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
239 (prefix (make-vector (1- (length key)) nil)) |
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
240 i) |
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
241 (setq i 0) |
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
242 (while (< i (length prefix)) |
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
243 (aset prefix i (aref key i)) |
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
244 (setq i (1+ i))) |
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
245 (describe-bindings prefix))) |
3982
e50f7b531c7f
(describe-prefix-bindings): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
3980
diff
changeset
|
246 ;; Make C-h after a prefix, when not specifically bound, |
e50f7b531c7f
(describe-prefix-bindings): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
3980
diff
changeset
|
247 ;; run describe-prefix-bindings. |
3980
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
248 (setq prefix-help-command 'describe-prefix-bindings) |
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
249 |
409 | 250 (defun view-emacs-news () |
251 "Display info on recent changes to Emacs." | |
252 (interactive) | |
444 | 253 (find-file-read-only (expand-file-name "NEWS" data-directory))) |
409 | 254 |
255 (defun view-lossage () | |
256 "Display last 100 input keystrokes." | |
257 (interactive) | |
258 (with-output-to-temp-buffer "*Help*" | |
259 (princ (key-description (recent-keys))) | |
260 (save-excursion | |
261 (set-buffer standard-output) | |
262 (goto-char (point-min)) | |
263 (while (progn (move-to-column 50) (not (eobp))) | |
264 (search-forward " " nil t) | |
265 (insert "\n"))) | |
266 (print-help-return-message))) | |
267 | |
6580 | 268 (defalias 'help 'help-for-help) |
2237
2670a8f6a42e
Teach this to use help-screen.el.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2134
diff
changeset
|
269 (make-help-screen help-for-help |
5680
4428fd0336f3
(help-for-help): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
5380
diff
changeset
|
270 "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:" |
5025
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
271 "You have typed \\[help-command], the help character. Type a Help option: |
6580 | 272 \(Use \\<help-map>\\[scroll-up] or \\[scroll-down] to scroll through this text. |
273 Type \\<help-map>\\[help-quit] to exit the Help command.) | |
409 | 274 |
4467
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
275 a command-apropos. Give a substring, and see a list of commands |
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
276 (functions interactively callable) that contain |
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
277 that substring. See also the apropos command. |
2638
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
278 b describe-bindings. Display table of all key bindings. |
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
279 c describe-key-briefly. Type a command key sequence; |
4467
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
280 it prints the function name that sequence runs. |
2638
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
281 f describe-function. Type a function name and get documentation of it. |
4467
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
282 C-f Info-goto-emacs-command-node. Type a function name; |
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
283 it takes you to the Info node for that command. |
2638
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
284 i info. The info documentation reader. |
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
285 k describe-key. Type a command key sequence; |
4467
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
286 it displays the full documentation. |
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
287 C-k Info-goto-emacs-key-command-node. Type a command key sequence; |
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
288 it takes you to the Info node for the command bound to that key. |
2638
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
289 l view-lossage. Shows last 100 characters you typed. |
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
290 m describe-mode. Print documentation of current major mode, |
4467
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
291 which describes the commands peculiar to it. |
2638
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
292 n view-emacs-news. Shows emacs news file. |
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
293 p finder-by-keyword. Find packages matching a given topic keyword. |
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
294 s describe-syntax. Display contents of syntax table, plus explanations |
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
295 t help-with-tutorial. Select the Emacs learn-by-doing tutorial. |
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
296 v describe-variable. Type name of a variable; |
4467
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
297 it displays the variable's documentation and value. |
2638
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
298 w where-is. Type command name; it prints which keystrokes |
4467
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
299 invoke that command. |
409 | 300 C-c print Emacs copying permission (General Public License). |
301 C-d print Emacs ordering information. | |
302 C-n print news of recent Emacs changes. | |
5025
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
303 C-p print information about the GNU project. |
409 | 304 C-w print information on absence of warranty for GNU Emacs." |
2237
2670a8f6a42e
Teach this to use help-screen.el.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2134
diff
changeset
|
305 help-map) |
409 | 306 |
307 ;; Return a function which is called by the list containing point. | |
308 ;; If that gives no function, return a function whose name is around point. | |
309 ;; If that doesn't give a function, return nil. | |
310 (defun function-called-at-point () | |
311 (or (condition-case () | |
312 (save-excursion | |
313 (save-restriction | |
314 (narrow-to-region (max (point-min) (- (point) 1000)) (point-max)) | |
315 (backward-up-list 1) | |
316 (forward-char 1) | |
317 (let (obj) | |
318 (setq obj (read (current-buffer))) | |
319 (and (symbolp obj) (fboundp obj) obj)))) | |
320 (error nil)) | |
321 (condition-case () | |
322 (save-excursion | |
323 (forward-sexp -1) | |
324 (skip-chars-forward "'") | |
325 (let ((obj (read (current-buffer)))) | |
326 (and (symbolp obj) (fboundp obj) obj))) | |
327 (error nil)))) | |
328 | |
329 (defun describe-function (function) | |
330 "Display the full documentation of FUNCTION (a symbol)." | |
331 (interactive | |
332 (let ((fn (function-called-at-point)) | |
333 (enable-recursive-minibuffers t) | |
334 val) | |
335 (setq val (completing-read (if fn | |
336 (format "Describe function (default %s): " fn) | |
337 "Describe function: ") | |
338 obarray 'fboundp t)) | |
339 (list (if (equal val "") | |
340 fn (intern val))))) | |
341 (with-output-to-temp-buffer "*Help*" | |
342 (prin1 function) | |
343 (princ ": ") | |
344 (let* ((def (symbol-function function)) | |
345 (beg (if (commandp def) "an interactive " "a "))) | |
2440
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
346 (princ (cond ((or (stringp def) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
347 (vectorp def)) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
348 "a keyboard macro.") |
409 | 349 ((subrp def) |
350 (concat beg "built-in function.")) | |
1821
04fb1d3d6992
JimB's changes since January 18th
Jim Blandy <jimb@redhat.com>
parents:
1467
diff
changeset
|
351 ((byte-code-function-p def) |
409 | 352 (concat beg "compiled Lisp function.")) |
353 ((symbolp def) | |
354 (format "alias for `%s'." def)) | |
355 ((eq (car-safe def) 'lambda) | |
356 (concat beg "Lisp function.")) | |
357 ((eq (car-safe def) 'macro) | |
358 "a Lisp macro.") | |
359 ((eq (car-safe def) 'mocklisp) | |
360 "a mocklisp function.") | |
361 ((eq (car-safe def) 'autoload) | |
1467
8d8c91b563ee
(describe-function): Print `an autoloaded', not `a ...'.
Richard M. Stallman <rms@gnu.org>
parents:
919
diff
changeset
|
362 (format "%s autoloaded Lisp %s." |
8d8c91b563ee
(describe-function): Print `an autoloaded', not `a ...'.
Richard M. Stallman <rms@gnu.org>
parents:
919
diff
changeset
|
363 (if (commandp def) "an interactive" "an") |
409 | 364 (if (nth 4 def) "macro" "function") |
878
5b1c5b4286e7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
365 ;;; Including the file name made this line too long. |
5b1c5b4286e7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
366 ;;; (nth 1 def) |
5b1c5b4286e7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
367 )) |
409 | 368 (t ""))) |
1889
1ed971f67bfd
(describe-function): Print the arglist if the function is bytecode or a list.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
369 (terpri) |
2440
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
370 (let ((arglist (cond ((byte-code-function-p def) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
371 (car (append def nil))) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
372 ((eq (car-safe def) 'lambda) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
373 (nth 1 def)) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
374 (t t)))) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
375 (if (listp arglist) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
376 (progn |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
377 (princ (cons function |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
378 (mapcar (lambda (arg) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
379 (if (memq arg '(&optional &rest)) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
380 arg |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
381 (intern (upcase (symbol-name arg))))) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
382 arglist))) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
383 (terpri)))) |
1889
1ed971f67bfd
(describe-function): Print the arglist if the function is bytecode or a list.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
384 (if (documentation function) |
2360
c12e0f0a3179
(describe-function): Add blank line above doc string.
Richard M. Stallman <rms@gnu.org>
parents:
2315
diff
changeset
|
385 (progn (terpri) |
c12e0f0a3179
(describe-function): Add blank line above doc string.
Richard M. Stallman <rms@gnu.org>
parents:
2315
diff
changeset
|
386 (princ (documentation function))) |
1889
1ed971f67bfd
(describe-function): Print the arglist if the function is bytecode or a list.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
387 (princ "not documented")) |
2440
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
388 ) |
409 | 389 (print-help-return-message) |
390 ;; Return the text we displayed. | |
391 (save-excursion (set-buffer standard-output) (buffer-string)))) | |
392 | |
393 (defun variable-at-point () | |
394 (condition-case () | |
395 (save-excursion | |
396 (forward-sexp -1) | |
397 (skip-chars-forward "'") | |
398 (let ((obj (read (current-buffer)))) | |
399 (and (symbolp obj) (boundp obj) obj))) | |
400 (error nil))) | |
401 | |
402 (defun describe-variable (variable) | |
403 "Display the full documentation of VARIABLE (a symbol). | |
404 Returns the documentation as a string, also." | |
405 (interactive | |
406 (let ((v (variable-at-point)) | |
407 (enable-recursive-minibuffers t) | |
408 val) | |
409 (setq val (completing-read (if v | |
410 (format "Describe variable (default %s): " v) | |
411 "Describe variable: ") | |
412 obarray 'boundp t)) | |
413 (list (if (equal val "") | |
414 v (intern val))))) | |
415 (with-output-to-temp-buffer "*Help*" | |
416 (prin1 variable) | |
417 (princ "'s value is ") | |
418 (if (not (boundp variable)) | |
419 (princ "void.") | |
420 (prin1 (symbol-value variable))) | |
421 (terpri) (terpri) | |
422 (princ "Documentation:") | |
423 (terpri) | |
424 (let ((doc (documentation-property variable 'variable-documentation))) | |
425 (if doc | |
426 (princ (substitute-command-keys doc)) | |
427 (princ "not documented as a variable."))) | |
428 (print-help-return-message) | |
429 ;; Return the text we displayed. | |
430 (save-excursion (set-buffer standard-output) (buffer-string)))) | |
431 | |
6476
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
432 (defun where-is (definition) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
433 "Print message listing key sequences that invoke specified command. |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
434 Argument is a command definition, usually a symbol with a function definition." |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
435 (interactive |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
436 (let ((fn (function-called-at-point)) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
437 (enable-recursive-minibuffers t) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
438 val) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
439 (setq val (completing-read (if fn |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
440 (format "Where is command (default %s): " fn) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
441 "Where is command: ") |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
442 obarray 'fboundp t)) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
443 (list (if (equal val "") |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
444 fn (intern val))))) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
445 (let* ((keys (where-is-internal definition overriding-local-map nil nil)) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
446 (keys1 (mapconcat 'key-description keys ", "))) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
447 (if (> (length keys1) 0) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
448 (message "%s is on %s" definition keys1) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
449 (message "%s is not on any key" definition))) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
450 nil) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
451 |
409 | 452 (defun command-apropos (string) |
453 "Like apropos but lists only symbols that are names of commands | |
454 \(interactively callable functions). Argument REGEXP is a regular expression | |
455 that is matched against command symbol names. Returns list of symbols and | |
456 documentation found." | |
457 (interactive "sCommand apropos (regexp): ") | |
458 (let ((message | |
459 (let ((standard-output (get-buffer-create "*Help*"))) | |
460 (print-help-return-message 'identity)))) | |
2079
51012c0f1227
(command-apropos): Print echo area message iff found symbols.
Richard M. Stallman <rms@gnu.org>
parents:
1889
diff
changeset
|
461 (if (apropos string t 'commandp) |
51012c0f1227
(command-apropos): Print echo area message iff found symbols.
Richard M. Stallman <rms@gnu.org>
parents:
1889
diff
changeset
|
462 (and message (message message))))) |
409 | 463 |
464 (defun locate-library (library &optional nosuffix) | |
465 "Show the full path name of Emacs library LIBRARY. | |
466 This command searches the directories in `load-path' like `M-x load-library' | |
467 to find the file that `M-x load-library RET LIBRARY RET' would load. | |
468 Optional second arg NOSUFFIX non-nil means don't add suffixes `.elc' or `.el' | |
469 to the specified name LIBRARY (a la calling `load' instead of `load-library')." | |
470 (interactive "sLocate library: ") | |
471 (catch 'answer | |
472 (mapcar | |
473 '(lambda (dir) | |
474 (mapcar | |
475 '(lambda (suf) | |
476 (let ((try (expand-file-name (concat library suf) dir))) | |
477 (and (file-readable-p try) | |
478 (null (file-directory-p try)) | |
479 (progn | |
480 (message "Library is file %s" try) | |
481 (throw 'answer try))))) | |
482 (if nosuffix '("") '(".elc" ".el" "")))) | |
483 load-path) | |
484 (message "No library %s in search path" library) | |
485 nil)) | |
660
08eb386dd0f3
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
444
diff
changeset
|
486 |
08eb386dd0f3
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
444
diff
changeset
|
487 ;;; help.el ends here |