Mercurial > emacs
annotate lisp/help.el @ 19597:1dfca0cdcb91
(nnfolder-request-list): Override
'nnmail-file-coding-system' by 'nnmail-active-file-coding-system'.
(nnfolder-request-list, nnfolder-possibly-change-group): Protect
from conversion by `pathname-coding-system' for XEmacs/mule.
(nnfolder-group-pathname): Encode pathname for Emacs 20.
author | Kenichi Handa <handa@m17n.org> |
---|---|
date | Thu, 28 Aug 1997 04:51:02 +0000 |
parents | b0bd0bd48893 |
children | 36044c8b8aef |
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 | |
14169 | 21 ;; along with GNU Emacs; see the file COPYING. If not, write to the |
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
23 ;; Boston, MA 02111-1307, USA. | |
409 | 24 |
2315
9e7ec92a4fdf
Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2312
diff
changeset
|
25 ;;; Commentary: |
9e7ec92a4fdf
Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2312
diff
changeset
|
26 |
16391
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
27 ;; This code implements GNU Emacs' on-line help system, the one invoked by |
2315
9e7ec92a4fdf
Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2312
diff
changeset
|
28 ;;`M-x help-for-help'. |
9e7ec92a4fdf
Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2312
diff
changeset
|
29 |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
755
diff
changeset
|
30 ;;; Code: |
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
755
diff
changeset
|
31 |
2312
ad7b89a430df
Don't load help-screen at run time if compiled.
Richard M. Stallman <rms@gnu.org>
parents:
2237
diff
changeset
|
32 ;; 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
|
33 ;; 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
|
34 (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
|
35 |
409 | 36 (defvar help-map (make-sparse-keymap) |
37 "Keymap for characters following the Help key.") | |
38 | |
9833 | 39 (defvar help-mode-map (make-sparse-keymap) |
40 "Keymap for help mode.") | |
41 | |
919 | 42 (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
|
43 (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
|
44 (define-key global-map [f1] 'help-command) |
409 | 45 (fset 'help-command help-map) |
46 | |
919 | 47 (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
|
48 (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
|
49 (define-key help-map [f1] 'help-for-help) |
409 | 50 (define-key help-map "?" 'help-for-help) |
51 | |
52 (define-key help-map "\C-c" 'describe-copying) | |
53 (define-key help-map "\C-d" 'describe-distribution) | |
54 (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
|
55 (define-key help-map "\C-p" 'describe-project) |
17200
9438563a5151
(help-map): Use apropos-command, not command-apropos.
Richard M. Stallman <rms@gnu.org>
parents:
17005
diff
changeset
|
56 (define-key help-map "a" 'apropos-command) |
409 | 57 |
58 (define-key help-map "b" 'describe-bindings) | |
59 | |
60 (define-key help-map "c" 'describe-key-briefly) | |
61 (define-key help-map "k" 'describe-key) | |
62 | |
63 (define-key help-map "d" 'describe-function) | |
64 (define-key help-map "f" 'describe-function) | |
65 | |
10923
fe008aef4cf1
(view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents:
10622
diff
changeset
|
66 (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
|
67 |
409 | 68 (define-key help-map "i" 'info) |
732 | 69 (define-key help-map "\C-f" 'Info-goto-emacs-command-node) |
70 (define-key help-map "\C-k" 'Info-goto-emacs-key-command-node) | |
18293
ac6884f51b58
(help-map): Make C-i run info-lookup-symbol.
Richard M. Stallman <rms@gnu.org>
parents:
17917
diff
changeset
|
71 (define-key help-map "\C-i" 'info-lookup-symbol) |
409 | 72 |
73 (define-key help-map "l" 'view-lossage) | |
74 | |
75 (define-key help-map "m" 'describe-mode) | |
76 | |
77 (define-key help-map "\C-n" 'view-emacs-news) | |
78 (define-key help-map "n" 'view-emacs-news) | |
79 | |
2134
b275e1b50542
Added autoload, binding and menu line for new finder feature (P).
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2079
diff
changeset
|
80 (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
|
81 (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
|
82 "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
|
83 |
409 | 84 (define-key help-map "s" 'describe-syntax) |
85 | |
86 (define-key help-map "t" 'help-with-tutorial) | |
87 | |
88 (define-key help-map "w" 'where-is) | |
89 | |
90 (define-key help-map "v" 'describe-variable) | |
91 | |
6580 | 92 (define-key help-map "q" 'help-quit) |
93 | |
12816
7a19739bd181
Added Font Lock mode support.
Simon Marshall <simon@gnu.org>
parents:
12499
diff
changeset
|
94 (defvar help-font-lock-keywords |
15788
e8e74fb6da7d
(help-font-lock-keywords): Use font-lock-function-name-face
Richard M. Stallman <rms@gnu.org>
parents:
15783
diff
changeset
|
95 (eval-when-compile |
e8e74fb6da7d
(help-font-lock-keywords): Use font-lock-function-name-face
Richard M. Stallman <rms@gnu.org>
parents:
15783
diff
changeset
|
96 (let ((name-char "[-+a-zA-Z0-9_*]") (sym-char "[-+a-zA-Z0-9_:*]")) |
e8e74fb6da7d
(help-font-lock-keywords): Use font-lock-function-name-face
Richard M. Stallman <rms@gnu.org>
parents:
15783
diff
changeset
|
97 (list |
e8e74fb6da7d
(help-font-lock-keywords): Use font-lock-function-name-face
Richard M. Stallman <rms@gnu.org>
parents:
15783
diff
changeset
|
98 ;; |
e8e74fb6da7d
(help-font-lock-keywords): Use font-lock-function-name-face
Richard M. Stallman <rms@gnu.org>
parents:
15783
diff
changeset
|
99 ;; The symbol itself. |
e8e74fb6da7d
(help-font-lock-keywords): Use font-lock-function-name-face
Richard M. Stallman <rms@gnu.org>
parents:
15783
diff
changeset
|
100 (list (concat "\\`\\(" name-char "+\\)\\(\\(:\\)\\|\\('\\)\\)") |
15810
add6684a3e67
(help-font-lock-keywords): Undo July 26 change.
Richard M. Stallman <rms@gnu.org>
parents:
15799
diff
changeset
|
101 '(1 (if (match-beginning 3) |
add6684a3e67
(help-font-lock-keywords): Undo July 26 change.
Richard M. Stallman <rms@gnu.org>
parents:
15799
diff
changeset
|
102 font-lock-function-name-face |
15826
4a675a6a15c8
Fully reinstall July 26 change.
Simon Marshall <simon@gnu.org>
parents:
15810
diff
changeset
|
103 font-lock-variable-name-face))) |
15788
e8e74fb6da7d
(help-font-lock-keywords): Use font-lock-function-name-face
Richard M. Stallman <rms@gnu.org>
parents:
15783
diff
changeset
|
104 ;; |
e8e74fb6da7d
(help-font-lock-keywords): Use font-lock-function-name-face
Richard M. Stallman <rms@gnu.org>
parents:
15783
diff
changeset
|
105 ;; Words inside `' which tend to be symbol names. |
e8e74fb6da7d
(help-font-lock-keywords): Use font-lock-function-name-face
Richard M. Stallman <rms@gnu.org>
parents:
15783
diff
changeset
|
106 (list (concat "`\\(" sym-char sym-char "+\\)'") |
e8e74fb6da7d
(help-font-lock-keywords): Use font-lock-function-name-face
Richard M. Stallman <rms@gnu.org>
parents:
15783
diff
changeset
|
107 1 'font-lock-reference-face t) |
e8e74fb6da7d
(help-font-lock-keywords): Use font-lock-function-name-face
Richard M. Stallman <rms@gnu.org>
parents:
15783
diff
changeset
|
108 ;; |
e8e74fb6da7d
(help-font-lock-keywords): Use font-lock-function-name-face
Richard M. Stallman <rms@gnu.org>
parents:
15783
diff
changeset
|
109 ;; CLisp `:' keywords as references. |
e8e74fb6da7d
(help-font-lock-keywords): Use font-lock-function-name-face
Richard M. Stallman <rms@gnu.org>
parents:
15783
diff
changeset
|
110 (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
|
111 "Default expressions to highlight in Help mode.") |
7a19739bd181
Added Font Lock mode support.
Simon Marshall <simon@gnu.org>
parents:
12499
diff
changeset
|
112 |
9833 | 113 (defun help-mode () |
114 "Major mode for viewing help text. | |
115 Entry to this mode runs the normal hook `help-mode-hook'. | |
116 Commands: | |
117 \\{help-mode-map}" | |
118 (interactive) | |
119 (kill-all-local-variables) | |
120 (use-local-map help-mode-map) | |
121 (setq mode-name "Help") | |
122 (setq major-mode 'help-mode) | |
12816
7a19739bd181
Added Font Lock mode support.
Simon Marshall <simon@gnu.org>
parents:
12499
diff
changeset
|
123 (make-local-variable 'font-lock-defaults) |
15799
2a1123f30c73
(help-fontify-buffer-function): Function deleted.
Richard M. Stallman <rms@gnu.org>
parents:
15788
diff
changeset
|
124 (setq font-lock-defaults '(help-font-lock-keywords)) |
13079
6a91723f2a8c
(help-mode): Call view-mode.
Richard M. Stallman <rms@gnu.org>
parents:
12941
diff
changeset
|
125 (view-mode) |
19228
3e0e9b7e2307
(help-mode): Set view-no-disable-on-exit.
Richard M. Stallman <rms@gnu.org>
parents:
19124
diff
changeset
|
126 (make-local-variable 'view-no-disable-on-exit) |
3e0e9b7e2307
(help-mode): Set view-no-disable-on-exit.
Richard M. Stallman <rms@gnu.org>
parents:
19124
diff
changeset
|
127 (setq view-no-disable-on-exit t) |
9833 | 128 (run-hooks 'help-mode-hook)) |
129 | |
6580 | 130 (defun help-quit () |
131 (interactive) | |
132 nil) | |
133 | |
17005
1fa50c7fdde3
(help-with-tutorial): Prefix argument to specify a
Karl Heuer <kwzh@gnu.org>
parents:
16771
diff
changeset
|
134 (defun help-with-tutorial (&optional arg) |
1fa50c7fdde3
(help-with-tutorial): Prefix argument to specify a
Karl Heuer <kwzh@gnu.org>
parents:
16771
diff
changeset
|
135 "Select the Emacs learn-by-doing tutorial. |
19423
f6f7ae045fe3
(help-with-tutorial): Use current-language-environment.
Richard M. Stallman <rms@gnu.org>
parents:
19243
diff
changeset
|
136 If there is a tutorial version written in the language |
19576
b0bd0bd48893
(help-with-tutorial): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
19423
diff
changeset
|
137 of the selected language environment, that version is used. |
19423
f6f7ae045fe3
(help-with-tutorial): Use current-language-environment.
Richard M. Stallman <rms@gnu.org>
parents:
19243
diff
changeset
|
138 If there's no tutorial in that language, `TUTORIAL' is selected. |
f6f7ae045fe3
(help-with-tutorial): Use current-language-environment.
Richard M. Stallman <rms@gnu.org>
parents:
19243
diff
changeset
|
139 With arg, you are asked to select which language." |
17005
1fa50c7fdde3
(help-with-tutorial): Prefix argument to specify a
Karl Heuer <kwzh@gnu.org>
parents:
16771
diff
changeset
|
140 (interactive "P") |
17756
0000a992fd24
(help-with-tutorial): Fix a bug of handling non-English
Kenichi Handa <handa@m17n.org>
parents:
17200
diff
changeset
|
141 (let (lang filename file) |
0000a992fd24
(help-with-tutorial): Fix a bug of handling non-English
Kenichi Handa <handa@m17n.org>
parents:
17200
diff
changeset
|
142 (if arg |
0000a992fd24
(help-with-tutorial): Fix a bug of handling non-English
Kenichi Handa <handa@m17n.org>
parents:
17200
diff
changeset
|
143 (or (setq lang (read-language-name 'tutorial "Language: ")) |
0000a992fd24
(help-with-tutorial): Fix a bug of handling non-English
Kenichi Handa <handa@m17n.org>
parents:
17200
diff
changeset
|
144 (error "No tutorial file of the specified language")) |
19423
f6f7ae045fe3
(help-with-tutorial): Use current-language-environment.
Richard M. Stallman <rms@gnu.org>
parents:
19243
diff
changeset
|
145 (setq lang current-language-environment)) |
17756
0000a992fd24
(help-with-tutorial): Fix a bug of handling non-English
Kenichi Handa <handa@m17n.org>
parents:
17200
diff
changeset
|
146 (setq filename (or (get-language-info lang 'tutorial) |
0000a992fd24
(help-with-tutorial): Fix a bug of handling non-English
Kenichi Handa <handa@m17n.org>
parents:
17200
diff
changeset
|
147 "TUTORIAL")) |
0000a992fd24
(help-with-tutorial): Fix a bug of handling non-English
Kenichi Handa <handa@m17n.org>
parents:
17200
diff
changeset
|
148 (setq file (expand-file-name (concat "~/" filename))) |
409 | 149 (delete-other-windows) |
150 (if (get-file-buffer file) | |
151 (switch-to-buffer (get-file-buffer file)) | |
152 (switch-to-buffer (create-file-buffer file)) | |
153 (setq buffer-file-name file) | |
154 (setq default-directory (expand-file-name "~/")) | |
755 | 155 (setq buffer-auto-save-file-name nil) |
17005
1fa50c7fdde3
(help-with-tutorial): Prefix argument to specify a
Karl Heuer <kwzh@gnu.org>
parents:
16771
diff
changeset
|
156 (insert-file-contents (expand-file-name filename data-directory)) |
409 | 157 (goto-char (point-min)) |
158 (search-forward "\n<<") | |
159 (beginning-of-line) | |
160 (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
|
161 (let ((n (- (window-height (selected-window)) |
409 | 162 (count-lines (point-min) (point)) |
6419
e5ce725b661d
(help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents:
6079
diff
changeset
|
163 6))) |
6433
e50519261181
(help-with-tutorial): Change previous change;
Richard M. Stallman <rms@gnu.org>
parents:
6419
diff
changeset
|
164 (if (< n 12) |
6419
e5ce725b661d
(help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents:
6079
diff
changeset
|
165 (newline n) |
e5ce725b661d
(help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents:
6079
diff
changeset
|
166 ;; 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
|
167 (newline (/ n 2)) |
e5ce725b661d
(help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents:
6079
diff
changeset
|
168 (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
|
169 "Text continues below]") |
e5ce725b661d
(help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents:
6079
diff
changeset
|
170 (newline (- n (/ n 2))))) |
409 | 171 (goto-char (point-min)) |
172 (set-buffer-modified-p nil)))) | |
173 | |
17917
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
174 (defun describe-key-briefly (key &optional insert) |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
175 "Print the name of the function KEY invokes. KEY is a string. |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
176 If INSERT (the prefix arg) is non-nil, insert the message in the buffer." |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
177 (interactive "kDescribe key briefly: \nP") |
2955
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
178 ;; 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
|
179 ;; following click or drag event. Otherwise that would |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
180 ;; erase the message. |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
181 (let ((type (aref key (1- (length key))))) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
182 (if (listp type) (setq type (car type))) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
183 (and (symbolp type) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
184 (memq 'down (event-modifiers type)) |
3986
0e5fa7a1ac36
(describe-key-briefly): Don't set `foo'.
Richard M. Stallman <rms@gnu.org>
parents:
3982
diff
changeset
|
185 (read-event))) |
13293
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
186 (save-excursion |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
187 (let ((modifiers (event-modifiers (aref key 0))) |
17917
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
188 (standard-output (if insert (current-buffer) t)) |
13293
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
189 window position) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
190 ;; For a mouse button event, go to the button it applies to |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
191 ;; to get the right key bindings. And go to the right place |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
192 ;; in case the keymap depends on where you clicked. |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
193 (if (or (memq 'click modifiers) (memq 'down modifiers) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
194 (memq 'drag modifiers)) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
195 (setq window (posn-window (event-start (aref key 0))) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
196 position (posn-point (event-start (aref key 0))))) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
197 (if (windowp window) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
198 (progn |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
199 (set-buffer (window-buffer window)) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
200 (goto-char position))) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
201 ;; Ok, now look up the key and name the command. |
17917
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
202 (let ((defn (key-binding key)) |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
203 (key-desc (key-description key))) |
13293
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
204 (if (or (null defn) (integerp defn)) |
17917
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
205 (princ (format "%s is undefined" key-desc)) |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
206 (princ (format (if insert |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
207 "%s (%s)" |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
208 (if (windowp window) |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
209 "%s at that spot runs the command %s" |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
210 "%s runs the command %s")) |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
211 key-desc |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
212 (if (symbolp defn) defn (prin1-to-string defn))))))))) |
409 | 213 |
214 (defun print-help-return-message (&optional function) | |
215 "Display or return message saying how to restore windows after help command. | |
216 Computes a message and applies the optional argument FUNCTION to it. | |
217 If FUNCTION is nil, applies `message' to it, thus printing it." | |
218 (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
|
219 (let ((first-message |
16391
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
220 (cond ((special-display-p (buffer-name standard-output)) |
8259
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
221 ;; 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
|
222 ;; 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
|
223 ;; 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
|
224 ;; manager, not with Emacs. |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
225 ;; 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
|
226 ;; 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
|
227 nil) |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
228 ((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
|
229 "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
|
230 (pop-up-windows |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
231 "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
|
232 (t |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
233 "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
|
234 (funcall (or function 'message) |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
235 (concat |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
236 (if first-message |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
237 (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
|
238 "") |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
239 (if first-message " " "") |
11524
cafa503e806c
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
11428
diff
changeset
|
240 ;; 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
|
241 ;; it's no use mentioning a command to scroll, so don't. |
16391
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
242 (if (special-display-p (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
|
243 nil |
16391
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
244 (if (same-window-p (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
|
245 ;; 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
|
246 (substitute-command-keys |
cafa503e806c
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
11428
diff
changeset
|
247 "\\[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
|
248 ;; 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
|
249 (substitute-command-keys |
11524
cafa503e806c
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
11428
diff
changeset
|
250 "\\[scroll-other-window] to scroll the help.")))))))) |
409 | 251 |
252 (defun describe-key (key) | |
253 "Display documentation of the function invoked by KEY. KEY is a string." | |
254 (interactive "kDescribe key: ") | |
2955
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
255 ;; 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
|
256 ;; following click or drag event. Otherwise that would |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
257 ;; erase the message. |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
258 (let ((type (aref key (1- (length key))))) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
259 (if (listp type) (setq type (car type))) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
260 (and (symbolp type) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
261 (memq 'down (event-modifiers type)) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
262 (read-event))) |
13293
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
263 (save-excursion |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
264 (let ((modifiers (event-modifiers (aref key 0))) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
265 window position) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
266 ;; For a mouse button event, go to the button it applies to |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
267 ;; to get the right key bindings. And go to the right place |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
268 ;; in case the keymap depends on where you clicked. |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
269 (if (or (memq 'click modifiers) (memq 'down modifiers) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
270 (memq 'drag modifiers)) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
271 (setq window (posn-window (event-start (aref key 0))) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
272 position (posn-point (event-start (aref key 0))))) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
273 (if (windowp window) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
274 (progn |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
275 (set-buffer (window-buffer window)) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
276 (goto-char position))) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
277 (let ((defn (key-binding key))) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
278 (if (or (null defn) (integerp defn)) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
279 (message "%s is undefined" (key-description key)) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
280 (with-output-to-temp-buffer "*Help*" |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
281 (princ (key-description key)) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
282 (if (windowp window) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
283 (princ " at that spot")) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
284 (princ " runs the command ") |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
285 (prin1 defn) |
19243
f8f590160844
(describe-key): Don't put a colon after the command name.
Richard M. Stallman <rms@gnu.org>
parents:
19228
diff
changeset
|
286 (princ "\n") |
13358
febf5ce4532c
(describe-function): Call documentation just once.
Richard M. Stallman <rms@gnu.org>
parents:
13348
diff
changeset
|
287 (let ((doc (documentation defn))) |
febf5ce4532c
(describe-function): Call documentation just once.
Richard M. Stallman <rms@gnu.org>
parents:
13348
diff
changeset
|
288 (if doc |
febf5ce4532c
(describe-function): Call documentation just once.
Richard M. Stallman <rms@gnu.org>
parents:
13348
diff
changeset
|
289 (progn (terpri) |
febf5ce4532c
(describe-function): Call documentation just once.
Richard M. Stallman <rms@gnu.org>
parents:
13348
diff
changeset
|
290 (princ doc)) |
febf5ce4532c
(describe-function): Call documentation just once.
Richard M. Stallman <rms@gnu.org>
parents:
13348
diff
changeset
|
291 (princ "not documented"))) |
13293
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
292 (save-excursion |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
293 (set-buffer standard-output) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
294 (help-mode)) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
295 (print-help-return-message))))))) |
409 | 296 |
6902
962a6ffb7b97
(describe-mode): Always show minor modes, at front.
Richard M. Stallman <rms@gnu.org>
parents:
6580
diff
changeset
|
297 (defun describe-mode () |
962a6ffb7b97
(describe-mode): Always show minor modes, at front.
Richard M. Stallman <rms@gnu.org>
parents:
6580
diff
changeset
|
298 "Display documentation of current major mode and minor modes. |
409 | 299 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
|
300 \(listed in `minor-mode-alist') must also be a function whose documentation |
409 | 301 describes the minor mode." |
6903
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
302 (interactive) |
409 | 303 (with-output-to-temp-buffer "*Help*" |
6903
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
304 (let ((minor-modes minor-mode-alist) |
16694
c19089a334b2
(describe-mode): Include minor modes that aren't buffer local.
Richard M. Stallman <rms@gnu.org>
parents:
16557
diff
changeset
|
305 (first t)) |
6903
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
306 (while minor-modes |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
307 (let* ((minor-mode (car (car minor-modes))) |
16694
c19089a334b2
(describe-mode): Include minor modes that aren't buffer local.
Richard M. Stallman <rms@gnu.org>
parents:
16557
diff
changeset
|
308 (indicator (car (cdr (car minor-modes))))) |
6903
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
309 ;; 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
|
310 ;; 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
|
311 ;; definition. |
16694
c19089a334b2
(describe-mode): Include minor modes that aren't buffer local.
Richard M. Stallman <rms@gnu.org>
parents:
16557
diff
changeset
|
312 (if (and (symbol-value minor-mode) |
6903
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
313 (fboundp minor-mode)) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
314 (let ((pretty-minor-mode minor-mode)) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
315 (if (string-match "-mode$" (symbol-name minor-mode)) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
316 (setq pretty-minor-mode |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
317 (capitalize |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
318 (substring (symbol-name minor-mode) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
319 0 (match-beginning 0))))) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
320 (while (and indicator (symbolp indicator)) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
321 (setq indicator (symbol-value indicator))) |
15783
e0524a01fc91
(describe-mode): Put a formfeed between each two modes.
Richard M. Stallman <rms@gnu.org>
parents:
14832
diff
changeset
|
322 (if first |
e0524a01fc91
(describe-mode): Put a formfeed between each two modes.
Richard M. Stallman <rms@gnu.org>
parents:
14832
diff
changeset
|
323 (princ "The minor modes are described first, |
e0524a01fc91
(describe-mode): Put a formfeed between each two modes.
Richard M. Stallman <rms@gnu.org>
parents:
14832
diff
changeset
|
324 followed by the major mode, which is described on the last page.\n\f\n")) |
e0524a01fc91
(describe-mode): Put a formfeed between each two modes.
Richard M. Stallman <rms@gnu.org>
parents:
14832
diff
changeset
|
325 (setq first nil) |
14832
4d511dd9bfce
(describe-mode): Handle minor mode w/o mode line indicator.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
326 (princ (format "%s minor mode (%s):\n" |
4d511dd9bfce
(describe-mode): Handle minor mode w/o mode line indicator.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
327 pretty-minor-mode |
4d511dd9bfce
(describe-mode): Handle minor mode w/o mode line indicator.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
328 (if indicator |
4d511dd9bfce
(describe-mode): Handle minor mode w/o mode line indicator.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
329 (format "indicator%s" indicator) |
4d511dd9bfce
(describe-mode): Handle minor mode w/o mode line indicator.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
330 "no indicator"))) |
6903
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
331 (princ (documentation minor-mode)) |
15783
e0524a01fc91
(describe-mode): Put a formfeed between each two modes.
Richard M. Stallman <rms@gnu.org>
parents:
14832
diff
changeset
|
332 (princ "\n\f\n")))) |
6903
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
333 (setq minor-modes (cdr minor-modes)))) |
409 | 334 (princ mode-name) |
6902
962a6ffb7b97
(describe-mode): Always show minor modes, at front.
Richard M. Stallman <rms@gnu.org>
parents:
6580
diff
changeset
|
335 (princ " mode:\n") |
409 | 336 (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
|
337 (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
|
338 (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
|
339 (help-mode)) |
409 | 340 (print-help-return-message))) |
341 | |
342 ;; So keyboard macro definitions are documented correctly | |
343 (fset 'defining-kbd-macro (symbol-function 'start-kbd-macro)) | |
344 | |
345 (defun describe-distribution () | |
346 "Display info on how to obtain the latest version of GNU Emacs." | |
347 (interactive) | |
348 (find-file-read-only | |
444 | 349 (expand-file-name "DISTRIB" data-directory))) |
409 | 350 |
351 (defun describe-copying () | |
352 "Display info on how you may redistribute copies of GNU Emacs." | |
353 (interactive) | |
354 (find-file-read-only | |
444 | 355 (expand-file-name "COPYING" data-directory)) |
409 | 356 (goto-char (point-min))) |
357 | |
5025
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
358 (defun describe-project () |
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
359 "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
|
360 (interactive) |
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
361 (find-file-read-only |
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
362 (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
|
363 (goto-char (point-min))) |
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
364 |
409 | 365 (defun describe-no-warranty () |
366 "Display info on all the kinds of warranty Emacs does NOT have." | |
367 (interactive) | |
368 (describe-copying) | |
369 (let (case-fold-search) | |
370 (search-forward "NO WARRANTY") | |
371 (recenter 0))) | |
372 | |
3980
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
373 (defun describe-prefix-bindings () |
3982
e50f7b531c7f
(describe-prefix-bindings): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
3980
diff
changeset
|
374 "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
|
375 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
|
376 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
|
377 (interactive) |
11890
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
378 (let* ((key (this-command-keys))) |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
379 (describe-bindings |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
380 (if (stringp key) |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
381 (substring key 0 (1- (length key))) |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
382 (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
|
383 (i 0)) |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
384 (while (< i (length prefix)) |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
385 (aset prefix i (aref key i)) |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
386 (setq i (1+ i))) |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
387 prefix))))) |
3982
e50f7b531c7f
(describe-prefix-bindings): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
3980
diff
changeset
|
388 ;; 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
|
389 ;; run describe-prefix-bindings. |
3980
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
390 (setq prefix-help-command 'describe-prefix-bindings) |
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
391 |
409 | 392 (defun view-emacs-news () |
393 "Display info on recent changes to Emacs." | |
394 (interactive) | |
444 | 395 (find-file-read-only (expand-file-name "NEWS" data-directory))) |
409 | 396 |
10923
fe008aef4cf1
(view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents:
10622
diff
changeset
|
397 (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
|
398 "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
|
399 (interactive) |
fe008aef4cf1
(view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents:
10622
diff
changeset
|
400 (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
|
401 |
409 | 402 (defun view-lossage () |
403 "Display last 100 input keystrokes." | |
404 (interactive) | |
405 (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
|
406 (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
|
407 (if (or (integerp key) |
8c492f23ee28
(view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents:
8259
diff
changeset
|
408 (symbolp key) |
8c492f23ee28
(view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents:
8259
diff
changeset
|
409 (listp key)) |
8c492f23ee28
(view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents:
8259
diff
changeset
|
410 (single-key-description key) |
8c492f23ee28
(view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents:
8259
diff
changeset
|
411 (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
|
412 (recent-keys) |
8c492f23ee28
(view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents:
8259
diff
changeset
|
413 " ")) |
409 | 414 (save-excursion |
415 (set-buffer standard-output) | |
416 (goto-char (point-min)) | |
417 (while (progn (move-to-column 50) (not (eobp))) | |
418 (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
|
419 (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
|
420 (help-mode)) |
409 | 421 (print-help-return-message))) |
422 | |
6580 | 423 (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
|
424 (make-help-screen help-for-help |
18632
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
425 "a b c C f F C-f i I k C-k l L m n p s t v w C-c C-d C-n C-p C-w; ? for help:" |
5025
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
426 "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
|
427 \(Use SPC or DEL to scroll through this text. Type \\<help-map>\\[help-quit] to exit the Help command.) |
409 | 428 |
4467
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
429 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
|
430 (functions interactively callable) that contain |
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
431 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
|
432 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
|
433 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
|
434 it prints the function name that sequence runs. |
18632
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
435 C describe-coding-system. This describes either a specific coding system |
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
436 (if you type its name) or the coding systems currently in use |
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
437 (if you type just RET). |
2638
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
438 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
|
439 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
|
440 it takes you to the Info node for that command. |
2638
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
441 i info. The info documentation reader. |
18632
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
442 I describe-input-method. Describe a specific input method (if you type |
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
443 its name) or the current input method (if you type just RET). |
2638
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
444 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
|
445 it displays the full documentation. |
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
446 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
|
447 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
|
448 l view-lossage. Shows last 100 characters you typed. |
18632
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
449 L describe-language-environment. This describes either the a |
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
450 specific language environment (if you type its name) |
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
451 or the current language environment (if you type just RET). |
2638
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
452 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
|
453 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
|
454 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
|
455 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
|
456 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
|
457 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
|
458 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
|
459 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
|
460 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
|
461 invoke that command. |
18632
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
462 |
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
463 F Display the frequently asked questions file. |
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
464 h Display the HELLO file which illustrates various scripts. |
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
465 C-c Display Emacs copying permission (General Public License). |
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
466 C-d Display Emacs ordering information. |
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
467 C-n Display news of recent Emacs changes. |
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
468 C-p Display information about the GNU project. |
0e44be1e2051
(help-for-help): Update help text.
Richard M. Stallman <rms@gnu.org>
parents:
18293
diff
changeset
|
469 C-w Display 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
|
470 help-map) |
409 | 471 |
472 ;; Return a function which is called by the list containing point. | |
473 ;; If that gives no function, return a function whose name is around point. | |
474 ;; If that doesn't give a function, return nil. | |
475 (defun function-called-at-point () | |
476 (or (condition-case () | |
477 (save-excursion | |
478 (save-restriction | |
479 (narrow-to-region (max (point-min) (- (point) 1000)) (point-max)) | |
480 (backward-up-list 1) | |
481 (forward-char 1) | |
482 (let (obj) | |
483 (setq obj (read (current-buffer))) | |
484 (and (symbolp obj) (fboundp obj) obj)))) | |
485 (error nil)) | |
486 (condition-case () | |
13209
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
487 (let ((stab (syntax-table))) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
488 (unwind-protect |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
489 (save-excursion |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
490 (set-syntax-table emacs-lisp-mode-syntax-table) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
491 (or (not (zerop (skip-syntax-backward "_w"))) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
492 (eq (char-syntax (following-char)) ?w) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
493 (eq (char-syntax (following-char)) ?_) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
494 (forward-sexp -1)) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
495 (skip-chars-forward "'") |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
496 (let ((obj (read (current-buffer)))) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
497 (and (symbolp obj) (fboundp obj) obj))) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
498 (set-syntax-table stab))) |
409 | 499 (error nil)))) |
500 | |
9639
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
501 (defun describe-function-find-file (function) |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
502 (let ((files load-history) |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
503 file functions) |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
504 (while files |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
505 (if (memq function (cdr (car files))) |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
506 (setq file (car (car files)) files nil)) |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
507 (setq files (cdr files))) |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
508 file)) |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
509 |
409 | 510 (defun describe-function (function) |
511 "Display the full documentation of FUNCTION (a symbol)." | |
512 (interactive | |
513 (let ((fn (function-called-at-point)) | |
514 (enable-recursive-minibuffers t) | |
515 val) | |
516 (setq val (completing-read (if fn | |
517 (format "Describe function (default %s): " fn) | |
518 "Describe function: ") | |
519 obarray 'fboundp t)) | |
520 (list (if (equal val "") | |
521 fn (intern val))))) | |
16439
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
522 (if function |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
523 (with-output-to-temp-buffer "*Help*" |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
524 (prin1 function) |
19124
e5e8552b076a
(describe-function): Use " is " instead of colon.
Richard M. Stallman <rms@gnu.org>
parents:
18632
diff
changeset
|
525 ;; Use " is " instead of a colon so that |
e5e8552b076a
(describe-function): Use " is " instead of colon.
Richard M. Stallman <rms@gnu.org>
parents:
18632
diff
changeset
|
526 ;; it is easier to get out the function name using forward-sexp. |
e5e8552b076a
(describe-function): Use " is " instead of colon.
Richard M. Stallman <rms@gnu.org>
parents:
18632
diff
changeset
|
527 (princ " is ") |
16439
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
528 (let* ((def (symbol-function function)) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
529 file-name |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
530 (beg (if (commandp def) "an interactive " "a "))) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
531 (princ (cond ((or (stringp def) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
532 (vectorp def)) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
533 "a keyboard macro") |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
534 ((subrp def) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
535 (concat beg "built-in function")) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
536 ((byte-code-function-p def) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
537 (concat beg "compiled Lisp function")) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
538 ((symbolp def) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
539 (format "alias for `%s'" def)) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
540 ((eq (car-safe def) 'lambda) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
541 (concat beg "Lisp function")) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
542 ((eq (car-safe def) 'macro) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
543 "a Lisp macro") |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
544 ((eq (car-safe def) 'mocklisp) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
545 "a mocklisp function") |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
546 ((eq (car-safe def) 'autoload) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
547 (setq file-name (nth 1 def)) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
548 (format "%s autoloaded Lisp %s" |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
549 (if (commandp def) "an interactive" "an") |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
550 (if (nth 4 def) "macro" "function") |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
551 )) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
552 (t ""))) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
553 (or file-name |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
554 (setq file-name (describe-function-find-file function))) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
555 (if file-name |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
556 (progn |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
557 (princ " in `") |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
558 ;; We used to add .el to the file name, |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
559 ;; but that's completely wrong when the user used load-file. |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
560 (princ file-name) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
561 (princ "'"))) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
562 (princ ".") |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
563 (terpri) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
564 (let ((arglist (cond ((byte-code-function-p def) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
565 (car (append def nil))) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
566 ((eq (car-safe def) 'lambda) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
567 (nth 1 def)) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
568 (t t)))) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
569 (if (listp arglist) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
570 (progn |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
571 (princ (cons function |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
572 (mapcar (lambda (arg) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
573 (if (memq arg '(&optional &rest)) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
574 arg |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
575 (intern (upcase (symbol-name arg))))) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
576 arglist))) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
577 (terpri)))) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
578 (let ((doc (documentation function))) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
579 (if doc |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
580 (progn (terpri) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
581 (princ doc)) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
582 (princ "not documented")))) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
583 (print-help-return-message) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
584 (save-excursion |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
585 (set-buffer standard-output) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
586 (help-mode) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
587 ;; Return the text we displayed. |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
588 (buffer-string))) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
589 (message "You didn't specify a function"))) |
409 | 590 |
16439
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
591 ;; We return 0 if we can't find a variable to return. |
409 | 592 (defun variable-at-point () |
593 (condition-case () | |
13209
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
594 (let ((stab (syntax-table))) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
595 (unwind-protect |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
596 (save-excursion |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
597 (set-syntax-table emacs-lisp-mode-syntax-table) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
598 (or (not (zerop (skip-syntax-backward "_w"))) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
599 (eq (char-syntax (following-char)) ?w) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
600 (eq (char-syntax (following-char)) ?_) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
601 (forward-sexp -1)) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
602 (skip-chars-forward "'") |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
603 (let ((obj (read (current-buffer)))) |
16439
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
604 (or (and (symbolp obj) (boundp obj) obj) |
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
605 0))) |
13209
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
606 (set-syntax-table stab))) |
16439
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
607 (error 0))) |
409 | 608 |
609 (defun describe-variable (variable) | |
610 "Display the full documentation of VARIABLE (a symbol). | |
611 Returns the documentation as a string, also." | |
612 (interactive | |
613 (let ((v (variable-at-point)) | |
614 (enable-recursive-minibuffers t) | |
615 val) | |
16439
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
616 (setq val (completing-read (if (symbolp v) |
409 | 617 (format "Describe variable (default %s): " v) |
618 "Describe variable: ") | |
619 obarray 'boundp t)) | |
620 (list (if (equal val "") | |
621 v (intern val))))) | |
16439
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
622 (if (symbolp variable) |
16557
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
623 (let (valvoid) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
624 (with-output-to-temp-buffer "*Help*" |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
625 (prin1 variable) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
626 (if (not (boundp variable)) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
627 (progn |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
628 (princ " is void") |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
629 (terpri) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
630 (setq valvoid t)) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
631 (princ "'s value is ") |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
632 (terpri) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
633 (pp (symbol-value variable)) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
634 (terpri)) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
635 (if (local-variable-p variable) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
636 (progn |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
637 (princ (format "Local in buffer %s; " (buffer-name))) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
638 (if (not (default-boundp variable)) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
639 (princ "globally void") |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
640 (princ "global value is ") |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
641 (terpri) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
642 (pp (default-value variable))) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
643 (terpri))) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
644 (terpri) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
645 (save-current-buffer |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
646 (set-buffer standard-output) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
647 (if (> (count-lines (point-min) (point-max)) 10) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
648 (progn |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
649 (goto-char (point-min)) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
650 (if valvoid |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
651 (forward-line 1) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
652 (forward-sexp 1) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
653 (delete-region (point) (progn (end-of-line) (point))) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
654 (insert "'s value is shown below.\n\n") |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
655 (save-excursion |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
656 (insert "\n\nValue:")))))) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
657 (princ "Documentation:") |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
658 (terpri) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
659 (let ((doc (documentation-property variable 'variable-documentation))) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
660 (princ (or doc "not documented as a variable."))) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
661 (print-help-return-message) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
662 (save-excursion |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
663 (set-buffer standard-output) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
664 (help-mode) |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
665 ;; Return the text we displayed. |
4ff6a0f0f5c7
(describe-variable): Pretty-print the values.
Richard M. Stallman <rms@gnu.org>
parents:
16439
diff
changeset
|
666 (buffer-string)))) |
16439
0c61b1f40de2
(describe-function): If no fn specified, say so.
Richard M. Stallman <rms@gnu.org>
parents:
16391
diff
changeset
|
667 (message "You did not specify a variable"))) |
409 | 668 |
17917
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
669 (defun where-is (definition &optional insert) |
6476
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
670 "Print message listing key sequences that invoke specified command. |
17917
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
671 Argument is a command definition, usually a symbol with a function definition. |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
672 If INSERT (the prefix arg) is non-nil, insert the message in the buffer." |
6476
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
673 (interactive |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
674 (let ((fn (function-called-at-point)) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
675 (enable-recursive-minibuffers t) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
676 val) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
677 (setq val (completing-read (if fn |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
678 (format "Where is command (default %s): " fn) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
679 "Where is command: ") |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
680 obarray 'fboundp t)) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
681 (list (if (equal val "") |
17917
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
682 fn (intern val)) |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
683 current-prefix-arg))) |
6476
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
684 (let* ((keys (where-is-internal definition overriding-local-map nil nil)) |
17917
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
685 (keys1 (mapconcat 'key-description keys ", ")) |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
686 (standard-output (if insert (current-buffer) t))) |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
687 (if insert |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
688 (if (> (length keys1) 0) |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
689 (princ (format "%s (%s)" keys1 definition)) |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
690 (princ (format "M-x %s RET" definition))) |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
691 (if (> (length keys1) 0) |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
692 (princ (format "%s is on %s" definition keys1)) |
2a41f677885f
(describe-key-briefly, where-is): Prefix arg means
Richard M. Stallman <rms@gnu.org>
parents:
17756
diff
changeset
|
693 (princ (format "%s is not on any key" definition))))) |
6476
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
694 nil) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
695 |
16273
14ff4afa06ec
(locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
16064
diff
changeset
|
696 (defun locate-library (library &optional nosuffix path interactive-call) |
16063
b4427bbd451e
(locate-library): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
15826
diff
changeset
|
697 "Show the precise file name of Emacs library LIBRARY. |
409 | 698 This command searches the directories in `load-path' like `M-x load-library' |
699 to find the file that `M-x load-library RET LIBRARY RET' would load. | |
700 Optional second arg NOSUFFIX non-nil means don't add suffixes `.elc' or `.el' | |
16064
a9d32637ee38
(locate-library): New arg PATH. Handle autocompression mode.
Richard M. Stallman <rms@gnu.org>
parents:
16063
diff
changeset
|
701 to the specified name LIBRARY. |
a9d32637ee38
(locate-library): New arg PATH. Handle autocompression mode.
Richard M. Stallman <rms@gnu.org>
parents:
16063
diff
changeset
|
702 |
a9d32637ee38
(locate-library): New arg PATH. Handle autocompression mode.
Richard M. Stallman <rms@gnu.org>
parents:
16063
diff
changeset
|
703 If the optional third arg PATH is specified, that list of directories |
a9d32637ee38
(locate-library): New arg PATH. Handle autocompression mode.
Richard M. Stallman <rms@gnu.org>
parents:
16063
diff
changeset
|
704 is used instead of `load-path'." |
16273
14ff4afa06ec
(locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
16064
diff
changeset
|
705 (interactive (list (read-string "Locate library: ") |
14ff4afa06ec
(locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
16064
diff
changeset
|
706 nil nil |
14ff4afa06ec
(locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
16064
diff
changeset
|
707 t)) |
14ff4afa06ec
(locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
16064
diff
changeset
|
708 (let (result) |
14ff4afa06ec
(locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
16064
diff
changeset
|
709 (catch 'answer |
14ff4afa06ec
(locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
16064
diff
changeset
|
710 (mapcar |
16391
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
711 (lambda (dir) |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
712 (mapcar |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
713 (lambda (suf) |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
714 (let ((try (expand-file-name (concat library suf) dir))) |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
715 (and (file-readable-p try) |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
716 (null (file-directory-p try)) |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
717 (progn |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
718 (setq result try) |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
719 (throw 'answer try))))) |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
720 (if nosuffix |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
721 '("") |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
722 (let ((basic '(".elc" ".el" "")) |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
723 (compressed '(".Z" ".gz" ""))) |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
724 ;; If autocompression mode is on, |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
725 ;; consider all combinations of library suffixes |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
726 ;; and compression suffixes. |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
727 (if (rassq 'jka-compr-handler file-name-handler-alist) |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
728 (apply 'nconc |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
729 (mapcar (lambda (compelt) |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
730 (mapcar (lambda (baselt) |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
731 (concat baselt compelt)) |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
732 basic)) |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
733 compressed)) |
5d64d742ccbb
(print-help-return-message): Use new functions `special-display-p' and
Erik Naggum <erik@naggum.no>
parents:
16273
diff
changeset
|
734 basic))))) |
16273
14ff4afa06ec
(locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
16064
diff
changeset
|
735 (or path load-path))) |
14ff4afa06ec
(locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
16064
diff
changeset
|
736 (and interactive-call |
14ff4afa06ec
(locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
16064
diff
changeset
|
737 (if result |
14ff4afa06ec
(locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
16064
diff
changeset
|
738 (message "Library is file %s" result) |
14ff4afa06ec
(locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
16064
diff
changeset
|
739 (message "No library %s in search path" library))) |
14ff4afa06ec
(locate-library): Print no messages if called from Lisp.
Richard M. Stallman <rms@gnu.org>
parents:
16064
diff
changeset
|
740 result)) |
660
08eb386dd0f3
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
444
diff
changeset
|
741 |
08eb386dd0f3
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
444
diff
changeset
|
742 ;;; help.el ends here |