Commit | Line | Data |
---|---|---|
5e8db0c6 RS |
1 | @c -*-texinfo-*- |
2 | @c This is part of the GNU Emacs Lisp Reference Manual. | |
fd897522 | 3 | @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999 |
177c0ea7 | 4 | @c Free Software Foundation, Inc. |
5e8db0c6 RS |
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 | |
969fe9b5 RS |
54 | string, if it has one, because that looks odd when you use @kbd{C-h f} |
55 | (@code{describe-function}) or @kbd{C-h v} (@code{describe-variable}) to | |
56 | view the documentation string. @xref{Documentation Tips}. | |
5e8db0c6 | 57 | |
969fe9b5 | 58 | Documentation strings can contain several special substrings, which |
5e8db0c6 RS |
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 | |
62 | rearranges the key bindings. (@xref{Accessing Documentation}.) | |
63 | ||
f9f59935 | 64 | In Emacs Lisp, a documentation string is accessible through the |
5e8db0c6 RS |
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 | |
f9f59935 RS |
70 | itself (@pxref{Lambda Expressions}). The function @code{documentation} |
71 | knows how to extract it. | |
5e8db0c6 RS |
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 | |
f9f59935 | 77 | function @code{documentation-property} knows how to retrieve it. |
5e8db0c6 RS |
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 | |
82a2fe69 | 84 | (including primitive functions and autoloaded functions) is stored in |
f9f59935 RS |
85 | the file @file{emacs/etc/DOC-@var{version}}---not inside Emacs. The |
86 | documentation strings for functions and variables loaded during the | |
87 | Emacs session from byte-compiled files are stored in those files | |
88 | (@pxref{Docs and Compilation}). | |
bfe721d1 KH |
89 | |
90 | The data structure inside Emacs has an integer offset into the file, or | |
f9f59935 RS |
91 | a list containing a file name and an integer, in place of the |
92 | documentation string. The functions @code{documentation} and | |
93 | @code{documentation-property} use that information to fetch the | |
94 | documentation string from the appropriate file; this is transparent to | |
95 | the user. | |
5e8db0c6 RS |
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 | |
b32a6a15 RS |
101 | The @file{emacs/lib-src} directory contains two utilities that you can |
102 | use to print nice-looking hardcopy for the file | |
1911e6e5 RS |
103 | @file{emacs/etc/DOC-@var{version}}. These are @file{sorted-doc} and |
104 | @file{digest-doc}. | |
5e8db0c6 RS |
105 | |
106 | @node Accessing Documentation | |
107 | @section Access to Documentation Strings | |
108 | ||
109 | @defun documentation-property symbol property &optional verbatim | |
caae20c7 RS |
110 | This function returns the documentation string that is recorded in |
111 | @var{symbol}'s property list under property @var{property}. It | |
112 | retrieves the text from a file if the value calls for that. If the | |
113 | property value isn't @code{nil}, isn't a string, and doesn't refer to | |
114 | text in a file, then it is evaluated to obtain a string. | |
115 | ||
116 | Finally, @code{documentation-property} passes the string through | |
117 | @code{substitute-command-keys} to substitute actual key bindings, | |
118 | unless @var{verbatim} is non-@code{nil}. | |
5e8db0c6 RS |
119 | |
120 | @smallexample | |
121 | @group | |
122 | (documentation-property 'command-line-processed | |
123 | 'variable-documentation) | |
1911e6e5 | 124 | @result{} "Non-nil once command line has been processed" |
5e8db0c6 RS |
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 | |
caae20c7 RS |
134 | This function returns the documentation string of @var{function}. |
135 | ||
136 | If @var{function} is a symbol, this function first looks for the | |
137 | @code{function-documentation} property of that symbol; if that has a | |
138 | non-@code{nil} value, the documentation comes from that value (if the | |
139 | value is not a string, it is evaluated). If @var{function} is not a | |
140 | symbol, or if it has no @code{function-documentation} property, then | |
141 | @code{documentation} extracts the documentation string from the actual | |
142 | function definition, reading it from a file if called for. | |
143 | ||
144 | Finally, unless @var{verbatim} is non-@code{nil}, it calls | |
145 | @code{substitute-command-keys} so as to return a value containing the | |
7f0afecc | 146 | actual (current) key bindings. |
5e8db0c6 RS |
147 | |
148 | The function @code{documentation} signals a @code{void-function} error | |
969fe9b5 | 149 | if @var{function} has no function definition. However, it is OK if |
5e8db0c6 RS |
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 | |
82a2fe69 | 155 | Here is an example of using the two functions, @code{documentation} and |
5e8db0c6 RS |
156 | @code{documentation-property}, to display the documentation strings for |
157 | several symbols in a @samp{*Help*} buffer. | |
158 | ||
159 | @smallexample | |
160 | @group | |
161 | (defun describe-symbols (pattern) | |
162 | "Describe the Emacs Lisp symbols matching PATTERN. | |
163 | All symbols that have PATTERN in their name are described | |
164 | in the `*Help*' buffer." | |
165 | (interactive "sDescribe symbols matching: ") | |
166 | (let ((describe-func | |
177c0ea7 | 167 | (function |
5e8db0c6 RS |
168 | (lambda (s) |
169 | @end group | |
170 | @group | |
171 | ;; @r{Print description of symbol.} | |
172 | (if (fboundp s) ; @r{It is a function.} | |
173 | (princ | |
174 | (format "%s\t%s\n%s\n\n" s | |
177c0ea7 | 175 | (if (commandp s) |
5e8db0c6 RS |
176 | (let ((keys (where-is-internal s))) |
177 | (if keys | |
178 | (concat | |
179 | "Keys: " | |
177c0ea7 | 180 | (mapconcat 'key-description |
5e8db0c6 RS |
181 | keys " ")) |
182 | "Keys: none")) | |
183 | "Function") | |
184 | @end group | |
185 | @group | |
177c0ea7 | 186 | (or (documentation s) |
5e8db0c6 | 187 | "not documented")))) |
177c0ea7 | 188 | |
5e8db0c6 RS |
189 | (if (boundp s) ; @r{It is a variable.} |
190 | @end group | |
191 | @group | |
192 | (princ | |
193 | (format "%s\t%s\n%s\n\n" s | |
177c0ea7 | 194 | (if (user-variable-p s) |
5e8db0c6 RS |
195 | "Option " "Variable") |
196 | @end group | |
197 | @group | |
177c0ea7 | 198 | (or (documentation-property |
5e8db0c6 RS |
199 | s 'variable-documentation) |
200 | "not documented"))))))) | |
201 | sym-list) | |
202 | @end group | |
203 | ||
204 | @group | |
205 | ;; @r{Build a list of symbols that match pattern.} | |
177c0ea7 | 206 | (mapatoms (function |
5e8db0c6 RS |
207 | (lambda (sym) |
208 | (if (string-match pattern (symbol-name sym)) | |
209 | (setq sym-list (cons sym sym-list)))))) | |
210 | @end group | |
211 | ||
212 | @group | |
213 | ;; @r{Display the data.} | |
214 | (with-output-to-temp-buffer "*Help*" | |
215 | (mapcar describe-func (sort sym-list 'string<)) | |
216 | (print-help-return-message)))) | |
217 | @end group | |
218 | @end smallexample | |
219 | ||
220 | The @code{describe-symbols} function works like @code{apropos}, | |
221 | but provides more information. | |
222 | ||
223 | @smallexample | |
224 | @group | |
225 | (describe-symbols "goal") | |
226 | ||
227 | ---------- Buffer: *Help* ---------- | |
177c0ea7 | 228 | goal-column Option |
9e2b495b | 229 | *Semipermanent goal column for vertical motion, as set by @dots{} |
5e8db0c6 RS |
230 | @end group |
231 | @c Do not blithely break or fill these lines. | |
232 | @c That makes them incorrect. | |
233 | ||
234 | @group | |
1911e6e5 | 235 | set-goal-column Keys: C-x C-n |
5e8db0c6 RS |
236 | Set the current horizontal position as a goal for C-n and C-p. |
237 | @end group | |
238 | @c DO NOT put a blank line here! That is factually inaccurate! | |
239 | @group | |
240 | Those commands will move to this position in the line moved to | |
241 | rather than trying to keep the same horizontal position. | |
242 | With a non-nil argument, clears out the goal column | |
243 | so that C-n and C-p resume vertical motion. | |
244 | The goal column is stored in the variable `goal-column'. | |
245 | @end group | |
246 | ||
247 | @group | |
248 | temporary-goal-column Variable | |
249 | Current goal column for vertical motion. | |
250 | It is the column where point was | |
251 | at the start of current run of vertical motion commands. | |
252 | When the `track-eol' feature is doing its job, the value is 9999. | |
253 | ---------- Buffer: *Help* ---------- | |
254 | @end group | |
255 | @end smallexample | |
256 | ||
bfccb7b3 EZ |
257 | The asterisk @samp{*} as the first character of a variable's doc string, |
258 | as shown above for the @code{goal-column} variable, means that it is a | |
259 | user option; see the description of @code{defvar} in @ref{Defining | |
260 | Variables}. | |
261 | ||
5e8db0c6 | 262 | @defun Snarf-documentation filename |
f9f59935 | 263 | This function is used only during Emacs initialization, just before |
5e8db0c6 RS |
264 | the runnable Emacs is dumped. It finds the file offsets of the |
265 | documentation strings stored in the file @var{filename}, and records | |
266 | them in the in-core function definitions and variable property lists in | |
267 | place of the actual strings. @xref{Building Emacs}. | |
268 | ||
f9f59935 RS |
269 | Emacs reads the file @var{filename} from the @file{emacs/etc} directory. |
270 | When the dumped Emacs is later executed, the same file will be looked | |
271 | for in the directory @code{doc-directory}. Usually @var{filename} is | |
5e8db0c6 RS |
272 | @code{"DOC-@var{version}"}. |
273 | @end defun | |
274 | ||
275 | @c Emacs 19 feature | |
276 | @defvar doc-directory | |
969fe9b5 | 277 | This variable holds the name of the directory which should contain the |
5e8db0c6 RS |
278 | file @code{"DOC-@var{version}"} that contains documentation strings for |
279 | built-in and preloaded functions and variables. | |
280 | ||
281 | In most cases, this is the same as @code{data-directory}. They may be | |
282 | different when you run Emacs from the directory where you built it, | |
283 | without actually installing it. See @code{data-directory} in @ref{Help | |
284 | Functions}. | |
285 | ||
286 | In older Emacs versions, @code{exec-directory} was used for this. | |
287 | @end defvar | |
288 | ||
289 | @node Keys in Documentation | |
290 | @section Substituting Key Bindings in Documentation | |
291 | @cindex documentation, keys in | |
292 | @cindex keys in documentation strings | |
293 | @cindex substituting keys in documentation | |
294 | ||
82a2fe69 RS |
295 | When documentation strings refer to key sequences, they should use the |
296 | current, actual key bindings. They can do so using certain special text | |
297 | sequences described below. Accessing documentation strings in the usual | |
298 | way substitutes current key binding information for these special | |
299 | sequences. This works by calling @code{substitute-command-keys}. You | |
300 | can also call that function yourself. | |
5e8db0c6 RS |
301 | |
302 | Here is a list of the special sequences and what they mean: | |
303 | ||
304 | @table @code | |
305 | @item \[@var{command}] | |
306 | stands for a key sequence that will invoke @var{command}, or @samp{M-x | |
307 | @var{command}} if @var{command} has no key bindings. | |
308 | ||
177c0ea7 | 309 | @item \@{@var{mapvar}@} |
969fe9b5 RS |
310 | stands for a summary of the keymap which is the value of the variable |
311 | @var{mapvar}. The summary is made using @code{describe-bindings}. | |
5e8db0c6 | 312 | |
177c0ea7 | 313 | @item \<@var{mapvar}> |
f9f59935 | 314 | stands for no text itself. It is used only for a side effect: it |
969fe9b5 | 315 | specifies @var{mapvar}'s value as the keymap for any following |
f9f59935 | 316 | @samp{\[@var{command}]} sequences in this documentation string. |
815c9631 RS |
317 | |
318 | @item \= | |
319 | quotes the following character and is discarded; thus, @samp{\=\[} puts | |
320 | @samp{\[} into the output, and @samp{\=\=} puts @samp{\=} into the | |
321 | output. | |
5e8db0c6 RS |
322 | @end table |
323 | ||
82a2fe69 | 324 | @strong{Please note:} Each @samp{\} must be doubled when written in a |
5e8db0c6 RS |
325 | string in Emacs Lisp. |
326 | ||
327 | @defun substitute-command-keys string | |
328 | This function scans @var{string} for the above special sequences and | |
329 | replaces them by what they stand for, returning the result as a string. | |
330 | This permits display of documentation that refers accurately to the | |
82a2fe69 | 331 | user's own customized key bindings. |
5e8db0c6 RS |
332 | @end defun |
333 | ||
334 | Here are examples of the special sequences: | |
335 | ||
336 | @smallexample | |
337 | @group | |
177c0ea7 | 338 | (substitute-command-keys |
5e8db0c6 RS |
339 | "To abort recursive edit, type: \\[abort-recursive-edit]") |
340 | @result{} "To abort recursive edit, type: C-]" | |
341 | @end group | |
342 | ||
343 | @group | |
177c0ea7 | 344 | (substitute-command-keys |
5e8db0c6 RS |
345 | "The keys that are defined for the minibuffer here are: |
346 | \\@{minibuffer-local-must-match-map@}") | |
347 | @result{} "The keys that are defined for the minibuffer here are: | |
348 | @end group | |
349 | ||
350 | ? minibuffer-completion-help | |
351 | SPC minibuffer-complete-word | |
352 | TAB minibuffer-complete | |
969fe9b5 | 353 | C-j minibuffer-complete-and-exit |
5e8db0c6 RS |
354 | RET minibuffer-complete-and-exit |
355 | C-g abort-recursive-edit | |
356 | " | |
357 | ||
358 | @group | |
359 | (substitute-command-keys | |
360 | "To abort a recursive edit from the minibuffer, type\ | |
361 | \\<minibuffer-local-must-match-map>\\[abort-recursive-edit].") | |
362 | @result{} "To abort a recursive edit from the minibuffer, type C-g." | |
363 | @end group | |
364 | @end smallexample | |
365 | ||
366 | @node Describing Characters | |
367 | @section Describing Characters for Help Messages | |
368 | ||
f9f59935 RS |
369 | These functions convert events, key sequences, or characters to |
370 | textual descriptions. These descriptions are useful for including | |
371 | arbitrary text characters or key sequences in messages, because they | |
372 | convert non-printing and whitespace characters to sequences of printing | |
5e8db0c6 RS |
373 | characters. The description of a non-whitespace printing character is |
374 | the character itself. | |
375 | ||
376 | @defun key-description sequence | |
377 | @cindex Emacs event standard notation | |
378 | This function returns a string containing the Emacs standard notation | |
379 | for the input events in @var{sequence}. The argument @var{sequence} may | |
380 | be a string, vector or list. @xref{Input Events}, for more information | |
381 | about valid events. See also the examples for | |
382 | @code{single-key-description}, below. | |
383 | @end defun | |
384 | ||
7f0afecc | 385 | @defun single-key-description event &optional no-angles |
5e8db0c6 RS |
386 | @cindex event printing |
387 | @cindex character printing | |
388 | @cindex control character printing | |
389 | @cindex meta character printing | |
390 | This function returns a string describing @var{event} in the standard | |
caae20c7 RS |
391 | Emacs notation for keyboard input. A normal printing character |
392 | appears as itself, but a control character turns into a string | |
393 | starting with @samp{C-}, a meta character turns into a string starting | |
394 | with @samp{M-}, and space, tab, etc.@: appear as @samp{SPC}, | |
395 | @samp{TAB}, etc. A function key symbol appears inside angle brackets | |
396 | @samp{<@dots{}>}. An event that is a list appears as the name of the | |
397 | symbol in the @sc{car} of the list, inside angle brackets. | |
7f0afecc EZ |
398 | |
399 | If the optional argument @var{no-angles} is non-@code{nil}, the angle | |
400 | brackets around function keys and event symbols are omitted; this is | |
caae20c7 | 401 | for compatibility with old versions of Emacs which didn't use the |
7f0afecc | 402 | brackets. |
5e8db0c6 RS |
403 | |
404 | @smallexample | |
405 | @group | |
406 | (single-key-description ?\C-x) | |
407 | @result{} "C-x" | |
408 | @end group | |
409 | @group | |
410 | (key-description "\C-x \M-y \n \t \r \f123") | |
969fe9b5 | 411 | @result{} "C-x SPC M-y SPC C-j SPC TAB SPC RET SPC C-l 1 2 3" |
5e8db0c6 RS |
412 | @end group |
413 | @group | |
7f0afecc EZ |
414 | (single-key-description 'delete) |
415 | @result{} "<delete>" | |
416 | @end group | |
417 | @group | |
5e8db0c6 | 418 | (single-key-description 'C-mouse-1) |
7f0afecc EZ |
419 | @result{} "<C-mouse-1>" |
420 | @end group | |
421 | @group | |
422 | (single-key-description 'C-mouse-1 t) | |
5e8db0c6 RS |
423 | @result{} "C-mouse-1" |
424 | @end group | |
425 | @end smallexample | |
426 | @end defun | |
427 | ||
428 | @defun text-char-description character | |
429 | This function returns a string describing @var{character} in the | |
430 | standard Emacs notation for characters that appear in text---like | |
431 | @code{single-key-description}, except that control characters are | |
432 | represented with a leading caret (which is how control characters in | |
433 | Emacs buffers are usually displayed). | |
434 | ||
435 | @smallexample | |
436 | @group | |
437 | (text-char-description ?\C-c) | |
438 | @result{} "^C" | |
439 | @end group | |
440 | @group | |
441 | (text-char-description ?\M-m) | |
442 | @result{} "M-m" | |
443 | @end group | |
444 | @group | |
445 | (text-char-description ?\C-\M-m) | |
446 | @result{} "M-^M" | |
447 | @end group | |
448 | @end smallexample | |
449 | @end defun | |
450 | ||
a9f0a989 RS |
451 | @defun read-kbd-macro string |
452 | This function is used mainly for operating on keyboard macros, but it | |
453 | can also be used as a rough inverse for @code{key-description}. You | |
454 | call it with a string containing key descriptions, separated by spaces; | |
455 | it returns a string or vector containing the corresponding events. | |
456 | (This may or may not be a single valid key sequence, depending on what | |
457 | events you use; @pxref{Keymap Terminology}.) | |
458 | @end defun | |
459 | ||
5e8db0c6 RS |
460 | @node Help Functions |
461 | @section Help Functions | |
462 | ||
463 | Emacs provides a variety of on-line help functions, all accessible to | |
464 | the user as subcommands of the prefix @kbd{C-h}. For more information | |
465 | about them, see @ref{Help, , Help, emacs, The GNU Emacs Manual}. Here | |
466 | we describe some program-level interfaces to the same information. | |
467 | ||
969fe9b5 | 468 | @deffn Command apropos regexp &optional do-all |
82a2fe69 RS |
469 | This function finds all symbols whose names contain a match for the |
470 | regular expression @var{regexp}, and returns a list of them | |
471 | (@pxref{Regular Expressions}). It also displays the symbols in a buffer | |
f9f59935 RS |
472 | named @samp{*Help*}, each with a one-line description taken from the |
473 | beginning of its documentation string. | |
5e8db0c6 RS |
474 | |
475 | @c Emacs 19 feature | |
a9f0a989 RS |
476 | If @var{do-all} is non-@code{nil}, then @code{apropos} also shows key |
477 | bindings for the functions that are found; it also shows all symbols, | |
478 | even those that are neither functions nor variables. | |
5e8db0c6 | 479 | |
82a2fe69 | 480 | In the first of the following examples, @code{apropos} finds all the |
969fe9b5 RS |
481 | symbols with names containing @samp{exec}. (We don't show here the |
482 | output that results in the @samp{*Help*} buffer.) | |
5e8db0c6 RS |
483 | |
484 | @smallexample | |
485 | @group | |
486 | (apropos "exec") | |
487 | @result{} (Buffer-menu-execute command-execute exec-directory | |
488 | exec-path execute-extended-command execute-kbd-macro | |
489 | executing-kbd-macro executing-macro) | |
490 | @end group | |
5e8db0c6 | 491 | @end smallexample |
5e8db0c6 RS |
492 | @end deffn |
493 | ||
494 | @defvar help-map | |
495 | The value of this variable is a local keymap for characters following the | |
496 | Help key, @kbd{C-h}. | |
497 | @end defvar | |
498 | ||
499 | @deffn {Prefix Command} help-command | |
f9f59935 | 500 | This symbol is not a function; its function definition cell holds the |
5e8db0c6 RS |
501 | keymap known as @code{help-map}. It is defined in @file{help.el} as |
502 | follows: | |
503 | ||
504 | @smallexample | |
505 | @group | |
506 | (define-key global-map "\C-h" 'help-command) | |
507 | (fset 'help-command help-map) | |
508 | @end group | |
509 | @end smallexample | |
510 | @end deffn | |
511 | ||
512 | @defun print-help-return-message &optional function | |
82a2fe69 RS |
513 | This function builds a string that explains how to restore the previous |
514 | state of the windows after a help command. After building the message, | |
515 | it applies @var{function} to it if @var{function} is non-@code{nil}. | |
516 | Otherwise it calls @code{message} to display it in the echo area. | |
5e8db0c6 RS |
517 | |
518 | This function expects to be called inside a | |
519 | @code{with-output-to-temp-buffer} special form, and expects | |
520 | @code{standard-output} to have the value bound by that special form. | |
521 | For an example of its use, see the long example in @ref{Accessing | |
522 | Documentation}. | |
523 | @end defun | |
524 | ||
525 | @defvar help-char | |
526 | The value of this variable is the help character---the character that | |
a9f0a989 RS |
527 | Emacs recognizes as meaning Help. By default, its value is 8, which |
528 | stands for @kbd{C-h}. When Emacs reads this character, if | |
529 | @code{help-form} is a non-@code{nil} Lisp expression, it evaluates that | |
530 | expression, and displays the result in a window if it is a string. | |
5e8db0c6 | 531 | |
1911e6e5 | 532 | Usually the value of @code{help-form} is @code{nil}. Then the |
5e8db0c6 RS |
533 | help character has no special meaning at the level of command input, and |
534 | it becomes part of a key sequence in the normal way. The standard key | |
535 | binding of @kbd{C-h} is a prefix key for several general-purpose help | |
536 | features. | |
537 | ||
538 | The help character is special after prefix keys, too. If it has no | |
539 | binding as a subcommand of the prefix key, it runs | |
540 | @code{describe-prefix-bindings}, which displays a list of all the | |
541 | subcommands of the prefix key. | |
542 | @end defvar | |
543 | ||
969fe9b5 RS |
544 | @defvar help-event-list |
545 | The value of this variable is a list of event types that serve as | |
546 | alternative ``help characters.'' These events are handled just like the | |
547 | event specified by @code{help-char}. | |
548 | @end defvar | |
549 | ||
5e8db0c6 RS |
550 | @defvar help-form |
551 | If this variable is non-@code{nil}, its value is a form to evaluate | |
552 | whenever the character @code{help-char} is read. If evaluating the form | |
553 | produces a string, that string is displayed. | |
554 | ||
555 | A command that calls @code{read-event} or @code{read-char} probably | |
556 | should bind @code{help-form} to a non-@code{nil} expression while it | |
969fe9b5 RS |
557 | does input. (The time when you should not do this is when @kbd{C-h} has |
558 | some other meaning.) Evaluating this expression should result in a | |
559 | string that explains what the input is for and how to enter it properly. | |
5e8db0c6 RS |
560 | |
561 | Entry to the minibuffer binds this variable to the value of | |
562 | @code{minibuffer-help-form} (@pxref{Minibuffer Misc}). | |
563 | @end defvar | |
564 | ||
565 | @defvar prefix-help-command | |
969fe9b5 RS |
566 | This variable holds a function to print help for a prefix key. The |
567 | function is called when the user types a prefix key followed by the help | |
568 | character, and the help character has no binding after that prefix. The | |
569 | variable's default value is @code{describe-prefix-bindings}. | |
5e8db0c6 RS |
570 | @end defvar |
571 | ||
572 | @defun describe-prefix-bindings | |
573 | This function calls @code{describe-bindings} to display a list of all | |
574 | the subcommands of the prefix key of the most recent key sequence. The | |
575 | prefix described consists of all but the last event of that key | |
82a2fe69 | 576 | sequence. (The last event is, presumably, the help character.) |
5e8db0c6 RS |
577 | @end defun |
578 | ||
a9f0a989 RS |
579 | The following two functions are meant for modes that want to provide |
580 | help without relinquishing control, such as the ``electric'' modes. | |
581 | Their names begin with @samp{Helper} to distinguish them from the | |
582 | ordinary help functions. | |
5e8db0c6 RS |
583 | |
584 | @deffn Command Helper-describe-bindings | |
585 | This command pops up a window displaying a help buffer containing a | |
586 | listing of all of the key bindings from both the local and global keymaps. | |
587 | It works by calling @code{describe-bindings}. | |
588 | @end deffn | |
589 | ||
590 | @deffn Command Helper-help | |
591 | This command provides help for the current mode. It prompts the user | |
592 | in the minibuffer with the message @samp{Help (Type ? for further | |
593 | options)}, and then provides assistance in finding out what the key | |
594 | bindings are, and what the mode is intended for. It returns @code{nil}. | |
595 | ||
596 | This can be customized by changing the map @code{Helper-help-map}. | |
597 | @end deffn | |
598 | ||
599 | @c Emacs 19 feature | |
600 | @defvar data-directory | |
601 | This variable holds the name of the directory in which Emacs finds | |
602 | certain documentation and text files that come with Emacs. In older | |
603 | Emacs versions, @code{exec-directory} was used for this. | |
604 | @end defvar | |
605 | ||
606 | @c Emacs 19 feature | |
607 | @defmac make-help-screen fname help-line help-text help-map | |
177c0ea7 | 608 | This macro defines a help command named @var{fname} that acts like a |
82a2fe69 | 609 | prefix key that shows a list of the subcommands it offers. |
5e8db0c6 RS |
610 | |
611 | When invoked, @var{fname} displays @var{help-text} in a window, then | |
612 | reads and executes a key sequence according to @var{help-map}. The | |
82a2fe69 | 613 | string @var{help-text} should describe the bindings available in |
5e8db0c6 RS |
614 | @var{help-map}. |
615 | ||
616 | The command @var{fname} is defined to handle a few events itself, by | |
617 | scrolling the display of @var{help-text}. When @var{fname} reads one of | |
618 | those special events, it does the scrolling and then reads another | |
82a2fe69 | 619 | event. When it reads an event that is not one of those few, and which |
5e8db0c6 RS |
620 | has a binding in @var{help-map}, it executes that key's binding and |
621 | then returns. | |
622 | ||
623 | The argument @var{help-line} should be a single-line summary of the | |
624 | alternatives in @var{help-map}. In the current version of Emacs, this | |
625 | argument is used only if you set the option @code{three-step-help} to | |
626 | @code{t}. | |
f9f59935 RS |
627 | |
628 | This macro is used in the command @code{help-for-help} which is the | |
629 | binding of @kbd{C-h C-h}. | |
5e8db0c6 RS |
630 | @end defmac |
631 | ||
632 | @defopt three-step-help | |
633 | If this variable is non-@code{nil}, commands defined with | |
634 | @code{make-help-screen} display their @var{help-line} strings in the | |
635 | echo area at first, and display the longer @var{help-text} strings only | |
636 | if the user types the help character again. | |
637 | @end defopt | |
ab5796a9 MB |
638 | |
639 | @ignore | |
640 | arch-tag: ba36b4c2-e60f-49e2-bc25-61158fdcd815 | |
641 | @end ignore |