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