annotate man/help.texi @ 90054:f2ebccfa87d4

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