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