Mercurial > emacs
annotate lispref/help.texi @ 58022:4f686c82cfc9
(bootstrap, bootstrap-clean-before): Remove .elc
files before building.
(bootfast, bootstrap-clean-before-fast): New targets, like
bootstrap but don't remove .elc files.
author | Kim F. Storm <storm@cua.dk> |
---|---|
date | Sun, 07 Nov 2004 23:27:18 +0000 |
parents | abaa918096d2 |
children | 74accd79beb7 59dcbfe97385 |
rev | line source |
---|---|
6381 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
56213
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2004 |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
39221
diff
changeset
|
4 @c Free Software Foundation, Inc. |
6381 | 5 @c See the file elisp.texi for copying conditions. |
6 @setfilename ../info/help | |
7 @node Documentation, Files, Modes, Top | |
8 @chapter Documentation | |
9 @cindex documentation strings | |
10 | |
11 GNU Emacs Lisp has convenient on-line help facilities, most of which | |
12 derive their information from the documentation strings associated with | |
13 functions and variables. This chapter describes how to write good | |
14 documentation strings for your Lisp programs, as well as how to write | |
15 programs to access documentation. | |
16 | |
17 Note that the documentation strings for Emacs are not the same thing | |
18 as the Emacs manual. Manuals have their own source files, written in | |
19 the Texinfo language; documentation strings are specified in the | |
20 definitions of the functions and variables they apply to. A collection | |
21 of documentation strings is not sufficient as a manual because a good | |
22 manual is not organized in that fashion; it is organized in terms of | |
23 topics of discussion. | |
24 | |
25 @menu | |
26 * Documentation Basics:: Good style for doc strings. | |
27 Where to put them. How Emacs stores them. | |
28 * Accessing Documentation:: How Lisp programs can access doc strings. | |
29 * Keys in Documentation:: Substituting current key bindings. | |
30 * Describing Characters:: Making printable descriptions of | |
31 non-printing characters and key sequences. | |
32 * Help Functions:: Subroutines used by Emacs help facilities. | |
33 @end menu | |
34 | |
35 @node Documentation Basics | |
36 @comment node-name, next, previous, up | |
37 @section Documentation Basics | |
38 @cindex documentation conventions | |
39 @cindex writing a documentation string | |
40 @cindex string, writing a doc string | |
41 | |
42 A documentation string is written using the Lisp syntax for strings, | |
43 with double-quote characters surrounding the text of the string. This | |
44 is because it really is a Lisp string object. The string serves as | |
45 documentation when it is written in the proper place in the definition | |
46 of a function or variable. In a function definition, the documentation | |
47 string follows the argument list. In a variable definition, the | |
48 documentation string follows the initial value of the variable. | |
49 | |
50 When you write a documentation string, make the first line a complete | |
51 sentence (or two complete sentences) since some commands, such as | |
52 @code{apropos}, show only the first line of a multi-line documentation | |
53 string. Also, you should not indent the second line of a documentation | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
54 string, if it has one, because that looks odd when you use @kbd{C-h f} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
55 (@code{describe-function}) or @kbd{C-h v} (@code{describe-variable}) to |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
56 view the documentation string. @xref{Documentation Tips}. |
6381 | 57 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
58 Documentation strings can contain several special substrings, which |
6381 | 59 stand for key bindings to be looked up in the current keymaps when the |
60 documentation is displayed. This allows documentation strings to refer | |
61 to the keys for related commands and be accurate even when a user | |
56213
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
62 rearranges the key bindings. (@xref{Keys in Documentation}.) |
6381 | 63 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
64 In Emacs Lisp, a documentation string is accessible through the |
6381 | 65 function or variable that it describes: |
66 | |
67 @itemize @bullet | |
68 @item | |
69 The documentation for a function is stored in the function definition | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
70 itself (@pxref{Lambda Expressions}). The function @code{documentation} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
71 knows how to extract it. |
6381 | 72 |
73 @item | |
74 @kindex variable-documentation | |
75 The documentation for a variable is stored in the variable's property | |
76 list under the property name @code{variable-documentation}. The | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
77 function @code{documentation-property} knows how to retrieve it. |
6381 | 78 @end itemize |
79 | |
80 @cindex @file{DOC} (documentation) file | |
81 @cindex @file{emacs/etc/DOC-@var{version}} | |
82 @cindex @file{etc/DOC-@var{version}} | |
83 To save space, the documentation for preloaded functions and variables | |
7254 | 84 (including primitive functions and autoloaded functions) is stored in |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
85 the file @file{emacs/etc/DOC-@var{version}}---not inside Emacs. The |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
86 documentation strings for functions and variables loaded during the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
87 Emacs session from byte-compiled files are stored in those files |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
88 (@pxref{Docs and Compilation}). |
12098 | 89 |
90 The data structure inside Emacs has an integer offset into the file, or | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
91 a list containing a file name and an integer, in place of the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
92 documentation string. The functions @code{documentation} and |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
93 @code{documentation-property} use that information to fetch the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
94 documentation string from the appropriate file; this is transparent to |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
95 the user. |
6381 | 96 |
97 For information on the uses of documentation strings, see @ref{Help, , | |
98 Help, emacs, The GNU Emacs Manual}. | |
99 | |
100 @c Wordy to prevent overfull hbox. --rjc 15mar92 | |
6708
3d0ab51bfa03
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6381
diff
changeset
|
101 The @file{emacs/lib-src} directory contains two utilities that you can |
3d0ab51bfa03
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6381
diff
changeset
|
102 use to print nice-looking hardcopy for the file |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
103 @file{emacs/etc/DOC-@var{version}}. These are @file{sorted-doc} and |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
104 @file{digest-doc}. |
6381 | 105 |
106 @node Accessing Documentation | |
107 @section Access to Documentation Strings | |
108 | |
109 @defun documentation-property symbol property &optional verbatim | |
39221
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39206
diff
changeset
|
110 This function returns the documentation string that is recorded in |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39206
diff
changeset
|
111 @var{symbol}'s property list under property @var{property}. It |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39206
diff
changeset
|
112 retrieves the text from a file if the value calls for that. If the |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39206
diff
changeset
|
113 property value isn't @code{nil}, isn't a string, and doesn't refer to |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39206
diff
changeset
|
114 text in a file, then it is evaluated to obtain a string. |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39206
diff
changeset
|
115 |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39206
diff
changeset
|
116 Finally, @code{documentation-property} passes the string through |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39206
diff
changeset
|
117 @code{substitute-command-keys} to substitute actual key bindings, |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39206
diff
changeset
|
118 unless @var{verbatim} is non-@code{nil}. |
6381 | 119 |
120 @smallexample | |
121 @group | |
122 (documentation-property 'command-line-processed | |
123 'variable-documentation) | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
124 @result{} "Non-nil once command line has been processed" |
6381 | 125 @end group |
126 @group | |
127 (symbol-plist 'command-line-processed) | |
128 @result{} (variable-documentation 188902) | |
129 @end group | |
130 @end smallexample | |
131 @end defun | |
132 | |
133 @defun documentation function &optional verbatim | |
39221
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39206
diff
changeset
|
134 This function returns the documentation string of @var{function}. |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39206
diff
changeset
|
135 |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39206
diff
changeset
|
136 If @var{function} is a symbol, this function first looks for the |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39206
diff
changeset
|
137 @code{function-documentation} property of that symbol; if that has a |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39206
diff
changeset
|
138 non-@code{nil} value, the documentation comes from that value (if the |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39206
diff
changeset
|
139 value is not a string, it is evaluated). If @var{function} is not a |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39206
diff
changeset
|
140 symbol, or if it has no @code{function-documentation} property, then |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39206
diff
changeset
|
141 @code{documentation} extracts the documentation string from the actual |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39206
diff
changeset
|
142 function definition, reading it from a file if called for. |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39206
diff
changeset
|
143 |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39206
diff
changeset
|
144 Finally, unless @var{verbatim} is non-@code{nil}, it calls |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39206
diff
changeset
|
145 @code{substitute-command-keys} so as to return a value containing the |
39206
41ede3832703
(Describing Characters) <single-key-description>:
Eli Zaretskii <eliz@gnu.org>
parents:
31130
diff
changeset
|
146 actual (current) key bindings. |
6381 | 147 |
148 The function @code{documentation} signals a @code{void-function} error | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
149 if @var{function} has no function definition. However, it is OK if |
6381 | 150 the function definition has no documentation string. In that case, |
151 @code{documentation} returns @code{nil}. | |
152 @end defun | |
153 | |
154 @c Wordy to prevent overfull hboxes. --rjc 15mar92 | |
7254 | 155 Here is an example of using the two functions, @code{documentation} and |
6381 | 156 @code{documentation-property}, to display the documentation strings for |
157 several symbols in a @samp{*Help*} buffer. | |
158 | |
53481
454b1ca272b8
(Accessing Documentation): Add anchor.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53298
diff
changeset
|
159 @anchor{describe-symbols example} |
6381 | 160 @smallexample |
161 @group | |
162 (defun describe-symbols (pattern) | |
163 "Describe the Emacs Lisp symbols matching PATTERN. | |
164 All symbols that have PATTERN in their name are described | |
165 in the `*Help*' buffer." | |
166 (interactive "sDescribe symbols matching: ") | |
167 (let ((describe-func | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
39221
diff
changeset
|
168 (function |
6381 | 169 (lambda (s) |
170 @end group | |
171 @group | |
172 ;; @r{Print description of symbol.} | |
173 (if (fboundp s) ; @r{It is a function.} | |
174 (princ | |
175 (format "%s\t%s\n%s\n\n" s | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
39221
diff
changeset
|
176 (if (commandp s) |
6381 | 177 (let ((keys (where-is-internal s))) |
178 (if keys | |
179 (concat | |
180 "Keys: " | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
39221
diff
changeset
|
181 (mapconcat 'key-description |
6381 | 182 keys " ")) |
183 "Keys: none")) | |
184 "Function") | |
185 @end group | |
186 @group | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
39221
diff
changeset
|
187 (or (documentation s) |
6381 | 188 "not documented")))) |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
39221
diff
changeset
|
189 |
6381 | 190 (if (boundp s) ; @r{It is a variable.} |
191 @end group | |
192 @group | |
193 (princ | |
194 (format "%s\t%s\n%s\n\n" s | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
39221
diff
changeset
|
195 (if (user-variable-p s) |
6381 | 196 "Option " "Variable") |
197 @end group | |
198 @group | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
39221
diff
changeset
|
199 (or (documentation-property |
6381 | 200 s 'variable-documentation) |
201 "not documented"))))))) | |
202 sym-list) | |
203 @end group | |
204 | |
205 @group | |
206 ;; @r{Build a list of symbols that match pattern.} | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
39221
diff
changeset
|
207 (mapatoms (function |
6381 | 208 (lambda (sym) |
209 (if (string-match pattern (symbol-name sym)) | |
210 (setq sym-list (cons sym sym-list)))))) | |
211 @end group | |
212 | |
213 @group | |
214 ;; @r{Display the data.} | |
215 (with-output-to-temp-buffer "*Help*" | |
216 (mapcar describe-func (sort sym-list 'string<)) | |
217 (print-help-return-message)))) | |
218 @end group | |
219 @end smallexample | |
220 | |
221 The @code{describe-symbols} function works like @code{apropos}, | |
222 but provides more information. | |
223 | |
224 @smallexample | |
225 @group | |
226 (describe-symbols "goal") | |
227 | |
228 ---------- Buffer: *Help* ---------- | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
39221
diff
changeset
|
229 goal-column Option |
16736
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
13349
diff
changeset
|
230 *Semipermanent goal column for vertical motion, as set by @dots{} |
6381 | 231 @end group |
232 @c Do not blithely break or fill these lines. | |
233 @c That makes them incorrect. | |
234 | |
235 @group | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
236 set-goal-column Keys: C-x C-n |
6381 | 237 Set the current horizontal position as a goal for C-n and C-p. |
238 @end group | |
239 @c DO NOT put a blank line here! That is factually inaccurate! | |
240 @group | |
241 Those commands will move to this position in the line moved to | |
242 rather than trying to keep the same horizontal position. | |
243 With a non-nil argument, clears out the goal column | |
244 so that C-n and C-p resume vertical motion. | |
245 The goal column is stored in the variable `goal-column'. | |
246 @end group | |
247 | |
248 @group | |
249 temporary-goal-column Variable | |
250 Current goal column for vertical motion. | |
251 It is the column where point was | |
252 at the start of current run of vertical motion commands. | |
253 When the `track-eol' feature is doing its job, the value is 9999. | |
254 ---------- Buffer: *Help* ---------- | |
255 @end group | |
256 @end smallexample | |
257 | |
31130
e9c859a12e47
Add a comment about the significance of an asterisk as the first
Eli Zaretskii <eliz@gnu.org>
parents:
27189
diff
changeset
|
258 The asterisk @samp{*} as the first character of a variable's doc string, |
e9c859a12e47
Add a comment about the significance of an asterisk as the first
Eli Zaretskii <eliz@gnu.org>
parents:
27189
diff
changeset
|
259 as shown above for the @code{goal-column} variable, means that it is a |
e9c859a12e47
Add a comment about the significance of an asterisk as the first
Eli Zaretskii <eliz@gnu.org>
parents:
27189
diff
changeset
|
260 user option; see the description of @code{defvar} in @ref{Defining |
e9c859a12e47
Add a comment about the significance of an asterisk as the first
Eli Zaretskii <eliz@gnu.org>
parents:
27189
diff
changeset
|
261 Variables}. |
e9c859a12e47
Add a comment about the significance of an asterisk as the first
Eli Zaretskii <eliz@gnu.org>
parents:
27189
diff
changeset
|
262 |
56213
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
263 @defun Snarf-documentation filename |
53298
8066757520a8
(Accessing Documentation): Add anchor.
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
264 @anchor{Definition of Snarf-documentation} |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
265 This function is used only during Emacs initialization, just before |
6381 | 266 the runnable Emacs is dumped. It finds the file offsets of the |
267 documentation strings stored in the file @var{filename}, and records | |
268 them in the in-core function definitions and variable property lists in | |
269 place of the actual strings. @xref{Building Emacs}. | |
270 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
271 Emacs reads the file @var{filename} from the @file{emacs/etc} directory. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
272 When the dumped Emacs is later executed, the same file will be looked |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
273 for in the directory @code{doc-directory}. Usually @var{filename} is |
6381 | 274 @code{"DOC-@var{version}"}. |
275 @end defun | |
276 | |
277 @c Emacs 19 feature | |
278 @defvar doc-directory | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
279 This variable holds the name of the directory which should contain the |
6381 | 280 file @code{"DOC-@var{version}"} that contains documentation strings for |
281 built-in and preloaded functions and variables. | |
282 | |
283 In most cases, this is the same as @code{data-directory}. They may be | |
284 different when you run Emacs from the directory where you built it, | |
56213
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
285 without actually installing it. @xref{Definition of data-directory}. |
6381 | 286 |
287 In older Emacs versions, @code{exec-directory} was used for this. | |
288 @end defvar | |
289 | |
290 @node Keys in Documentation | |
291 @section Substituting Key Bindings in Documentation | |
292 @cindex documentation, keys in | |
293 @cindex keys in documentation strings | |
294 @cindex substituting keys in documentation | |
295 | |
7254 | 296 When documentation strings refer to key sequences, they should use the |
297 current, actual key bindings. They can do so using certain special text | |
298 sequences described below. Accessing documentation strings in the usual | |
299 way substitutes current key binding information for these special | |
300 sequences. This works by calling @code{substitute-command-keys}. You | |
301 can also call that function yourself. | |
6381 | 302 |
303 Here is a list of the special sequences and what they mean: | |
304 | |
305 @table @code | |
306 @item \[@var{command}] | |
307 stands for a key sequence that will invoke @var{command}, or @samp{M-x | |
308 @var{command}} if @var{command} has no key bindings. | |
309 | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
39221
diff
changeset
|
310 @item \@{@var{mapvar}@} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
311 stands for a summary of the keymap which is the value of the variable |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
312 @var{mapvar}. The summary is made using @code{describe-bindings}. |
6381 | 313 |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
39221
diff
changeset
|
314 @item \<@var{mapvar}> |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
315 stands for no text itself. It is used only for a side effect: it |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
316 specifies @var{mapvar}'s value as the keymap for any following |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
317 @samp{\[@var{command}]} sequences in this documentation string. |
13349
1c9bf4febb14
Document \= in doc string.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
318 |
1c9bf4febb14
Document \= in doc string.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
319 @item \= |
1c9bf4febb14
Document \= in doc string.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
320 quotes the following character and is discarded; thus, @samp{\=\[} puts |
1c9bf4febb14
Document \= in doc string.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
321 @samp{\[} into the output, and @samp{\=\=} puts @samp{\=} into the |
1c9bf4febb14
Document \= in doc string.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
322 output. |
6381 | 323 @end table |
324 | |
7254 | 325 @strong{Please note:} Each @samp{\} must be doubled when written in a |
6381 | 326 string in Emacs Lisp. |
327 | |
328 @defun substitute-command-keys string | |
329 This function scans @var{string} for the above special sequences and | |
330 replaces them by what they stand for, returning the result as a string. | |
331 This permits display of documentation that refers accurately to the | |
7254 | 332 user's own customized key bindings. |
6381 | 333 @end defun |
334 | |
335 Here are examples of the special sequences: | |
336 | |
337 @smallexample | |
338 @group | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
39221
diff
changeset
|
339 (substitute-command-keys |
6381 | 340 "To abort recursive edit, type: \\[abort-recursive-edit]") |
341 @result{} "To abort recursive edit, type: C-]" | |
342 @end group | |
343 | |
344 @group | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
39221
diff
changeset
|
345 (substitute-command-keys |
6381 | 346 "The keys that are defined for the minibuffer here are: |
347 \\@{minibuffer-local-must-match-map@}") | |
348 @result{} "The keys that are defined for the minibuffer here are: | |
349 @end group | |
350 | |
351 ? minibuffer-completion-help | |
352 SPC minibuffer-complete-word | |
353 TAB minibuffer-complete | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
354 C-j minibuffer-complete-and-exit |
6381 | 355 RET minibuffer-complete-and-exit |
356 C-g abort-recursive-edit | |
357 " | |
358 | |
359 @group | |
360 (substitute-command-keys | |
361 "To abort a recursive edit from the minibuffer, type\ | |
362 \\<minibuffer-local-must-match-map>\\[abort-recursive-edit].") | |
363 @result{} "To abort a recursive edit from the minibuffer, type C-g." | |
364 @end group | |
365 @end smallexample | |
366 | |
367 @node Describing Characters | |
368 @section Describing Characters for Help Messages | |
369 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
370 These functions convert events, key sequences, or characters to |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
371 textual descriptions. These descriptions are useful for including |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
372 arbitrary text characters or key sequences in messages, because they |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
373 convert non-printing and whitespace characters to sequences of printing |
6381 | 374 characters. The description of a non-whitespace printing character is |
375 the character itself. | |
376 | |
56213
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
377 @defun key-description sequence &optional prefix |
6381 | 378 @cindex Emacs event standard notation |
379 This function returns a string containing the Emacs standard notation | |
56213
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
380 for the input events in @var{sequence}. If @var{prefix} is |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
381 non-@code{nil}, it is a sequence of input events leading up to |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
382 @var{sequence} and is included in the return value. Both arguments |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
383 may be strings, vectors or lists. @xref{Input Events}, for more |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
384 information about valid events. |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
385 |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
386 @smallexample |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
387 @group |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
388 (key-description [?\M-3 delete]) |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
389 @result{} "M-3 <delete>" |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
390 @end group |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
391 @group |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
392 (key-description [delete] "\M-3") |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
393 @result{} "M-3 <delete>" |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
394 @end group |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
395 @end smallexample |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
396 |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
397 See also the examples for @code{single-key-description}, below. |
6381 | 398 @end defun |
399 | |
39206
41ede3832703
(Describing Characters) <single-key-description>:
Eli Zaretskii <eliz@gnu.org>
parents:
31130
diff
changeset
|
400 @defun single-key-description event &optional no-angles |
6381 | 401 @cindex event printing |
402 @cindex character printing | |
403 @cindex control character printing | |
404 @cindex meta character printing | |
405 This function returns a string describing @var{event} in the standard | |
39221
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39206
diff
changeset
|
406 Emacs notation for keyboard input. A normal printing character |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39206
diff
changeset
|
407 appears as itself, but a control character turns into a string |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39206
diff
changeset
|
408 starting with @samp{C-}, a meta character turns into a string starting |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39206
diff
changeset
|
409 with @samp{M-}, and space, tab, etc.@: appear as @samp{SPC}, |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39206
diff
changeset
|
410 @samp{TAB}, etc. A function key symbol appears inside angle brackets |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39206
diff
changeset
|
411 @samp{<@dots{}>}. An event that is a list appears as the name of the |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39206
diff
changeset
|
412 symbol in the @sc{car} of the list, inside angle brackets. |
39206
41ede3832703
(Describing Characters) <single-key-description>:
Eli Zaretskii <eliz@gnu.org>
parents:
31130
diff
changeset
|
413 |
41ede3832703
(Describing Characters) <single-key-description>:
Eli Zaretskii <eliz@gnu.org>
parents:
31130
diff
changeset
|
414 If the optional argument @var{no-angles} is non-@code{nil}, the angle |
41ede3832703
(Describing Characters) <single-key-description>:
Eli Zaretskii <eliz@gnu.org>
parents:
31130
diff
changeset
|
415 brackets around function keys and event symbols are omitted; this is |
39221
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39206
diff
changeset
|
416 for compatibility with old versions of Emacs which didn't use the |
39206
41ede3832703
(Describing Characters) <single-key-description>:
Eli Zaretskii <eliz@gnu.org>
parents:
31130
diff
changeset
|
417 brackets. |
6381 | 418 |
419 @smallexample | |
420 @group | |
421 (single-key-description ?\C-x) | |
422 @result{} "C-x" | |
423 @end group | |
424 @group | |
425 (key-description "\C-x \M-y \n \t \r \f123") | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
426 @result{} "C-x SPC M-y SPC C-j SPC TAB SPC RET SPC C-l 1 2 3" |
6381 | 427 @end group |
428 @group | |
39206
41ede3832703
(Describing Characters) <single-key-description>:
Eli Zaretskii <eliz@gnu.org>
parents:
31130
diff
changeset
|
429 (single-key-description 'delete) |
41ede3832703
(Describing Characters) <single-key-description>:
Eli Zaretskii <eliz@gnu.org>
parents:
31130
diff
changeset
|
430 @result{} "<delete>" |
41ede3832703
(Describing Characters) <single-key-description>:
Eli Zaretskii <eliz@gnu.org>
parents:
31130
diff
changeset
|
431 @end group |
41ede3832703
(Describing Characters) <single-key-description>:
Eli Zaretskii <eliz@gnu.org>
parents:
31130
diff
changeset
|
432 @group |
6381 | 433 (single-key-description 'C-mouse-1) |
39206
41ede3832703
(Describing Characters) <single-key-description>:
Eli Zaretskii <eliz@gnu.org>
parents:
31130
diff
changeset
|
434 @result{} "<C-mouse-1>" |
41ede3832703
(Describing Characters) <single-key-description>:
Eli Zaretskii <eliz@gnu.org>
parents:
31130
diff
changeset
|
435 @end group |
41ede3832703
(Describing Characters) <single-key-description>:
Eli Zaretskii <eliz@gnu.org>
parents:
31130
diff
changeset
|
436 @group |
41ede3832703
(Describing Characters) <single-key-description>:
Eli Zaretskii <eliz@gnu.org>
parents:
31130
diff
changeset
|
437 (single-key-description 'C-mouse-1 t) |
6381 | 438 @result{} "C-mouse-1" |
439 @end group | |
440 @end smallexample | |
441 @end defun | |
442 | |
443 @defun text-char-description character | |
444 This function returns a string describing @var{character} in the | |
445 standard Emacs notation for characters that appear in text---like | |
446 @code{single-key-description}, except that control characters are | |
447 represented with a leading caret (which is how control characters in | |
56213
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
448 Emacs buffers are usually displayed). Another difference is that |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
449 @code{text-char-description} recognizes the 2**7 bit as the Meta |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
450 character, whereas @code{single-key-description} uses the 2**27 bit |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
451 for Meta. |
6381 | 452 |
453 @smallexample | |
454 @group | |
455 (text-char-description ?\C-c) | |
456 @result{} "^C" | |
457 @end group | |
458 @group | |
459 (text-char-description ?\M-m) | |
54032
dbcba6606213
(Describing Characters): Fix text-char-description example output.
Richard M. Stallman <rms@gnu.org>
parents:
53481
diff
changeset
|
460 @result{} "\xed" |
6381 | 461 @end group |
462 @group | |
463 (text-char-description ?\C-\M-m) | |
54032
dbcba6606213
(Describing Characters): Fix text-char-description example output.
Richard M. Stallman <rms@gnu.org>
parents:
53481
diff
changeset
|
464 @result{} "\x8d" |
6381 | 465 @end group |
56213
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
466 @group |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
467 (text-char-description (+ 128 ?m)) |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
468 @result{} "M-m" |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
469 @end group |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
470 @group |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
471 (text-char-description (+ 128 ?\C-m)) |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
472 @result{} "M-^M" |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
473 @end group |
6381 | 474 @end smallexample |
475 @end defun | |
476 | |
56213
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
477 @defun read-kbd-macro string &optional need-vector |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
478 This function is used mainly for operating on keyboard macros, but it |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
479 can also be used as a rough inverse for @code{key-description}. You |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
480 call it with a string containing key descriptions, separated by spaces; |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
481 it returns a string or vector containing the corresponding events. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
482 (This may or may not be a single valid key sequence, depending on what |
56213
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
483 events you use; @pxref{Keymap Terminology}.) If @var{need-vector} is |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
484 non-@code{nil}, the return value is always a vector. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
485 @end defun |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
486 |
6381 | 487 @node Help Functions |
488 @section Help Functions | |
489 | |
490 Emacs provides a variety of on-line help functions, all accessible to | |
491 the user as subcommands of the prefix @kbd{C-h}. For more information | |
492 about them, see @ref{Help, , Help, emacs, The GNU Emacs Manual}. Here | |
493 we describe some program-level interfaces to the same information. | |
494 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
495 @deffn Command apropos regexp &optional do-all |
56213
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
496 This function finds all ``meaningful'' symbols whose names contain a |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
497 match for the regular expression @var{regexp}, and returns a list of |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
498 them, with associated documentation (@pxref{Regular Expressions}). It |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
499 also displays the symbols in a buffer named @samp{*Apropos*}, each |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
500 with a one-line description taken from the beginning of its |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
501 documentation string. A symbol is ``meaningful'' if it has a |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
502 definition as a function, variable, or face, or has properties. |
6381 | 503 |
504 @c Emacs 19 feature | |
56213
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
505 If @var{do-all} is non-@code{nil}, or if the user option |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
506 @code{apropos-do-all} is non-@code{nil}, then @code{apropos} also |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
507 shows key bindings for the functions that are found; it also shows |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
508 @emph{all} interned symbols, not just meaningful ones (and it lists |
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
509 them in the return value as well). |
6381 | 510 @end deffn |
511 | |
512 @defvar help-map | |
513 The value of this variable is a local keymap for characters following the | |
514 Help key, @kbd{C-h}. | |
515 @end defvar | |
516 | |
517 @deffn {Prefix Command} help-command | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
518 This symbol is not a function; its function definition cell holds the |
6381 | 519 keymap known as @code{help-map}. It is defined in @file{help.el} as |
520 follows: | |
521 | |
522 @smallexample | |
523 @group | |
56213
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
524 (define-key global-map (char-to-string help-char) 'help-command) |
6381 | 525 (fset 'help-command help-map) |
526 @end group | |
527 @end smallexample | |
528 @end deffn | |
529 | |
530 @defun print-help-return-message &optional function | |
7254 | 531 This function builds a string that explains how to restore the previous |
532 state of the windows after a help command. After building the message, | |
533 it applies @var{function} to it if @var{function} is non-@code{nil}. | |
534 Otherwise it calls @code{message} to display it in the echo area. | |
6381 | 535 |
536 This function expects to be called inside a | |
537 @code{with-output-to-temp-buffer} special form, and expects | |
538 @code{standard-output} to have the value bound by that special form. | |
539 For an example of its use, see the long example in @ref{Accessing | |
540 Documentation}. | |
541 @end defun | |
542 | |
543 @defvar help-char | |
544 The value of this variable is the help character---the character that | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
545 Emacs recognizes as meaning Help. By default, its value is 8, which |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
546 stands for @kbd{C-h}. When Emacs reads this character, if |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
547 @code{help-form} is a non-@code{nil} Lisp expression, it evaluates that |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
548 expression, and displays the result in a window if it is a string. |
6381 | 549 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
550 Usually the value of @code{help-form} is @code{nil}. Then the |
6381 | 551 help character has no special meaning at the level of command input, and |
552 it becomes part of a key sequence in the normal way. The standard key | |
553 binding of @kbd{C-h} is a prefix key for several general-purpose help | |
554 features. | |
555 | |
556 The help character is special after prefix keys, too. If it has no | |
557 binding as a subcommand of the prefix key, it runs | |
558 @code{describe-prefix-bindings}, which displays a list of all the | |
559 subcommands of the prefix key. | |
560 @end defvar | |
561 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
562 @defvar help-event-list |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
563 The value of this variable is a list of event types that serve as |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
564 alternative ``help characters.'' These events are handled just like the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
565 event specified by @code{help-char}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
566 @end defvar |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
567 |
6381 | 568 @defvar help-form |
569 If this variable is non-@code{nil}, its value is a form to evaluate | |
570 whenever the character @code{help-char} is read. If evaluating the form | |
571 produces a string, that string is displayed. | |
572 | |
573 A command that calls @code{read-event} or @code{read-char} probably | |
574 should bind @code{help-form} to a non-@code{nil} expression while it | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
575 does input. (The time when you should not do this is when @kbd{C-h} has |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
576 some other meaning.) Evaluating this expression should result in a |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
577 string that explains what the input is for and how to enter it properly. |
6381 | 578 |
579 Entry to the minibuffer binds this variable to the value of | |
56213
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
580 @code{minibuffer-help-form} (@pxref{Definition of minibuffer-help-form}). |
6381 | 581 @end defvar |
582 | |
583 @defvar prefix-help-command | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
584 This variable holds a function to print help for a prefix key. The |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
585 function is called when the user types a prefix key followed by the help |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
586 character, and the help character has no binding after that prefix. The |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
587 variable's default value is @code{describe-prefix-bindings}. |
6381 | 588 @end defvar |
589 | |
590 @defun describe-prefix-bindings | |
591 This function calls @code{describe-bindings} to display a list of all | |
592 the subcommands of the prefix key of the most recent key sequence. The | |
593 prefix described consists of all but the last event of that key | |
7254 | 594 sequence. (The last event is, presumably, the help character.) |
6381 | 595 @end defun |
596 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
597 The following two functions are meant for modes that want to provide |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
598 help without relinquishing control, such as the ``electric'' modes. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
599 Their names begin with @samp{Helper} to distinguish them from the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
600 ordinary help functions. |
6381 | 601 |
602 @deffn Command Helper-describe-bindings | |
603 This command pops up a window displaying a help buffer containing a | |
604 listing of all of the key bindings from both the local and global keymaps. | |
605 It works by calling @code{describe-bindings}. | |
606 @end deffn | |
607 | |
608 @deffn Command Helper-help | |
609 This command provides help for the current mode. It prompts the user | |
610 in the minibuffer with the message @samp{Help (Type ? for further | |
611 options)}, and then provides assistance in finding out what the key | |
612 bindings are, and what the mode is intended for. It returns @code{nil}. | |
613 | |
614 This can be customized by changing the map @code{Helper-help-map}. | |
615 @end deffn | |
616 | |
617 @c Emacs 19 feature | |
618 @defvar data-directory | |
56213
abaa918096d2
Various small changes in addition to the following.
Luc Teirlinck <teirllm@auburn.edu>
parents:
54032
diff
changeset
|
619 @anchor{Definition of data-directory} |
6381 | 620 This variable holds the name of the directory in which Emacs finds |
621 certain documentation and text files that come with Emacs. In older | |
622 Emacs versions, @code{exec-directory} was used for this. | |
623 @end defvar | |
624 | |
625 @c Emacs 19 feature | |
626 @defmac make-help-screen fname help-line help-text help-map | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
39221
diff
changeset
|
627 This macro defines a help command named @var{fname} that acts like a |
7254 | 628 prefix key that shows a list of the subcommands it offers. |
6381 | 629 |
630 When invoked, @var{fname} displays @var{help-text} in a window, then | |
631 reads and executes a key sequence according to @var{help-map}. The | |
7254 | 632 string @var{help-text} should describe the bindings available in |
6381 | 633 @var{help-map}. |
634 | |
635 The command @var{fname} is defined to handle a few events itself, by | |
636 scrolling the display of @var{help-text}. When @var{fname} reads one of | |
637 those special events, it does the scrolling and then reads another | |
7254 | 638 event. When it reads an event that is not one of those few, and which |
6381 | 639 has a binding in @var{help-map}, it executes that key's binding and |
640 then returns. | |
641 | |
642 The argument @var{help-line} should be a single-line summary of the | |
643 alternatives in @var{help-map}. In the current version of Emacs, this | |
644 argument is used only if you set the option @code{three-step-help} to | |
645 @code{t}. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
646 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
647 This macro is used in the command @code{help-for-help} which is the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
648 binding of @kbd{C-h C-h}. |
6381 | 649 @end defmac |
650 | |
651 @defopt three-step-help | |
652 If this variable is non-@code{nil}, commands defined with | |
653 @code{make-help-screen} display their @var{help-line} strings in the | |
654 echo area at first, and display the longer @var{help-text} strings only | |
655 if the user types the help character again. | |
656 @end defopt | |
52401 | 657 |
658 @ignore | |
659 arch-tag: ba36b4c2-e60f-49e2-bc25-61158fdcd815 | |
660 @end ignore |