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