annotate doc/emacs/help.texi @ 112397:a7191495c39c

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