annotate man/help.texi @ 67815:3af6058f9f07

(describe-char): Bug fix for previous changes: Juggle current buffer.
author Nick Roberts <nickrob@snap.net.nz>
date Mon, 26 Dec 2005 12:35:35 +0000
parents 38ade54b22bb
children ab50d02721ae 7beb78bc1f8e
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,
3723093a21fd Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 60991
diff changeset
3 @c 2002, 2003, 2004, 2005 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
Dave Love <fx@gnu.org>
parents:
diff changeset
14 Emacs provides extensive help features accessible through a single
38488
2a70c922f6ad Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 38461
diff changeset
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
Dave Love <fx@gnu.org>
parents:
diff changeset
17 @kbd{C-h} are called @dfn{help options}. One help option is @kbd{C-h};
Dave Love <fx@gnu.org>
parents:
diff changeset
18 that is how you ask for help about using @kbd{C-h}. To cancel, type
Dave Love <fx@gnu.org>
parents:
diff changeset
19 @kbd{C-g}. The function key @key{F1} is equivalent to @kbd{C-h}.
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
Dave Love <fx@gnu.org>
parents:
diff changeset
23 @kbd{C-h C-h} (@code{help-for-help}) displays a list of the possible
Dave Love <fx@gnu.org>
parents:
diff changeset
24 help options, each with a brief description. Before you type a help
Dave Love <fx@gnu.org>
parents:
diff changeset
25 option, you can use @key{SPC} or @key{DEL} to scroll through the list.
Dave Love <fx@gnu.org>
parents:
diff changeset
26
Dave Love <fx@gnu.org>
parents:
diff changeset
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
Dave Love <fx@gnu.org>
parents:
diff changeset
32
Dave Love <fx@gnu.org>
parents:
diff changeset
33 Most help buffers use a special major mode, Help mode, which lets you
28433
8605ab7873d4 Hyperlinks, help echo.
Dave Love <fx@gnu.org>
parents: 26767
diff changeset
34 scroll conveniently with @key{SPC} and @key{DEL}. It also offers
66515
a3510f204ba4 (Help): Help mode now creates hyperlinks for URLs.
Bill Wohler <wohler@newt.com>
parents: 64890
diff changeset
35 hyperlinks to URLs and further help regarding cross-referenced names, Info
a3510f204ba4 (Help): Help mode now creates hyperlinks for URLs.
Bill Wohler <wohler@newt.com>
parents: 64890
diff changeset
36 nodes, customization buffers and the like. @xref{Help Mode}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
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
5464ee1ba8e2 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 38488
diff changeset
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
67514
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
47 @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
48 This searches for commands whose names match @var{topics}, which
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
49 should be a keyword, a list of keywords, or a regular expression
67712
38ade54b22bb Correct typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 67514
diff changeset
50 (@pxref{Regexps}). This command displays all the matches in a new
67514
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
51 buffer. @xref{Apropos}.
32432
2b1871fcf25f *** empty log message ***
Dave Love <fx@gnu.org>
parents: 32363
diff changeset
52
37151
3d209a687950 Add `d' after `C-h i' in examples.
Richard M. Stallman <rms@gnu.org>
parents: 36655
diff changeset
53 @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
54 This looks up @var{topic} in the indices of the Emacs on-line manual.
36365
ad274190f071 (Help): Fix a typo.
Eli Zaretskii <eliz@gnu.org>
parents: 36185
diff changeset
55 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
56 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
57 looking for.
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}
36159
41b70b041a5a Clean up and move index-searching recommendation.
Richard M. Stallman <rms@gnu.org>
parents: 34024
diff changeset
60 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
61 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
62 indices.
41b70b041a5a Clean up and move index-searching recommendation.
Richard M. Stallman <rms@gnu.org>
parents: 34024
diff changeset
63
54473
6f6d287fe506 Sync keywords with finder.el.
Juri Linkov <juri@jurta.org>
parents: 52401
diff changeset
64 @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
65 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
66 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
67
32362
c74db5a73b6f Fix last change for docs search procedure (suggested by Dave Love).
Eli Zaretskii <eliz@gnu.org>
parents: 32276
diff changeset
68 @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
69 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
70 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
71 @end table
49a967404304 (Help): Describe an orderly procedure to find features in the docs.
Eli Zaretskii <eliz@gnu.org>
parents: 30801
diff changeset
72
39368
eaeec47bf5fe (Help): Mention C-h C-f and C-h C-k.
Eli Zaretskii <eliz@gnu.org>
parents: 38870
diff changeset
73 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
74 @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
75 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
76 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
77 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
78 command.
eaeec47bf5fe (Help): Mention C-h C-f and C-h C-k.
Eli Zaretskii <eliz@gnu.org>
parents: 38870
diff changeset
79
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
80 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
81 * Help Summary:: Brief list of all Help commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
82 * Key Help:: Asking what a key does in Emacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
83 * Name Help:: Asking about a command, variable or function name.
Dave Love <fx@gnu.org>
parents:
diff changeset
84 * Apropos:: Asking what pertains to a given topic.
Dave Love <fx@gnu.org>
parents:
diff changeset
85 * Library Keywords:: Finding Lisp libraries by keywords (topics).
Dave Love <fx@gnu.org>
parents:
diff changeset
86 * Language Help:: Help relating to international language support.
Dave Love <fx@gnu.org>
parents:
diff changeset
87 * Help Mode:: Special features of Help mode and Help buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
88 * 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
89 * Help Files:: Commands to display pre-written help files.
28433
8605ab7873d4 Hyperlinks, help echo.
Dave Love <fx@gnu.org>
parents: 26767
diff changeset
90 * Help Echo:: Help on active text and tooltips (`balloon help')
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
91 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
92
Dave Love <fx@gnu.org>
parents:
diff changeset
93 @iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
94 @node Help Summary
Dave Love <fx@gnu.org>
parents:
diff changeset
95 @end iftex
55626
1c7ccc3495fe @ifnottex, not @ifinfo
Karl Berry <karl@gnu.org>
parents: 54473
diff changeset
96 @ifnottex
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
97 @node Help Summary
Dave Love <fx@gnu.org>
parents:
diff changeset
98 @section Help Summary
55626
1c7ccc3495fe @ifnottex, not @ifinfo
Karl Berry <karl@gnu.org>
parents: 54473
diff changeset
99 @end ifnottex
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
100
46243
dfc7817ae834 Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents: 39368
diff changeset
101 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
102 @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
103 pre-written file of information.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
104
Dave Love <fx@gnu.org>
parents:
diff changeset
105 @table @kbd
67514
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
106 @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
107 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
108 (@code{apropos-command}; @pxref{Apropos}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
109 @item C-h b
Dave Love <fx@gnu.org>
parents:
diff changeset
110 Display a table of all key bindings in effect now, in this order: minor
Dave Love <fx@gnu.org>
parents:
diff changeset
111 mode bindings, major mode bindings, and global bindings
Dave Love <fx@gnu.org>
parents:
diff changeset
112 (@code{describe-bindings}).
Dave Love <fx@gnu.org>
parents:
diff changeset
113 @item C-h c @var{key}
38488
2a70c922f6ad Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 38461
diff changeset
114 Show the name of the command that @var{key} runs
36185
62cf166239f3 Change in quoting.
Richard M. Stallman <rms@gnu.org>
parents: 36159
diff changeset
115 (@code{describe-key-briefly}). Here @kbd{c} stands for ``character.''
62cf166239f3 Change in quoting.
Richard M. Stallman <rms@gnu.org>
parents: 36159
diff changeset
116 For more extensive information on @var{key}, use @kbd{C-h k}.
67514
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
117 @item C-h d @var{topics} @key{RET}
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
118 Display a list of commands and variables whose documentation matches
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
119 @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
120 @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
121 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
122 (@code{view-echo-area-messages}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
123 @item C-h f @var{function} @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
124 Display documentation on the Lisp function named @var{function}
Dave Love <fx@gnu.org>
parents:
diff changeset
125 (@code{describe-function}). Since commands are Lisp functions,
Dave Love <fx@gnu.org>
parents:
diff changeset
126 a command name may be used.
Dave Love <fx@gnu.org>
parents:
diff changeset
127 @item C-h h
37151
3d209a687950 Add `d' after `C-h i' in examples.
Richard M. Stallman <rms@gnu.org>
parents: 36655
diff changeset
128 Display the @file{HELLO} file, which shows examples of various character
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
129 sets.
Dave Love <fx@gnu.org>
parents:
diff changeset
130 @item C-h i
Dave Love <fx@gnu.org>
parents:
diff changeset
131 Run Info, the program for browsing documentation files (@code{info}).
Dave Love <fx@gnu.org>
parents:
diff changeset
132 The complete Emacs manual is available on-line in Info.
Dave Love <fx@gnu.org>
parents:
diff changeset
133 @item C-h k @var{key}
Dave Love <fx@gnu.org>
parents:
diff changeset
134 Display the name and documentation of the command that @var{key} runs
Dave Love <fx@gnu.org>
parents:
diff changeset
135 (@code{describe-key}).
Dave Love <fx@gnu.org>
parents:
diff changeset
136 @item C-h l
Dave Love <fx@gnu.org>
parents:
diff changeset
137 Display a description of the last 100 characters you typed
Dave Love <fx@gnu.org>
parents:
diff changeset
138 (@code{view-lossage}).
Dave Love <fx@gnu.org>
parents:
diff changeset
139 @item C-h m
Dave Love <fx@gnu.org>
parents:
diff changeset
140 Display documentation of the current major mode (@code{describe-mode}).
Dave Love <fx@gnu.org>
parents:
diff changeset
141 @item C-h p
Dave Love <fx@gnu.org>
parents:
diff changeset
142 Find packages by topic keyword (@code{finder-by-keyword}).
Dave Love <fx@gnu.org>
parents:
diff changeset
143 @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
144 Display the current contents of the syntax table, plus an explanation of
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
145 what they mean (@code{describe-syntax}). @xref{Syntax}.
Dave Love <fx@gnu.org>
parents:
diff changeset
146 @item C-h t
Dave Love <fx@gnu.org>
parents:
diff changeset
147 Enter the Emacs interactive tutorial (@code{help-with-tutorial}).
Dave Love <fx@gnu.org>
parents:
diff changeset
148 @item C-h v @var{var} @key{RET}
38488
2a70c922f6ad Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 38461
diff changeset
149 Display the documentation of the Lisp variable @var{var}
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
150 (@code{describe-variable}).
Dave Love <fx@gnu.org>
parents:
diff changeset
151 @item C-h w @var{command} @key{RET}
38488
2a70c922f6ad Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 38461
diff changeset
152 Show which keys run the command named @var{command} (@code{where-is}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
153 @item C-h C @var{coding} @key{RET}
38488
2a70c922f6ad Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 38461
diff changeset
154 Describe coding system @var{coding}
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
155 (@code{describe-coding-system}).
Dave Love <fx@gnu.org>
parents:
diff changeset
156 @item C-h C @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
157 Describe the coding systems currently in use.
Dave Love <fx@gnu.org>
parents:
diff changeset
158 @item C-h I @var{method} @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
159 Describe an input method (@code{describe-input-method}).
Dave Love <fx@gnu.org>
parents:
diff changeset
160 @item C-h L @var{language-env} @key{RET}
38745
5464ee1ba8e2 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 38488
diff changeset
161 Display information on the character sets, coding systems, and input
38488
2a70c922f6ad Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 38461
diff changeset
162 methods used for language environment @var{language-env}
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
163 (@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
164 @item C-h F @var{function} @key{RET}
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
165 Enter Info and go to the node documenting the Emacs function @var{function}
Dave Love <fx@gnu.org>
parents:
diff changeset
166 (@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
167 @item C-h K @var{key}
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
168 Enter Info and go to the node where the key sequence @var{key} is
Dave Love <fx@gnu.org>
parents:
diff changeset
169 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
170 @item C-h S @var{symbol} @key{RET}
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
171 Display the Info documentation on symbol @var{symbol} according to the
Dave Love <fx@gnu.org>
parents:
diff changeset
172 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
173 @item C-h .
ec2b6eebb74a (Help Summary): Add `C-h .'.
Richard M. Stallman <rms@gnu.org>
parents: 60794
diff changeset
174 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
175 links in @samp{*Help*} buffers (@code{display-local-help}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
176 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
177
Dave Love <fx@gnu.org>
parents:
diff changeset
178 @node Key Help
Dave Love <fx@gnu.org>
parents:
diff changeset
179 @section Documentation for a Key
Dave Love <fx@gnu.org>
parents:
diff changeset
180
Dave Love <fx@gnu.org>
parents:
diff changeset
181 @kindex C-h c
Dave Love <fx@gnu.org>
parents:
diff changeset
182 @findex describe-key-briefly
Dave Love <fx@gnu.org>
parents:
diff changeset
183 The most basic @kbd{C-h} options are @kbd{C-h c}
Dave Love <fx@gnu.org>
parents:
diff changeset
184 (@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
185 @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
186 that @var{key} is bound to. For example, @kbd{C-h c C-f} displays
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
187 @samp{forward-char}. Since command names are chosen to describe what
Dave Love <fx@gnu.org>
parents:
diff changeset
188 the commands do, this is a good way to get a very brief description of
Dave Love <fx@gnu.org>
parents:
diff changeset
189 what @var{key} does.
Dave Love <fx@gnu.org>
parents:
diff changeset
190
Dave Love <fx@gnu.org>
parents:
diff changeset
191 @kindex C-h k
Dave Love <fx@gnu.org>
parents:
diff changeset
192 @findex describe-key
Dave Love <fx@gnu.org>
parents:
diff changeset
193 @kbd{C-h k @var{key}} is similar but gives more information: it
Dave Love <fx@gnu.org>
parents:
diff changeset
194 displays the documentation string of the command as well as its name.
Dave Love <fx@gnu.org>
parents:
diff changeset
195 This is too big for the echo area, so a window is used for the display.
Dave Love <fx@gnu.org>
parents:
diff changeset
196
Dave Love <fx@gnu.org>
parents:
diff changeset
197 @kbd{C-h c} and @kbd{C-h k} work for any sort of key sequences,
Dave Love <fx@gnu.org>
parents:
diff changeset
198 including function keys and mouse events.
Dave Love <fx@gnu.org>
parents:
diff changeset
199
60106
2116c6a9e16c (Help): Correct error about C-h in query-replace.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
200 @kindex C-h w
2116c6a9e16c (Help): Correct error about C-h in query-replace.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
201 @findex where-is
2116c6a9e16c (Help): Correct error about C-h in query-replace.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
202 @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
203 @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
204 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
205 @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
206
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
207 @node Name Help
Dave Love <fx@gnu.org>
parents:
diff changeset
208 @section Help by Command or Variable Name
Dave Love <fx@gnu.org>
parents:
diff changeset
209
Dave Love <fx@gnu.org>
parents:
diff changeset
210 @kindex C-h f
Dave Love <fx@gnu.org>
parents:
diff changeset
211 @findex describe-function
Dave Love <fx@gnu.org>
parents:
diff changeset
212 @kbd{C-h f} (@code{describe-function}) reads the name of a Lisp function
Dave Love <fx@gnu.org>
parents:
diff changeset
213 using the minibuffer, then displays that function's documentation string
Dave Love <fx@gnu.org>
parents:
diff changeset
214 in a window. Since commands are Lisp functions, you can use this to get
Dave Love <fx@gnu.org>
parents:
diff changeset
215 the documentation of a command that you know by name. For example,
Dave Love <fx@gnu.org>
parents:
diff changeset
216
Dave Love <fx@gnu.org>
parents:
diff changeset
217 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
218 C-h f auto-fill-mode @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
219 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
220
Dave Love <fx@gnu.org>
parents:
diff changeset
221 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
222 displays the documentation of @code{auto-fill-mode}. This is the only
Dave Love <fx@gnu.org>
parents:
diff changeset
223 way to get the documentation of a command that is not bound to any key
Dave Love <fx@gnu.org>
parents:
diff changeset
224 (one which you would normally run using @kbd{M-x}).
Dave Love <fx@gnu.org>
parents:
diff changeset
225
60106
2116c6a9e16c (Help): Correct error about C-h in query-replace.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
226 @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
227 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
228 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
229 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
230 @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
231 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
232 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
233 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
234 when other function names are allowed.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
235
38488
2a70c922f6ad Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 38461
diff changeset
236 The default function name for @kbd{C-h f} to describe, if you type
2a70c922f6ad Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 38461
diff changeset
237 just @key{RET}, is the name of the function called by the innermost Lisp
2a70c922f6ad Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 38461
diff changeset
238 expression in the buffer around point, @emph{provided} that is a valid,
2a70c922f6ad Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 38461
diff changeset
239 defined Lisp function name. For example, if point is located following
2a70c922f6ad Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 38461
diff changeset
240 the text @samp{(make-vector (car x)}, the innermost list containing
2a70c922f6ad Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 38461
diff changeset
241 point is the one that starts with @samp{(make-vector}, so the default is
2a70c922f6ad Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 38461
diff changeset
242 to describe the function @code{make-vector}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
243
Dave Love <fx@gnu.org>
parents:
diff changeset
244 @kbd{C-h f} is often useful just to verify that you have the right
Dave Love <fx@gnu.org>
parents:
diff changeset
245 spelling for the function name. If @kbd{C-h f} mentions a name from the
Dave Love <fx@gnu.org>
parents:
diff changeset
246 buffer as the default, that name must be defined as a Lisp function. If
Dave Love <fx@gnu.org>
parents:
diff changeset
247 that is all you want to know, just type @kbd{C-g} to cancel the @kbd{C-h
Dave Love <fx@gnu.org>
parents:
diff changeset
248 f} command, then go on editing.
Dave Love <fx@gnu.org>
parents:
diff changeset
249
Dave Love <fx@gnu.org>
parents:
diff changeset
250 @kbd{C-h v} (@code{describe-variable}) is like @kbd{C-h f} but describes
Dave Love <fx@gnu.org>
parents:
diff changeset
251 Lisp variables instead of Lisp functions. Its default is the Lisp symbol
Dave Love <fx@gnu.org>
parents:
diff changeset
252 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
253 variable. @xref{Variables}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
254
60429
c5b260f33beb (Name Help): Xref to Hyperlinking.
Richard M. Stallman <rms@gnu.org>
parents: 60106
diff changeset
255 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
256 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
257 (@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
258 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
259 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
260 (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
261 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
262
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
263 @node Apropos
Dave Love <fx@gnu.org>
parents:
diff changeset
264 @section Apropos
Dave Love <fx@gnu.org>
parents:
diff changeset
265
67514
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
266 A more sophisticated sort of question to ask is, ``What are the
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
267 commands for working with files?'' The @dfn{apropos} commands ask
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
268 such questions---they look for things whose names match an
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
269 @dfn{apropos pattern}, which means either a word, a list of words, or
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
270 a regular expression. Each apropos command displays a list of
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
271 matching items in a special buffer.
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
272
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
273 @table @kbd
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
274 @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
275 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
276
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
277 @item M-x apropos @key{RET} @var{pattern} @key{RET}
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
278 Similar, but it searches for noninteractive functions and for
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
279 variables, as well as commands.
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
280
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
281 @item M-x apropos-variable @key{RET} @var{pattern} @key{RET}
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
282 Similar, but it searches for variables only.
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
283
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
284 @item M-x apropos-value @key{RET} @var{pattern} @key{RET}
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
285 Similar, but it searches for variables based on their values, or
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
286 functions based on their definitions.
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
287
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
288 @item C-h d @var{pattern} @key{RET}
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
289 Search the @emph{documentation strings} (the built-in short
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
290 descriptions) of all variables and functions (not their names) for a
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
291 match for @var{pattern}.
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
292 @end table
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
293
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
294 @kindex C-h a
Dave Love <fx@gnu.org>
parents:
diff changeset
295 @findex apropos-command
Dave Love <fx@gnu.org>
parents:
diff changeset
296 @cindex apropos
67514
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
297 To find the commands that work on files, type @kbd{C-h a file
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
298 @key{RET}}. This displays a list of all command names that contain
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
299 @samp{file}, including @code{copy-file}, @code{find-file}, and so on.
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
300 With each command name appears a brief description of how to use the
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
301 command, and what keys you can currently invoke it with. For example,
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
302 it would say that you can invoke @code{find-file} by typing @kbd{C-x
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
303 C-f}. The @kbd{a} in @kbd{C-h a} stands for ``Apropos''; @kbd{C-h a}
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
304 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
305 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
306 argument, it checks noninteractive functions as well.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
307
67514
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
308 If you want more information about a function definition, variable or
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
309 symbol property listed in the Apropos buffer, you can click on it with
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
310 @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
311
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
312 @kbd{C-h a} with a single word can find too many matches. Don't
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
313 just give up; you can give Apropos a list of words to search for.
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
314 When you specify more than one word in the apropos pattern, a name
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
315 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
316 you are looking for commands to kill a chunk of text before point, you
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
317 could try @kbd{C-h a kill back backward behind before @key{RET}}.
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
318
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
319 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
320 (@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
321 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
322 characters, @samp{^$*+?.\[}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
323
Dave Love <fx@gnu.org>
parents:
diff changeset
324 Here is a set of arguments to give to @kbd{C-h a} that covers many
67514
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
325 classes of Emacs commands, since there are strong conventions for
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
326 naming the standard Emacs commands. By giving you a feel for the
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
327 naming conventions, this set should also serve to aid you in
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
328 developing a technique for picking Apropos keywords.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
329
Dave Love <fx@gnu.org>
parents:
diff changeset
330 @quotation
Dave Love <fx@gnu.org>
parents:
diff changeset
331 char, line, word, sentence, paragraph, region, page, sexp, list, defun,
Dave Love <fx@gnu.org>
parents:
diff changeset
332 rect, buffer, frame, window, face, file, dir, register, mode, beginning, end,
Dave Love <fx@gnu.org>
parents:
diff changeset
333 forward, backward, next, previous, up, down, search, goto, kill, delete,
Dave Love <fx@gnu.org>
parents:
diff changeset
334 mark, insert, yank, fill, indent, case, change, set, what, list, find,
Dave Love <fx@gnu.org>
parents:
diff changeset
335 view, describe, default.
Dave Love <fx@gnu.org>
parents:
diff changeset
336 @end quotation
Dave Love <fx@gnu.org>
parents:
diff changeset
337
67514
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
338 @findex apropos
67712
38ade54b22bb Correct typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 67514
diff changeset
339 To list all Lisp symbols that contain a match for an Apropos pattern,
67514
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
340 not just the ones that are defined as commands, use the command
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
341 @kbd{M-x apropos} instead of @kbd{C-h a}. This command does not check
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
342 key bindings by default; specify a numeric argument if you want it to
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
343 check them.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
344
67514
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
345 @findex apropos-variable
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
346 To list user-customizable variables that match an apropos pattern,
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
347 use the command @kbd{M-x apropos-variable}. If you specify a prefix
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
348 argument, it checks all variables.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
349
66827
5163ae9b5c75 (Help): Fix C-h a entry. Add C-h d entry.
Kim F. Storm <storm@cua.dk>
parents: 66746
diff changeset
350 @kindex C-h d
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
351 @findex apropos-documentation
67514
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
352 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
353 except that it searches documentation strings instead of symbol names
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
354 for matches for the specified Apropos pattern.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
355
Dave Love <fx@gnu.org>
parents:
diff changeset
356 @findex apropos-value
67514
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
357 The @code{apropos-value} command is like @code{apropos} except that
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
358 it searches variables' values for matches for the pattern. With a
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
359 prefix argument, it also checks symbols' function definitions and
b33e99f74b5e (Apropos): Rewrite. Talk about "apropos patterns".
Richard M. Stallman <rms@gnu.org>
parents: 66827
diff changeset
360 property lists.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
361
Dave Love <fx@gnu.org>
parents:
diff changeset
362 @vindex apropos-do-all
Dave Love <fx@gnu.org>
parents:
diff changeset
363 If the variable @code{apropos-do-all} is non-@code{nil}, the commands
Dave Love <fx@gnu.org>
parents:
diff changeset
364 above all behave as if they had been given a prefix argument.
Dave Love <fx@gnu.org>
parents:
diff changeset
365
60953
ec2b6eebb74a (Help Summary): Add `C-h .'.
Richard M. Stallman <rms@gnu.org>
parents: 60794
diff changeset
366 @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
367 @cindex apropos search results, order by score
60953
ec2b6eebb74a (Help Summary): Add `C-h .'.
Richard M. Stallman <rms@gnu.org>
parents: 60794
diff changeset
368 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
369 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
370 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
371 most relevant ones first.
ec2b6eebb74a (Help Summary): Add `C-h .'.
Richard M. Stallman <rms@gnu.org>
parents: 60794
diff changeset
372
66827
5163ae9b5c75 (Help): Fix C-h a entry. Add C-h d entry.
Kim F. Storm <storm@cua.dk>
parents: 66746
diff changeset
373 @vindex apropos-documentation-sort-by-scores
5163ae9b5c75 (Help): Fix C-h a entry. Add C-h d entry.
Kim F. Storm <storm@cua.dk>
parents: 66746
diff changeset
374 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
375 @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
376 the variable @code{apropos-documentation-sort-by-scores} is
67712
38ade54b22bb Correct typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 67514
diff changeset
377 @code{nil}, Apropos lists the symbols found in alphabetical order.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
378
Dave Love <fx@gnu.org>
parents:
diff changeset
379 @node Library Keywords
Dave Love <fx@gnu.org>
parents:
diff changeset
380 @section Keyword Search for Lisp Libraries
Dave Love <fx@gnu.org>
parents:
diff changeset
381
Dave Love <fx@gnu.org>
parents:
diff changeset
382 @kindex C-h p
Dave Love <fx@gnu.org>
parents:
diff changeset
383 @findex finder-by-keyword
Dave Love <fx@gnu.org>
parents:
diff changeset
384 The @kbd{C-h p} command lets you search the standard Emacs Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
385 libraries by topic keywords. Here is a partial list of keywords you can
Dave Love <fx@gnu.org>
parents:
diff changeset
386 use:
Dave Love <fx@gnu.org>
parents:
diff changeset
387
51790
0a8de3bc39b5 (Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents: 46243
diff changeset
388 @multitable {emulations} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa}
0a8de3bc39b5 (Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents: 46243
diff changeset
389 @item abbrev@tab abbreviation handling, typing shortcuts, macros.
54473
6f6d287fe506 Sync keywords with finder.el.
Juri Linkov <juri@jurta.org>
parents: 52401
diff changeset
390 @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
391 @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
392 @item calendar@tab calendar and time management support.
0a8de3bc39b5 (Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents: 46243
diff changeset
393 @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
394 @item convenience@tab convenience features for faster editing.
51790
0a8de3bc39b5 (Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents: 46243
diff changeset
395 @item data@tab support for editing files of data.
0a8de3bc39b5 (Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents: 46243
diff changeset
396 @item docs@tab support for Emacs documentation.
0a8de3bc39b5 (Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents: 46243
diff changeset
397 @item emulations@tab emulations of other editors.
0a8de3bc39b5 (Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents: 46243
diff changeset
398 @item extensions@tab Emacs Lisp language extensions.
54473
6f6d287fe506 Sync keywords with finder.el.
Juri Linkov <juri@jurta.org>
parents: 52401
diff changeset
399 @item faces@tab support for multiple fonts.
6f6d287fe506 Sync keywords with finder.el.
Juri Linkov <juri@jurta.org>
parents: 52401
diff changeset
400 @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
401 @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
402 @item games@tab games, jokes and amusements.
0a8de3bc39b5 (Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents: 46243
diff changeset
403 @item hardware@tab support for interfacing with exotic hardware.
0a8de3bc39b5 (Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents: 46243
diff changeset
404 @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
405 @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
406 @item i18n@tab internationalization and alternate character-set support.
0a8de3bc39b5 (Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents: 46243
diff changeset
407 @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
408 @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
409 @item lisp@tab Lisp support, including Emacs Lisp.
6f6d287fe506 Sync keywords with finder.el.
Juri Linkov <juri@jurta.org>
parents: 52401
diff changeset
410 @item local@tab code local to your site.
51790
0a8de3bc39b5 (Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents: 46243
diff changeset
411 @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
412 @item mail@tab modes for electronic-mail handling.
54473
6f6d287fe506 Sync keywords with finder.el.
Juri Linkov <juri@jurta.org>
parents: 52401
diff changeset
413 @item matching@tab various sorts of searching and matching.
6f6d287fe506 Sync keywords with finder.el.
Juri Linkov <juri@jurta.org>
parents: 52401
diff changeset
414 @item mouse@tab mouse support.
6f6d287fe506 Sync keywords with finder.el.
Juri Linkov <juri@jurta.org>
parents: 52401
diff changeset
415 @item multimedia@tab images and sound support.
51790
0a8de3bc39b5 (Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents: 46243
diff changeset
416 @item news@tab support for netnews reading and posting.
0a8de3bc39b5 (Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents: 46243
diff changeset
417 @item oop@tab support for object-oriented programming.
54473
6f6d287fe506 Sync keywords with finder.el.
Juri Linkov <juri@jurta.org>
parents: 52401
diff changeset
418 @item outlines@tab support for hierarchical outlining.
51790
0a8de3bc39b5 (Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents: 46243
diff changeset
419 @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
420 @item terminals@tab support for terminal types.
54473
6f6d287fe506 Sync keywords with finder.el.
Juri Linkov <juri@jurta.org>
parents: 52401
diff changeset
421 @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
422 @item tools@tab programming tools.
54473
6f6d287fe506 Sync keywords with finder.el.
Juri Linkov <juri@jurta.org>
parents: 52401
diff changeset
423 @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
424 @item wp@tab word processing.
0a8de3bc39b5 (Library Keywords): Use @multitable.
Richard M. Stallman <rms@gnu.org>
parents: 46243
diff changeset
425 @end multitable
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
426
Dave Love <fx@gnu.org>
parents:
diff changeset
427 @node Language Help
Dave Love <fx@gnu.org>
parents:
diff changeset
428 @section Help for International Language Support
Dave Love <fx@gnu.org>
parents:
diff changeset
429
Dave Love <fx@gnu.org>
parents:
diff changeset
430 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
431 (@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
432 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
433 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
434 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
435 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
436 text to illustrate scripts.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
437
Dave Love <fx@gnu.org>
parents:
diff changeset
438 The command @kbd{C-h h} (@code{view-hello-file}) displays the file
Dave Love <fx@gnu.org>
parents:
diff changeset
439 @file{etc/HELLO}, which shows how to say ``hello'' in many languages.
Dave Love <fx@gnu.org>
parents:
diff changeset
440
Dave Love <fx@gnu.org>
parents:
diff changeset
441 The command @kbd{C-h I} (@code{describe-input-method}) describes
Dave Love <fx@gnu.org>
parents:
diff changeset
442 information about input methods---either a specified input method, or by
Dave Love <fx@gnu.org>
parents:
diff changeset
443 default the input method in use. @xref{Input Methods}.
Dave Love <fx@gnu.org>
parents:
diff changeset
444
Dave Love <fx@gnu.org>
parents:
diff changeset
445 The command @kbd{C-h C} (@code{describe-coding-system}) describes
Dave Love <fx@gnu.org>
parents:
diff changeset
446 information about coding systems---either a specified coding system, or
Dave Love <fx@gnu.org>
parents:
diff changeset
447 the ones currently in use. @xref{Coding Systems}.
Dave Love <fx@gnu.org>
parents:
diff changeset
448
Dave Love <fx@gnu.org>
parents:
diff changeset
449 @node Help Mode
Dave Love <fx@gnu.org>
parents:
diff changeset
450 @section Help Mode Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
451
38488
2a70c922f6ad Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 38461
diff changeset
452 Help buffers provide the same commands as View mode (@pxref{Misc File
2a70c922f6ad Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 38461
diff changeset
453 Ops}), plus a few special commands of their own.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
454
Dave Love <fx@gnu.org>
parents:
diff changeset
455 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
456 @item @key{SPC}
Dave Love <fx@gnu.org>
parents:
diff changeset
457 Scroll forward.
Dave Love <fx@gnu.org>
parents:
diff changeset
458 @item @key{DEL}
36655
985393bc6af7 (Help Mode): Mention the backspace key.
Eli Zaretskii <eliz@gnu.org>
parents: 36454
diff changeset
459 @itemx @key{BS}
985393bc6af7 (Help Mode): Mention the backspace key.
Eli Zaretskii <eliz@gnu.org>
parents: 36454
diff changeset
460 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
461 @key{backspace}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
462 @item @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
463 Follow a cross reference at point.
Dave Love <fx@gnu.org>
parents:
diff changeset
464 @item @key{TAB}
Dave Love <fx@gnu.org>
parents:
diff changeset
465 Move point forward to the next cross reference.
Dave Love <fx@gnu.org>
parents:
diff changeset
466 @item S-@key{TAB}
Dave Love <fx@gnu.org>
parents:
diff changeset
467 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
468 @item Mouse-1
2116c6a9e16c (Help): Correct error about C-h in query-replace.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
469 @itemx Mouse-2
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
470 Follow a cross reference that you click on.
Dave Love <fx@gnu.org>
parents:
diff changeset
471 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
472
60106
2116c6a9e16c (Help): Correct error about C-h in query-replace.
Richard M. Stallman <rms@gnu.org>
parents: 59798
diff changeset
473 When a function name (@pxref{M-x,, Running Commands by Name}) or
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
474 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
475 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
476 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
477 @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
478 @kbd{C-c C-b} to retrace your steps.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
479
66570
272a21a12d44 (Help Mode): URLs viewed with browse-url.
Bill Wohler <wohler@newt.com>
parents: 66515
diff changeset
480 @cindex URL, viewing in help
272a21a12d44 (Help Mode): URLs viewed with browse-url.
Bill Wohler <wohler@newt.com>
parents: 66515
diff changeset
481 @cindex help, viewing web pages
272a21a12d44 (Help Mode): URLs viewed with browse-url.
Bill Wohler <wohler@newt.com>
parents: 66515
diff changeset
482 @cindex viewing web pages in help
272a21a12d44 (Help Mode): URLs viewed with browse-url.
Bill Wohler <wohler@newt.com>
parents: 66515
diff changeset
483 @cindex web pages, viewing in help
272a21a12d44 (Help Mode): URLs viewed with browse-url.
Bill Wohler <wohler@newt.com>
parents: 66515
diff changeset
484 @findex browse-url
66614
66a051003eb6 (Help Mode): Fix typo.
Bill Wohler <wohler@newt.com>
parents: 66570
diff changeset
485 You can follow cross references to URLs (web pages) as well. When
66570
272a21a12d44 (Help Mode): URLs viewed with browse-url.
Bill Wohler <wohler@newt.com>
parents: 66515
diff changeset
486 you follow a cross reference that is a URL, the @code{browse-url}
272a21a12d44 (Help Mode): URLs viewed with browse-url.
Bill Wohler <wohler@newt.com>
parents: 66515
diff changeset
487 command is used to view the web page in a browser of your choosing.
272a21a12d44 (Help Mode): URLs viewed with browse-url.
Bill Wohler <wohler@newt.com>
parents: 66515
diff changeset
488 @xref{Browse-URL}.
272a21a12d44 (Help Mode): URLs viewed with browse-url.
Bill Wohler <wohler@newt.com>
parents: 66515
diff changeset
489
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
490 @kindex @key{TAB} @r{(Help mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
491 @findex help-next-ref
Dave Love <fx@gnu.org>
parents:
diff changeset
492 @kindex S-@key{TAB} @r{(Help mode)}
Dave Love <fx@gnu.org>
parents:
diff changeset
493 @findex help-previous-ref
Dave Love <fx@gnu.org>
parents:
diff changeset
494 There are convenient commands for moving point to cross references in
Dave Love <fx@gnu.org>
parents:
diff changeset
495 the help text. @key{TAB} (@code{help-next-ref}) moves point down to the
Dave Love <fx@gnu.org>
parents:
diff changeset
496 next cross reference. Use @kbd{S-@key{TAB}} to move point up to the
Dave Love <fx@gnu.org>
parents:
diff changeset
497 previous cross reference (@code{help-previous-ref}).
Dave Love <fx@gnu.org>
parents:
diff changeset
498
Dave Love <fx@gnu.org>
parents:
diff changeset
499 @node Misc Help
Dave Love <fx@gnu.org>
parents:
diff changeset
500 @section Other Help Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
501
Dave Love <fx@gnu.org>
parents:
diff changeset
502 @kindex C-h i
Dave Love <fx@gnu.org>
parents:
diff changeset
503 @findex info
Dave Love <fx@gnu.org>
parents:
diff changeset
504 @cindex Info
Dave Love <fx@gnu.org>
parents:
diff changeset
505 @cindex manuals, on-line
Dave Love <fx@gnu.org>
parents:
diff changeset
506 @cindex on-line manuals
Dave Love <fx@gnu.org>
parents:
diff changeset
507 @kbd{C-h i} (@code{info}) runs the Info program, which is used for
Dave Love <fx@gnu.org>
parents:
diff changeset
508 browsing through structured documentation files. The entire Emacs manual
38488
2a70c922f6ad Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 38461
diff changeset
509 is available within Info. Eventually all the documentation of the GNU
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
510 system will be available. Type @kbd{h} after entering Info to run
Dave Love <fx@gnu.org>
parents:
diff changeset
511 a tutorial on using Info.
Dave Love <fx@gnu.org>
parents:
diff changeset
512
56735
d6c81d81255e (Misc Help): Add an index entry for finding an Info
Eli Zaretskii <eliz@gnu.org>
parents: 56649
diff changeset
513 @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
514 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
515 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
516 (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
517 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
518 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
519 documentation file. This way, you can browse a file which doesn't
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
520 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
521 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
522 of the file.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
523
46243
dfc7817ae834 Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents: 39368
diff changeset
524 @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
525 @kindex C-h K
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
526 @findex Info-goto-emacs-key-command-node
Dave Love <fx@gnu.org>
parents:
diff changeset
527 @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
528 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
529 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
530 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
531 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
532 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
533 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
534 @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
535 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
536 @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
537
46243
dfc7817ae834 Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents: 39368
diff changeset
538 @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
539 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
540 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
541 which manual describes them, like when using some specialized mode.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
542
46243
dfc7817ae834 Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents: 39368
diff changeset
543 @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
544 @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
545 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
546 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
547 (@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
548 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
549 command works depend on the major mode.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
550
Dave Love <fx@gnu.org>
parents:
diff changeset
551 @kindex C-h l
Dave Love <fx@gnu.org>
parents:
diff changeset
552 @findex view-lossage
Dave Love <fx@gnu.org>
parents:
diff changeset
553 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
554 typed, use @kbd{C-h l} (@code{view-lossage}). @kbd{C-h l} displays the last
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
555 100 command characters you typed in. If you see commands that you don't
Dave Love <fx@gnu.org>
parents:
diff changeset
556 know, you can use @kbd{C-h c} to find out what they do.
Dave Love <fx@gnu.org>
parents:
diff changeset
557
46243
dfc7817ae834 Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents: 39368
diff changeset
558 @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
559 @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
560 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
561 @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
562 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
563
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
564 @kindex C-h m
Dave Love <fx@gnu.org>
parents:
diff changeset
565 @findex describe-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
566 Emacs has numerous major modes, each of which redefines a few keys and
Dave Love <fx@gnu.org>
parents:
diff changeset
567 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
568 (@code{describe-mode}) displays documentation on the current major mode,
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
569 which normally describes all the commands that are changed in this
Dave Love <fx@gnu.org>
parents:
diff changeset
570 mode.
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}
Dave Love <fx@gnu.org>
parents:
diff changeset
575 (@code{describe-syntax}) present other information about the current
Dave Love <fx@gnu.org>
parents:
diff changeset
576 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
577 effect, showing the local bindings defined by the current minor modes first,
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
578 then the local bindings defined by the current major mode, and finally
Dave Love <fx@gnu.org>
parents:
diff changeset
579 the global bindings (@pxref{Key Bindings}). @kbd{C-h s} displays the
Dave Love <fx@gnu.org>
parents:
diff changeset
580 contents of the syntax table, with explanations of each character's
Dave Love <fx@gnu.org>
parents:
diff changeset
581 syntax (@pxref{Syntax}).
Dave Love <fx@gnu.org>
parents:
diff changeset
582
Dave Love <fx@gnu.org>
parents:
diff changeset
583 You can get a similar list for a particular prefix key by typing
Dave Love <fx@gnu.org>
parents:
diff changeset
584 @kbd{C-h} after the prefix key. (There are a few prefix keys for which
Dave Love <fx@gnu.org>
parents:
diff changeset
585 this does not work---those that provide their own bindings for
Dave Love <fx@gnu.org>
parents:
diff changeset
586 @kbd{C-h}. One of these is @key{ESC}, because @kbd{@key{ESC} C-h} is
Dave Love <fx@gnu.org>
parents:
diff changeset
587 actually @kbd{C-M-h}, which marks a defun.)
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
dfc7817ae834 Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents: 39368
diff changeset
592 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
593 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
594 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
595 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
596
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
597 @kindex C-h C-c
Dave Love <fx@gnu.org>
parents:
diff changeset
598 @findex describe-copying
Dave Love <fx@gnu.org>
parents:
diff changeset
599 @kindex C-h C-d
Dave Love <fx@gnu.org>
parents:
diff changeset
600 @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
601 @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
602 @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
603 @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
604 @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
605 @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
606 @findex view-emacs-news
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
607 @kindex C-h C-p
Dave Love <fx@gnu.org>
parents:
diff changeset
608 @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
609 @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
610 @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
611 @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
612 @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
613 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
614 information.
dfc7817ae834 Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents: 39368
diff changeset
615
dfc7817ae834 Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents: 39368
diff changeset
616 @table @kbd
dfc7817ae834 Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents: 39368
diff changeset
617 @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
618 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
619 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
620 @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
621 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
622 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
623 @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
624 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
625 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
626 @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
627 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
628 @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
629 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
630 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
631 @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
632 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
633 (@code{describe-project}).
dfc7817ae834 Document the major rearrangement of help commands after 21.1.
Richard M. Stallman <rms@gnu.org>
parents: 39368
diff changeset
634 @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
635 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
636 @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
637 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
638 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
639 @end table
28433
8605ab7873d4 Hyperlinks, help echo.
Dave Love <fx@gnu.org>
parents: 26767
diff changeset
640
8605ab7873d4 Hyperlinks, help echo.
Dave Love <fx@gnu.org>
parents: 26767
diff changeset
641 @node Help Echo
8605ab7873d4 Hyperlinks, help echo.
Dave Love <fx@gnu.org>
parents: 26767
diff changeset
642 @section Help on Active Text and Tooltips
8605ab7873d4 Hyperlinks, help echo.
Dave Love <fx@gnu.org>
parents: 26767
diff changeset
643
8605ab7873d4 Hyperlinks, help echo.
Dave Love <fx@gnu.org>
parents: 26767
diff changeset
644 @cindex tooltips
38461
23f63206a867 Proofreading fixes from Chris Green <chris_e_green@yahoo.com>.
Eli Zaretskii <eliz@gnu.org>
parents: 37151
diff changeset
645 @cindex balloon help
38745
5464ee1ba8e2 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 38488
diff changeset
646 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
647 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
648 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
649 text is displayed as a ``tooltip'' (sometimes known as ``balloon
66746
2a26902fb8a4 (Help Echo): By default, help echos are only shown on mouse-over, not
Luc Teirlinck <teirllm@auburn.edu>
parents: 66614
diff changeset
650 help''), when you move the mouse over the active text. @xref{Tooltips}.
2a26902fb8a4 (Help Echo): By default, help echos are only shown on mouse-over, not
Luc Teirlinck <teirllm@auburn.edu>
parents: 66614
diff changeset
651 On some systems, it is shown in the echo area. On text-only
2a26902fb8a4 (Help Echo): By default, help echos are only shown on mouse-over, not
Luc Teirlinck <teirllm@auburn.edu>
parents: 66614
diff changeset
652 terminals, Emacs may not be able to follow the mouse and hence will
2a26902fb8a4 (Help Echo): By default, help echos are only shown on mouse-over, not
Luc Teirlinck <teirllm@auburn.edu>
parents: 66614
diff changeset
653 not show the help text on mouse-over.
60953
ec2b6eebb74a (Help Summary): Add `C-h .'.
Richard M. Stallman <rms@gnu.org>
parents: 60794
diff changeset
654
ec2b6eebb74a (Help Summary): Add `C-h .'.
Richard M. Stallman <rms@gnu.org>
parents: 60794
diff changeset
655 @kindex C-h .
ec2b6eebb74a (Help Summary): Add `C-h .'.
Richard M. Stallman <rms@gnu.org>
parents: 60794
diff changeset
656 @findex display-local-help
ec2b6eebb74a (Help Summary): Add `C-h .'.
Richard M. Stallman <rms@gnu.org>
parents: 60794
diff changeset
657 @vindex help-at-pt-display-when-idle
ec2b6eebb74a (Help Summary): Add `C-h .'.
Richard M. Stallman <rms@gnu.org>
parents: 60794
diff changeset
658 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
659 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
660 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
661 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
662 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
663 @code{t}.
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 51790
diff changeset
664
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 51790
diff changeset
665 @ignore
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 51790
diff changeset
666 arch-tag: 6f33ab62-bc75-4367-8057-fd67cc15c3a1
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 51790
diff changeset
667 @end ignore