Commit | Line | Data |
---|---|---|
6bf7aab6 | 1 | @c This is part of the Emacs manual. |
49e71458 | 2 | @c Copyright (C) 1985, 86, 87, 93, 94, 95, 97, 2000, 2001, 2004 |
7d291226 | 3 | @c Free Software Foundation, Inc. |
6bf7aab6 DL |
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 | ||
14 | Emacs provides extensive help features accessible through a single | |
c8cdfe6a | 15 | character, @kbd{C-h}. @kbd{C-h} is a prefix key that is used for |
58fa012d | 16 | commands that display documentation. The characters that you can type after |
6bf7aab6 DL |
17 | @kbd{C-h} are called @dfn{help options}. One help option is @kbd{C-h}; |
18 | that is how you ask for help about using @kbd{C-h}. To cancel, type | |
19 | @kbd{C-g}. The function key @key{F1} is equivalent to @kbd{C-h}. | |
20 | ||
21 | @kindex C-h C-h | |
22 | @findex help-for-help | |
23 | @kbd{C-h C-h} (@code{help-for-help}) displays a list of the possible | |
24 | help options, each with a brief description. Before you type a help | |
25 | option, you can use @key{SPC} or @key{DEL} to scroll through the list. | |
26 | ||
27 | @kbd{C-h} or @key{F1} means ``help'' in various other contexts as | |
0bbb35f9 RS |
28 | well. After a prefix key, it displays a list of the alternatives that |
29 | can follow the prefix key. (A few prefix keys don't support | |
30 | @kbd{C-h}, because they define other meanings for it, but they all | |
31 | support @key{F1}.) | |
6bf7aab6 DL |
32 | |
33 | Most help buffers use a special major mode, Help mode, which lets you | |
7d291226 | 34 | scroll conveniently with @key{SPC} and @key{DEL}. It also offers |
a83e8765 | 35 | hyperlinks to further help regarding cross-referenced names, Info nodes, |
7d291226 | 36 | customization buffers and the like. @xref{Help Mode}. |
6bf7aab6 | 37 | |
576c1dcb EZ |
38 | @cindex searching documentation efficiently |
39 | @cindex looking for a subject in documentation | |
ab6620fa | 40 | If you are looking for a certain feature, but don't know where |
0ec1f115 | 41 | exactly it is documented, and aren't sure of the name of a |
19b2c4ca | 42 | related command or variable, we recommend trying these methods. Usually |
ab6620fa RS |
43 | it is best to start with an apropos command, then try searching the |
44 | manual index, then finally look in the FAQ and the package keywords. | |
576c1dcb EZ |
45 | |
46 | @table @kbd | |
47 | @item C-h a @var{topic} @key{RET} | |
a83e8765 | 48 | This searches for commands whose names match @var{topic}, which should |
0ec1f115 RS |
49 | be a regular expression (@pxref{Regexps}). Browse the buffer that this |
50 | command displays to find what you are looking for. @xref{Apropos}. | |
576c1dcb | 51 | |
cb4755c4 | 52 | @item M-x apropos @key{RET} @var{topic} @key{RET} |
0bbb35f9 RS |
53 | This works like @kbd{C-h a}, but it also searches for noninteractive |
54 | functions and for variables. @xref{Apropos}. | |
3085f862 | 55 | |
cb4755c4 | 56 | @item M-x apropos-documentation @key{RET} @var{topic} @key{RET} |
57f49913 DL |
57 | This searches the @emph{documentation strings} (the built-in short |
58 | descriptions) of all variables and functions (not their names) for a | |
59 | match for @var{topic}, a regular expression. @xref{Apropos}. | |
60 | ||
dc941693 | 61 | @item C-h i d m emacs @key{RET} i @var{topic} @key{RET} |
a83e8765 | 62 | This looks up @var{topic} in the indices of the Emacs on-line manual. |
dcd5ecef | 63 | If there are several matches, Emacs displays the first one. You can then |
97db3e8a | 64 | press @kbd{,} to move to other matches, until you find what you are |
a83e8765 RS |
65 | looking for. |
66 | ||
dc941693 | 67 | @item C-h i d m emacs @key{RET} s @var{topic} @key{RET} |
a83e8765 RS |
68 | Similar, but searches for @var{topic} (which can be a regular |
69 | expression) in the @emph{text} of the manual rather than in its | |
70 | indices. | |
71 | ||
1dcc8951 | 72 | @item C-h C-f |
0bbb35f9 RS |
73 | This brings up the Emacs FAQ. You can use the Info commands |
74 | to browse it. | |
576c1dcb | 75 | |
3085f862 | 76 | @item C-h p |
576c1dcb | 77 | Finally, you can try looking up a suitable package using keywords |
3085f862 | 78 | pertinent to the feature you need. @xref{Library Keywords}. |
576c1dcb EZ |
79 | @end table |
80 | ||
4e9d1a58 | 81 | To find the documentation of a key sequence or a menu item, type |
00b5a712 | 82 | @kbd{C-h K} and then type that key sequence or select the menu |
4e9d1a58 EZ |
83 | item. This looks up the description of the command invoked by the key |
84 | or the menu in the appropriate manual (not necessarily the Emacs | |
00b5a712 | 85 | manual). Likewise, use @kbd{C-h F} for reading documentation of a |
4e9d1a58 EZ |
86 | command. |
87 | ||
6bf7aab6 DL |
88 | @menu |
89 | * Help Summary:: Brief list of all Help commands. | |
90 | * Key Help:: Asking what a key does in Emacs. | |
91 | * Name Help:: Asking about a command, variable or function name. | |
92 | * Apropos:: Asking what pertains to a given topic. | |
93 | * Library Keywords:: Finding Lisp libraries by keywords (topics). | |
94 | * Language Help:: Help relating to international language support. | |
95 | * Help Mode:: Special features of Help mode and Help buffers. | |
96 | * Misc Help:: Other help commands. | |
00b5a712 | 97 | * Help Files:: Commands to display pre-written help files. |
7d291226 | 98 | * Help Echo:: Help on active text and tooltips (`balloon help') |
6bf7aab6 DL |
99 | @end menu |
100 | ||
101 | @iftex | |
102 | @node Help Summary | |
103 | @end iftex | |
49e71458 | 104 | @ifnottex |
6bf7aab6 DL |
105 | @node Help Summary |
106 | @section Help Summary | |
49e71458 | 107 | @end ifnottex |
6bf7aab6 | 108 | |
00b5a712 RS |
109 | Here is a summary of the Emacs interactive help commands. |
110 | @xref{Help Files}, for other help commands that just display a | |
111 | pre-written file of information. | |
6bf7aab6 DL |
112 | |
113 | @table @kbd | |
114 | @item C-h a @var{regexp} @key{RET} | |
115 | Display a list of commands whose names match @var{regexp} | |
116 | (@code{apropos-command}). | |
117 | @item C-h b | |
118 | Display a table of all key bindings in effect now, in this order: minor | |
119 | mode bindings, major mode bindings, and global bindings | |
120 | (@code{describe-bindings}). | |
121 | @item C-h c @var{key} | |
c8cdfe6a | 122 | Show the name of the command that @var{key} runs |
2684ed46 RS |
123 | (@code{describe-key-briefly}). Here @kbd{c} stands for ``character.'' |
124 | For more extensive information on @var{key}, use @kbd{C-h k}. | |
6bf7aab6 DL |
125 | @item C-h f @var{function} @key{RET} |
126 | Display documentation on the Lisp function named @var{function} | |
127 | (@code{describe-function}). Since commands are Lisp functions, | |
128 | a command name may be used. | |
129 | @item C-h h | |
dc941693 | 130 | Display the @file{HELLO} file, which shows examples of various character |
6bf7aab6 DL |
131 | sets. |
132 | @item C-h i | |
133 | Run Info, the program for browsing documentation files (@code{info}). | |
134 | The complete Emacs manual is available on-line in Info. | |
135 | @item C-h k @var{key} | |
136 | Display the name and documentation of the command that @var{key} runs | |
137 | (@code{describe-key}). | |
138 | @item C-h l | |
139 | Display a description of the last 100 characters you typed | |
140 | (@code{view-lossage}). | |
141 | @item C-h m | |
142 | Display documentation of the current major mode (@code{describe-mode}). | |
6bf7aab6 DL |
143 | @item C-h p |
144 | Find packages by topic keyword (@code{finder-by-keyword}). | |
145 | @item C-h s | |
58fa012d | 146 | Display the current contents of the syntax table, plus an explanation of |
6bf7aab6 DL |
147 | what they mean (@code{describe-syntax}). @xref{Syntax}. |
148 | @item C-h t | |
149 | Enter the Emacs interactive tutorial (@code{help-with-tutorial}). | |
150 | @item C-h v @var{var} @key{RET} | |
c8cdfe6a | 151 | Display the documentation of the Lisp variable @var{var} |
6bf7aab6 DL |
152 | (@code{describe-variable}). |
153 | @item C-h w @var{command} @key{RET} | |
c8cdfe6a | 154 | Show which keys run the command named @var{command} (@code{where-is}). |
6bf7aab6 | 155 | @item C-h C @var{coding} @key{RET} |
c8cdfe6a | 156 | Describe coding system @var{coding} |
6bf7aab6 DL |
157 | (@code{describe-coding-system}). |
158 | @item C-h C @key{RET} | |
159 | Describe the coding systems currently in use. | |
160 | @item C-h I @var{method} @key{RET} | |
161 | Describe an input method (@code{describe-input-method}). | |
162 | @item C-h L @var{language-env} @key{RET} | |
0ec1f115 | 163 | Display information on the character sets, coding systems, and input |
c8cdfe6a | 164 | methods used for language environment @var{language-env} |
6bf7aab6 | 165 | (@code{describe-language-environment}). |
00b5a712 | 166 | @item C-h F @var{function} @key{RET} |
6bf7aab6 DL |
167 | Enter Info and go to the node documenting the Emacs function @var{function} |
168 | (@code{Info-goto-emacs-command-node}). | |
00b5a712 | 169 | @item C-h K @var{key} |
6bf7aab6 DL |
170 | Enter Info and go to the node where the key sequence @var{key} is |
171 | documented (@code{Info-goto-emacs-key-command-node}). | |
00b5a712 | 172 | @item C-h S @var{symbol} @key{RET} |
6bf7aab6 DL |
173 | Display the Info documentation on symbol @var{symbol} according to the |
174 | programming language you are editing (@code{info-lookup-symbol}). | |
175 | @end table | |
176 | ||
177 | @node Key Help | |
178 | @section Documentation for a Key | |
179 | ||
180 | @kindex C-h c | |
181 | @findex describe-key-briefly | |
182 | The most basic @kbd{C-h} options are @kbd{C-h c} | |
183 | (@code{describe-key-briefly}) and @w{@kbd{C-h k}} (@code{describe-key}). | |
1ba2ce68 RS |
184 | @kbd{C-h c @var{key}} displays in the echo area the name of the command |
185 | that @var{key} is bound to. For example, @kbd{C-h c C-f} displays | |
6bf7aab6 DL |
186 | @samp{forward-char}. Since command names are chosen to describe what |
187 | the commands do, this is a good way to get a very brief description of | |
188 | what @var{key} does. | |
189 | ||
190 | @kindex C-h k | |
191 | @findex describe-key | |
192 | @kbd{C-h k @var{key}} is similar but gives more information: it | |
193 | displays the documentation string of the command as well as its name. | |
194 | This is too big for the echo area, so a window is used for the display. | |
195 | ||
196 | @kbd{C-h c} and @kbd{C-h k} work for any sort of key sequences, | |
197 | including function keys and mouse events. | |
198 | ||
0bbb35f9 RS |
199 | @kindex C-h w |
200 | @findex where-is | |
201 | @kbd{C-h w @var{command} @key{RET}} tells you what keys are bound to | |
202 | @var{command}. It displays a list of the keys in the echo area. If it | |
203 | says the command is not on any key, you must use @kbd{M-x} to run it. | |
204 | @kbd{C-h w} runs the command @code{where-is}. | |
205 | ||
6bf7aab6 DL |
206 | @node Name Help |
207 | @section Help by Command or Variable Name | |
208 | ||
209 | @kindex C-h f | |
210 | @findex describe-function | |
211 | @kbd{C-h f} (@code{describe-function}) reads the name of a Lisp function | |
212 | using the minibuffer, then displays that function's documentation string | |
213 | in a window. Since commands are Lisp functions, you can use this to get | |
214 | the documentation of a command that you know by name. For example, | |
215 | ||
216 | @example | |
217 | C-h f auto-fill-mode @key{RET} | |
218 | @end example | |
219 | ||
220 | @noindent | |
221 | displays the documentation of @code{auto-fill-mode}. This is the only | |
222 | way to get the documentation of a command that is not bound to any key | |
223 | (one which you would normally run using @kbd{M-x}). | |
224 | ||
0bbb35f9 RS |
225 | @kbd{C-h f} is also useful for Lisp functions that you are planning |
226 | to use in a Lisp program. For example, if you have just written the | |
227 | expression @code{(make-vector len)} and want to check that you are | |
228 | using @code{make-vector} properly, type @kbd{C-h f make-vector | |
229 | @key{RET}}. Because @kbd{C-h f} allows all function names, not just | |
230 | command names, you may find that some of your favorite completion | |
231 | abbreviations that work in @kbd{M-x} don't work in @kbd{C-h f}. An | |
232 | abbreviation may be unique among command names, yet fail to be unique | |
233 | when other function names are allowed. | |
6bf7aab6 | 234 | |
c8cdfe6a EZ |
235 | The default function name for @kbd{C-h f} to describe, if you type |
236 | just @key{RET}, is the name of the function called by the innermost Lisp | |
237 | expression in the buffer around point, @emph{provided} that is a valid, | |
238 | defined Lisp function name. For example, if point is located following | |
239 | the text @samp{(make-vector (car x)}, the innermost list containing | |
240 | point is the one that starts with @samp{(make-vector}, so the default is | |
241 | to describe the function @code{make-vector}. | |
6bf7aab6 DL |
242 | |
243 | @kbd{C-h f} is often useful just to verify that you have the right | |
244 | spelling for the function name. If @kbd{C-h f} mentions a name from the | |
245 | buffer as the default, that name must be defined as a Lisp function. If | |
246 | that is all you want to know, just type @kbd{C-g} to cancel the @kbd{C-h | |
247 | f} command, then go on editing. | |
248 | ||
6bf7aab6 DL |
249 | @kbd{C-h v} (@code{describe-variable}) is like @kbd{C-h f} but describes |
250 | Lisp variables instead of Lisp functions. Its default is the Lisp symbol | |
251 | around or before point, but only if that is the name of a known Lisp | |
a8ec80f1 RS |
252 | variable. @xref{Variables}. |
253 | ||
254 | Help buffers describing Emacs variables and functions normally have | |
255 | hyperlinks to the definition, if you have the source files installed. | |
256 | (@xref{Hyperlinking}.) If you know Lisp (or C), this provides the | |
257 | ultimate documentation. If you don't know Lisp, you should learn it. | |
258 | If you are just @emph{using} Emacs, treating Emacs as an object | |
259 | (file), then you don't really love it. For true intimacy with your | |
260 | editor, you need to read the source code. | |
a83e8765 | 261 | |
6bf7aab6 DL |
262 | @node Apropos |
263 | @section Apropos | |
264 | ||
265 | @kindex C-h a | |
266 | @findex apropos-command | |
267 | @cindex apropos | |
268 | A more sophisticated sort of question to ask is, ``What are the | |
269 | commands for working with files?'' To ask this question, type @kbd{C-h | |
270 | a file @key{RET}}, which displays a list of all command names that | |
271 | contain @samp{file}, including @code{copy-file}, @code{find-file}, and | |
272 | so on. With each command name appears a brief description of how to use | |
273 | the command, and what keys you can currently invoke it with. For | |
274 | example, it would say that you can invoke @code{find-file} by typing | |
2684ed46 | 275 | @kbd{C-x C-f}. The @kbd{a} in @kbd{C-h a} stands for ``Apropos''; |
6bf7aab6 DL |
276 | @kbd{C-h a} runs the command @code{apropos-command}. This command |
277 | normally checks only commands (interactive functions); if you specify a | |
278 | prefix argument, it checks noninteractive functions as well. | |
279 | ||
0bbb35f9 RS |
280 | Because @kbd{C-h a} looks only for commands whose names contain the |
281 | string you specify, you must use ingenuity in choosing the string. If | |
282 | you are looking for commands for killing backwards and @kbd{C-h a | |
283 | kill-backwards @key{RET}} doesn't reveal any, don't give up. Try just | |
284 | @kbd{kill}, or just @kbd{backwards}, or just @kbd{back}. Be | |
6bf7aab6 DL |
285 | persistent. Also note that you can use a regular expression as the |
286 | argument, for more flexibility (@pxref{Regexps}). | |
287 | ||
288 | Here is a set of arguments to give to @kbd{C-h a} that covers many | |
289 | classes of Emacs commands, since there are strong conventions for naming | |
290 | the standard Emacs commands. By giving you a feel for the naming | |
291 | conventions, this set should also serve to aid you in developing a | |
292 | technique for picking @code{apropos} strings. | |
293 | ||
294 | @quotation | |
295 | char, line, word, sentence, paragraph, region, page, sexp, list, defun, | |
296 | rect, buffer, frame, window, face, file, dir, register, mode, beginning, end, | |
297 | forward, backward, next, previous, up, down, search, goto, kill, delete, | |
298 | mark, insert, yank, fill, indent, case, change, set, what, list, find, | |
299 | view, describe, default. | |
300 | @end quotation | |
301 | ||
302 | @findex apropos-variable | |
303 | To list all user variables that match a regexp, use the command | |
19b2c4ca RS |
304 | @kbd{M-x apropos-variable}. By default, this command shows only |
305 | variables meant for user customization; if you specify a prefix | |
306 | argument, it checks all variables. | |
6bf7aab6 DL |
307 | |
308 | @findex apropos | |
309 | To list all Lisp symbols that contain a match for a regexp, not just | |
310 | the ones that are defined as commands, use the command @kbd{M-x apropos} | |
311 | instead of @kbd{C-h a}. This command does not check key bindings by | |
312 | default; specify a numeric argument if you want it to check them. | |
313 | ||
314 | @findex apropos-documentation | |
315 | The @code{apropos-documentation} command is like @code{apropos} except | |
316 | that it searches documentation strings as well as symbol names for | |
317 | matches for the specified regular expression. | |
318 | ||
319 | @findex apropos-value | |
320 | The @code{apropos-value} command is like @code{apropos} except that it | |
321 | searches symbols' values for matches for the specified regular | |
322 | expression. This command does not check function definitions or | |
323 | property lists by default; specify a numeric argument if you want it to | |
324 | check them. | |
325 | ||
326 | @vindex apropos-do-all | |
327 | If the variable @code{apropos-do-all} is non-@code{nil}, the commands | |
328 | above all behave as if they had been given a prefix argument. | |
329 | ||
330 | If you want more information about a function definition, variable or | |
331 | symbol property listed in the Apropos buffer, you can click on it with | |
0bbb35f9 | 332 | @kbd{Mouse-1} or @kbd{Mouse-2}, or move there and type @key{RET}. |
6bf7aab6 DL |
333 | |
334 | @node Library Keywords | |
335 | @section Keyword Search for Lisp Libraries | |
336 | ||
337 | @kindex C-h p | |
338 | @findex finder-by-keyword | |
339 | The @kbd{C-h p} command lets you search the standard Emacs Lisp | |
340 | libraries by topic keywords. Here is a partial list of keywords you can | |
341 | use: | |
342 | ||
a70a412f RS |
343 | @multitable {emulations} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} |
344 | @item abbrev@tab abbreviation handling, typing shortcuts, macros. | |
1dcc8951 JL |
345 | @item bib@tab code related to the @code{bib} bibliography processor. |
346 | @item c@tab support for the C language and related languages. | |
a70a412f RS |
347 | @item calendar@tab calendar and time management support. |
348 | @item comm@tab communications, networking, remote access to files. | |
1dcc8951 | 349 | @item convenience@tab convenience features for faster editing. |
a70a412f RS |
350 | @item data@tab support for editing files of data. |
351 | @item docs@tab support for Emacs documentation. | |
352 | @item emulations@tab emulations of other editors. | |
353 | @item extensions@tab Emacs Lisp language extensions. | |
1dcc8951 JL |
354 | @item faces@tab support for multiple fonts. |
355 | @item files@tab support for editing and manipulating files. | |
a70a412f RS |
356 | @item frames@tab support for Emacs frames and window systems. |
357 | @item games@tab games, jokes and amusements. | |
358 | @item hardware@tab support for interfacing with exotic hardware. | |
359 | @item help@tab support for on-line help systems. | |
1dcc8951 | 360 | @item hypermedia@tab support for links between text or other media types. |
a70a412f RS |
361 | @item i18n@tab internationalization and alternate character-set support. |
362 | @item internal@tab code for Emacs internals, build process, defaults. | |
363 | @item languages@tab specialized modes for editing programming languages. | |
1dcc8951 JL |
364 | @item lisp@tab Lisp support, including Emacs Lisp. |
365 | @item local@tab code local to your site. | |
a70a412f RS |
366 | @item maint@tab maintenance aids for the Emacs development group. |
367 | @item mail@tab modes for electronic-mail handling. | |
1dcc8951 JL |
368 | @item matching@tab various sorts of searching and matching. |
369 | @item mouse@tab mouse support. | |
370 | @item multimedia@tab images and sound support. | |
a70a412f | 371 | @item news@tab support for netnews reading and posting. |
a70a412f | 372 | @item oop@tab support for object-oriented programming. |
1dcc8951 | 373 | @item outlines@tab support for hierarchical outlining. |
a70a412f RS |
374 | @item processes@tab process, subshell, compilation, and job control support. |
375 | @item terminals@tab support for terminal types. | |
1dcc8951 | 376 | @item tex@tab supporting code for the @TeX{} formatter. |
a70a412f | 377 | @item tools@tab programming tools. |
1dcc8951 | 378 | @item unix@tab front-ends/assistants for, or emulators of, UNIX-like features. |
a70a412f RS |
379 | @item wp@tab word processing. |
380 | @end multitable | |
6bf7aab6 DL |
381 | |
382 | @node Language Help | |
383 | @section Help for International Language Support | |
384 | ||
385 | You can use the command @kbd{C-h L} | |
58fa012d EZ |
386 | (@code{describe-language-environment}) to find out information about |
387 | the support for a specific language environment. @xref{Language | |
388 | Environments}. This tells you which languages this language | |
389 | environment is useful for, and lists the character sets, coding | |
390 | systems, and input methods that go with it. It also shows some sample | |
391 | text to illustrate scripts. | |
6bf7aab6 DL |
392 | |
393 | The command @kbd{C-h h} (@code{view-hello-file}) displays the file | |
394 | @file{etc/HELLO}, which shows how to say ``hello'' in many languages. | |
395 | ||
396 | The command @kbd{C-h I} (@code{describe-input-method}) describes | |
397 | information about input methods---either a specified input method, or by | |
398 | default the input method in use. @xref{Input Methods}. | |
399 | ||
400 | The command @kbd{C-h C} (@code{describe-coding-system}) describes | |
401 | information about coding systems---either a specified coding system, or | |
402 | the ones currently in use. @xref{Coding Systems}. | |
403 | ||
404 | @node Help Mode | |
405 | @section Help Mode Commands | |
406 | ||
c8cdfe6a EZ |
407 | Help buffers provide the same commands as View mode (@pxref{Misc File |
408 | Ops}), plus a few special commands of their own. | |
6bf7aab6 DL |
409 | |
410 | @table @kbd | |
411 | @item @key{SPC} | |
412 | Scroll forward. | |
413 | @item @key{DEL} | |
7d794ffb EZ |
414 | @itemx @key{BS} |
415 | Scroll backward. On some keyboards, this key is known as @key{BS} or | |
416 | @key{backspace}. | |
6bf7aab6 DL |
417 | @item @key{RET} |
418 | Follow a cross reference at point. | |
419 | @item @key{TAB} | |
420 | Move point forward to the next cross reference. | |
421 | @item S-@key{TAB} | |
422 | Move point back to the previous cross reference. | |
0bbb35f9 RS |
423 | @item Mouse-1 |
424 | @itemx Mouse-2 | |
6bf7aab6 DL |
425 | Follow a cross reference that you click on. |
426 | @end table | |
427 | ||
0bbb35f9 | 428 | When a function name (@pxref{M-x,, Running Commands by Name}) or |
6bf7aab6 | 429 | variable name (@pxref{Variables}) appears in the documentation, it |
0bbb35f9 RS |
430 | normally appears inside paired single-quotes. You can click on the |
431 | name with @kbd{Mouse-1} or @kbd{Mouse-2}, or move point there and type | |
432 | @key{RET}, to view the documentation of that command or variable. Use | |
433 | @kbd{C-c C-b} to retrace your steps. | |
6bf7aab6 DL |
434 | |
435 | @kindex @key{TAB} @r{(Help mode)} | |
436 | @findex help-next-ref | |
437 | @kindex S-@key{TAB} @r{(Help mode)} | |
438 | @findex help-previous-ref | |
439 | There are convenient commands for moving point to cross references in | |
440 | the help text. @key{TAB} (@code{help-next-ref}) moves point down to the | |
441 | next cross reference. Use @kbd{S-@key{TAB}} to move point up to the | |
442 | previous cross reference (@code{help-previous-ref}). | |
443 | ||
444 | @node Misc Help | |
445 | @section Other Help Commands | |
446 | ||
447 | @kindex C-h i | |
448 | @findex info | |
449 | @cindex Info | |
450 | @cindex manuals, on-line | |
451 | @cindex on-line manuals | |
452 | @kbd{C-h i} (@code{info}) runs the Info program, which is used for | |
453 | browsing through structured documentation files. The entire Emacs manual | |
c8cdfe6a | 454 | is available within Info. Eventually all the documentation of the GNU |
6bf7aab6 DL |
455 | system will be available. Type @kbd{h} after entering Info to run |
456 | a tutorial on using Info. | |
457 | ||
ba86d34d | 458 | @cindex find Info manual by its file name |
6bf7aab6 DL |
459 | If you specify a numeric argument, @kbd{C-h i} prompts for the name of |
460 | a documentation file. This way, you can browse a file which doesn't | |
461 | have an entry in the top-level Info menu. It is also handy when you | |
462 | need to get to the documentation quickly, and you know the exact name of | |
463 | the file. | |
464 | ||
00b5a712 RS |
465 | @kindex C-h F |
466 | @kindex C-h K | |
6bf7aab6 DL |
467 | @findex Info-goto-emacs-key-command-node |
468 | @findex Info-goto-emacs-command-node | |
00b5a712 RS |
469 | There are two special help commands for accessing Emacs |
470 | documentation through Info. @kbd{C-h F @var{function} @key{RET}} | |
471 | enters Info and goes straight to the documentation of the Emacs | |
472 | function @var{function}. @kbd{C-h K @var{key}} enters Info and goes | |
473 | straight to the documentation of the key @var{key}. These two keys | |
474 | run the commands @code{Info-goto-emacs-command-node} and | |
475 | @code{Info-goto-emacs-key-command-node}. You can use @kbd{C-h K} to | |
4e9d1a58 | 476 | find the documentation of a menu item: just select that menu item when |
00b5a712 | 477 | @kbd{C-h K} prompts for a key. |
4e9d1a58 | 478 | |
00b5a712 RS |
479 | @kbd{C-h F} and @kbd{C-h K} know about commands and keys described |
480 | in manuals other than the Emacs manual. Thus, they make it easier to | |
481 | find the documentation of commands and keys when you are not sure | |
482 | which manual describes them, like when using some specialized mode. | |
6bf7aab6 | 483 | |
00b5a712 RS |
484 | @kindex C-h S |
485 | @findex info-lookup-symbol | |
486 | When editing a program, if you have an Info version of the manual | |
487 | for the programming language, you can use the command @kbd{C-h S} | |
488 | (@code{info-lookup-symbol}) to refer to the manual documentation for a | |
489 | symbol (keyword, function or variable). The details of how this | |
490 | command works depend on the major mode. | |
6bf7aab6 DL |
491 | |
492 | @kindex C-h l | |
493 | @findex view-lossage | |
494 | If something surprising happens, and you are not sure what commands you | |
1ba2ce68 | 495 | typed, use @kbd{C-h l} (@code{view-lossage}). @kbd{C-h l} displays the last |
6bf7aab6 DL |
496 | 100 command characters you typed in. If you see commands that you don't |
497 | know, you can use @kbd{C-h c} to find out what they do. | |
498 | ||
00b5a712 RS |
499 | @kindex C-h e |
500 | @findex view-echo-area-messages | |
501 | To review messages that recently appeared in the echo area, use | |
502 | @kbd{C-h e} (@code{view-echo-area-messages}). This displays the | |
503 | buffer @code{*Messages*}, where those messages are kept. | |
504 | ||
6bf7aab6 DL |
505 | @kindex C-h m |
506 | @findex describe-mode | |
507 | Emacs has numerous major modes, each of which redefines a few keys and | |
508 | makes a few other changes in how editing works. @kbd{C-h m} | |
1ba2ce68 | 509 | (@code{describe-mode}) displays documentation on the current major mode, |
6bf7aab6 DL |
510 | which normally describes all the commands that are changed in this |
511 | mode. | |
512 | ||
513 | @kindex C-h b | |
514 | @findex describe-bindings | |
515 | @kbd{C-h b} (@code{describe-bindings}) and @kbd{C-h s} | |
516 | (@code{describe-syntax}) present other information about the current | |
517 | Emacs mode. @kbd{C-h b} displays a list of all the key bindings now in | |
58fa012d | 518 | effect, showing the local bindings defined by the current minor modes first, |
6bf7aab6 DL |
519 | then the local bindings defined by the current major mode, and finally |
520 | the global bindings (@pxref{Key Bindings}). @kbd{C-h s} displays the | |
521 | contents of the syntax table, with explanations of each character's | |
522 | syntax (@pxref{Syntax}). | |
523 | ||
524 | You can get a similar list for a particular prefix key by typing | |
525 | @kbd{C-h} after the prefix key. (There are a few prefix keys for which | |
526 | this does not work---those that provide their own bindings for | |
527 | @kbd{C-h}. One of these is @key{ESC}, because @kbd{@key{ESC} C-h} is | |
528 | actually @kbd{C-M-h}, which marks a defun.) | |
529 | ||
00b5a712 RS |
530 | @node Help Files |
531 | @section Help Files | |
532 | ||
533 | The Emacs help commands described above display the state of data | |
534 | bases within Emacs. Emacs has a few other help commands that display | |
535 | pre-written help files. These commands all have the form @kbd{C-h | |
536 | C-@var{char}}; that is, @kbd{C-h} followed by a control character. | |
537 | ||
6bf7aab6 DL |
538 | @kindex C-h C-c |
539 | @findex describe-copying | |
540 | @kindex C-h C-d | |
541 | @findex describe-distribution | |
00b5a712 RS |
542 | @kindex C-h C-e |
543 | @findex view-emacs-problems | |
544 | @kindex C-h C-f | |
545 | @findex view-emacs-FAQ | |
546 | @kindex C-h C-n | |
547 | @findex view-emacs-news | |
6bf7aab6 DL |
548 | @kindex C-h C-p |
549 | @findex describe-project | |
00b5a712 RS |
550 | @kindex C-h C-t |
551 | @findex view-emacs-todo | |
552 | @kindex C-h C-w | |
553 | @findex describe-no-warranty | |
58fa012d | 554 | The other @kbd{C-h} options display various files containing useful |
00b5a712 RS |
555 | information. |
556 | ||
557 | @table @kbd | |
558 | @item C-h C-c | |
559 | Displays the Emacs copying conditions (@code{describe-copying}). | |
560 | These are the rules under which you can copy and redistribute Emacs. | |
561 | @item C-h C-d | |
562 | Displays information on how to download or order the latest version of | |
563 | Emacs and other GNU software (@code{describe-distribution}). | |
564 | @item C-h C-e | |
565 | Displays the list of known Emacs problems, sometimes with suggested | |
566 | workarounds (@code{view-emacs-problems}). | |
567 | @item C-h C-f | |
568 | Displays the Emacs frequently-answered-questions list (@code{view-emacs-FAQ}). | |
569 | @item C-h C-n | |
570 | Displays the Emacs ``news'' file, which lists new Emacs features, most | |
571 | recent first (@code{view-emacs-news}). | |
572 | @item C-h C-p | |
573 | Displays general information about the GNU Project | |
574 | (@code{describe-project}). | |
575 | @item C-h C-t | |
576 | Displays the Emacs to-do list (@code{view-todo}). | |
577 | @item C-h C-w | |
578 | Displays the full details on the complete absence of warranty for GNU | |
579 | Emacs (@code{describe-no-warranty}). | |
580 | @end table | |
7d291226 DL |
581 | |
582 | @node Help Echo | |
583 | @section Help on Active Text and Tooltips | |
584 | ||
585 | @cindex tooltips | |
58fa012d | 586 | @cindex balloon help |
0ec1f115 | 587 | When a region of text is ``active,'' so that you can select it with |
2684ed46 RS |
588 | the mouse or a key like @kbd{RET}, it often has associated help text. |
589 | Areas of the mode line are examples. This help will normally be | |
1ba2ce68 | 590 | shown in the echo area when you move point into the active text. In |
58fa012d EZ |
591 | a window system you can display the help text as a ``tooltip'' |
592 | (sometimes known as ``balloon help''). @xref{Tooltips}. | |
ab5796a9 MB |
593 | |
594 | @ignore | |
595 | arch-tag: 6f33ab62-bc75-4367-8057-fd67cc15c3a1 | |
596 | @end ignore |