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