annotate man/help.texi @ 82621:8bdedd5fc7a2

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