Mercurial > emacs
annotate lisp/help.el @ 11501:a56d6a86fa85
(f90-keywords): "only" added to keyword list.
(f90-font-lock-keywords-1): Type may now have attributes private
and public.
(f90-font-lock-keywords-2): Fixed difference between type and type().
(hilit-set-mode-patterns): Type may now have attributes private.
and public, fixed difference between type and type().
(f90-p-type-re): New regular-expression constant for type commands.
(f90-mode): indent-tabs-mode put to nil by default.
(f90-looking-at-type-like): Now uses f90-p-type-re.
(f90-no-block-limit): Now uses f90-p-type-re.
(f90-change-keywords): Don't change preprocessor lines.
author | Karl Heuer <kwzh@gnu.org> |
---|---|
date | Thu, 20 Apr 1995 17:23:29 +0000 |
parents | d39d8e8b6d20 |
children | cafa503e806c |
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 |
7298 | 3 ;; Copyright (C) 1985, 1986, 1993, 1994 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 | |
9833 | 38 (defvar help-mode-map (make-sparse-keymap) |
39 "Keymap for help mode.") | |
40 | |
919 | 41 (define-key global-map (char-to-string help-char) 'help-command) |
409 | 42 (fset 'help-command help-map) |
43 | |
919 | 44 (define-key help-map (char-to-string help-char) 'help-for-help) |
409 | 45 (define-key help-map "?" 'help-for-help) |
46 | |
47 (define-key help-map "\C-c" 'describe-copying) | |
48 (define-key help-map "\C-d" 'describe-distribution) | |
49 (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
|
50 (define-key help-map "\C-p" 'describe-project) |
409 | 51 (define-key help-map "a" 'command-apropos) |
52 | |
53 (define-key help-map "b" 'describe-bindings) | |
54 | |
55 (define-key help-map "c" 'describe-key-briefly) | |
56 (define-key help-map "k" 'describe-key) | |
57 | |
58 (define-key help-map "d" 'describe-function) | |
59 (define-key help-map "f" 'describe-function) | |
60 | |
10923
fe008aef4cf1
(view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents:
10622
diff
changeset
|
61 (define-key help-map "F" 'view-emacs-FAQ) |
fe008aef4cf1
(view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents:
10622
diff
changeset
|
62 |
409 | 63 (define-key help-map "i" 'info) |
732 | 64 (define-key help-map "\C-f" 'Info-goto-emacs-command-node) |
65 (define-key help-map "\C-k" 'Info-goto-emacs-key-command-node) | |
409 | 66 |
67 (define-key help-map "l" 'view-lossage) | |
68 | |
69 (define-key help-map "m" 'describe-mode) | |
70 | |
71 (define-key help-map "\C-n" 'view-emacs-news) | |
72 (define-key help-map "n" 'view-emacs-news) | |
73 | |
2134
b275e1b50542
Added autoload, binding and menu line for new finder feature (P).
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2079
diff
changeset
|
74 (define-key help-map "p" 'finder-by-keyword) |
7978
8356e992ddb6
(finder-by-keyword): Add doc string and t for interactive.
Richard M. Stallman <rms@gnu.org>
parents:
7298
diff
changeset
|
75 (autoload 'finder-by-keyword "finder" |
8356e992ddb6
(finder-by-keyword): Add doc string and t for interactive.
Richard M. Stallman <rms@gnu.org>
parents:
7298
diff
changeset
|
76 "Find packages matching a given keyword." t) |
2134
b275e1b50542
Added autoload, binding and menu line for new finder feature (P).
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2079
diff
changeset
|
77 |
409 | 78 (define-key help-map "s" 'describe-syntax) |
79 | |
80 (define-key help-map "t" 'help-with-tutorial) | |
81 | |
82 (define-key help-map "w" 'where-is) | |
83 | |
84 (define-key help-map "v" 'describe-variable) | |
85 | |
6580 | 86 (define-key help-map "q" 'help-quit) |
87 | |
9833 | 88 (defun help-mode () |
89 "Major mode for viewing help text. | |
90 Entry to this mode runs the normal hook `help-mode-hook'. | |
91 Commands: | |
92 \\{help-mode-map}" | |
93 (interactive) | |
94 (kill-all-local-variables) | |
95 (use-local-map help-mode-map) | |
96 (setq mode-name "Help") | |
97 (setq major-mode 'help-mode) | |
98 (run-hooks 'help-mode-hook)) | |
99 | |
6580 | 100 (defun help-quit () |
101 (interactive) | |
102 nil) | |
103 | |
409 | 104 (defun help-with-tutorial () |
105 "Select the Emacs learn-by-doing tutorial." | |
106 (interactive) | |
107 (let ((file (expand-file-name "~/TUTORIAL"))) | |
108 (delete-other-windows) | |
109 (if (get-file-buffer file) | |
110 (switch-to-buffer (get-file-buffer file)) | |
111 (switch-to-buffer (create-file-buffer file)) | |
112 (setq buffer-file-name file) | |
113 (setq default-directory (expand-file-name "~/")) | |
755 | 114 (setq buffer-auto-save-file-name nil) |
444 | 115 (insert-file-contents (expand-file-name "TUTORIAL" data-directory)) |
409 | 116 (goto-char (point-min)) |
117 (search-forward "\n<<") | |
118 (beginning-of-line) | |
119 (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
|
120 (let ((n (- (window-height (selected-window)) |
409 | 121 (count-lines (point-min) (point)) |
6419
e5ce725b661d
(help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents:
6079
diff
changeset
|
122 6))) |
6433
e50519261181
(help-with-tutorial): Change previous change;
Richard M. Stallman <rms@gnu.org>
parents:
6419
diff
changeset
|
123 (if (< n 12) |
6419
e5ce725b661d
(help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents:
6079
diff
changeset
|
124 (newline n) |
e5ce725b661d
(help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents:
6079
diff
changeset
|
125 ;; 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
|
126 (newline (/ n 2)) |
e5ce725b661d
(help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents:
6079
diff
changeset
|
127 (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
|
128 "Text continues below]") |
e5ce725b661d
(help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents:
6079
diff
changeset
|
129 (newline (- n (/ n 2))))) |
409 | 130 (goto-char (point-min)) |
131 (set-buffer-modified-p nil)))) | |
132 | |
133 (defun describe-key-briefly (key) | |
134 "Print the name of the function KEY invokes. KEY is a string." | |
135 (interactive "kDescribe key briefly: ") | |
2955
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
136 ;; 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
|
137 ;; following click or drag event. Otherwise that would |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
138 ;; erase the message. |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
139 (let ((type (aref key (1- (length key))))) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
140 (if (listp type) (setq type (car type))) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
141 (and (symbolp type) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
142 (memq 'down (event-modifiers type)) |
3986
0e5fa7a1ac36
(describe-key-briefly): Don't set `foo'.
Richard M. Stallman <rms@gnu.org>
parents:
3982
diff
changeset
|
143 (read-event))) |
409 | 144 (let ((defn (key-binding key))) |
145 (if (or (null defn) (integerp defn)) | |
146 (message "%s is undefined" (key-description key)) | |
147 (message "%s runs the command %s" | |
148 (key-description key) | |
149 (if (symbolp defn) defn (prin1-to-string defn)))))) | |
150 | |
151 (defun print-help-return-message (&optional function) | |
152 "Display or return message saying how to restore windows after help command. | |
153 Computes a message and applies the optional argument FUNCTION to it. | |
154 If FUNCTION is nil, applies `message' to it, thus printing it." | |
155 (and (not (get-buffer-window standard-output)) | |
8259
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
156 (let ((first-message |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
157 (cond ((or (member (buffer-name standard-output) |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
158 special-display-buffer-names) |
8992
245187067d35
(print-help-return-message): Handle cons cells
Richard M. Stallman <rms@gnu.org>
parents:
8858
diff
changeset
|
159 (assoc (buffer-name standard-output) |
245187067d35
(print-help-return-message): Handle cons cells
Richard M. Stallman <rms@gnu.org>
parents:
8858
diff
changeset
|
160 special-display-buffer-names) |
8259
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
161 (let (found |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
162 (tail special-display-regexps) |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
163 (name (buffer-name standard-output))) |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
164 (while (and tail (not found)) |
9833 | 165 (if (or (and (consp (car tail)) |
8992
245187067d35
(print-help-return-message): Handle cons cells
Richard M. Stallman <rms@gnu.org>
parents:
8858
diff
changeset
|
166 (string-match (car (car tail)) name)) |
245187067d35
(print-help-return-message): Handle cons cells
Richard M. Stallman <rms@gnu.org>
parents:
8858
diff
changeset
|
167 (and (stringp (car tail)) |
245187067d35
(print-help-return-message): Handle cons cells
Richard M. Stallman <rms@gnu.org>
parents:
8858
diff
changeset
|
168 (string-match (car tail) name))) |
8259
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
169 (setq found t)) |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
170 (setq tail (cdr tail))) |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
171 found)) |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
172 ;; If the help output buffer is a special display buffer, |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
173 ;; don't say anything about how to get rid of it. |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
174 ;; First of all, the user will do that with the window |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
175 ;; manager, not with Emacs. |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
176 ;; Secondly, the buffer has not been displayed yet, |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
177 ;; so we don't know whether its frame will be selected. |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
178 ;; Even the message about scrolling the help |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
179 ;; might be wrong, but it seems worth showing it anyway. |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
180 nil) |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
181 ((not (one-window-p t)) |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
182 "Type \\[switch-to-buffer-other-window] RET to restore the other window.") |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
183 (pop-up-windows |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
184 "Type \\[delete-other-windows] to remove help window.") |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
185 (t |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
186 "Type \\[switch-to-buffer] RET to remove help window.")))) |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
187 (funcall (or function 'message) |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
188 (concat |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
189 (if first-message |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
190 (substitute-command-keys first-message) |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
191 "") |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
192 (if first-message " " "") |
11428
d39d8e8b6d20
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
10923
diff
changeset
|
193 (if (or (member (buffer-name standard-output) |
d39d8e8b6d20
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
10923
diff
changeset
|
194 same-window-buffer-names) |
d39d8e8b6d20
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
10923
diff
changeset
|
195 (memq t (mapcar '(lambda (elt) |
d39d8e8b6d20
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
10923
diff
changeset
|
196 (string-match elt (buffer-name standard-output))) |
d39d8e8b6d20
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
10923
diff
changeset
|
197 same-window-regexps))) |
d39d8e8b6d20
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
10923
diff
changeset
|
198 (substitute-command-keys |
d39d8e8b6d20
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
10923
diff
changeset
|
199 "\\[scroll-up] to scroll the help.") |
d39d8e8b6d20
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
10923
diff
changeset
|
200 (substitute-command-keys |
d39d8e8b6d20
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
10923
diff
changeset
|
201 "\\[scroll-other-window] to scroll the help."))))))) |
409 | 202 |
203 (defun describe-key (key) | |
204 "Display documentation of the function invoked by KEY. KEY is a string." | |
205 (interactive "kDescribe key: ") | |
2955
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
206 ;; 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
|
207 ;; following click or drag event. Otherwise that would |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
208 ;; erase the message. |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
209 (let ((type (aref key (1- (length key))))) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
210 (if (listp type) (setq type (car type))) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
211 (and (symbolp type) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
212 (memq 'down (event-modifiers type)) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
213 (read-event))) |
409 | 214 (let ((defn (key-binding key))) |
215 (if (or (null defn) (integerp defn)) | |
216 (message "%s is undefined" (key-description key)) | |
217 (with-output-to-temp-buffer "*Help*" | |
218 (prin1 defn) | |
219 (princ ":\n") | |
220 (if (documentation defn) | |
221 (princ (documentation defn)) | |
222 (princ "not documented")) | |
9854
f810a558acf6
(describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
9833
diff
changeset
|
223 (save-excursion |
f810a558acf6
(describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
9833
diff
changeset
|
224 (set-buffer standard-output) |
f810a558acf6
(describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
9833
diff
changeset
|
225 (help-mode)) |
409 | 226 (print-help-return-message))))) |
227 | |
6902
962a6ffb7b97
(describe-mode): Always show minor modes, at front.
Richard M. Stallman <rms@gnu.org>
parents:
6580
diff
changeset
|
228 (defun describe-mode () |
962a6ffb7b97
(describe-mode): Always show minor modes, at front.
Richard M. Stallman <rms@gnu.org>
parents:
6580
diff
changeset
|
229 "Display documentation of current major mode and minor modes. |
409 | 230 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
|
231 \(listed in `minor-mode-alist') must also be a function whose documentation |
409 | 232 describes the minor mode." |
6903
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
233 (interactive) |
409 | 234 (with-output-to-temp-buffer "*Help*" |
6903
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
235 (let ((minor-modes minor-mode-alist) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
236 (locals (buffer-local-variables))) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
237 (while minor-modes |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
238 (let* ((minor-mode (car (car minor-modes))) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
239 (indicator (car (cdr (car minor-modes)))) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
240 (local-binding (assq minor-mode locals))) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
241 ;; Document a minor mode if it is listed in minor-mode-alist, |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
242 ;; bound locally in this buffer, non-nil, and has a function |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
243 ;; definition. |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
244 (if (and local-binding |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
245 (cdr local-binding) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
246 (fboundp minor-mode)) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
247 (let ((pretty-minor-mode minor-mode)) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
248 (if (string-match "-mode$" (symbol-name minor-mode)) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
249 (setq pretty-minor-mode |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
250 (capitalize |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
251 (substring (symbol-name minor-mode) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
252 0 (match-beginning 0))))) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
253 (while (and indicator (symbolp indicator)) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
254 (setq indicator (symbol-value indicator))) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
255 (princ (format "%s minor mode (indicator%s):\n" |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
256 pretty-minor-mode indicator)) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
257 (princ (documentation minor-mode)) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
258 (princ "\n\n")))) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
259 (setq minor-modes (cdr minor-modes)))) |
409 | 260 (princ mode-name) |
6902
962a6ffb7b97
(describe-mode): Always show minor modes, at front.
Richard M. Stallman <rms@gnu.org>
parents:
6580
diff
changeset
|
261 (princ " mode:\n") |
409 | 262 (princ (documentation major-mode)) |
9854
f810a558acf6
(describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
9833
diff
changeset
|
263 (save-excursion |
f810a558acf6
(describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
9833
diff
changeset
|
264 (set-buffer standard-output) |
f810a558acf6
(describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
9833
diff
changeset
|
265 (help-mode)) |
409 | 266 (print-help-return-message))) |
267 | |
268 ;; So keyboard macro definitions are documented correctly | |
269 (fset 'defining-kbd-macro (symbol-function 'start-kbd-macro)) | |
270 | |
271 (defun describe-distribution () | |
272 "Display info on how to obtain the latest version of GNU Emacs." | |
273 (interactive) | |
274 (find-file-read-only | |
444 | 275 (expand-file-name "DISTRIB" data-directory))) |
409 | 276 |
277 (defun describe-copying () | |
278 "Display info on how you may redistribute copies of GNU Emacs." | |
279 (interactive) | |
280 (find-file-read-only | |
444 | 281 (expand-file-name "COPYING" data-directory)) |
409 | 282 (goto-char (point-min))) |
283 | |
5025
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
284 (defun describe-project () |
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
285 "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
|
286 (interactive) |
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
287 (find-file-read-only |
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
288 (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
|
289 (goto-char (point-min))) |
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
290 |
409 | 291 (defun describe-no-warranty () |
292 "Display info on all the kinds of warranty Emacs does NOT have." | |
293 (interactive) | |
294 (describe-copying) | |
295 (let (case-fold-search) | |
296 (search-forward "NO WARRANTY") | |
297 (recenter 0))) | |
298 | |
3980
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
299 (defun describe-prefix-bindings () |
3982
e50f7b531c7f
(describe-prefix-bindings): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
3980
diff
changeset
|
300 "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
|
301 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
|
302 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
|
303 (interactive) |
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
304 (let* ((key (this-command-keys)) |
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
305 (prefix (make-vector (1- (length key)) nil)) |
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
306 i) |
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
307 (setq i 0) |
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
308 (while (< i (length prefix)) |
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
309 (aset prefix i (aref key i)) |
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
310 (setq i (1+ i))) |
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
311 (describe-bindings prefix))) |
3982
e50f7b531c7f
(describe-prefix-bindings): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
3980
diff
changeset
|
312 ;; 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
|
313 ;; run describe-prefix-bindings. |
3980
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
314 (setq prefix-help-command 'describe-prefix-bindings) |
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
315 |
409 | 316 (defun view-emacs-news () |
317 "Display info on recent changes to Emacs." | |
318 (interactive) | |
444 | 319 (find-file-read-only (expand-file-name "NEWS" data-directory))) |
409 | 320 |
10923
fe008aef4cf1
(view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents:
10622
diff
changeset
|
321 (defun view-emacs-FAQ () |
fe008aef4cf1
(view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents:
10622
diff
changeset
|
322 "Display the Emacs Frequently Asked Questions (FAQ) file." |
fe008aef4cf1
(view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents:
10622
diff
changeset
|
323 (interactive) |
fe008aef4cf1
(view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents:
10622
diff
changeset
|
324 (find-file-read-only (expand-file-name "FAQ" data-directory))) |
fe008aef4cf1
(view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents:
10622
diff
changeset
|
325 |
409 | 326 (defun view-lossage () |
327 "Display last 100 input keystrokes." | |
328 (interactive) | |
329 (with-output-to-temp-buffer "*Help*" | |
8504
8c492f23ee28
(view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents:
8259
diff
changeset
|
330 (princ (mapconcat (function (lambda (key) |
8c492f23ee28
(view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents:
8259
diff
changeset
|
331 (if (or (integerp key) |
8c492f23ee28
(view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents:
8259
diff
changeset
|
332 (symbolp key) |
8c492f23ee28
(view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents:
8259
diff
changeset
|
333 (listp key)) |
8c492f23ee28
(view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents:
8259
diff
changeset
|
334 (single-key-description key) |
8c492f23ee28
(view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents:
8259
diff
changeset
|
335 (prin1-to-string key nil)))) |
8c492f23ee28
(view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents:
8259
diff
changeset
|
336 (recent-keys) |
8c492f23ee28
(view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents:
8259
diff
changeset
|
337 " ")) |
409 | 338 (save-excursion |
339 (set-buffer standard-output) | |
340 (goto-char (point-min)) | |
341 (while (progn (move-to-column 50) (not (eobp))) | |
342 (search-forward " " nil t) | |
9854
f810a558acf6
(describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
9833
diff
changeset
|
343 (insert "\n")) |
f810a558acf6
(describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
9833
diff
changeset
|
344 (help-mode)) |
409 | 345 (print-help-return-message))) |
346 | |
6580 | 347 (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
|
348 (make-help-screen help-for-help |
5680
4428fd0336f3
(help-for-help): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
5380
diff
changeset
|
349 "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
|
350 "You have typed \\[help-command], the help character. Type a Help option: |
10479
f2f290b13413
(help-for-help): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
10196
diff
changeset
|
351 \(Use SPC or DEL to scroll through this text. Type \\<help-map>\\[help-quit] to exit the Help command.) |
409 | 352 |
4467
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
353 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
|
354 (functions interactively callable) that contain |
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
355 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
|
356 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
|
357 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
|
358 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
|
359 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
|
360 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
|
361 it takes you to the Info node for that command. |
10923
fe008aef4cf1
(view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents:
10622
diff
changeset
|
362 F view-emacs-FAQ. Shows emacs frequently asked questions file. |
2638
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
363 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
|
364 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
|
365 it displays the full documentation. |
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
366 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
|
367 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
|
368 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
|
369 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
|
370 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
|
371 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
|
372 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
|
373 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
|
374 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
|
375 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
|
376 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
|
377 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
|
378 invoke that command. |
409 | 379 C-c print Emacs copying permission (General Public License). |
380 C-d print Emacs ordering information. | |
381 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
|
382 C-p print information about the GNU project. |
409 | 383 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
|
384 help-map) |
409 | 385 |
386 ;; Return a function which is called by the list containing point. | |
387 ;; If that gives no function, return a function whose name is around point. | |
388 ;; If that doesn't give a function, return nil. | |
389 (defun function-called-at-point () | |
390 (or (condition-case () | |
391 (save-excursion | |
392 (save-restriction | |
393 (narrow-to-region (max (point-min) (- (point) 1000)) (point-max)) | |
394 (backward-up-list 1) | |
395 (forward-char 1) | |
396 (let (obj) | |
397 (setq obj (read (current-buffer))) | |
398 (and (symbolp obj) (fboundp obj) obj)))) | |
399 (error nil)) | |
400 (condition-case () | |
401 (save-excursion | |
402 (forward-sexp -1) | |
403 (skip-chars-forward "'") | |
404 (let ((obj (read (current-buffer)))) | |
405 (and (symbolp obj) (fboundp obj) obj))) | |
406 (error nil)))) | |
407 | |
9639
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
408 (defun describe-function-find-file (function) |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
409 (let ((files load-history) |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
410 file functions) |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
411 (while files |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
412 (if (memq function (cdr (car files))) |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
413 (setq file (car (car files)) files nil)) |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
414 (setq files (cdr files))) |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
415 file)) |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
416 |
409 | 417 (defun describe-function (function) |
418 "Display the full documentation of FUNCTION (a symbol)." | |
419 (interactive | |
420 (let ((fn (function-called-at-point)) | |
421 (enable-recursive-minibuffers t) | |
422 val) | |
423 (setq val (completing-read (if fn | |
424 (format "Describe function (default %s): " fn) | |
425 "Describe function: ") | |
426 obarray 'fboundp t)) | |
427 (list (if (equal val "") | |
428 fn (intern val))))) | |
429 (with-output-to-temp-buffer "*Help*" | |
430 (prin1 function) | |
431 (princ ": ") | |
432 (let* ((def (symbol-function function)) | |
433 (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
|
434 (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
|
435 (vectorp def)) |
9638
e77a0d87d792
(describe-function): Mention the file it was loaded from.
Richard M. Stallman <rms@gnu.org>
parents:
9161
diff
changeset
|
436 "a keyboard macro") |
409 | 437 ((subrp def) |
9638
e77a0d87d792
(describe-function): Mention the file it was loaded from.
Richard M. Stallman <rms@gnu.org>
parents:
9161
diff
changeset
|
438 (concat beg "built-in function")) |
1821
04fb1d3d6992
JimB's changes since January 18th
Jim Blandy <jimb@redhat.com>
parents:
1467
diff
changeset
|
439 ((byte-code-function-p def) |
9638
e77a0d87d792
(describe-function): Mention the file it was loaded from.
Richard M. Stallman <rms@gnu.org>
parents:
9161
diff
changeset
|
440 (concat beg "compiled Lisp function")) |
409 | 441 ((symbolp def) |
9638
e77a0d87d792
(describe-function): Mention the file it was loaded from.
Richard M. Stallman <rms@gnu.org>
parents:
9161
diff
changeset
|
442 (format "alias for `%s'" def)) |
409 | 443 ((eq (car-safe def) 'lambda) |
9638
e77a0d87d792
(describe-function): Mention the file it was loaded from.
Richard M. Stallman <rms@gnu.org>
parents:
9161
diff
changeset
|
444 (concat beg "Lisp function")) |
409 | 445 ((eq (car-safe def) 'macro) |
9638
e77a0d87d792
(describe-function): Mention the file it was loaded from.
Richard M. Stallman <rms@gnu.org>
parents:
9161
diff
changeset
|
446 "a Lisp macro") |
409 | 447 ((eq (car-safe def) 'mocklisp) |
9638
e77a0d87d792
(describe-function): Mention the file it was loaded from.
Richard M. Stallman <rms@gnu.org>
parents:
9161
diff
changeset
|
448 "a mocklisp function") |
409 | 449 ((eq (car-safe def) 'autoload) |
9638
e77a0d87d792
(describe-function): Mention the file it was loaded from.
Richard M. Stallman <rms@gnu.org>
parents:
9161
diff
changeset
|
450 (format "%s autoloaded Lisp %s" |
1467
8d8c91b563ee
(describe-function): Print `an autoloaded', not `a ...'.
Richard M. Stallman <rms@gnu.org>
parents:
919
diff
changeset
|
451 (if (commandp def) "an interactive" "an") |
409 | 452 (if (nth 4 def) "macro" "function") |
878
5b1c5b4286e7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
453 ;;; Including the file name made this line too long. |
5b1c5b4286e7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
454 ;;; (nth 1 def) |
5b1c5b4286e7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
455 )) |
409 | 456 (t ""))) |
9639
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
457 (let ((file (describe-function-find-file function))) |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
458 (if file |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
459 (progn |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
460 (princ " in `") |
10195
68e113512fa4
(describe-function): Don't add `.el' when printing file name.
Richard M. Stallman <rms@gnu.org>
parents:
9854
diff
changeset
|
461 ;; We used to add .el to the file name, |
68e113512fa4
(describe-function): Don't add `.el' when printing file name.
Richard M. Stallman <rms@gnu.org>
parents:
9854
diff
changeset
|
462 ;; but that's completely wrong when the user used load-file. |
10196
b3ba0a974d14
(describe-function): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
10195
diff
changeset
|
463 (princ file) |
b3ba0a974d14
(describe-function): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
10195
diff
changeset
|
464 (princ "'")))) |
9638
e77a0d87d792
(describe-function): Mention the file it was loaded from.
Richard M. Stallman <rms@gnu.org>
parents:
9161
diff
changeset
|
465 (princ ".") |
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
|
466 (terpri) |
2440
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
467 (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
|
468 (car (append def nil))) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
469 ((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
|
470 (nth 1 def)) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
471 (t t)))) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
472 (if (listp arglist) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
473 (progn |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
474 (princ (cons function |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
475 (mapcar (lambda (arg) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
476 (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
|
477 arg |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
478 (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
|
479 arglist))) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
480 (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
|
481 (if (documentation function) |
2360
c12e0f0a3179
(describe-function): Add blank line above doc string.
Richard M. Stallman <rms@gnu.org>
parents:
2315
diff
changeset
|
482 (progn (terpri) |
c12e0f0a3179
(describe-function): Add blank line above doc string.
Richard M. Stallman <rms@gnu.org>
parents:
2315
diff
changeset
|
483 (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
|
484 (princ "not documented")) |
2440
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
485 ) |
409 | 486 (print-help-return-message) |
9854
f810a558acf6
(describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
9833
diff
changeset
|
487 (save-excursion |
f810a558acf6
(describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
9833
diff
changeset
|
488 (set-buffer standard-output) |
f810a558acf6
(describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
9833
diff
changeset
|
489 (help-mode) |
f810a558acf6
(describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
9833
diff
changeset
|
490 ;; Return the text we displayed. |
f810a558acf6
(describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
9833
diff
changeset
|
491 (buffer-string)))) |
409 | 492 |
493 (defun variable-at-point () | |
494 (condition-case () | |
495 (save-excursion | |
496 (forward-sexp -1) | |
497 (skip-chars-forward "'") | |
498 (let ((obj (read (current-buffer)))) | |
499 (and (symbolp obj) (boundp obj) obj))) | |
500 (error nil))) | |
501 | |
502 (defun describe-variable (variable) | |
503 "Display the full documentation of VARIABLE (a symbol). | |
504 Returns the documentation as a string, also." | |
505 (interactive | |
506 (let ((v (variable-at-point)) | |
507 (enable-recursive-minibuffers t) | |
508 val) | |
509 (setq val (completing-read (if v | |
510 (format "Describe variable (default %s): " v) | |
511 "Describe variable: ") | |
512 obarray 'boundp t)) | |
513 (list (if (equal val "") | |
514 v (intern val))))) | |
515 (with-output-to-temp-buffer "*Help*" | |
516 (prin1 variable) | |
517 (if (not (boundp variable)) | |
10622
97213941b5e8
(describe-variable): If var is local, mention default.
Richard M. Stallman <rms@gnu.org>
parents:
10573
diff
changeset
|
518 (princ " is void") |
97213941b5e8
(describe-variable): If var is local, mention default.
Richard M. Stallman <rms@gnu.org>
parents:
10573
diff
changeset
|
519 (princ "'s value is ") |
409 | 520 (prin1 (symbol-value variable))) |
8858
dff46e860b51
(describe-variable): Report whether var is local in this buf.
Richard M. Stallman <rms@gnu.org>
parents:
8504
diff
changeset
|
521 (terpri) |
10573
ab52927eddad
(describe-variable): Use local-variable-p.
Richard M. Stallman <rms@gnu.org>
parents:
10479
diff
changeset
|
522 (if (local-variable-p variable) |
10622
97213941b5e8
(describe-variable): If var is local, mention default.
Richard M. Stallman <rms@gnu.org>
parents:
10573
diff
changeset
|
523 (progn |
97213941b5e8
(describe-variable): If var is local, mention default.
Richard M. Stallman <rms@gnu.org>
parents:
10573
diff
changeset
|
524 (princ (format "Local in buffer %s; " (buffer-name))) |
97213941b5e8
(describe-variable): If var is local, mention default.
Richard M. Stallman <rms@gnu.org>
parents:
10573
diff
changeset
|
525 (if (not (default-boundp variable)) |
97213941b5e8
(describe-variable): If var is local, mention default.
Richard M. Stallman <rms@gnu.org>
parents:
10573
diff
changeset
|
526 (princ "globally void") |
97213941b5e8
(describe-variable): If var is local, mention default.
Richard M. Stallman <rms@gnu.org>
parents:
10573
diff
changeset
|
527 (princ "global value is ") |
97213941b5e8
(describe-variable): If var is local, mention default.
Richard M. Stallman <rms@gnu.org>
parents:
10573
diff
changeset
|
528 (prin1 (default-value variable))) |
97213941b5e8
(describe-variable): If var is local, mention default.
Richard M. Stallman <rms@gnu.org>
parents:
10573
diff
changeset
|
529 (terpri))) |
8858
dff46e860b51
(describe-variable): Report whether var is local in this buf.
Richard M. Stallman <rms@gnu.org>
parents:
8504
diff
changeset
|
530 (terpri) |
409 | 531 (princ "Documentation:") |
532 (terpri) | |
533 (let ((doc (documentation-property variable 'variable-documentation))) | |
534 (if doc | |
535 (princ (substitute-command-keys doc)) | |
536 (princ "not documented as a variable."))) | |
537 (print-help-return-message) | |
9854
f810a558acf6
(describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
9833
diff
changeset
|
538 (save-excursion |
f810a558acf6
(describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
9833
diff
changeset
|
539 (set-buffer standard-output) |
f810a558acf6
(describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
9833
diff
changeset
|
540 (help-mode) |
f810a558acf6
(describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
9833
diff
changeset
|
541 ;; Return the text we displayed. |
f810a558acf6
(describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
9833
diff
changeset
|
542 (buffer-string)))) |
409 | 543 |
6476
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
544 (defun where-is (definition) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
545 "Print message listing key sequences that invoke specified command. |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
546 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
|
547 (interactive |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
548 (let ((fn (function-called-at-point)) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
549 (enable-recursive-minibuffers t) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
550 val) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
551 (setq val (completing-read (if fn |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
552 (format "Where is command (default %s): " fn) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
553 "Where is command: ") |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
554 obarray 'fboundp t)) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
555 (list (if (equal val "") |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
556 fn (intern val))))) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
557 (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
|
558 (keys1 (mapconcat 'key-description keys ", "))) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
559 (if (> (length keys1) 0) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
560 (message "%s is on %s" definition keys1) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
561 (message "%s is not on any key" definition))) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
562 nil) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
563 |
409 | 564 (defun command-apropos (string) |
565 "Like apropos but lists only symbols that are names of commands | |
566 \(interactively callable functions). Argument REGEXP is a regular expression | |
567 that is matched against command symbol names. Returns list of symbols and | |
568 documentation found." | |
569 (interactive "sCommand apropos (regexp): ") | |
570 (let ((message | |
571 (let ((standard-output (get-buffer-create "*Help*"))) | |
572 (print-help-return-message 'identity)))) | |
9161
a75fa15b9e23
(command-apropos): Pass t for no-header to apropos.
Richard M. Stallman <rms@gnu.org>
parents:
8992
diff
changeset
|
573 (if (apropos string t 'commandp t) |
2079
51012c0f1227
(command-apropos): Print echo area message iff found symbols.
Richard M. Stallman <rms@gnu.org>
parents:
1889
diff
changeset
|
574 (and message (message message))))) |
409 | 575 |
576 (defun locate-library (library &optional nosuffix) | |
577 "Show the full path name of Emacs library LIBRARY. | |
578 This command searches the directories in `load-path' like `M-x load-library' | |
579 to find the file that `M-x load-library RET LIBRARY RET' would load. | |
580 Optional second arg NOSUFFIX non-nil means don't add suffixes `.elc' or `.el' | |
581 to the specified name LIBRARY (a la calling `load' instead of `load-library')." | |
582 (interactive "sLocate library: ") | |
583 (catch 'answer | |
584 (mapcar | |
585 '(lambda (dir) | |
586 (mapcar | |
587 '(lambda (suf) | |
588 (let ((try (expand-file-name (concat library suf) dir))) | |
589 (and (file-readable-p try) | |
590 (null (file-directory-p try)) | |
591 (progn | |
592 (message "Library is file %s" try) | |
593 (throw 'answer try))))) | |
594 (if nosuffix '("") '(".elc" ".el" "")))) | |
595 load-path) | |
596 (message "No library %s in search path" library) | |
597 nil)) | |
660
08eb386dd0f3
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
444
diff
changeset
|
598 |
08eb386dd0f3
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
444
diff
changeset
|
599 ;;; help.el ends here |