Mercurial > emacs
annotate man/help.texi @ 71879:d236eeffa8f7
*** empty log message ***
author | Kim F. Storm <storm@cua.dk> |
---|---|
date | Thu, 13 Jul 2006 22:52:49 +0000 |
parents | 2bce43489a02 |
children | 933b9c047ad0 138ce2701550 |
rev | line source |
---|---|
25829 | 1 @c This is part of the Emacs manual. |
64890
3723093a21fd
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
60991
diff
changeset
|
2 @c Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1997, 2000, 2001, |
68639
dc2d5a6655a3
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
68509
diff
changeset
|
3 @c 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc. |
25829 | 4 @c See file emacs.texi for copying conditions. |
5 @node Help, Mark, M-x, Top | |
6 @chapter Help | |
7 @kindex Help | |
8 @cindex help | |
9 @cindex self-documentation | |
10 @findex help-command | |
11 @kindex C-h | |
12 @kindex F1 | |
13 | |
71585 | 14 Emacs provides extensive help features, all accessible through the |
15 @dfn{help character}, @kbd{C-h}. This is a prefix key that is used | |
16 for commands that display documentation; the next character you type | |
17 should be a @dfn{help options}, to ask for a particular kind of help. | |
18 You can cancel the @kbd{C-h} command with @kbd{C-g}. The function key | |
19 @key{F1} is equivalent to @kbd{C-h}. | |
25829 | 20 |
21 @kindex C-h C-h | |
22 @findex help-for-help | |
71585 | 23 @kbd{C-h} itself is one of the help options; @kbd{C-h C-h} displays |
24 a list of help options, with a brief description of each one | |
25 (@code{help-for-help}). You can scroll the list with @key{SPC} and | |
26 @key{DEL}, then type the help option you want. To cancel, type | |
27 @kbd{C-g}. | |
25829 | 28 |
29 @kbd{C-h} or @key{F1} means ``help'' in various other contexts as | |
71585 | 30 well. For instance, you can type them after a prefix key to display |
31 list of the keys that can follow the prefix key. (A few prefix keys | |
32 don't support @kbd{C-h} in this way, because they define other | |
33 meanings for it, but they all support @key{F1} for help.) | |
25829 | 34 |
71585 | 35 Most help buffers use a special major mode, Help mode, which lets |
36 you scroll conveniently with @key{SPC} and @key{DEL}. You can also | |
37 follow hyperlinks to URLs, and to other facilities including Info | |
38 nodes and customization buffers. @xref{Help Mode}. | |
25829 | 39 |
32276
49a967404304
(Help): Describe an orderly procedure to find features in the docs.
Eli Zaretskii <eliz@gnu.org>
parents:
30801
diff
changeset
|
40 @cindex searching documentation efficiently |
49a967404304
(Help): Describe an orderly procedure to find features in the docs.
Eli Zaretskii <eliz@gnu.org>
parents:
30801
diff
changeset
|
41 @cindex looking for a subject in documentation |
71585 | 42 If you are looking for a certain feature, but don't know what it is |
43 called or where to look, we recommend three methods. First, try an | |
44 apropos command, then try searching the manual index, then look in the | |
45 FAQ and the package keywords. | |
32276
49a967404304
(Help): Describe an orderly procedure to find features in the docs.
Eli Zaretskii <eliz@gnu.org>
parents:
30801
diff
changeset
|
46 |
49a967404304
(Help): Describe an orderly procedure to find features in the docs.
Eli Zaretskii <eliz@gnu.org>
parents:
30801
diff
changeset
|
47 @table @kbd |
67514
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
48 @item C-h a @var{topics} @key{RET} |
71585 | 49 This searches for commands whose names match the argument |
50 @var{topics}. The argument can be a keyword, a list of keywords, or a | |
51 regular expression (@pxref{Regexps}). This command displays all the | |
52 matches in a new buffer. @xref{Apropos}. | |
32432 | 53 |
37151
3d209a687950
Add `d' after `C-h i' in examples.
Richard M. Stallman <rms@gnu.org>
parents:
36655
diff
changeset
|
54 @item C-h i d m emacs @key{RET} i @var{topic} @key{RET} |
71585 | 55 This searches for @var{topic} in the indices of the on-line Emacs |
56 manual, and displays the first match found. Press @kbd{,} to see | |
57 subsequent matches. You can use a regular expression as @var{topic}. | |
36159
41b70b041a5a
Clean up and move index-searching recommendation.
Richard M. Stallman <rms@gnu.org>
parents:
34024
diff
changeset
|
58 |
37151
3d209a687950
Add `d' after `C-h i' in examples.
Richard M. Stallman <rms@gnu.org>
parents:
36655
diff
changeset
|
59 @item C-h i d m emacs @key{RET} s @var{topic} @key{RET} |
71585 | 60 Similar, but searches the @emph{text} of the manual rather than the |
36159
41b70b041a5a
Clean up and move index-searching recommendation.
Richard M. Stallman <rms@gnu.org>
parents:
34024
diff
changeset
|
61 indices. |
41b70b041a5a
Clean up and move index-searching recommendation.
Richard M. Stallman <rms@gnu.org>
parents:
34024
diff
changeset
|
62 |
54473
6f6d287fe506
Sync keywords with finder.el.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
63 @item C-h C-f |
71585 | 64 This displays the Emacs FAQ. You can use the Info commands |
60106
2116c6a9e16c
(Help): Correct error about C-h in query-replace.
Richard M. Stallman <rms@gnu.org>
parents:
59798
diff
changeset
|
65 to browse it. |
32276
49a967404304
(Help): Describe an orderly procedure to find features in the docs.
Eli Zaretskii <eliz@gnu.org>
parents:
30801
diff
changeset
|
66 |
32362
c74db5a73b6f
Fix last change for docs search procedure (suggested by Dave Love).
Eli Zaretskii <eliz@gnu.org>
parents:
32276
diff
changeset
|
67 @item C-h p |
71585 | 68 This displays the available Emacs packages based on keywords. |
69 @xref{Library Keywords}. | |
32276
49a967404304
(Help): Describe an orderly procedure to find features in the docs.
Eli Zaretskii <eliz@gnu.org>
parents:
30801
diff
changeset
|
70 @end table |
49a967404304
(Help): Describe an orderly procedure to find features in the docs.
Eli Zaretskii <eliz@gnu.org>
parents:
30801
diff
changeset
|
71 |
25829 | 72 @menu |
73 * Help Summary:: Brief list of all Help commands. | |
74 * Key Help:: Asking what a key does in Emacs. | |
75 * Name Help:: Asking about a command, variable or function name. | |
76 * Apropos:: Asking what pertains to a given topic. | |
77 * Library Keywords:: Finding Lisp libraries by keywords (topics). | |
78 * Language Help:: Help relating to international language support. | |
79 * Help Mode:: Special features of Help mode and Help buffers. | |
80 * Misc Help:: Other help commands. | |
46243
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
81 * Help Files:: Commands to display pre-written help files. |
28433 | 82 * Help Echo:: Help on active text and tooltips (`balloon help') |
25829 | 83 @end menu |
84 | |
85 @iftex | |
86 @node Help Summary | |
87 @end iftex | |
55626 | 88 @ifnottex |
25829 | 89 @node Help Summary |
90 @section Help Summary | |
55626 | 91 @end ifnottex |
25829 | 92 |
71585 | 93 Here is a summary of the Emacs interactive help commands. (The |
94 character that follows @kbd{C-h} is the ``help option.'') @xref{Help | |
95 Files}, for other help commands that display fixed files of | |
96 information. | |
25829 | 97 |
98 @table @kbd | |
67514
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
99 @item C-h a @var{topics} @key{RET} |
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
100 Display a list of commands whose names match @var{topics} |
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
101 (@code{apropos-command}; @pxref{Apropos}). |
25829 | 102 @item C-h b |
71585 | 103 Display all active key bindings; minor mode bindings first, then those |
104 of the major mode, then global bindings (@code{describe-bindings}). | |
25829 | 105 @item C-h c @var{key} |
71585 | 106 Given a key sequence @var{key}, show the name of the command that it |
107 runs (@code{describe-key-briefly}). Here @kbd{c} stands for | |
108 ``character.'' For more extensive information on @var{key}, use | |
109 @kbd{C-h k}. | |
67514
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
110 @item C-h d @var{topics} @key{RET} |
71585 | 111 Display the commands and variables whose documentation matches |
67514
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
112 @var{topics} (@code{apropos-documentation}). |
66827
5163ae9b5c75
(Help): Fix C-h a entry. Add C-h d entry.
Kim F. Storm <storm@cua.dk>
parents:
66746
diff
changeset
|
113 @item C-h e |
5163ae9b5c75
(Help): Fix C-h a entry. Add C-h d entry.
Kim F. Storm <storm@cua.dk>
parents:
66746
diff
changeset
|
114 Display the @code{*Messages*} buffer |
5163ae9b5c75
(Help): Fix C-h a entry. Add C-h d entry.
Kim F. Storm <storm@cua.dk>
parents:
66746
diff
changeset
|
115 (@code{view-echo-area-messages}). |
25829 | 116 @item C-h f @var{function} @key{RET} |
117 Display documentation on the Lisp function named @var{function} | |
118 (@code{describe-function}). Since commands are Lisp functions, | |
71585 | 119 this works for commands too. |
25829 | 120 @item C-h h |
37151
3d209a687950
Add `d' after `C-h i' in examples.
Richard M. Stallman <rms@gnu.org>
parents:
36655
diff
changeset
|
121 Display the @file{HELLO} file, which shows examples of various character |
25829 | 122 sets. |
123 @item C-h i | |
71585 | 124 Run Info, the GNU documentation browser (@code{info}). |
25829 | 125 The complete Emacs manual is available on-line in Info. |
126 @item C-h k @var{key} | |
127 Display the name and documentation of the command that @var{key} runs | |
128 (@code{describe-key}). | |
129 @item C-h l | |
130 Display a description of the last 100 characters you typed | |
131 (@code{view-lossage}). | |
132 @item C-h m | |
133 Display documentation of the current major mode (@code{describe-mode}). | |
134 @item C-h p | |
135 Find packages by topic keyword (@code{finder-by-keyword}). | |
136 @item C-h s | |
71585 | 137 Display the current contents of the syntax table, with an explanation of |
25829 | 138 what they mean (@code{describe-syntax}). @xref{Syntax}. |
139 @item C-h t | |
140 Enter the Emacs interactive tutorial (@code{help-with-tutorial}). | |
141 @item C-h v @var{var} @key{RET} | |
38488 | 142 Display the documentation of the Lisp variable @var{var} |
25829 | 143 (@code{describe-variable}). |
144 @item C-h w @var{command} @key{RET} | |
38488 | 145 Show which keys run the command named @var{command} (@code{where-is}). |
25829 | 146 @item C-h C @var{coding} @key{RET} |
71585 | 147 Describe the coding system @var{coding} |
25829 | 148 (@code{describe-coding-system}). |
149 @item C-h C @key{RET} | |
150 Describe the coding systems currently in use. | |
151 @item C-h I @var{method} @key{RET} | |
71585 | 152 Describe the input method @var{method} (@code{describe-input-method}). |
25829 | 153 @item C-h L @var{language-env} @key{RET} |
38745 | 154 Display information on the character sets, coding systems, and input |
71585 | 155 methods used in language environment @var{language-env} |
25829 | 156 (@code{describe-language-environment}). |
46243
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
157 @item C-h F @var{function} @key{RET} |
71585 | 158 Enter Info and goes to the node that documents the Emacs function |
159 @var{function} (@code{Info-goto-emacs-command-node}). | |
46243
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
160 @item C-h K @var{key} |
71585 | 161 Enter Info and goes to the node that documents the key sequence |
162 @var{key} (@code{Info-goto-emacs-key-command-node}). | |
46243
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
163 @item C-h S @var{symbol} @key{RET} |
25829 | 164 Display the Info documentation on symbol @var{symbol} according to the |
165 programming language you are editing (@code{info-lookup-symbol}). | |
60953
ec2b6eebb74a
(Help Summary): Add `C-h .'.
Richard M. Stallman <rms@gnu.org>
parents:
60794
diff
changeset
|
166 @item C-h . |
71585 | 167 Display the help message for a special text area, if point is in one |
168 (@code{display-local-help}). (These include, for example, links in | |
169 @samp{*Help*} buffers.) | |
25829 | 170 @end table |
171 | |
172 @node Key Help | |
173 @section Documentation for a Key | |
174 | |
175 @kindex C-h c | |
176 @findex describe-key-briefly | |
71585 | 177 The help commands to get information about a key sequence are |
178 @kbd{C-h c} and @w{@kbd{C-h k}}. @kbd{C-h c @var{key}} displays in | |
179 the echo area the name of the command that @var{key} is bound to. For | |
180 example, @kbd{C-h c C-f} displays @samp{forward-char}. Since command | |
181 names are chosen to describe what the commands do, this gives you a | |
182 very brief description of what @var{key} does. | |
25829 | 183 |
184 @kindex C-h k | |
185 @findex describe-key | |
186 @kbd{C-h k @var{key}} is similar but gives more information: it | |
187 displays the documentation string of the command as well as its name. | |
71585 | 188 It displays this information in a window, since it may not fit in the |
189 echo area. | |
25829 | 190 |
68509 | 191 @kindex C-h K |
192 @findex Info-goto-emacs-key-command-node | |
71585 | 193 To find the documentation of a key sequence @var{key}, type @kbd{C-h |
194 K @var{key}}. This displays the appropriate manual section which | |
195 contains the documentation of @var{key}. | |
68509 | 196 |
197 @kbd{C-h c}, @kbd{C-h k} and @kbd{C-h K} work for any sort of key | |
198 sequences, including function keys, menus, and mouse events. For | |
71585 | 199 instance, after @kbd{C-h k} you can select a menu item from the menu |
200 bar, to view the documentation string of the command it runs. | |
25829 | 201 |
60106
2116c6a9e16c
(Help): Correct error about C-h in query-replace.
Richard M. Stallman <rms@gnu.org>
parents:
59798
diff
changeset
|
202 @kindex C-h w |
2116c6a9e16c
(Help): Correct error about C-h in query-replace.
Richard M. Stallman <rms@gnu.org>
parents:
59798
diff
changeset
|
203 @findex where-is |
71585 | 204 @kbd{C-h w @var{command} @key{RET}} lists the keys that are bound to |
205 @var{command}. It displays the list in the echo area. If it says the | |
206 command is not on any key, that means you must use @kbd{M-x} to run | |
207 it. @kbd{C-h w} runs the command @code{where-is}. | |
60106
2116c6a9e16c
(Help): Correct error about C-h in query-replace.
Richard M. Stallman <rms@gnu.org>
parents:
59798
diff
changeset
|
208 |
25829 | 209 @node Name Help |
210 @section Help by Command or Variable Name | |
211 | |
212 @kindex C-h f | |
213 @findex describe-function | |
71585 | 214 @kbd{C-h f @var{function} @key{RET}} (@code{describe-function}) |
215 displays the documentation of Lisp function @var{function}, in a | |
216 window. Since commands are Lisp functions, you can use this method to | |
217 view the documentation of any command whose name you know. For | |
218 example, | |
25829 | 219 |
220 @example | |
221 C-h f auto-fill-mode @key{RET} | |
222 @end example | |
223 | |
224 @noindent | |
225 displays the documentation of @code{auto-fill-mode}. This is the only | |
226 way to get the documentation of a command that is not bound to any key | |
227 (one which you would normally run using @kbd{M-x}). | |
228 | |
71585 | 229 @kbd{C-h f} is also useful for Lisp functions that you use in a Lisp |
230 program. For example, if you have just written the expression | |
231 @code{(make-vector len)} and want to check that you are using | |
232 @code{make-vector} properly, type @kbd{C-h f make-vector @key{RET}}. | |
233 Because @kbd{C-h f} allows all function names, not just command names, | |
234 you may find that some of your favorite completion abbreviations that | |
235 work in @kbd{M-x} don't work in @kbd{C-h f}. An abbreviation that is | |
236 unique among command names may not be unique among all function names. | |
25829 | 237 |
71585 | 238 If you type @kbd{C-h f @key{RET}}, it describes the function called |
239 by the innermost Lisp expression in the buffer around point, | |
240 @emph{provided} that function name is a valid, defined Lisp function. | |
241 (That name appears as the default while you enter the argument.) For | |
242 example, if point is located following the text @samp{(make-vector | |
243 (car x)}, the innermost list containing point is the one that starts | |
244 with @samp{(make-vector}, so @kbd{C-h f @key{RET}} will describe the | |
245 function @code{make-vector}. | |
25829 | 246 |
71585 | 247 @kbd{C-h f} is also useful just to verify that you spelled a |
248 function name correctly. If the minibuffer prompt for @kbd{C-h f} | |
249 shows the function name from the buffer as the default, it means that | |
250 name is defined as a Lisp function. Type @kbd{C-g} to cancel the | |
251 @kbd{C-h f} command if you don't really want to view the | |
252 documentation. | |
25829 | 253 |
71585 | 254 @kbd{C-h v} (@code{describe-variable}) is like @kbd{C-h f} but |
255 describes Lisp variables instead of Lisp functions. Its default is | |
256 the Lisp symbol around or before point, if that is the name of a | |
257 defined Lisp variable. @xref{Variables}. | |
25829 | 258 |
71585 | 259 Help buffers that describe Emacs variables and functions normally |
260 have hyperlinks to the corresponding source definition, if you have | |
261 the source files installed. (@xref{Hyperlinking}.) If you know Lisp | |
262 (or C), this provides the ultimate documentation. If you don't know | |
263 Lisp, you should learn it. (The Introduction to Emacs Lisp | |
264 Programming, available from the FSF through fsf.org, is a good way to | |
265 get started.) If Emacs feels you are just @emph{using} it, treating | |
266 it as an object program, its feelings may be hurt. For real intimacy, | |
267 read the Emacs source code. | |
68509 | 268 |
269 @kindex C-h F | |
270 @findex Info-goto-emacs-command-node | |
71585 | 271 To find a function's documentation in a manual, use @kbd{C-h F} |
272 (@code{Info-goto-emacs-command-node}). This knows about various | |
273 manuals, not just the Emacs manual, and finds the right one. | |
36159
41b70b041a5a
Clean up and move index-searching recommendation.
Richard M. Stallman <rms@gnu.org>
parents:
34024
diff
changeset
|
274 |
25829 | 275 @node Apropos |
276 @section Apropos | |
277 | |
71585 | 278 The @dfn{apropos} commands answer questions like, ``What are the |
279 commands for working with files?'' More precisely, you specify an | |
67514
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
280 @dfn{apropos pattern}, which means either a word, a list of words, or |
71585 | 281 a regular expression. Each apropos command displays a list of items |
282 that match the pattern, in a separate buffer. | |
67514
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
283 |
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
284 @table @kbd |
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
285 @item C-h a @var{pattern} @key{RET} |
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
286 Search for commands whose names match @var{pattern}. |
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
287 |
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
288 @item M-x apropos @key{RET} @var{pattern} @key{RET} |
71585 | 289 Search for functions and variables whose names match @var{pattern}. |
290 Both interactive functions (commands) and noninteractive functions can | |
291 be found by this command. | |
67514
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
292 |
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
293 @item M-x apropos-variable @key{RET} @var{pattern} @key{RET} |
71585 | 294 Search for user-option variables whose names match @var{pattern}. |
67514
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
295 |
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
296 @item M-x apropos-value @key{RET} @var{pattern} @key{RET} |
71585 | 297 Search for functions whose definitions @var{pattern}, and variables |
298 whose values match @var{pattern}. | |
67514
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
299 |
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
300 @item C-h d @var{pattern} @key{RET} |
71585 | 301 Search for functions and variables whose @strong{documentation |
302 strings} match @var{pattern}. | |
67514
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
303 @end table |
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
304 |
25829 | 305 @kindex C-h a |
306 @findex apropos-command | |
307 @cindex apropos | |
71585 | 308 The simplest kind of apropos pattern is one word. Anything which |
309 contains that word matches the pattern. Thus, to find the commands | |
310 that work on files, type @kbd{C-h a file @key{RET}}. This displays a | |
311 list of all command names that contain @samp{file}, including | |
312 @code{copy-file}, @code{find-file}, and so on. Each command name | |
313 comes with a brief description and a list of keys you can currently | |
314 invoke it with. In our example, it would say that you can invoke | |
315 @code{find-file} by typing @kbd{C-x C-f}. | |
316 | |
317 The @kbd{a} in @kbd{C-h a} stands for ``Apropos''; @kbd{C-h a} | |
67514
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
318 runs the command @code{apropos-command}. This command normally checks |
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
319 only commands (interactive functions); if you specify a prefix |
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
320 argument, it checks noninteractive functions as well. |
25829 | 321 |
71585 | 322 For more information about a function definition, variable or symbol |
323 property listed in the apropos buffer, you can click on it with | |
67514
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
324 @kbd{Mouse-1} or @kbd{Mouse-2}, or move there and type @key{RET}. |
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
325 |
71585 | 326 When you specify more than one word in the apropos pattern, a name |
67514
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
327 must contain at least two of the words in order to match. Thus, if |
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
328 you are looking for commands to kill a chunk of text before point, you |
71585 | 329 could try @kbd{C-h a kill back backward behind before @key{RET}}. The |
330 real command name @code{kill-backward} will match that; if there were | |
331 a command @code{kill-text-before}, it would also match, since it | |
332 contains two of the specified words. | |
67514
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
333 |
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
334 For even greater flexibility, you can specify a regular expression |
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
335 (@pxref{Regexps}). An apropos pattern is interpreted as a regular |
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
336 expression if it contains any of the regular expression special |
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
337 characters, @samp{^$*+?.\[}. |
25829 | 338 |
71585 | 339 Following the conventions for naming Emacs commands, here are some |
340 words that you'll find useful in apropos patterns. By using them in | |
341 @kbd{C-h a}, you will also get a feel for the naming conventions. | |
25829 | 342 |
343 @quotation | |
344 char, line, word, sentence, paragraph, region, page, sexp, list, defun, | |
345 rect, buffer, frame, window, face, file, dir, register, mode, beginning, end, | |
346 forward, backward, next, previous, up, down, search, goto, kill, delete, | |
347 mark, insert, yank, fill, indent, case, change, set, what, list, find, | |
348 view, describe, default. | |
349 @end quotation | |
350 | |
67514
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
351 @findex apropos |
71585 | 352 Use @kbd{M-x apropos} instead of @kbd{C-h a} to list all the Lisp |
353 symbols that match an apropos pattern, not just the symbols that are | |
354 commands. This command does not list key bindings by default; specify | |
355 a numeric argument if you want it to list them. | |
25829 | 356 |
67514
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
357 @findex apropos-variable |
71585 | 358 Use @kbd{M-x apropos-variable} to list user-customizable variables |
359 that match an apropos pattern. If you specify a prefix argument, it | |
360 lists all matching variables. | |
25829 | 361 |
66827
5163ae9b5c75
(Help): Fix C-h a entry. Add C-h d entry.
Kim F. Storm <storm@cua.dk>
parents:
66746
diff
changeset
|
362 @kindex C-h d |
25829 | 363 @findex apropos-documentation |
67514
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
364 The @code{apropos-documentation} command is like @code{apropos} |
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
365 except that it searches documentation strings instead of symbol names |
71585 | 366 for matches. |
25829 | 367 |
368 @findex apropos-value | |
67514
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
369 The @code{apropos-value} command is like @code{apropos} except that |
71585 | 370 it searches variables' values for matches for the apropos pattern. |
371 With a prefix argument, it also checks symbols' function definitions | |
372 and property lists. | |
25829 | 373 |
374 @vindex apropos-do-all | |
71585 | 375 If the variable @code{apropos-do-all} is non-@code{nil}, the apropos |
376 commands always behave as if they had been given a prefix argument. | |
25829 | 377 |
60953
ec2b6eebb74a
(Help Summary): Add `C-h .'.
Richard M. Stallman <rms@gnu.org>
parents:
60794
diff
changeset
|
378 @vindex apropos-sort-by-scores |
60991
1978175440c1
(Emacs Server): Fix the command for setting server-name.
Eli Zaretskii <eliz@gnu.org>
parents:
60953
diff
changeset
|
379 @cindex apropos search results, order by score |
71585 | 380 By default, apropos lists the search results in alphabetical order. |
381 If the variable @code{apropos-sort-by-scores} is non-@code{nil}, the | |
382 apropos commands try to guess the relevance of each result, and | |
383 display the most relevant ones first. | |
60953
ec2b6eebb74a
(Help Summary): Add `C-h .'.
Richard M. Stallman <rms@gnu.org>
parents:
60794
diff
changeset
|
384 |
66827
5163ae9b5c75
(Help): Fix C-h a entry. Add C-h d entry.
Kim F. Storm <storm@cua.dk>
parents:
66746
diff
changeset
|
385 @vindex apropos-documentation-sort-by-scores |
71585 | 386 By default, apropos lists the search results for |
67514
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
387 @code{apropos-documentation} in order of relevance of the match. If |
b33e99f74b5e
(Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents:
66827
diff
changeset
|
388 the variable @code{apropos-documentation-sort-by-scores} is |
71585 | 389 @code{nil}, apropos lists the symbols found in alphabetical order. |
25829 | 390 |
391 @node Library Keywords | |
392 @section Keyword Search for Lisp Libraries | |
393 | |
394 @kindex C-h p | |
395 @findex finder-by-keyword | |
396 The @kbd{C-h p} command lets you search the standard Emacs Lisp | |
397 libraries by topic keywords. Here is a partial list of keywords you can | |
398 use: | |
399 | |
70407
0c8d6310fd45
reduce body text size for emacs manual to 10pt
Karl Berry <karl@gnu.org>
parents:
69742
diff
changeset
|
400 @multitable {convenience} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} |
51790
0a8de3bc39b5
(Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents:
46243
diff
changeset
|
401 @item abbrev@tab abbreviation handling, typing shortcuts, macros. |
54473
6f6d287fe506
Sync keywords with finder.el.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
402 @item bib@tab code related to the @code{bib} bibliography processor. |
6f6d287fe506
Sync keywords with finder.el.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
403 @item c@tab support for the C language and related languages. |
51790
0a8de3bc39b5
(Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents:
46243
diff
changeset
|
404 @item calendar@tab calendar and time management support. |
0a8de3bc39b5
(Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents:
46243
diff
changeset
|
405 @item comm@tab communications, networking, remote access to files. |
54473
6f6d287fe506
Sync keywords with finder.el.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
406 @item convenience@tab convenience features for faster editing. |
51790
0a8de3bc39b5
(Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents:
46243
diff
changeset
|
407 @item data@tab support for editing files of data. |
0a8de3bc39b5
(Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents:
46243
diff
changeset
|
408 @item docs@tab support for Emacs documentation. |
0a8de3bc39b5
(Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents:
46243
diff
changeset
|
409 @item emulations@tab emulations of other editors. |
0a8de3bc39b5
(Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents:
46243
diff
changeset
|
410 @item extensions@tab Emacs Lisp language extensions. |
54473
6f6d287fe506
Sync keywords with finder.el.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
411 @item faces@tab support for multiple fonts. |
6f6d287fe506
Sync keywords with finder.el.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
412 @item files@tab support for editing and manipulating files. |
51790
0a8de3bc39b5
(Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents:
46243
diff
changeset
|
413 @item frames@tab support for Emacs frames and window systems. |
0a8de3bc39b5
(Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents:
46243
diff
changeset
|
414 @item games@tab games, jokes and amusements. |
0a8de3bc39b5
(Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents:
46243
diff
changeset
|
415 @item hardware@tab support for interfacing with exotic hardware. |
0a8de3bc39b5
(Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents:
46243
diff
changeset
|
416 @item help@tab support for on-line help systems. |
54473
6f6d287fe506
Sync keywords with finder.el.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
417 @item hypermedia@tab support for links between text or other media types. |
51790
0a8de3bc39b5
(Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents:
46243
diff
changeset
|
418 @item i18n@tab internationalization and alternate character-set support. |
0a8de3bc39b5
(Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents:
46243
diff
changeset
|
419 @item internal@tab code for Emacs internals, build process, defaults. |
0a8de3bc39b5
(Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents:
46243
diff
changeset
|
420 @item languages@tab specialized modes for editing programming languages. |
54473
6f6d287fe506
Sync keywords with finder.el.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
421 @item lisp@tab Lisp support, including Emacs Lisp. |
6f6d287fe506
Sync keywords with finder.el.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
422 @item local@tab code local to your site. |
51790
0a8de3bc39b5
(Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents:
46243
diff
changeset
|
423 @item maint@tab maintenance aids for the Emacs development group. |
0a8de3bc39b5
(Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents:
46243
diff
changeset
|
424 @item mail@tab modes for electronic-mail handling. |
54473
6f6d287fe506
Sync keywords with finder.el.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
425 @item matching@tab various sorts of searching and matching. |
6f6d287fe506
Sync keywords with finder.el.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
426 @item mouse@tab mouse support. |
6f6d287fe506
Sync keywords with finder.el.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
427 @item multimedia@tab images and sound support. |
51790
0a8de3bc39b5
(Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents:
46243
diff
changeset
|
428 @item news@tab support for netnews reading and posting. |
0a8de3bc39b5
(Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents:
46243
diff
changeset
|
429 @item oop@tab support for object-oriented programming. |
54473
6f6d287fe506
Sync keywords with finder.el.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
430 @item outlines@tab support for hierarchical outlining. |
51790
0a8de3bc39b5
(Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents:
46243
diff
changeset
|
431 @item processes@tab process, subshell, compilation, and job control support. |
0a8de3bc39b5
(Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents:
46243
diff
changeset
|
432 @item terminals@tab support for terminal types. |
54473
6f6d287fe506
Sync keywords with finder.el.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
433 @item tex@tab supporting code for the @TeX{} formatter. |
51790
0a8de3bc39b5
(Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents:
46243
diff
changeset
|
434 @item tools@tab programming tools. |
54473
6f6d287fe506
Sync keywords with finder.el.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
435 @item unix@tab front-ends/assistants for, or emulators of, UNIX-like features. |
51790
0a8de3bc39b5
(Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents:
46243
diff
changeset
|
436 @item wp@tab word processing. |
0a8de3bc39b5
(Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents:
46243
diff
changeset
|
437 @end multitable |
25829 | 438 |
439 @node Language Help | |
440 @section Help for International Language Support | |
441 | |
442 You can use the command @kbd{C-h L} | |
71585 | 443 (@code{describe-language-environment}) to get information about a |
444 specific language environment. @xref{Language Environments}. This | |
445 tells you which languages this language environment supports. It also | |
446 lists the character sets, coding systems, and input methods that work | |
447 with this language environment, and finally shows some sample text to | |
448 illustrate scripts. | |
25829 | 449 |
450 The command @kbd{C-h h} (@code{view-hello-file}) displays the file | |
451 @file{etc/HELLO}, which shows how to say ``hello'' in many languages. | |
452 | |
71585 | 453 The command @kbd{C-h I} (@code{describe-input-method}) describes an |
454 input method---either a specified input method, or by default the | |
455 input method currently in use. @xref{Input Methods}. | |
25829 | 456 |
457 The command @kbd{C-h C} (@code{describe-coding-system}) describes | |
71585 | 458 coding systems---either a specified coding system, or the ones |
459 currently in use. @xref{Coding Systems}. | |
25829 | 460 |
461 @node Help Mode | |
462 @section Help Mode Commands | |
463 | |
38488 | 464 Help buffers provide the same commands as View mode (@pxref{Misc File |
465 Ops}), plus a few special commands of their own. | |
25829 | 466 |
467 @table @kbd | |
468 @item @key{SPC} | |
469 Scroll forward. | |
470 @item @key{DEL} | |
68509 | 471 Scroll backward. |
25829 | 472 @item @key{RET} |
473 Follow a cross reference at point. | |
474 @item @key{TAB} | |
475 Move point forward to the next cross reference. | |
476 @item S-@key{TAB} | |
477 Move point back to the previous cross reference. | |
60106
2116c6a9e16c
(Help): Correct error about C-h in query-replace.
Richard M. Stallman <rms@gnu.org>
parents:
59798
diff
changeset
|
478 @item Mouse-1 |
2116c6a9e16c
(Help): Correct error about C-h in query-replace.
Richard M. Stallman <rms@gnu.org>
parents:
59798
diff
changeset
|
479 @itemx Mouse-2 |
25829 | 480 Follow a cross reference that you click on. |
69588
d71425c5cd17
(Help Mode): Document "C-c C-c".
Luc Teirlinck <teirllm@auburn.edu>
parents:
68691
diff
changeset
|
481 @item C-c C-c |
d71425c5cd17
(Help Mode): Document "C-c C-c".
Luc Teirlinck <teirllm@auburn.edu>
parents:
68691
diff
changeset
|
482 Show all documentation about the symbol at point. |
25829 | 483 @end table |
484 | |
69588
d71425c5cd17
(Help Mode): Document "C-c C-c".
Luc Teirlinck <teirllm@auburn.edu>
parents:
68691
diff
changeset
|
485 When a function name (@pxref{M-x,, Running Commands by Name}), |
71585 | 486 variable name (@pxref{Variables}), or face name (@pxref{Faces}) |
487 appears in the documentation, it normally appears inside paired | |
488 single-quotes. To view the documentation of that command, variable or | |
489 face, you can click on the name with @kbd{Mouse-1} or @kbd{Mouse-2}, | |
490 or move point there and type @key{RET}. Use @kbd{C-c C-b} to retrace | |
491 your steps. | |
25829 | 492 |
66570
272a21a12d44
(Help Mode): URLs viewed with browse-url.
Bill Wohler <wohler@newt.com>
parents:
66515
diff
changeset
|
493 @cindex URL, viewing in help |
272a21a12d44
(Help Mode): URLs viewed with browse-url.
Bill Wohler <wohler@newt.com>
parents:
66515
diff
changeset
|
494 @cindex help, viewing web pages |
272a21a12d44
(Help Mode): URLs viewed with browse-url.
Bill Wohler <wohler@newt.com>
parents:
66515
diff
changeset
|
495 @cindex viewing web pages in help |
272a21a12d44
(Help Mode): URLs viewed with browse-url.
Bill Wohler <wohler@newt.com>
parents:
66515
diff
changeset
|
496 @cindex web pages, viewing in help |
272a21a12d44
(Help Mode): URLs viewed with browse-url.
Bill Wohler <wohler@newt.com>
parents:
66515
diff
changeset
|
497 @findex browse-url |
71585 | 498 You can follow cross references to URLs (web pages) also. This uses |
499 the @code{browse-url} command to view the page in the browser you | |
500 choose. @xref{Browse-URL}. | |
66570
272a21a12d44
(Help Mode): URLs viewed with browse-url.
Bill Wohler <wohler@newt.com>
parents:
66515
diff
changeset
|
501 |
25829 | 502 @kindex @key{TAB} @r{(Help mode)} |
503 @findex help-next-ref | |
504 @kindex S-@key{TAB} @r{(Help mode)} | |
505 @findex help-previous-ref | |
71585 | 506 There are convenient commands to move point to cross references in |
507 the help text. @key{TAB} (@code{help-next-ref}) moves point down to | |
508 the next cross reference. @kbd{S-@key{TAB}} moves up to the previous | |
509 cross reference (@code{help-previous-ref}). | |
25829 | 510 |
71585 | 511 To view all documentation about any symbol name that appears in the |
512 text, move point to the symbol name and type @kbd{C-c C-c} | |
69588
d71425c5cd17
(Help Mode): Document "C-c C-c".
Luc Teirlinck <teirllm@auburn.edu>
parents:
68691
diff
changeset
|
513 (@code{help-follow-symbol}). This shows all available documentation |
71585 | 514 about the symbol as a variable, function and/or face. As above, use |
515 @kbd{C-c C-b} to retrace your steps. | |
69588
d71425c5cd17
(Help Mode): Document "C-c C-c".
Luc Teirlinck <teirllm@auburn.edu>
parents:
68691
diff
changeset
|
516 |
25829 | 517 @node Misc Help |
518 @section Other Help Commands | |
519 | |
520 @kindex C-h i | |
521 @findex info | |
522 @cindex Info | |
523 @cindex manuals, on-line | |
524 @cindex on-line manuals | |
71585 | 525 @kbd{C-h i} (@code{info}) runs the Info program, which browses |
526 structured documentation files. The entire Emacs manual is available | |
527 within Info, along with many other manuals for the GNU system. Type | |
528 @kbd{h} after entering Info to run a tutorial on using Info. | |
25829 | 529 |
56735
d6c81d81255e
(Misc Help): Add an index entry for finding an Info
Eli Zaretskii <eliz@gnu.org>
parents:
56649
diff
changeset
|
530 @cindex find Info manual by its file name |
71585 | 531 With a numeric argument @var{n}, @kbd{C-h i} selects the Info buffer |
532 @samp{*info*<@var{n}>}. This is useful if you want to browse multiple | |
533 Info manuals simultaneously. If you specify just @kbd{C-u} as the | |
534 prefix argument, @kbd{C-h i} prompts for the name of a documentation | |
535 file, so you can browse a file which doesn't have an entry in the | |
536 top-level Info menu. | |
25829 | 537 |
68509 | 538 The help commands @kbd{C-h F @var{function} @key{RET}} and @kbd{C-h |
539 K @var{key}}, described above, enter Info and go straight to the | |
540 documentation of @var{function} or @var{key}. | |
25829 | 541 |
46243
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
542 @kindex C-h S |
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
543 @findex info-lookup-symbol |
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
544 When editing a program, if you have an Info version of the manual |
71585 | 545 for the programming language, you can use @kbd{C-h S} |
546 (@code{info-lookup-symbol}) to find symbol (keyword, function or | |
547 variable) in the proper manual. The details of how this command works | |
548 depend on the major mode. | |
25829 | 549 |
550 @kindex C-h l | |
551 @findex view-lossage | |
71585 | 552 If something surprising happens, and you are not sure what you |
553 typed, use @kbd{C-h l} (@code{view-lossage}). @kbd{C-h l} displays | |
554 the last 100 characters you typed in Emacs. If you see commands that | |
555 you don't know, you can use @kbd{C-h c} to find out what they do. | |
25829 | 556 |
46243
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
557 @kindex C-h e |
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
558 @findex view-echo-area-messages |
71585 | 559 To review recent echo area messages, use @kbd{C-h e} |
560 (@code{view-echo-area-messages}). This displays the buffer | |
561 @code{*Messages*}, where those messages are kept. | |
46243
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
562 |
25829 | 563 @kindex C-h m |
564 @findex describe-mode | |
71585 | 565 Each Emacs major mode typically redefines a few keys and makes other |
566 changes in how editing works. @kbd{C-h m} (@code{describe-mode}) | |
567 displays documentation on the current major mode, which normally | |
568 describes the commands and features that are changed in this mode. | |
25829 | 569 |
570 @kindex C-h b | |
571 @findex describe-bindings | |
572 @kbd{C-h b} (@code{describe-bindings}) and @kbd{C-h s} | |
71585 | 573 (@code{describe-syntax}) show other information about the current |
574 environment within Emacs. @kbd{C-h b} displays a list of all the key | |
575 bindings now in effect: first the local bindings of the current minor | |
576 modes, then the local bindings defined by the current major mode, and | |
577 finally the global bindings (@pxref{Key Bindings}). @kbd{C-h s} | |
578 displays the contents of the syntax table, with explanations of each | |
579 character's syntax (@pxref{Syntax}). | |
25829 | 580 |
71585 | 581 You can get a list of subcommands for a particular prefix key by |
582 typing @kbd{C-h} after the prefix key. (There are a few prefix keys | |
583 for which this does not work---those that provide their own bindings | |
584 for @kbd{C-h}. One of these is @key{ESC}, because @kbd{@key{ESC} C-h} | |
585 is actually @kbd{C-M-h}, which marks a defun.) | |
25829 | 586 |
46243
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
587 @node Help Files |
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
588 @section Help Files |
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
589 |
71585 | 590 The Emacs help commands described above display dynamic help based |
591 on the current state within Emacs, or refer to manuals. Other help | |
592 commands display pre-written, static help files. These commands all | |
593 have the form @kbd{C-h C-@var{char}}; that is, @kbd{C-h} followed by a | |
594 control character. | |
46243
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
595 |
25829 | 596 @kindex C-h C-c |
597 @findex describe-copying | |
598 @kindex C-h C-d | |
599 @findex describe-distribution | |
46243
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
600 @kindex C-h C-e |
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
601 @findex view-emacs-problems |
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
602 @kindex C-h C-f |
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
603 @findex view-emacs-FAQ |
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
604 @kindex C-h C-n |
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
605 @findex view-emacs-news |
25829 | 606 @kindex C-h C-p |
607 @findex describe-project | |
46243
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
608 @kindex C-h C-t |
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
609 @findex view-emacs-todo |
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
610 @kindex C-h C-w |
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
611 @findex describe-no-warranty |
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
612 |
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
613 @table @kbd |
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
614 @item C-h C-c |
71585 | 615 Display the Emacs copying conditions (@code{describe-copying}). |
46243
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
616 These are the rules under which you can copy and redistribute Emacs. |
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
617 @item C-h C-d |
71585 | 618 Display how to download or order the latest version of |
46243
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
619 Emacs and other GNU software (@code{describe-distribution}). |
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
620 @item C-h C-e |
71585 | 621 Display the list of known Emacs problems, sometimes with suggested |
46243
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
622 workarounds (@code{view-emacs-problems}). |
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
623 @item C-h C-f |
71585 | 624 Display the Emacs frequently-answered-questions list (@code{view-emacs-FAQ}). |
46243
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
625 @item C-h C-n |
71585 | 626 Display the Emacs ``news'' file, which lists new features in the most |
627 recent version of Emacs (@code{view-emacs-news}). | |
46243
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
628 @item C-h C-p |
71585 | 629 Display general information about the GNU Project |
46243
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
630 (@code{describe-project}). |
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
631 @item C-h C-t |
71585 | 632 Display the Emacs to-do list (@code{view-todo}). |
46243
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
633 @item C-h C-w |
71585 | 634 Display the full details on the complete absence of warranty for GNU |
46243
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
635 Emacs (@code{describe-no-warranty}). |
dfc7817ae834
Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents:
39368
diff
changeset
|
636 @end table |
28433 | 637 |
638 @node Help Echo | |
639 @section Help on Active Text and Tooltips | |
640 | |
641 @cindex tooltips | |
38461
23f63206a867
Proofreading fixes from Chris Green <chris_e_green@yahoo.com>.
Eli Zaretskii <eliz@gnu.org>
parents:
37151
diff
changeset
|
642 @cindex balloon help |
38745 | 643 When a region of text is ``active,'' so that you can select it with |
36185 | 644 the mouse or a key like @kbd{RET}, it often has associated help text. |
71585 | 645 For instance, most parts of the mode line have help text. On |
646 graphical displays, the help text is displayed as a ``tooltip'' | |
647 (sometimes known as ``balloon help''), when you move the mouse over | |
648 the active text. @xref{Tooltips}. On some systems, it is shown in | |
649 the echo area. On text-only terminals, if Emacs cannot follow the | |
650 mouse, it cannot show the help text on mouse-over. | |
60953
ec2b6eebb74a
(Help Summary): Add `C-h .'.
Richard M. Stallman <rms@gnu.org>
parents:
60794
diff
changeset
|
651 |
ec2b6eebb74a
(Help Summary): Add `C-h .'.
Richard M. Stallman <rms@gnu.org>
parents:
60794
diff
changeset
|
652 @kindex C-h . |
ec2b6eebb74a
(Help Summary): Add `C-h .'.
Richard M. Stallman <rms@gnu.org>
parents:
60794
diff
changeset
|
653 @findex display-local-help |
ec2b6eebb74a
(Help Summary): Add `C-h .'.
Richard M. Stallman <rms@gnu.org>
parents:
60794
diff
changeset
|
654 @vindex help-at-pt-display-when-idle |
ec2b6eebb74a
(Help Summary): Add `C-h .'.
Richard M. Stallman <rms@gnu.org>
parents:
60794
diff
changeset
|
655 You can also access text region help info using the keyboard. The |
ec2b6eebb74a
(Help Summary): Add `C-h .'.
Richard M. Stallman <rms@gnu.org>
parents:
60794
diff
changeset
|
656 command @kbd{C-h .} (@code{display-local-help}) displays any help text |
ec2b6eebb74a
(Help Summary): Add `C-h .'.
Richard M. Stallman <rms@gnu.org>
parents:
60794
diff
changeset
|
657 associated with the text at point, using the echo area. If you want |
ec2b6eebb74a
(Help Summary): Add `C-h .'.
Richard M. Stallman <rms@gnu.org>
parents:
60794
diff
changeset
|
658 help text to be displayed automatically whenever it is available at |
ec2b6eebb74a
(Help Summary): Add `C-h .'.
Richard M. Stallman <rms@gnu.org>
parents:
60794
diff
changeset
|
659 point, set the variable @code{help-at-pt-display-when-idle} to |
ec2b6eebb74a
(Help Summary): Add `C-h .'.
Richard M. Stallman <rms@gnu.org>
parents:
60794
diff
changeset
|
660 @code{t}. |
52401 | 661 |
662 @ignore | |
663 arch-tag: 6f33ab62-bc75-4367-8057-fd67cc15c3a1 | |
664 @end ignore |