Mercurial > emacs
annotate lisp/help.el @ 16191:7397d7d0ed17
Fix previous change.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Sun, 15 Sep 1996 01:49:08 +0000 |
parents | a9d32637ee38 |
children | 14ff4afa06ec |
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 |
9e7ec92a4fdf
Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2312
diff
changeset
|
27 ;; This code implements GNU Emac's on-line help system, the one invoked by |
9e7ec92a4fdf
Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2312
diff
changeset
|
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) |
409 | 56 (define-key help-map "a" 'command-apropos) |
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) | |
409 | 71 |
72 (define-key help-map "l" 'view-lossage) | |
73 | |
74 (define-key help-map "m" 'describe-mode) | |
75 | |
76 (define-key help-map "\C-n" 'view-emacs-news) | |
77 (define-key help-map "n" 'view-emacs-news) | |
78 | |
2134
b275e1b50542
Added autoload, binding and menu line for new finder feature (P).
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2079
diff
changeset
|
79 (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
|
80 (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
|
81 "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
|
82 |
409 | 83 (define-key help-map "s" 'describe-syntax) |
84 | |
85 (define-key help-map "t" 'help-with-tutorial) | |
86 | |
87 (define-key help-map "w" 'where-is) | |
88 | |
89 (define-key help-map "v" 'describe-variable) | |
90 | |
6580 | 91 (define-key help-map "q" 'help-quit) |
92 | |
12816
7a19739bd181
Added Font Lock mode support.
Simon Marshall <simon@gnu.org>
parents:
12499
diff
changeset
|
93 (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
|
94 (eval-when-compile |
e8e74fb6da7d
(help-font-lock-keywords): Use font-lock-function-name-face
Richard M. Stallman <rms@gnu.org>
parents:
15783
diff
changeset
|
95 (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
|
96 (list |
e8e74fb6da7d
(help-font-lock-keywords): Use font-lock-function-name-face
Richard M. Stallman <rms@gnu.org>
parents:
15783
diff
changeset
|
97 ;; |
e8e74fb6da7d
(help-font-lock-keywords): Use font-lock-function-name-face
Richard M. Stallman <rms@gnu.org>
parents:
15783
diff
changeset
|
98 ;; The symbol itself. |
e8e74fb6da7d
(help-font-lock-keywords): Use font-lock-function-name-face
Richard M. Stallman <rms@gnu.org>
parents:
15783
diff
changeset
|
99 (list (concat "\\`\\(" name-char "+\\)\\(\\(:\\)\\|\\('\\)\\)") |
15810
add6684a3e67
(help-font-lock-keywords): Undo July 26 change.
Richard M. Stallman <rms@gnu.org>
parents:
15799
diff
changeset
|
100 '(1 (if (match-beginning 3) |
add6684a3e67
(help-font-lock-keywords): Undo July 26 change.
Richard M. Stallman <rms@gnu.org>
parents:
15799
diff
changeset
|
101 font-lock-function-name-face |
15826
4a675a6a15c8
Fully reinstall July 26 change.
Simon Marshall <simon@gnu.org>
parents:
15810
diff
changeset
|
102 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
|
103 ;; |
e8e74fb6da7d
(help-font-lock-keywords): Use font-lock-function-name-face
Richard M. Stallman <rms@gnu.org>
parents:
15783
diff
changeset
|
104 ;; 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
|
105 (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
|
106 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
|
107 ;; |
e8e74fb6da7d
(help-font-lock-keywords): Use font-lock-function-name-face
Richard M. Stallman <rms@gnu.org>
parents:
15783
diff
changeset
|
108 ;; 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
|
109 (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
|
110 "Default expressions to highlight in Help mode.") |
7a19739bd181
Added Font Lock mode support.
Simon Marshall <simon@gnu.org>
parents:
12499
diff
changeset
|
111 |
9833 | 112 (defun help-mode () |
113 "Major mode for viewing help text. | |
114 Entry to this mode runs the normal hook `help-mode-hook'. | |
115 Commands: | |
116 \\{help-mode-map}" | |
117 (interactive) | |
118 (kill-all-local-variables) | |
119 (use-local-map help-mode-map) | |
120 (setq mode-name "Help") | |
121 (setq major-mode 'help-mode) | |
12816
7a19739bd181
Added Font Lock mode support.
Simon Marshall <simon@gnu.org>
parents:
12499
diff
changeset
|
122 (make-local-variable 'font-lock-defaults) |
15799
2a1123f30c73
(help-fontify-buffer-function): Function deleted.
Richard M. Stallman <rms@gnu.org>
parents:
15788
diff
changeset
|
123 (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
|
124 (view-mode) |
9833 | 125 (run-hooks 'help-mode-hook)) |
126 | |
6580 | 127 (defun help-quit () |
128 (interactive) | |
129 nil) | |
130 | |
409 | 131 (defun help-with-tutorial () |
132 "Select the Emacs learn-by-doing tutorial." | |
133 (interactive) | |
134 (let ((file (expand-file-name "~/TUTORIAL"))) | |
135 (delete-other-windows) | |
136 (if (get-file-buffer file) | |
137 (switch-to-buffer (get-file-buffer file)) | |
138 (switch-to-buffer (create-file-buffer file)) | |
139 (setq buffer-file-name file) | |
140 (setq default-directory (expand-file-name "~/")) | |
755 | 141 (setq buffer-auto-save-file-name nil) |
444 | 142 (insert-file-contents (expand-file-name "TUTORIAL" data-directory)) |
409 | 143 (goto-char (point-min)) |
144 (search-forward "\n<<") | |
145 (beginning-of-line) | |
146 (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
|
147 (let ((n (- (window-height (selected-window)) |
409 | 148 (count-lines (point-min) (point)) |
6419
e5ce725b661d
(help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents:
6079
diff
changeset
|
149 6))) |
6433
e50519261181
(help-with-tutorial): Change previous change;
Richard M. Stallman <rms@gnu.org>
parents:
6419
diff
changeset
|
150 (if (< n 12) |
6419
e5ce725b661d
(help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents:
6079
diff
changeset
|
151 (newline n) |
e5ce725b661d
(help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents:
6079
diff
changeset
|
152 ;; 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
|
153 (newline (/ n 2)) |
e5ce725b661d
(help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents:
6079
diff
changeset
|
154 (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
|
155 "Text continues below]") |
e5ce725b661d
(help-with-tutorial): Avoid unexplained large blank area.
Karl Heuer <kwzh@gnu.org>
parents:
6079
diff
changeset
|
156 (newline (- n (/ n 2))))) |
409 | 157 (goto-char (point-min)) |
158 (set-buffer-modified-p nil)))) | |
159 | |
160 (defun describe-key-briefly (key) | |
161 "Print the name of the function KEY invokes. KEY is a string." | |
162 (interactive "kDescribe key briefly: ") | |
2955
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
163 ;; 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
|
164 ;; following click or drag event. Otherwise that would |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
165 ;; erase the message. |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
166 (let ((type (aref key (1- (length key))))) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
167 (if (listp type) (setq type (car type))) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
168 (and (symbolp type) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
169 (memq 'down (event-modifiers type)) |
3986
0e5fa7a1ac36
(describe-key-briefly): Don't set `foo'.
Richard M. Stallman <rms@gnu.org>
parents:
3982
diff
changeset
|
170 (read-event))) |
13293
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
171 (save-excursion |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
172 (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
|
173 window position) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
174 ;; 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
|
175 ;; 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
|
176 ;; 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
|
177 (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
|
178 (memq 'drag modifiers)) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
179 (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
|
180 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
|
181 (if (windowp window) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
182 (progn |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
183 (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
|
184 (goto-char position))) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
185 ;; Ok, now look up the key and name the command. |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
186 (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
|
187 (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
|
188 (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
|
189 (message (if (windowp window) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
190 "%s at that spot runs the command %s" |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
191 "%s runs the command %s") |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
192 (key-description key) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
193 (if (symbolp defn) defn (prin1-to-string defn)))))))) |
409 | 194 |
195 (defun print-help-return-message (&optional function) | |
196 "Display or return message saying how to restore windows after help command. | |
197 Computes a message and applies the optional argument FUNCTION to it. | |
198 If FUNCTION is nil, applies `message' to it, thus printing it." | |
199 (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
|
200 (let ((first-message |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
201 (cond ((or (member (buffer-name standard-output) |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
202 special-display-buffer-names) |
8992
245187067d35
(print-help-return-message): Handle cons cells
Richard M. Stallman <rms@gnu.org>
parents:
8858
diff
changeset
|
203 (assoc (buffer-name standard-output) |
245187067d35
(print-help-return-message): Handle cons cells
Richard M. Stallman <rms@gnu.org>
parents:
8858
diff
changeset
|
204 special-display-buffer-names) |
8259
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
205 (let (found |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
206 (tail special-display-regexps) |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
207 (name (buffer-name standard-output))) |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
208 (while (and tail (not found)) |
9833 | 209 (if (or (and (consp (car tail)) |
8992
245187067d35
(print-help-return-message): Handle cons cells
Richard M. Stallman <rms@gnu.org>
parents:
8858
diff
changeset
|
210 (string-match (car (car tail)) name)) |
245187067d35
(print-help-return-message): Handle cons cells
Richard M. Stallman <rms@gnu.org>
parents:
8858
diff
changeset
|
211 (and (stringp (car tail)) |
245187067d35
(print-help-return-message): Handle cons cells
Richard M. Stallman <rms@gnu.org>
parents:
8858
diff
changeset
|
212 (string-match (car tail) name))) |
8259
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
213 (setq found t)) |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
214 (setq tail (cdr tail))) |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
215 found)) |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
216 ;; 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
|
217 ;; 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
|
218 ;; 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
|
219 ;; manager, not with Emacs. |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
220 ;; 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
|
221 ;; 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
|
222 ;; Even the message about scrolling the help |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
223 ;; might be wrong, but it seems worth showing it anyway. |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
224 nil) |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
225 ((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
|
226 "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
|
227 (pop-up-windows |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
228 "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
|
229 (t |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
230 "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
|
231 (funcall (or function 'message) |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
232 (concat |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
233 (if first-message |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
234 (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
|
235 "") |
604d89082229
(print-help-return-message): If help buffer is a
Richard M. Stallman <rms@gnu.org>
parents:
7978
diff
changeset
|
236 (if first-message " " "") |
11524
cafa503e806c
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
11428
diff
changeset
|
237 ;; 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
|
238 ;; it's no use mentioning a command to scroll, so don't. |
11428
d39d8e8b6d20
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
10923
diff
changeset
|
239 (if (or (member (buffer-name standard-output) |
11524
cafa503e806c
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
11428
diff
changeset
|
240 special-display-buffer-names) |
13099
5ab611596c38
(print-help-return-message): Handle lists in
Richard M. Stallman <rms@gnu.org>
parents:
13079
diff
changeset
|
241 (assoc (buffer-name standard-output) |
5ab611596c38
(print-help-return-message): Handle lists in
Richard M. Stallman <rms@gnu.org>
parents:
13079
diff
changeset
|
242 special-display-buffer-names) |
11428
d39d8e8b6d20
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
10923
diff
changeset
|
243 (memq t (mapcar '(lambda (elt) |
13099
5ab611596c38
(print-help-return-message): Handle lists in
Richard M. Stallman <rms@gnu.org>
parents:
13079
diff
changeset
|
244 (if (consp elt) |
5ab611596c38
(print-help-return-message): Handle lists in
Richard M. Stallman <rms@gnu.org>
parents:
13079
diff
changeset
|
245 (setq elt (car elt))) |
11428
d39d8e8b6d20
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
10923
diff
changeset
|
246 (string-match elt (buffer-name standard-output))) |
11524
cafa503e806c
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
11428
diff
changeset
|
247 special-display-regexps))) |
cafa503e806c
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
11428
diff
changeset
|
248 nil |
cafa503e806c
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
11428
diff
changeset
|
249 (if (or (member (buffer-name standard-output) |
cafa503e806c
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
11428
diff
changeset
|
250 same-window-buffer-names) |
13099
5ab611596c38
(print-help-return-message): Handle lists in
Richard M. Stallman <rms@gnu.org>
parents:
13079
diff
changeset
|
251 (assoc (buffer-name standard-output) |
5ab611596c38
(print-help-return-message): Handle lists in
Richard M. Stallman <rms@gnu.org>
parents:
13079
diff
changeset
|
252 same-window-buffer-names) |
11524
cafa503e806c
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
11428
diff
changeset
|
253 (memq t (mapcar '(lambda (elt) |
13099
5ab611596c38
(print-help-return-message): Handle lists in
Richard M. Stallman <rms@gnu.org>
parents:
13079
diff
changeset
|
254 (if (consp elt) |
5ab611596c38
(print-help-return-message): Handle lists in
Richard M. Stallman <rms@gnu.org>
parents:
13079
diff
changeset
|
255 (setq elt (car elt))) |
11524
cafa503e806c
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
11428
diff
changeset
|
256 (string-match elt (buffer-name standard-output))) |
cafa503e806c
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
11428
diff
changeset
|
257 same-window-regexps))) |
cafa503e806c
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
11428
diff
changeset
|
258 ;; 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
|
259 (substitute-command-keys |
cafa503e806c
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
11428
diff
changeset
|
260 "\\[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
|
261 ;; 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
|
262 (substitute-command-keys |
11524
cafa503e806c
(print-help-return-message): Check same-window-buffer-names
Richard M. Stallman <rms@gnu.org>
parents:
11428
diff
changeset
|
263 "\\[scroll-other-window] to scroll the help.")))))))) |
409 | 264 |
265 (defun describe-key (key) | |
266 "Display documentation of the function invoked by KEY. KEY is a string." | |
267 (interactive "kDescribe key: ") | |
2955
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
268 ;; 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
|
269 ;; following click or drag event. Otherwise that would |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
270 ;; erase the message. |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
271 (let ((type (aref key (1- (length key))))) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
272 (if (listp type) (setq type (car type))) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
273 (and (symbolp type) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
274 (memq 'down (event-modifiers type)) |
f34f9e634b81
(describe-key, describe-key-briefly):
Richard M. Stallman <rms@gnu.org>
parents:
2697
diff
changeset
|
275 (read-event))) |
13293
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
276 (save-excursion |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
277 (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
|
278 window position) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
279 ;; 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
|
280 ;; 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
|
281 ;; 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
|
282 (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
|
283 (memq 'drag modifiers)) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
284 (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
|
285 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
|
286 (if (windowp window) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
287 (progn |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
288 (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
|
289 (goto-char position))) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
290 (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
|
291 (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
|
292 (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
|
293 (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
|
294 (princ (key-description key)) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
295 (if (windowp window) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
296 (princ " at that spot")) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
297 (princ " runs the command ") |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
298 (prin1 defn) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
299 (princ ":\n") |
13358
febf5ce4532c
(describe-function): Call documentation just once.
Richard M. Stallman <rms@gnu.org>
parents:
13348
diff
changeset
|
300 (let ((doc (documentation defn))) |
febf5ce4532c
(describe-function): Call documentation just once.
Richard M. Stallman <rms@gnu.org>
parents:
13348
diff
changeset
|
301 (if doc |
febf5ce4532c
(describe-function): Call documentation just once.
Richard M. Stallman <rms@gnu.org>
parents:
13348
diff
changeset
|
302 (progn (terpri) |
febf5ce4532c
(describe-function): Call documentation just once.
Richard M. Stallman <rms@gnu.org>
parents:
13348
diff
changeset
|
303 (princ doc)) |
febf5ce4532c
(describe-function): Call documentation just once.
Richard M. Stallman <rms@gnu.org>
parents:
13348
diff
changeset
|
304 (princ "not documented"))) |
13293
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
305 (save-excursion |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
306 (set-buffer standard-output) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
307 (help-mode)) |
5270a0a465a7
(describe-key, describe-key-briefly): For a mouse click,
Richard M. Stallman <rms@gnu.org>
parents:
13209
diff
changeset
|
308 (print-help-return-message))))))) |
409 | 309 |
6902
962a6ffb7b97
(describe-mode): Always show minor modes, at front.
Richard M. Stallman <rms@gnu.org>
parents:
6580
diff
changeset
|
310 (defun describe-mode () |
962a6ffb7b97
(describe-mode): Always show minor modes, at front.
Richard M. Stallman <rms@gnu.org>
parents:
6580
diff
changeset
|
311 "Display documentation of current major mode and minor modes. |
409 | 312 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
|
313 \(listed in `minor-mode-alist') must also be a function whose documentation |
409 | 314 describes the minor mode." |
6903
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
315 (interactive) |
409 | 316 (with-output-to-temp-buffer "*Help*" |
6903
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
317 (let ((minor-modes minor-mode-alist) |
15783
e0524a01fc91
(describe-mode): Put a formfeed between each two modes.
Richard M. Stallman <rms@gnu.org>
parents:
14832
diff
changeset
|
318 (first t) |
6903
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
319 (locals (buffer-local-variables))) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
320 (while minor-modes |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
321 (let* ((minor-mode (car (car minor-modes))) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
322 (indicator (car (cdr (car minor-modes)))) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
323 (local-binding (assq minor-mode locals))) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
324 ;; 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
|
325 ;; 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
|
326 ;; definition. |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
327 (if (and local-binding |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
328 (cdr local-binding) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
329 (fboundp minor-mode)) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
330 (let ((pretty-minor-mode minor-mode)) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
331 (if (string-match "-mode$" (symbol-name minor-mode)) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
332 (setq pretty-minor-mode |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
333 (capitalize |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
334 (substring (symbol-name minor-mode) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
335 0 (match-beginning 0))))) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
336 (while (and indicator (symbolp indicator)) |
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
337 (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
|
338 (if first |
e0524a01fc91
(describe-mode): Put a formfeed between each two modes.
Richard M. Stallman <rms@gnu.org>
parents:
14832
diff
changeset
|
339 (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
|
340 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
|
341 (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
|
342 (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
|
343 pretty-minor-mode |
4d511dd9bfce
(describe-mode): Handle minor mode w/o mode line indicator.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
344 (if indicator |
4d511dd9bfce
(describe-mode): Handle minor mode w/o mode line indicator.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
345 (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
|
346 "no indicator"))) |
6903
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
347 (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
|
348 (princ "\n\f\n")))) |
6903
61d9d9b5ccba
(describe-mode): Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents:
6902
diff
changeset
|
349 (setq minor-modes (cdr minor-modes)))) |
409 | 350 (princ mode-name) |
6902
962a6ffb7b97
(describe-mode): Always show minor modes, at front.
Richard M. Stallman <rms@gnu.org>
parents:
6580
diff
changeset
|
351 (princ " mode:\n") |
409 | 352 (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
|
353 (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
|
354 (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
|
355 (help-mode)) |
409 | 356 (print-help-return-message))) |
357 | |
358 ;; So keyboard macro definitions are documented correctly | |
359 (fset 'defining-kbd-macro (symbol-function 'start-kbd-macro)) | |
360 | |
361 (defun describe-distribution () | |
362 "Display info on how to obtain the latest version of GNU Emacs." | |
363 (interactive) | |
364 (find-file-read-only | |
444 | 365 (expand-file-name "DISTRIB" data-directory))) |
409 | 366 |
367 (defun describe-copying () | |
368 "Display info on how you may redistribute copies of GNU Emacs." | |
369 (interactive) | |
370 (find-file-read-only | |
444 | 371 (expand-file-name "COPYING" data-directory)) |
409 | 372 (goto-char (point-min))) |
373 | |
5025
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
374 (defun describe-project () |
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
375 "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
|
376 (interactive) |
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
377 (find-file-read-only |
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
378 (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
|
379 (goto-char (point-min))) |
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
380 |
409 | 381 (defun describe-no-warranty () |
382 "Display info on all the kinds of warranty Emacs does NOT have." | |
383 (interactive) | |
384 (describe-copying) | |
385 (let (case-fold-search) | |
386 (search-forward "NO WARRANTY") | |
387 (recenter 0))) | |
388 | |
3980
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
389 (defun describe-prefix-bindings () |
3982
e50f7b531c7f
(describe-prefix-bindings): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
3980
diff
changeset
|
390 "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
|
391 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
|
392 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
|
393 (interactive) |
11890
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
394 (let* ((key (this-command-keys))) |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
395 (describe-bindings |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
396 (if (stringp key) |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
397 (substring key 0 (1- (length key))) |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
398 (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
|
399 (i 0)) |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
400 (while (< i (length prefix)) |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
401 (aset prefix i (aref key i)) |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
402 (setq i (1+ i))) |
543a76aa50b9
(describe-prefix-bindings): If key is a string,
Karl Heuer <kwzh@gnu.org>
parents:
11524
diff
changeset
|
403 prefix))))) |
3982
e50f7b531c7f
(describe-prefix-bindings): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
3980
diff
changeset
|
404 ;; 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
|
405 ;; run describe-prefix-bindings. |
3980
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
406 (setq prefix-help-command 'describe-prefix-bindings) |
bf2d4294a1dd
(describe-prefix-bindings): New command.
Richard M. Stallman <rms@gnu.org>
parents:
3145
diff
changeset
|
407 |
409 | 408 (defun view-emacs-news () |
409 "Display info on recent changes to Emacs." | |
410 (interactive) | |
444 | 411 (find-file-read-only (expand-file-name "NEWS" data-directory))) |
409 | 412 |
10923
fe008aef4cf1
(view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents:
10622
diff
changeset
|
413 (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
|
414 "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
|
415 (interactive) |
fe008aef4cf1
(view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents:
10622
diff
changeset
|
416 (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
|
417 |
409 | 418 (defun view-lossage () |
419 "Display last 100 input keystrokes." | |
420 (interactive) | |
421 (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
|
422 (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
|
423 (if (or (integerp key) |
8c492f23ee28
(view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents:
8259
diff
changeset
|
424 (symbolp key) |
8c492f23ee28
(view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents:
8259
diff
changeset
|
425 (listp key)) |
8c492f23ee28
(view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents:
8259
diff
changeset
|
426 (single-key-description key) |
8c492f23ee28
(view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents:
8259
diff
changeset
|
427 (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
|
428 (recent-keys) |
8c492f23ee28
(view-lossage): Handle buffers and frames in recent-keys.
Richard M. Stallman <rms@gnu.org>
parents:
8259
diff
changeset
|
429 " ")) |
409 | 430 (save-excursion |
431 (set-buffer standard-output) | |
432 (goto-char (point-min)) | |
433 (while (progn (move-to-column 50) (not (eobp))) | |
434 (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
|
435 (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
|
436 (help-mode)) |
409 | 437 (print-help-return-message))) |
438 | |
6580 | 439 (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
|
440 (make-help-screen help-for-help |
5680
4428fd0336f3
(help-for-help): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
5380
diff
changeset
|
441 "a b c f C-f i k C-k l m n p s t v w C-c C-d C-n C-w, or ? for more help:" |
5025
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
442 "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
|
443 \(Use SPC or DEL to scroll through this text. Type \\<help-map>\\[help-quit] to exit the Help command.) |
409 | 444 |
4467
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
445 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
|
446 (functions interactively callable) that contain |
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
447 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
|
448 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
|
449 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
|
450 it prints the function name that sequence runs. |
2638
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
451 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
|
452 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
|
453 it takes you to the Info node for that command. |
10923
fe008aef4cf1
(view-emacs-FAQ): New function. Bind to C-h F.
Richard M. Stallman <rms@gnu.org>
parents:
10622
diff
changeset
|
454 F view-emacs-FAQ. Shows emacs frequently asked questions file. |
2638
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
455 i info. The info documentation reader. |
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
456 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
|
457 it displays the full documentation. |
1e8785572dd4
(help-for-help): Mention C-k and C-f.
Roland McGrath <roland@gnu.org>
parents:
3986
diff
changeset
|
458 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
|
459 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
|
460 l view-lossage. Shows last 100 characters you typed. |
5ff504c4ae11
(help-for-help): Use lower case letters for help options.
Richard M. Stallman <rms@gnu.org>
parents:
2440
diff
changeset
|
461 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
|
462 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
|
463 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
|
464 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
|
465 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
|
466 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
|
467 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
|
468 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
|
469 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
|
470 invoke that command. |
409 | 471 C-c print Emacs copying permission (General Public License). |
472 C-d print Emacs ordering information. | |
473 C-n print news of recent Emacs changes. | |
5025
0556b068e9ee
(describe-project): New function, on C-h C-p.
Richard M. Stallman <rms@gnu.org>
parents:
4467
diff
changeset
|
474 C-p print information about the GNU project. |
409 | 475 C-w print information on absence of warranty for GNU Emacs." |
2237
2670a8f6a42e
Teach this to use help-screen.el.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2134
diff
changeset
|
476 help-map) |
409 | 477 |
478 ;; Return a function which is called by the list containing point. | |
479 ;; If that gives no function, return a function whose name is around point. | |
480 ;; If that doesn't give a function, return nil. | |
481 (defun function-called-at-point () | |
482 (or (condition-case () | |
483 (save-excursion | |
484 (save-restriction | |
485 (narrow-to-region (max (point-min) (- (point) 1000)) (point-max)) | |
486 (backward-up-list 1) | |
487 (forward-char 1) | |
488 (let (obj) | |
489 (setq obj (read (current-buffer))) | |
490 (and (symbolp obj) (fboundp obj) obj)))) | |
491 (error nil)) | |
492 (condition-case () | |
13209
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
493 (let ((stab (syntax-table))) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
494 (unwind-protect |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
495 (save-excursion |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
496 (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
|
497 (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
|
498 (eq (char-syntax (following-char)) ?w) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
499 (eq (char-syntax (following-char)) ?_) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
500 (forward-sexp -1)) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
501 (skip-chars-forward "'") |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
502 (let ((obj (read (current-buffer)))) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
503 (and (symbolp obj) (fboundp obj) obj))) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
504 (set-syntax-table stab))) |
409 | 505 (error nil)))) |
506 | |
9639
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
507 (defun describe-function-find-file (function) |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
508 (let ((files load-history) |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
509 file functions) |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
510 (while files |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
511 (if (memq function (cdr (car files))) |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
512 (setq file (car (car files)) files nil)) |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
513 (setq files (cdr files))) |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
514 file)) |
7cad0025f303
(describe-function-find-file): New function.
Richard M. Stallman <rms@gnu.org>
parents:
9638
diff
changeset
|
515 |
409 | 516 (defun describe-function (function) |
517 "Display the full documentation of FUNCTION (a symbol)." | |
518 (interactive | |
519 (let ((fn (function-called-at-point)) | |
520 (enable-recursive-minibuffers t) | |
521 val) | |
522 (setq val (completing-read (if fn | |
523 (format "Describe function (default %s): " fn) | |
524 "Describe function: ") | |
525 obarray 'fboundp t)) | |
526 (list (if (equal val "") | |
527 fn (intern val))))) | |
528 (with-output-to-temp-buffer "*Help*" | |
529 (prin1 function) | |
530 (princ ": ") | |
531 (let* ((def (symbol-function function)) | |
12941
0c332255735f
(describe-function): Show file name for autoloaded fns.
Richard M. Stallman <rms@gnu.org>
parents:
12834
diff
changeset
|
532 file-name |
409 | 533 (beg (if (commandp def) "an interactive " "a "))) |
2440
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
534 (princ (cond ((or (stringp def) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
535 (vectorp def)) |
9638
e77a0d87d792
(describe-function): Mention the file it was loaded from.
Richard M. Stallman <rms@gnu.org>
parents:
9161
diff
changeset
|
536 "a keyboard macro") |
409 | 537 ((subrp def) |
9638
e77a0d87d792
(describe-function): Mention the file it was loaded from.
Richard M. Stallman <rms@gnu.org>
parents:
9161
diff
changeset
|
538 (concat beg "built-in function")) |
1821
04fb1d3d6992
JimB's changes since January 18th
Jim Blandy <jimb@redhat.com>
parents:
1467
diff
changeset
|
539 ((byte-code-function-p def) |
9638
e77a0d87d792
(describe-function): Mention the file it was loaded from.
Richard M. Stallman <rms@gnu.org>
parents:
9161
diff
changeset
|
540 (concat beg "compiled Lisp function")) |
409 | 541 ((symbolp def) |
9638
e77a0d87d792
(describe-function): Mention the file it was loaded from.
Richard M. Stallman <rms@gnu.org>
parents:
9161
diff
changeset
|
542 (format "alias for `%s'" def)) |
409 | 543 ((eq (car-safe def) 'lambda) |
9638
e77a0d87d792
(describe-function): Mention the file it was loaded from.
Richard M. Stallman <rms@gnu.org>
parents:
9161
diff
changeset
|
544 (concat beg "Lisp function")) |
409 | 545 ((eq (car-safe def) 'macro) |
9638
e77a0d87d792
(describe-function): Mention the file it was loaded from.
Richard M. Stallman <rms@gnu.org>
parents:
9161
diff
changeset
|
546 "a Lisp macro") |
409 | 547 ((eq (car-safe def) 'mocklisp) |
9638
e77a0d87d792
(describe-function): Mention the file it was loaded from.
Richard M. Stallman <rms@gnu.org>
parents:
9161
diff
changeset
|
548 "a mocklisp function") |
409 | 549 ((eq (car-safe def) 'autoload) |
12941
0c332255735f
(describe-function): Show file name for autoloaded fns.
Richard M. Stallman <rms@gnu.org>
parents:
12834
diff
changeset
|
550 (setq file-name (nth 1 def)) |
9638
e77a0d87d792
(describe-function): Mention the file it was loaded from.
Richard M. Stallman <rms@gnu.org>
parents:
9161
diff
changeset
|
551 (format "%s autoloaded Lisp %s" |
1467
8d8c91b563ee
(describe-function): Print `an autoloaded', not `a ...'.
Richard M. Stallman <rms@gnu.org>
parents:
919
diff
changeset
|
552 (if (commandp def) "an interactive" "an") |
409 | 553 (if (nth 4 def) "macro" "function") |
878
5b1c5b4286e7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
846
diff
changeset
|
554 )) |
409 | 555 (t ""))) |
12941
0c332255735f
(describe-function): Show file name for autoloaded fns.
Richard M. Stallman <rms@gnu.org>
parents:
12834
diff
changeset
|
556 (or file-name |
0c332255735f
(describe-function): Show file name for autoloaded fns.
Richard M. Stallman <rms@gnu.org>
parents:
12834
diff
changeset
|
557 (setq file-name (describe-function-find-file function))) |
0c332255735f
(describe-function): Show file name for autoloaded fns.
Richard M. Stallman <rms@gnu.org>
parents:
12834
diff
changeset
|
558 (if file-name |
0c332255735f
(describe-function): Show file name for autoloaded fns.
Richard M. Stallman <rms@gnu.org>
parents:
12834
diff
changeset
|
559 (progn |
0c332255735f
(describe-function): Show file name for autoloaded fns.
Richard M. Stallman <rms@gnu.org>
parents:
12834
diff
changeset
|
560 (princ " in `") |
0c332255735f
(describe-function): Show file name for autoloaded fns.
Richard M. Stallman <rms@gnu.org>
parents:
12834
diff
changeset
|
561 ;; We used to add .el to the file name, |
0c332255735f
(describe-function): Show file name for autoloaded fns.
Richard M. Stallman <rms@gnu.org>
parents:
12834
diff
changeset
|
562 ;; but that's completely wrong when the user used load-file. |
0c332255735f
(describe-function): Show file name for autoloaded fns.
Richard M. Stallman <rms@gnu.org>
parents:
12834
diff
changeset
|
563 (princ file-name) |
0c332255735f
(describe-function): Show file name for autoloaded fns.
Richard M. Stallman <rms@gnu.org>
parents:
12834
diff
changeset
|
564 (princ "'"))) |
9638
e77a0d87d792
(describe-function): Mention the file it was loaded from.
Richard M. Stallman <rms@gnu.org>
parents:
9161
diff
changeset
|
565 (princ ".") |
1889
1ed971f67bfd
(describe-function): Print the arglist if the function is bytecode or a list.
Richard M. Stallman <rms@gnu.org>
parents:
1821
diff
changeset
|
566 (terpri) |
2440
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
567 (let ((arglist (cond ((byte-code-function-p def) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
568 (car (append def nil))) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
569 ((eq (car-safe def) 'lambda) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
570 (nth 1 def)) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
571 (t t)))) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
572 (if (listp arglist) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
573 (progn |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
574 (princ (cons function |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
575 (mapcar (lambda (arg) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
576 (if (memq arg '(&optional &rest)) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
577 arg |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
578 (intern (upcase (symbol-name arg))))) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
579 arglist))) |
46fcbdb6cc3a
(describe-function): For Lisp functions, write a prototype call before
Roland McGrath <roland@gnu.org>
parents:
2360
diff
changeset
|
580 (terpri)))) |
13358
febf5ce4532c
(describe-function): Call documentation just once.
Richard M. Stallman <rms@gnu.org>
parents:
13348
diff
changeset
|
581 (let ((doc (documentation function))) |
febf5ce4532c
(describe-function): Call documentation just once.
Richard M. Stallman <rms@gnu.org>
parents:
13348
diff
changeset
|
582 (if doc |
febf5ce4532c
(describe-function): Call documentation just once.
Richard M. Stallman <rms@gnu.org>
parents:
13348
diff
changeset
|
583 (progn (terpri) |
febf5ce4532c
(describe-function): Call documentation just once.
Richard M. Stallman <rms@gnu.org>
parents:
13348
diff
changeset
|
584 (princ doc)) |
febf5ce4532c
(describe-function): Call documentation just once.
Richard M. Stallman <rms@gnu.org>
parents:
13348
diff
changeset
|
585 (princ "not documented")))) |
409 | 586 (print-help-return-message) |
9854
f810a558acf6
(describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
9833
diff
changeset
|
587 (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
|
588 (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
|
589 (help-mode) |
f810a558acf6
(describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
9833
diff
changeset
|
590 ;; Return the text we displayed. |
f810a558acf6
(describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
9833
diff
changeset
|
591 (buffer-string)))) |
409 | 592 |
593 (defun variable-at-point () | |
594 (condition-case () | |
13209
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
595 (let ((stab (syntax-table))) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
596 (unwind-protect |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
597 (save-excursion |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
598 (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
|
599 (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
|
600 (eq (char-syntax (following-char)) ?w) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
601 (eq (char-syntax (following-char)) ?_) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
602 (forward-sexp -1)) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
603 (skip-chars-forward "'") |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
604 (let ((obj (read (current-buffer)))) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
605 (and (symbolp obj) (boundp obj) obj))) |
c2f172263810
(variable-at-point, function-called-at-point):
Richard M. Stallman <rms@gnu.org>
parents:
13197
diff
changeset
|
606 (set-syntax-table stab))) |
409 | 607 (error nil))) |
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) | |
616 (setq val (completing-read (if v | |
617 (format "Describe variable (default %s): " v) | |
618 "Describe variable: ") | |
619 obarray 'boundp t)) | |
620 (list (if (equal val "") | |
621 v (intern val))))) | |
622 (with-output-to-temp-buffer "*Help*" | |
623 (prin1 variable) | |
624 (if (not (boundp variable)) | |
10622
97213941b5e8
(describe-variable): If var is local, mention default.
Richard M. Stallman <rms@gnu.org>
parents:
10573
diff
changeset
|
625 (princ " is void") |
97213941b5e8
(describe-variable): If var is local, mention default.
Richard M. Stallman <rms@gnu.org>
parents:
10573
diff
changeset
|
626 (princ "'s value is ") |
409 | 627 (prin1 (symbol-value variable))) |
8858
dff46e860b51
(describe-variable): Report whether var is local in this buf.
Richard M. Stallman <rms@gnu.org>
parents:
8504
diff
changeset
|
628 (terpri) |
10573
ab52927eddad
(describe-variable): Use local-variable-p.
Richard M. Stallman <rms@gnu.org>
parents:
10479
diff
changeset
|
629 (if (local-variable-p variable) |
10622
97213941b5e8
(describe-variable): If var is local, mention default.
Richard M. Stallman <rms@gnu.org>
parents:
10573
diff
changeset
|
630 (progn |
97213941b5e8
(describe-variable): If var is local, mention default.
Richard M. Stallman <rms@gnu.org>
parents:
10573
diff
changeset
|
631 (princ (format "Local in buffer %s; " (buffer-name))) |
97213941b5e8
(describe-variable): If var is local, mention default.
Richard M. Stallman <rms@gnu.org>
parents:
10573
diff
changeset
|
632 (if (not (default-boundp variable)) |
97213941b5e8
(describe-variable): If var is local, mention default.
Richard M. Stallman <rms@gnu.org>
parents:
10573
diff
changeset
|
633 (princ "globally void") |
97213941b5e8
(describe-variable): If var is local, mention default.
Richard M. Stallman <rms@gnu.org>
parents:
10573
diff
changeset
|
634 (princ "global value is ") |
97213941b5e8
(describe-variable): If var is local, mention default.
Richard M. Stallman <rms@gnu.org>
parents:
10573
diff
changeset
|
635 (prin1 (default-value variable))) |
97213941b5e8
(describe-variable): If var is local, mention default.
Richard M. Stallman <rms@gnu.org>
parents:
10573
diff
changeset
|
636 (terpri))) |
8858
dff46e860b51
(describe-variable): Report whether var is local in this buf.
Richard M. Stallman <rms@gnu.org>
parents:
8504
diff
changeset
|
637 (terpri) |
409 | 638 (princ "Documentation:") |
639 (terpri) | |
640 (let ((doc (documentation-property variable 'variable-documentation))) | |
13348
1569ab66932d
(describe-variable): Don't call substitute-command-keys.
Richard M. Stallman <rms@gnu.org>
parents:
13293
diff
changeset
|
641 (princ (or doc "not documented as a variable."))) |
409 | 642 (print-help-return-message) |
9854
f810a558acf6
(describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
9833
diff
changeset
|
643 (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
|
644 (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
|
645 (help-mode) |
f810a558acf6
(describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
9833
diff
changeset
|
646 ;; Return the text we displayed. |
f810a558acf6
(describe-key, describe-mode, view-lossage, describe-function, describe-variable): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
parents:
9833
diff
changeset
|
647 (buffer-string)))) |
409 | 648 |
6476
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
649 (defun where-is (definition) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
650 "Print message listing key sequences that invoke specified command. |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
651 Argument is a command definition, usually a symbol with a function definition." |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
652 (interactive |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
653 (let ((fn (function-called-at-point)) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
654 (enable-recursive-minibuffers t) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
655 val) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
656 (setq val (completing-read (if fn |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
657 (format "Where is command (default %s): " fn) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
658 "Where is command: ") |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
659 obarray 'fboundp t)) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
660 (list (if (equal val "") |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
661 fn (intern val))))) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
662 (let* ((keys (where-is-internal definition overriding-local-map nil nil)) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
663 (keys1 (mapconcat 'key-description keys ", "))) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
664 (if (> (length keys1) 0) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
665 (message "%s is on %s" definition keys1) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
666 (message "%s is not on any key" definition))) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
667 nil) |
2e28b96d5b64
(where-is): New function.
Richard M. Stallman <rms@gnu.org>
parents:
6433
diff
changeset
|
668 |
16064
a9d32637ee38
(locate-library): New arg PATH. Handle autocompression mode.
Richard M. Stallman <rms@gnu.org>
parents:
16063
diff
changeset
|
669 (defun locate-library (library &optional nosuffix path) |
16063
b4427bbd451e
(locate-library): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
15826
diff
changeset
|
670 "Show the precise file name of Emacs library LIBRARY. |
409 | 671 This command searches the directories in `load-path' like `M-x load-library' |
672 to find the file that `M-x load-library RET LIBRARY RET' would load. | |
673 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
|
674 to the specified name LIBRARY. |
a9d32637ee38
(locate-library): New arg PATH. Handle autocompression mode.
Richard M. Stallman <rms@gnu.org>
parents:
16063
diff
changeset
|
675 |
a9d32637ee38
(locate-library): New arg PATH. Handle autocompression mode.
Richard M. Stallman <rms@gnu.org>
parents:
16063
diff
changeset
|
676 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
|
677 is used instead of `load-path'." |
409 | 678 (interactive "sLocate library: ") |
679 (catch 'answer | |
680 (mapcar | |
681 '(lambda (dir) | |
682 (mapcar | |
683 '(lambda (suf) | |
684 (let ((try (expand-file-name (concat library suf) dir))) | |
685 (and (file-readable-p try) | |
686 (null (file-directory-p try)) | |
687 (progn | |
688 (message "Library is file %s" try) | |
689 (throw 'answer try))))) | |
16064
a9d32637ee38
(locate-library): New arg PATH. Handle autocompression mode.
Richard M. Stallman <rms@gnu.org>
parents:
16063
diff
changeset
|
690 (if nosuffix |
a9d32637ee38
(locate-library): New arg PATH. Handle autocompression mode.
Richard M. Stallman <rms@gnu.org>
parents:
16063
diff
changeset
|
691 '("") |
a9d32637ee38
(locate-library): New arg PATH. Handle autocompression mode.
Richard M. Stallman <rms@gnu.org>
parents:
16063
diff
changeset
|
692 (let ((basic '(".elc" ".el" "")) |
a9d32637ee38
(locate-library): New arg PATH. Handle autocompression mode.
Richard M. Stallman <rms@gnu.org>
parents:
16063
diff
changeset
|
693 (compressed '(".Z" ".gz" ""))) |
a9d32637ee38
(locate-library): New arg PATH. Handle autocompression mode.
Richard M. Stallman <rms@gnu.org>
parents:
16063
diff
changeset
|
694 ;; If autocompression mode is on, |
a9d32637ee38
(locate-library): New arg PATH. Handle autocompression mode.
Richard M. Stallman <rms@gnu.org>
parents:
16063
diff
changeset
|
695 ;; consider all combinations of library suffixes |
a9d32637ee38
(locate-library): New arg PATH. Handle autocompression mode.
Richard M. Stallman <rms@gnu.org>
parents:
16063
diff
changeset
|
696 ;; and compression suffixes. |
a9d32637ee38
(locate-library): New arg PATH. Handle autocompression mode.
Richard M. Stallman <rms@gnu.org>
parents:
16063
diff
changeset
|
697 (if (rassq 'jka-compr-handler file-name-handler-alist) |
a9d32637ee38
(locate-library): New arg PATH. Handle autocompression mode.
Richard M. Stallman <rms@gnu.org>
parents:
16063
diff
changeset
|
698 (apply 'nconc |
a9d32637ee38
(locate-library): New arg PATH. Handle autocompression mode.
Richard M. Stallman <rms@gnu.org>
parents:
16063
diff
changeset
|
699 (mapcar '(lambda (compelt) |
a9d32637ee38
(locate-library): New arg PATH. Handle autocompression mode.
Richard M. Stallman <rms@gnu.org>
parents:
16063
diff
changeset
|
700 (mapcar '(lambda (baselt) |
a9d32637ee38
(locate-library): New arg PATH. Handle autocompression mode.
Richard M. Stallman <rms@gnu.org>
parents:
16063
diff
changeset
|
701 (concat baselt compelt)) |
a9d32637ee38
(locate-library): New arg PATH. Handle autocompression mode.
Richard M. Stallman <rms@gnu.org>
parents:
16063
diff
changeset
|
702 basic)) |
a9d32637ee38
(locate-library): New arg PATH. Handle autocompression mode.
Richard M. Stallman <rms@gnu.org>
parents:
16063
diff
changeset
|
703 compressed)) |
a9d32637ee38
(locate-library): New arg PATH. Handle autocompression mode.
Richard M. Stallman <rms@gnu.org>
parents:
16063
diff
changeset
|
704 basic))))) |
a9d32637ee38
(locate-library): New arg PATH. Handle autocompression mode.
Richard M. Stallman <rms@gnu.org>
parents:
16063
diff
changeset
|
705 (or path load-path)) |
409 | 706 (message "No library %s in search path" library) |
707 nil)) | |
660
08eb386dd0f3
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
444
diff
changeset
|
708 |
08eb386dd0f3
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
444
diff
changeset
|
709 ;;; help.el ends here |