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