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