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