Mercurial > emacs
annotate lisp/help.el @ 6063:233fffcfb6c8
(Fget_char_property): New function.
author | Karl Heuer <kwzh@gnu.org> |
---|---|
date | Thu, 24 Feb 1994 19:18:32 +0000 |
parents | 4428fd0336f3 |
children | 6617a69cece1 |
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 | |
80 (defun help-with-tutorial () | |
81 "Select the Emacs learn-by-doing tutorial." | |
82 (interactive) | |
83 (let ((file (expand-file-name "~/TUTORIAL"))) | |
84 (delete-other-windows) | |
85 (if (get-file-buffer file) | |
86 (switch-to-buffer (get-file-buffer file)) | |
87 (switch-to-buffer (create-file-buffer file)) | |
88 (setq buffer-file-name file) | |
89 (setq default-directory (expand-file-name "~/")) | |
755 | 90 (setq buffer-auto-save-file-name nil) |
444 | 91 (insert-file-contents (expand-file-name "TUTORIAL" data-directory)) |
409 | 92 (goto-char (point-min)) |
93 (search-forward "\n<<") | |
94 (beginning-of-line) | |
95 (delete-region (point) (progn (end-of-line) (point))) | |
96 (newline (- (window-height (selected-window)) | |
97 (count-lines (point-min) (point)) | |
98 6)) | |
99 (goto-char (point-min)) | |
100 (set-buffer-modified-p nil)))) | |
101 | |
102 (defun describe-key-briefly (key) | |
103 "Print the name of the function KEY invokes. KEY is a string." | |
104 (interactive "kDescribe key briefly: ") | |
2955
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
105 ;; 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
|
106 ;; following click or drag event. Otherwise that would |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
107 ;; erase the message. |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
108 (let ((type (aref key (1- (length key))))) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
109 (if (listp type) (setq type (car type))) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
110 (and (symbolp type) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
111 (memq 'down (event-modifiers type)) |
3986
0e5fa7a1ac36
(describe-key-briefly): Don't set `foo'.
Richard M. Stallman <rms@gnu.org>
parents:
3982
diff
changeset
|
112 (read-event))) |
409 | 113 (let ((defn (key-binding key))) |
114 (if (or (null defn) (integerp defn)) | |
115 (message "%s is undefined" (key-description key)) | |
116 (message "%s runs the command %s" | |
117 (key-description key) | |
118 (if (symbolp defn) defn (prin1-to-string defn)))))) | |
119 | |
120 (defun print-help-return-message (&optional function) | |
121 "Display or return message saying how to restore windows after help command. | |
122 Computes a message and applies the optional argument FUNCTION to it. | |
123 If FUNCTION is nil, applies `message' to it, thus printing it." | |
124 (and (not (get-buffer-window standard-output)) | |
125 (funcall (or function 'message) | |
126 (concat | |
127 (substitute-command-keys | |
128 (if (one-window-p t) | |
129 (if pop-up-windows | |
130 "Type \\[delete-other-windows] to remove help window." | |
131 "Type \\[switch-to-buffer] RET to remove help window.") | |
132 "Type \\[switch-to-buffer-other-window] RET to restore the other window.")) | |
133 (substitute-command-keys | |
134 " \\[scroll-other-window] to scroll the help."))))) | |
135 | |
136 (defun describe-key (key) | |
137 "Display documentation of the function invoked by KEY. KEY is a string." | |
138 (interactive "kDescribe key: ") | |
2955
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
139 ;; 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
|
140 ;; following click or drag event. Otherwise that would |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
141 ;; erase the message. |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
142 (let ((type (aref key (1- (length key))))) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
143 (if (listp type) (setq type (car type))) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
144 (and (symbolp type) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
145 (memq 'down (event-modifiers type)) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
146 (read-event))) |
409 | 147 (let ((defn (key-binding key))) |
148 (if (or (null defn) (integerp defn)) | |
149 (message "%s is undefined" (key-description key)) | |
150 (with-output-to-temp-buffer "*Help*" | |
151 (prin1 defn) | |
152 (princ ":\n") | |
153 (if (documentation defn) | |
154 (princ (documentation defn)) | |
155 (princ "not documented")) | |
156 (print-help-return-message))))) | |
157 | |
158 (defun describe-mode (&optional minor) | |
159 "Display documentation of current major mode. | |
160 If optional MINOR is non-nil (or prefix argument is given if interactive), | |
161 display documentation of active minor modes as well. | |
162 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
|
163 \(listed in `minor-mode-alist') must also be a function whose documentation |
409 | 164 describes the minor mode." |
165 (interactive) | |
166 (with-output-to-temp-buffer "*Help*" | |
167 (princ mode-name) | |
168 (princ " Mode:\n") | |
169 (princ (documentation major-mode)) | |
170 (let ((minor-modes minor-mode-alist) | |
171 (locals (buffer-local-variables))) | |
172 (while minor-modes | |
173 (let* ((minor-mode (car (car minor-modes))) | |
174 (indicator (car (cdr (car minor-modes)))) | |
175 (local-binding (assq minor-mode locals))) | |
176 ;; Document a minor mode if it is listed in minor-mode-alist, | |
177 ;; bound locally in this buffer, non-nil, and has a function | |
178 ;; definition. | |
179 (if (and local-binding | |
180 (cdr local-binding) | |
181 (fboundp minor-mode)) | |
182 (progn | |
183 (princ (format "\n\n\n%s minor mode (indicator%s):\n" | |
184 minor-mode indicator)) | |
185 (princ (documentation minor-mode))))) | |
186 (setq minor-modes (cdr minor-modes)))) | |
187 (print-help-return-message))) | |
188 | |
189 ;; So keyboard macro definitions are documented correctly | |
190 (fset 'defining-kbd-macro (symbol-function 'start-kbd-macro)) | |
191 | |
192 (defun describe-distribution () | |
193 "Display info on how to obtain the latest version of GNU Emacs." | |
194 (interactive) | |
195 (find-file-read-only | |
444 | 196 (expand-file-name "DISTRIB" data-directory))) |
409 | 197 |
198 (defun describe-copying () | |
199 "Display info on how you may redistribute copies of GNU Emacs." | |
200 (interactive) | |
201 (find-file-read-only | |
444 | 202 (expand-file-name "COPYING" data-directory)) |
409 | 203 (goto-char (point-min))) |
204 | |
5025
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
205 (defun describe-project () |
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
206 "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
|
207 (interactive) |
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
208 (find-file-read-only |
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
209 (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
|
210 (goto-char (point-min))) |
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
211 |
409 | 212 (defun describe-no-warranty () |
213 "Display info on all the kinds of warranty Emacs does NOT have." | |
214 (interactive) | |
215 (describe-copying) | |
216 (let (case-fold-search) | |
217 (search-forward "NO WARRANTY") | |
218 (recenter 0))) | |
219 | |
3980
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
220 (defun describe-prefix-bindings () |
3982
e50f7b531c7f
(describe-prefix-bindings): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
3980
diff
changeset
|
221 "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
|
222 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
|
223 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
|
224 (interactive) |
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
225 (let* ((key (this-command-keys)) |
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
226 (prefix (make-vector (1- (length key)) nil)) |
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
227 i) |
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
228 (setq i 0) |
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
229 (while (< i (length prefix)) |
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
230 (aset prefix i (aref key i)) |
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
231 (setq i (1+ i))) |
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
232 (describe-bindings prefix))) |
3982
e50f7b531c7f
(describe-prefix-bindings): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
3980
diff
changeset
|
233 ;; 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
|
234 ;; run describe-prefix-bindings. |
3980
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
235 (setq prefix-help-command 'describe-prefix-bindings) |
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
236 |
409 | 237 (defun view-emacs-news () |
238 "Display info on recent changes to Emacs." | |
239 (interactive) | |
444 | 240 (find-file-read-only (expand-file-name "NEWS" data-directory))) |
409 | 241 |
242 (defun view-lossage () | |
243 "Display last 100 input keystrokes." | |
244 (interactive) | |
245 (with-output-to-temp-buffer "*Help*" | |
246 (princ (key-description (recent-keys))) | |
247 (save-excursion | |
248 (set-buffer standard-output) | |
249 (goto-char (point-min)) | |
250 (while (progn (move-to-column 50) (not (eobp))) | |
251 (search-forward " " nil t) | |
252 (insert "\n"))) | |
253 (print-help-return-message))) | |
254 | |
2237
2670a8f6a42e
Teach this to use help-screen.el.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2134
diff
changeset
|
255 (make-help-screen help-for-help |
5680
4428fd0336f3
(help-for-help): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
5380
diff
changeset
|
256 "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
|
257 "You have typed \\[help-command], the help character. Type a Help option: |
5380
801232ccc5e5
(help-for-help): Mention the scroll commands.
Richard M. Stallman <rms@gnu.org>
parents:
5025
diff
changeset
|
258 \(Use \\[scroll-up] or \\[scroll-down] to scroll through this text.) |
409 | 259 |
4467
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
260 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
|
261 (functions interactively callable) that contain |
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
262 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
|
263 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
|
264 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
|
265 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
|
266 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
|
267 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
|
268 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
|
269 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
|
270 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
|
271 it displays the full documentation. |
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
272 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
|
273 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
|
274 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
|
275 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
|
276 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
|
277 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
|
278 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
|
279 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
|
280 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
|
281 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
|
282 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
|
283 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
|
284 invoke that command. |
409 | 285 C-c print Emacs copying permission (General Public License). |
286 C-d print Emacs ordering information. | |
287 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
|
288 C-p print information about the GNU project. |
409 | 289 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
|
290 help-map) |
409 | 291 |
292 ;; Return a function which is called by the list containing point. | |
293 ;; If that gives no function, return a function whose name is around point. | |
294 ;; If that doesn't give a function, return nil. | |
295 (defun function-called-at-point () | |
296 (or (condition-case () | |
297 (save-excursion | |
298 (save-restriction | |
299 (narrow-to-region (max (point-min) (- (point) 1000)) (point-max)) | |
300 (backward-up-list 1) | |
301 (forward-char 1) | |
302 (let (obj) | |
303 (setq obj (read (current-buffer))) | |
304 (and (symbolp obj) (fboundp obj) obj)))) | |
305 (error nil)) | |
306 (condition-case () | |
307 (save-excursion | |
308 (forward-sexp -1) | |
309 (skip-chars-forward "'") | |
310 (let ((obj (read (current-buffer)))) | |
311 (and (symbolp obj) (fboundp obj) obj))) | |
312 (error nil)))) | |
313 | |
314 (defun describe-function (function) | |
315 "Display the full documentation of FUNCTION (a symbol)." | |
316 (interactive | |
317 (let ((fn (function-called-at-point)) | |
318 (enable-recursive-minibuffers t) | |
319 val) | |
320 (setq val (completing-read (if fn | |
321 (format "Describe function (default %s): " fn) | |
322 "Describe function: ") | |
323 obarray 'fboundp t)) | |
324 (list (if (equal val "") | |
325 fn (intern val))))) | |
326 (with-output-to-temp-buffer "*Help*" | |
327 (prin1 function) | |
328 (princ ": ") | |
329 (let* ((def (symbol-function function)) | |
330 (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
|
331 (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
|
332 (vectorp def)) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
333 "a keyboard macro.") |
409 | 334 ((subrp def) |
335 (concat beg "built-in function.")) | |
1821
04fb1d3d6992
JimB's changes since January 18th
Jim Blandy <jimb@redhat.com>
parents:
1467
diff
changeset
|
336 ((byte-code-function-p def) |
409 | 337 (concat beg "compiled Lisp function.")) |
338 ((symbolp def) | |
339 (format "alias for `%s'." def)) | |
340 ((eq (car-safe def) 'lambda) | |
341 (concat beg "Lisp function.")) | |
342 ((eq (car-safe def) 'macro) | |
343 "a Lisp macro.") | |
344 ((eq (car-safe def) 'mocklisp) | |
345 "a mocklisp function.") | |
346 ((eq (car-safe def) 'autoload) | |
1467
8d8c91b563ee
(describe-function): Print `an autoloaded', not `a ...'.
Richard M. Stallman <rms@gnu.org>
parents:
919
diff
changeset
|
347 (format "%s autoloaded Lisp %s." |
8d8c91b563ee
(describe-function): Print `an autoloaded', not `a ...'.
Richard M. Stallman <rms@gnu.org>
parents:
919
diff
changeset
|
348 (if (commandp def) "an interactive" "an") |
409 | 349 (if (nth 4 def) "macro" "function") |
878
5b1c5b4286e7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
350 ;;; Including the file name made this line too long. |
5b1c5b4286e7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
351 ;;; (nth 1 def) |
5b1c5b4286e7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
352 )) |
409 | 353 (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
|
354 (terpri) |
2440
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
355 (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
|
356 (car (append def nil))) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
357 ((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
|
358 (nth 1 def)) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
359 (t t)))) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
360 (if (listp arglist) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
361 (progn |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
362 (princ (cons function |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
363 (mapcar (lambda (arg) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
364 (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
|
365 arg |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
366 (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
|
367 arglist))) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
368 (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
|
369 (if (documentation function) |
2360
c12e0f0a3179
(describe-function): Add blank line above doc string.
Richard M. Stallman <rms@gnu.org>
parents:
2315
diff
changeset
|
370 (progn (terpri) |
c12e0f0a3179
(describe-function): Add blank line above doc string.
Richard M. Stallman <rms@gnu.org>
parents:
2315
diff
changeset
|
371 (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
|
372 (princ "not documented")) |
2440
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
373 ) |
409 | 374 (print-help-return-message) |
375 ;; Return the text we displayed. | |
376 (save-excursion (set-buffer standard-output) (buffer-string)))) | |
377 | |
378 (defun variable-at-point () | |
379 (condition-case () | |
380 (save-excursion | |
381 (forward-sexp -1) | |
382 (skip-chars-forward "'") | |
383 (let ((obj (read (current-buffer)))) | |
384 (and (symbolp obj) (boundp obj) obj))) | |
385 (error nil))) | |
386 | |
387 (defun describe-variable (variable) | |
388 "Display the full documentation of VARIABLE (a symbol). | |
389 Returns the documentation as a string, also." | |
390 (interactive | |
391 (let ((v (variable-at-point)) | |
392 (enable-recursive-minibuffers t) | |
393 val) | |
394 (setq val (completing-read (if v | |
395 (format "Describe variable (default %s): " v) | |
396 "Describe variable: ") | |
397 obarray 'boundp t)) | |
398 (list (if (equal val "") | |
399 v (intern val))))) | |
400 (with-output-to-temp-buffer "*Help*" | |
401 (prin1 variable) | |
402 (princ "'s value is ") | |
403 (if (not (boundp variable)) | |
404 (princ "void.") | |
405 (prin1 (symbol-value variable))) | |
406 (terpri) (terpri) | |
407 (princ "Documentation:") | |
408 (terpri) | |
409 (let ((doc (documentation-property variable 'variable-documentation))) | |
410 (if doc | |
411 (princ (substitute-command-keys doc)) | |
412 (princ "not documented as a variable."))) | |
413 (print-help-return-message) | |
414 ;; Return the text we displayed. | |
415 (save-excursion (set-buffer standard-output) (buffer-string)))) | |
416 | |
417 (defun command-apropos (string) | |
418 "Like apropos but lists only symbols that are names of commands | |
419 \(interactively callable functions). Argument REGEXP is a regular expression | |
420 that is matched against command symbol names. Returns list of symbols and | |
421 documentation found." | |
422 (interactive "sCommand apropos (regexp): ") | |
423 (let ((message | |
424 (let ((standard-output (get-buffer-create "*Help*"))) | |
425 (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
|
426 (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
|
427 (and message (message message))))) |
409 | 428 |
429 (defun locate-library (library &optional nosuffix) | |
430 "Show the full path name of Emacs library LIBRARY. | |
431 This command searches the directories in `load-path' like `M-x load-library' | |
432 to find the file that `M-x load-library RET LIBRARY RET' would load. | |
433 Optional second arg NOSUFFIX non-nil means don't add suffixes `.elc' or `.el' | |
434 to the specified name LIBRARY (a la calling `load' instead of `load-library')." | |
435 (interactive "sLocate library: ") | |
436 (catch 'answer | |
437 (mapcar | |
438 '(lambda (dir) | |
439 (mapcar | |
440 '(lambda (suf) | |
441 (let ((try (expand-file-name (concat library suf) dir))) | |
442 (and (file-readable-p try) | |
443 (null (file-directory-p try)) | |
444 (progn | |
445 (message "Library is file %s" try) | |
446 (throw 'answer try))))) | |
447 (if nosuffix '("") '(".elc" ".el" "")))) | |
448 load-path) | |
449 (message "No library %s in search path" library) | |
450 nil)) | |
660
08eb386dd0f3
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
444
diff
changeset
|
451 |
08eb386dd0f3
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
444
diff
changeset
|
452 ;;; help.el ends here |