aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard M. Stallman2006-07-03 15:50:37 +0000
committerRichard M. Stallman2006-07-03 15:50:37 +0000
commit1abade00b8ebf52f51353da7297537b3f4b34996 (patch)
tree7457c3e331bc10e476f8a72b7a4617948647896a
parentbc5fba524ec067fc2db8372178df353ac647086d (diff)
downloademacs-1abade00b8ebf52f51353da7297537b3f4b34996.tar.gz
emacs-1abade00b8ebf52f51353da7297537b3f4b34996.zip
Lots of cleanups.
-rw-r--r--man/help.texi528
-rw-r--r--man/m-x.texi66
2 files changed, 289 insertions, 305 deletions
diff --git a/man/help.texi b/man/help.texi
index 4d69e18cc39..47600b711fa 100644
--- a/man/help.texi
+++ b/man/help.texi
@@ -11,65 +11,62 @@
11@kindex C-h 11@kindex C-h
12@kindex F1 12@kindex F1
13 13
14 Emacs provides extensive help features accessible through a single 14 Emacs provides extensive help features, all accessible through the
15character, @kbd{C-h} (or @key{F1}). @kbd{C-h} is a prefix key that is 15@dfn{help character}, @kbd{C-h}. This is a prefix key that is used
16used for commands that display documentation. The characters that you 16for commands that display documentation; the next character you type
17can type after @kbd{C-h} are called @dfn{help options}. One help 17should be a @dfn{help options}, to ask for a particular kind of help.
18option is @kbd{C-h}; that is how you ask for help about using 18You can cancel the @kbd{C-h} command with @kbd{C-g}. The function key
19@kbd{C-h}. To cancel, type @kbd{C-g}. The function key @key{F1} is 19@key{F1} is equivalent to @kbd{C-h}.
20equivalent to @kbd{C-h}.
21 20
22@kindex C-h C-h 21@kindex C-h C-h
23@findex help-for-help 22@findex help-for-help
24 @kbd{C-h C-h} (@code{help-for-help}) displays a list of the possible 23 @kbd{C-h} itself is one of the help options; @kbd{C-h C-h} displays
25help options, each with a brief description. You can look at the 24a list of help options, with a brief description of each one
26list, using @key{SPC} and @key{DEL} to scroll through it, then type 25(@code{help-for-help}). You can scroll the list with @key{SPC} and
27the help option you want. To cancel, type @kbd{C-g}. 26@key{DEL}, then type the help option you want. To cancel, type
27@kbd{C-g}.
28 28
29 @kbd{C-h} or @key{F1} means ``help'' in various other contexts as 29 @kbd{C-h} or @key{F1} means ``help'' in various other contexts as
30well. After a prefix key, it displays a list of the alternatives that 30well. For instance, you can type them after a prefix key to display
31can follow the prefix key. (A few prefix keys don't support 31list of the keys that can follow the prefix key. (A few prefix keys
32@kbd{C-h}, because they define other meanings for it, but they all 32don't support @kbd{C-h} in this way, because they define other
33support @key{F1}.) 33meanings for it, but they all support @key{F1} for help.)
34 34
35 Most help buffers use a special major mode, Help mode, which lets you 35 Most help buffers use a special major mode, Help mode, which lets
36scroll conveniently with @key{SPC} and @key{DEL}. It also offers 36you scroll conveniently with @key{SPC} and @key{DEL}. You can also
37hyperlinks to URLs and further help regarding cross-referenced names, Info 37follow hyperlinks to URLs, and to other facilities including Info
38nodes, customization buffers and the like. @xref{Help Mode}. 38nodes and customization buffers. @xref{Help Mode}.
39 39
40@cindex searching documentation efficiently 40@cindex searching documentation efficiently
41@cindex looking for a subject in documentation 41@cindex looking for a subject in documentation
42 If you are looking for a certain feature, but don't know where 42 If you are looking for a certain feature, but don't know what it is
43exactly it is documented, and aren't sure of the name of a 43called or where to look, we recommend three methods. First, try an
44related command or variable, we recommend trying these methods. Usually 44apropos command, then try searching the manual index, then look in the
45it is best to start with an apropos command, then try searching the 45FAQ and the package keywords.
46manual index, then finally look in the FAQ and the package keywords.
47 46
48@table @kbd 47@table @kbd
49@item C-h a @var{topics} @key{RET} 48@item C-h a @var{topics} @key{RET}
50This searches for commands whose names match @var{topics}, which 49This searches for commands whose names match the argument
51should be a keyword, a list of keywords, or a regular expression 50@var{topics}. The argument can be a keyword, a list of keywords, or a
52(@pxref{Regexps}). This command displays all the matches in a new 51regular expression (@pxref{Regexps}). This command displays all the
53buffer. @xref{Apropos}. 52matches in a new buffer. @xref{Apropos}.
54 53
55@item C-h i d m emacs @key{RET} i @var{topic} @key{RET} 54@item C-h i d m emacs @key{RET} i @var{topic} @key{RET}
56This looks up @var{topic} in the indices of the Emacs on-line manual. 55This searches for @var{topic} in the indices of the on-line Emacs
57If there are several matches, Emacs displays the first one. You can then 56manual, and displays the first match found. Press @kbd{,} to see
58press @kbd{,} to move to other matches, until you find what you are 57subsequent matches. You can use a regular expression as @var{topic}.
59looking for.
60 58
61@item C-h i d m emacs @key{RET} s @var{topic} @key{RET} 59@item C-h i d m emacs @key{RET} s @var{topic} @key{RET}
62Similar, but searches for @var{topic} (which can be a regular 60Similar, but searches the @emph{text} of the manual rather than the
63expression) in the @emph{text} of the manual rather than in its
64indices. 61indices.
65 62
66@item C-h C-f 63@item C-h C-f
67This brings up the Emacs FAQ. You can use the Info commands 64This displays the Emacs FAQ. You can use the Info commands
68to browse it. 65to browse it.
69 66
70@item C-h p 67@item C-h p
71Finally, you can try looking up a suitable package using keywords 68This displays the available Emacs packages based on keywords.
72pertinent to the feature you need. @xref{Library Keywords}. 69@xref{Library Keywords}.
73@end table 70@end table
74 71
75@menu 72@menu
@@ -93,25 +90,25 @@ pertinent to the feature you need. @xref{Library Keywords}.
93@section Help Summary 90@section Help Summary
94@end ifnottex 91@end ifnottex
95 92
96 Here is a summary of the Emacs interactive help commands. 93 Here is a summary of the Emacs interactive help commands. (The
97@xref{Help Files}, for other help commands that just display a 94character that follows @kbd{C-h} is the ``help option.'') @xref{Help
98pre-written file of information. The character that follows 95Files}, for other help commands that display fixed files of
99@kbd{C-h} is a ``help option.'' 96information.
100 97
101@table @kbd 98@table @kbd
102@item C-h a @var{topics} @key{RET} 99@item C-h a @var{topics} @key{RET}
103Display a list of commands whose names match @var{topics} 100Display a list of commands whose names match @var{topics}
104(@code{apropos-command}; @pxref{Apropos}). 101(@code{apropos-command}; @pxref{Apropos}).
105@item C-h b 102@item C-h b
106Display a table of all key bindings in effect now, in this order: minor 103Display all active key bindings; minor mode bindings first, then those
107mode bindings, major mode bindings, and global bindings 104of the major mode, then global bindings (@code{describe-bindings}).
108(@code{describe-bindings}).
109@item C-h c @var{key} 105@item C-h c @var{key}
110Show the name of the command that @var{key} runs 106Given a key sequence @var{key}, show the name of the command that it
111(@code{describe-key-briefly}). Here @kbd{c} stands for ``character.'' 107runs (@code{describe-key-briefly}). Here @kbd{c} stands for
112For more extensive information on @var{key}, use @kbd{C-h k}. 108``character.'' For more extensive information on @var{key}, use
109@kbd{C-h k}.
113@item C-h d @var{topics} @key{RET} 110@item C-h d @var{topics} @key{RET}
114Display a list of commands and variables whose documentation matches 111Display the commands and variables whose documentation matches
115@var{topics} (@code{apropos-documentation}). 112@var{topics} (@code{apropos-documentation}).
116@item C-h e 113@item C-h e
117Display the @code{*Messages*} buffer 114Display the @code{*Messages*} buffer
@@ -119,12 +116,12 @@ Display the @code{*Messages*} buffer
119@item C-h f @var{function} @key{RET} 116@item C-h f @var{function} @key{RET}
120Display documentation on the Lisp function named @var{function} 117Display documentation on the Lisp function named @var{function}
121(@code{describe-function}). Since commands are Lisp functions, 118(@code{describe-function}). Since commands are Lisp functions,
122a command name may be used. 119this works for commands too.
123@item C-h h 120@item C-h h
124Display the @file{HELLO} file, which shows examples of various character 121Display the @file{HELLO} file, which shows examples of various character
125sets. 122sets.
126@item C-h i 123@item C-h i
127Run Info, the program for browsing documentation files (@code{info}). 124Run Info, the GNU documentation browser (@code{info}).
128The complete Emacs manual is available on-line in Info. 125The complete Emacs manual is available on-line in Info.
129@item C-h k @var{key} 126@item C-h k @var{key}
130Display the name and documentation of the command that @var{key} runs 127Display the name and documentation of the command that @var{key} runs
@@ -137,7 +134,7 @@ Display documentation of the current major mode (@code{describe-mode}).
137@item C-h p 134@item C-h p
138Find packages by topic keyword (@code{finder-by-keyword}). 135Find packages by topic keyword (@code{finder-by-keyword}).
139@item C-h s 136@item C-h s
140Display the current contents of the syntax table, plus an explanation of 137Display the current contents of the syntax table, with an explanation of
141what they mean (@code{describe-syntax}). @xref{Syntax}. 138what they mean (@code{describe-syntax}). @xref{Syntax}.
142@item C-h t 139@item C-h t
143Enter the Emacs interactive tutorial (@code{help-with-tutorial}). 140Enter the Emacs interactive tutorial (@code{help-with-tutorial}).
@@ -147,28 +144,29 @@ Display the documentation of the Lisp variable @var{var}
147@item C-h w @var{command} @key{RET} 144@item C-h w @var{command} @key{RET}
148Show which keys run the command named @var{command} (@code{where-is}). 145Show which keys run the command named @var{command} (@code{where-is}).
149@item C-h C @var{coding} @key{RET} 146@item C-h C @var{coding} @key{RET}
150Describe coding system @var{coding} 147Describe the coding system @var{coding}
151(@code{describe-coding-system}). 148(@code{describe-coding-system}).
152@item C-h C @key{RET} 149@item C-h C @key{RET}
153Describe the coding systems currently in use. 150Describe the coding systems currently in use.
154@item C-h I @var{method} @key{RET} 151@item C-h I @var{method} @key{RET}
155Describe an input method (@code{describe-input-method}). 152Describe the input method @var{method} (@code{describe-input-method}).
156@item C-h L @var{language-env} @key{RET} 153@item C-h L @var{language-env} @key{RET}
157Display information on the character sets, coding systems, and input 154Display information on the character sets, coding systems, and input
158methods used for language environment @var{language-env} 155methods used in language environment @var{language-env}
159(@code{describe-language-environment}). 156(@code{describe-language-environment}).
160@item C-h F @var{function} @key{RET} 157@item C-h F @var{function} @key{RET}
161Enter Info and go to the node documenting the Emacs function @var{function} 158Enter Info and goes to the node that documents the Emacs function
162(@code{Info-goto-emacs-command-node}). 159@var{function} (@code{Info-goto-emacs-command-node}).
163@item C-h K @var{key} 160@item C-h K @var{key}
164Enter Info and go to the node where the key sequence @var{key} is 161Enter Info and goes to the node that documents the key sequence
165documented (@code{Info-goto-emacs-key-command-node}). 162@var{key} (@code{Info-goto-emacs-key-command-node}).
166@item C-h S @var{symbol} @key{RET} 163@item C-h S @var{symbol} @key{RET}
167Display the Info documentation on symbol @var{symbol} according to the 164Display the Info documentation on symbol @var{symbol} according to the
168programming language you are editing (@code{info-lookup-symbol}). 165programming language you are editing (@code{info-lookup-symbol}).
169@item C-h . 166@item C-h .
170Display a help message associated with special text areas, such as 167Display the help message for a special text area, if point is in one
171links in @samp{*Help*} buffers (@code{display-local-help}). 168(@code{display-local-help}). (These include, for example, links in
169@samp{*Help*} buffers.)
172@end table 170@end table
173 171
174@node Key Help 172@node Key Help
@@ -176,50 +174,48 @@ links in @samp{*Help*} buffers (@code{display-local-help}).
176 174
177@kindex C-h c 175@kindex C-h c
178@findex describe-key-briefly 176@findex describe-key-briefly
179 The most basic @kbd{C-h} commands are @kbd{C-h c} 177 The help commands to get information about a key sequence are
180(@code{describe-key-briefly}) and @w{@kbd{C-h k}} (@code{describe-key}). 178@kbd{C-h c} and @w{@kbd{C-h k}}. @kbd{C-h c @var{key}} displays in
181@kbd{C-h c @var{key}} displays in the echo area the name of the command 179the echo area the name of the command that @var{key} is bound to. For
182that @var{key} is bound to. For example, @kbd{C-h c C-f} displays 180example, @kbd{C-h c C-f} displays @samp{forward-char}. Since command
183@samp{forward-char}. Since command names are chosen to describe what 181names are chosen to describe what the commands do, this gives you a
184the commands do, this is a good way to get a very brief description of 182very brief description of what @var{key} does.
185what @var{key} does.
186 183
187@kindex C-h k 184@kindex C-h k
188@findex describe-key 185@findex describe-key
189 @kbd{C-h k @var{key}} is similar but gives more information: it 186 @kbd{C-h k @var{key}} is similar but gives more information: it
190displays the documentation string of the command as well as its name. 187displays the documentation string of the command as well as its name.
191This is too big for the echo area, so a window is used for the display. 188It displays this information in a window, since it may not fit in the
189echo area.
192 190
193@kindex C-h K 191@kindex C-h K
194@findex Info-goto-emacs-key-command-node 192@findex Info-goto-emacs-key-command-node
195 To find the documentation of a key sequence, type @kbd{C-h K} and 193 To find the documentation of a key sequence @var{key}, type @kbd{C-h
196then enter that key sequence. This looks up the description of the 194K @var{key}}. This displays the appropriate manual section which
197command invoked by the key in whichever manual describes it (this need 195contains the documentation of @var{key}.
198not be the Emacs manual). @kbd{C-h K} runs the command
199@code{Info-goto-emacs-key-command-node}.
200 196
201 @kbd{C-h c}, @kbd{C-h k} and @kbd{C-h K} work for any sort of key 197 @kbd{C-h c}, @kbd{C-h k} and @kbd{C-h K} work for any sort of key
202sequences, including function keys, menus, and mouse events. For 198sequences, including function keys, menus, and mouse events. For
203instance, you can type @kbd{C-h k} and then select a menu item from 199instance, after @kbd{C-h k} you can select a menu item from the menu
204the menu bar, to show the documentation string of the command that 200bar, to view the documentation string of the command it runs.
205menu item runs.
206 201
207@kindex C-h w 202@kindex C-h w
208@findex where-is 203@findex where-is
209 @kbd{C-h w @var{command} @key{RET}} tells you what keys are bound to 204 @kbd{C-h w @var{command} @key{RET}} lists the keys that are bound to
210@var{command}. It displays a list of the keys in the echo area. If it 205@var{command}. It displays the list in the echo area. If it says the
211says the command is not on any key, you must use @kbd{M-x} to run it. 206command is not on any key, that means you must use @kbd{M-x} to run
212@kbd{C-h w} runs the command @code{where-is}. 207it. @kbd{C-h w} runs the command @code{where-is}.
213 208
214@node Name Help 209@node Name Help
215@section Help by Command or Variable Name 210@section Help by Command or Variable Name
216 211
217@kindex C-h f 212@kindex C-h f
218@findex describe-function 213@findex describe-function
219 @kbd{C-h f} (@code{describe-function}) reads the name of a Lisp function 214 @kbd{C-h f @var{function} @key{RET}} (@code{describe-function})
220using the minibuffer, then displays that function's documentation string 215displays the documentation of Lisp function @var{function}, in a
221in a window. Since commands are Lisp functions, you can use this to get 216window. Since commands are Lisp functions, you can use this method to
222the documentation of a command that you know by name. For example, 217view the documentation of any command whose name you know. For
218example,
223 219
224@example 220@example
225C-h f auto-fill-mode @key{RET} 221C-h f auto-fill-mode @key{RET}
@@ -230,118 +226,119 @@ displays the documentation of @code{auto-fill-mode}. This is the only
230way to get the documentation of a command that is not bound to any key 226way to get the documentation of a command that is not bound to any key
231(one which you would normally run using @kbd{M-x}). 227(one which you would normally run using @kbd{M-x}).
232 228
233 @kbd{C-h f} is also useful for Lisp functions that you are planning 229 @kbd{C-h f} is also useful for Lisp functions that you use in a Lisp
234to use in a Lisp program. For example, if you have just written the 230program. For example, if you have just written the expression
235expression @code{(make-vector len)} and want to check that you are 231@code{(make-vector len)} and want to check that you are using
236using @code{make-vector} properly, type @kbd{C-h f make-vector 232@code{make-vector} properly, type @kbd{C-h f make-vector @key{RET}}.
237@key{RET}}. Because @kbd{C-h f} allows all function names, not just 233Because @kbd{C-h f} allows all function names, not just command names,
238command names, you may find that some of your favorite completion 234you may find that some of your favorite completion abbreviations that
239abbreviations that work in @kbd{M-x} don't work in @kbd{C-h f}. An 235work in @kbd{M-x} don't work in @kbd{C-h f}. An abbreviation that is
240abbreviation may be unique among command names, yet fail to be unique 236unique among command names may not be unique among all function names.
241when other function names are allowed. 237
242 238 If you type @kbd{C-h f @key{RET}}, it describes the function called
243 The default function name for @kbd{C-h f} to describe, if you type 239by the innermost Lisp expression in the buffer around point,
244just @key{RET}, is the name of the function called by the innermost Lisp 240@emph{provided} that function name is a valid, defined Lisp function.
245expression in the buffer around point, @emph{provided} that is a valid, 241(That name appears as the default while you enter the argument.) For
246defined Lisp function name. For example, if point is located following 242example, if point is located following the text @samp{(make-vector
247the text @samp{(make-vector (car x)}, the innermost list containing 243(car x)}, the innermost list containing point is the one that starts
248point is the one that starts with @samp{(make-vector}, so the default is 244with @samp{(make-vector}, so @kbd{C-h f @key{RET}} will describe the
249to describe the function @code{make-vector}. 245function @code{make-vector}.
250 246
251 @kbd{C-h f} is often useful just to verify that you have the right 247 @kbd{C-h f} is also useful just to verify that you spelled a
252spelling for the function name. If @kbd{C-h f} mentions a name from the 248function name correctly. If the minibuffer prompt for @kbd{C-h f}
253buffer as the default, that name must be defined as a Lisp function. If 249shows the function name from the buffer as the default, it means that
254that is all you want to know, just type @kbd{C-g} to cancel the @kbd{C-h 250name is defined as a Lisp function. Type @kbd{C-g} to cancel the
255f} command, then go on editing. 251@kbd{C-h f} command if you don't really want to view the
256 252documentation.
257 @kbd{C-h v} (@code{describe-variable}) is like @kbd{C-h f} but describes 253
258Lisp variables instead of Lisp functions. Its default is the Lisp symbol 254 @kbd{C-h v} (@code{describe-variable}) is like @kbd{C-h f} but
259around or before point, but only if that is the name of a known Lisp 255describes Lisp variables instead of Lisp functions. Its default is
260variable. @xref{Variables}. 256the Lisp symbol around or before point, if that is the name of a
261 257defined Lisp variable. @xref{Variables}.
262 Help buffers describing Emacs variables and functions normally have 258
263hyperlinks to the definition, if you have the source files installed. 259 Help buffers that describe Emacs variables and functions normally
264(@xref{Hyperlinking}.) If you know Lisp (or C), this provides the 260have hyperlinks to the corresponding source definition, if you have
265ultimate documentation. If you don't know Lisp, you should learn it. 261the source files installed. (@xref{Hyperlinking}.) If you know Lisp
266(The Introduction to Emacs Lisp Programming, available from the FSF 262(or C), this provides the ultimate documentation. If you don't know
267through fsf.org, is a good way to get started.) Emacs won't be happy 263Lisp, you should learn it. (The Introduction to Emacs Lisp
268if it feels you are just @emph{using} Emacs, treating it as an object 264Programming, available from the FSF through fsf.org, is a good way to
269program. If you really love Emacs, show that you care by reading the 265get started.) If Emacs feels you are just @emph{using} it, treating
270source code. 266it as an object program, its feelings may be hurt. For real intimacy,
267read the Emacs source code.
271 268
272@kindex C-h F 269@kindex C-h F
273@findex Info-goto-emacs-command-node 270@findex Info-goto-emacs-command-node
274 To find a specific function's documentation in a manual, use 271 To find a function's documentation in a manual, use @kbd{C-h F}
275@kbd{C-h F} (@code{Info-goto-emacs-command-node}). This knows 272(@code{Info-goto-emacs-command-node}). This knows about various
276about various manuals, not just the Emacs manual, and finds the 273manuals, not just the Emacs manual, and finds the right one.
277right one.
278 274
279@node Apropos 275@node Apropos
280@section Apropos 276@section Apropos
281 277
282 A more sophisticated sort of question to ask is, ``What are the 278 The @dfn{apropos} commands answer questions like, ``What are the
283commands for working with files?'' The @dfn{apropos} commands ask 279commands for working with files?'' More precisely, you specify an
284such questions---they look for things whose names match an
285@dfn{apropos pattern}, which means either a word, a list of words, or 280@dfn{apropos pattern}, which means either a word, a list of words, or
286a regular expression. Each apropos command displays a list of 281a regular expression. Each apropos command displays a list of items
287matching items in a special buffer. 282that match the pattern, in a separate buffer.
288 283
289@table @kbd 284@table @kbd
290@item C-h a @var{pattern} @key{RET} 285@item C-h a @var{pattern} @key{RET}
291Search for commands whose names match @var{pattern}. 286Search for commands whose names match @var{pattern}.
292 287
293@item M-x apropos @key{RET} @var{pattern} @key{RET} 288@item M-x apropos @key{RET} @var{pattern} @key{RET}
294Similar, but it searches for noninteractive functions and for 289Search for functions and variables whose names match @var{pattern}.
295variables, as well as commands. 290Both interactive functions (commands) and noninteractive functions can
291be found by this command.
296 292
297@item M-x apropos-variable @key{RET} @var{pattern} @key{RET} 293@item M-x apropos-variable @key{RET} @var{pattern} @key{RET}
298Similar, but it searches for variables only. 294Search for user-option variables whose names match @var{pattern}.
299 295
300@item M-x apropos-value @key{RET} @var{pattern} @key{RET} 296@item M-x apropos-value @key{RET} @var{pattern} @key{RET}
301Similar, but it searches for variables based on their values, or 297Search for functions whose definitions @var{pattern}, and variables
302functions based on their definitions. 298whose values match @var{pattern}.
303 299
304@item C-h d @var{pattern} @key{RET} 300@item C-h d @var{pattern} @key{RET}
305Search the @emph{documentation strings} (the built-in short 301Search for functions and variables whose @strong{documentation
306descriptions) of all variables and functions (not their names) for a 302strings} match @var{pattern}.
307match for @var{pattern}.
308@end table 303@end table
309 304
310@kindex C-h a 305@kindex C-h a
311@findex apropos-command 306@findex apropos-command
312@cindex apropos 307@cindex apropos
313 To find the commands that work on files, type @kbd{C-h a file 308 The simplest kind of apropos pattern is one word. Anything which
314@key{RET}}. This displays a list of all command names that contain 309contains that word matches the pattern. Thus, to find the commands
315@samp{file}, including @code{copy-file}, @code{find-file}, and so on. 310that work on files, type @kbd{C-h a file @key{RET}}. This displays a
316With each command name appears a brief description of how to use the 311list of all command names that contain @samp{file}, including
317command, and what keys you can currently invoke it with. For example, 312@code{copy-file}, @code{find-file}, and so on. Each command name
318it would say that you can invoke @code{find-file} by typing @kbd{C-x 313comes with a brief description and a list of keys you can currently
319C-f}. The @kbd{a} in @kbd{C-h a} stands for ``Apropos''; @kbd{C-h a} 314invoke it with. In our example, it would say that you can invoke
315@code{find-file} by typing @kbd{C-x C-f}.
316
317 The @kbd{a} in @kbd{C-h a} stands for ``Apropos''; @kbd{C-h a}
320runs the command @code{apropos-command}. This command normally checks 318runs the command @code{apropos-command}. This command normally checks
321only commands (interactive functions); if you specify a prefix 319only commands (interactive functions); if you specify a prefix
322argument, it checks noninteractive functions as well. 320argument, it checks noninteractive functions as well.
323 321
324 If you want more information about a function definition, variable or 322 For more information about a function definition, variable or symbol
325symbol property listed in the Apropos buffer, you can click on it with 323property listed in the apropos buffer, you can click on it with
326@kbd{Mouse-1} or @kbd{Mouse-2}, or move there and type @key{RET}. 324@kbd{Mouse-1} or @kbd{Mouse-2}, or move there and type @key{RET}.
327 325
328 @kbd{C-h a} with a single word can find too many matches. Don't 326 When you specify more than one word in the apropos pattern, a name
329just give up; you can give Apropos a list of words to search for.
330When you specify more than one word in the apropos pattern, a name
331must contain at least two of the words in order to match. Thus, if 327must contain at least two of the words in order to match. Thus, if
332you are looking for commands to kill a chunk of text before point, you 328you are looking for commands to kill a chunk of text before point, you
333could try @kbd{C-h a kill back backward behind before @key{RET}}. 329could try @kbd{C-h a kill back backward behind before @key{RET}}. The
330real command name @code{kill-backward} will match that; if there were
331a command @code{kill-text-before}, it would also match, since it
332contains two of the specified words.
334 333
335 For even greater flexibility, you can specify a regular expression 334 For even greater flexibility, you can specify a regular expression
336(@pxref{Regexps}). An apropos pattern is interpreted as a regular 335(@pxref{Regexps}). An apropos pattern is interpreted as a regular
337expression if it contains any of the regular expression special 336expression if it contains any of the regular expression special
338characters, @samp{^$*+?.\[}. 337characters, @samp{^$*+?.\[}.
339 338
340 Here is a set of arguments to give to @kbd{C-h a} that covers many 339 Following the conventions for naming Emacs commands, here are some
341classes of Emacs commands, since there are strong conventions for 340words that you'll find useful in apropos patterns. By using them in
342naming the standard Emacs commands. By giving you a feel for the 341@kbd{C-h a}, you will also get a feel for the naming conventions.
343naming conventions, this set should also serve to aid you in
344developing a technique for picking Apropos keywords.
345 342
346@quotation 343@quotation
347char, line, word, sentence, paragraph, region, page, sexp, list, defun, 344char, line, word, sentence, paragraph, region, page, sexp, list, defun,
@@ -352,45 +349,44 @@ view, describe, default.
352@end quotation 349@end quotation
353 350
354@findex apropos 351@findex apropos
355 To list all Lisp symbols that contain a match for an Apropos pattern, 352 Use @kbd{M-x apropos} instead of @kbd{C-h a} to list all the Lisp
356not just the ones that are defined as commands, use the command 353symbols that match an apropos pattern, not just the symbols that are
357@kbd{M-x apropos} instead of @kbd{C-h a}. This command does not check 354commands. This command does not list key bindings by default; specify
358key bindings by default; specify a numeric argument if you want it to 355a numeric argument if you want it to list them.
359check them.
360 356
361@findex apropos-variable 357@findex apropos-variable
362 To list user-customizable variables that match an apropos pattern, 358 Use @kbd{M-x apropos-variable} to list user-customizable variables
363use the command @kbd{M-x apropos-variable}. If you specify a prefix 359that match an apropos pattern. If you specify a prefix argument, it
364argument, it checks all variables. 360lists all matching variables.
365 361
366@kindex C-h d 362@kindex C-h d
367@findex apropos-documentation 363@findex apropos-documentation
368 The @code{apropos-documentation} command is like @code{apropos} 364 The @code{apropos-documentation} command is like @code{apropos}
369except that it searches documentation strings instead of symbol names 365except that it searches documentation strings instead of symbol names
370for matches for the specified Apropos pattern. 366for matches.
371 367
372@findex apropos-value 368@findex apropos-value
373 The @code{apropos-value} command is like @code{apropos} except that 369 The @code{apropos-value} command is like @code{apropos} except that
374it searches variables' values for matches for the pattern. With a 370it searches variables' values for matches for the apropos pattern.
375prefix argument, it also checks symbols' function definitions and 371With a prefix argument, it also checks symbols' function definitions
376property lists. 372and property lists.
377 373
378@vindex apropos-do-all 374@vindex apropos-do-all
379 If the variable @code{apropos-do-all} is non-@code{nil}, the commands 375 If the variable @code{apropos-do-all} is non-@code{nil}, the apropos
380above all behave as if they had been given a prefix argument. 376commands always behave as if they had been given a prefix argument.
381 377
382@vindex apropos-sort-by-scores 378@vindex apropos-sort-by-scores
383@cindex apropos search results, order by score 379@cindex apropos search results, order by score
384 By default, Apropos lists the search results in alphabetical order. 380 By default, apropos lists the search results in alphabetical order.
385If the variable @code{apropos-sort-by-scores} is non-@code{nil}, 381If the variable @code{apropos-sort-by-scores} is non-@code{nil}, the
386Apropos tries to guess the relevance of each result, and displays the 382apropos commands try to guess the relevance of each result, and
387most relevant ones first. 383display the most relevant ones first.
388 384
389@vindex apropos-documentation-sort-by-scores 385@vindex apropos-documentation-sort-by-scores
390 By default, Apropos lists the search results for 386 By default, apropos lists the search results for
391@code{apropos-documentation} in order of relevance of the match. If 387@code{apropos-documentation} in order of relevance of the match. If
392the variable @code{apropos-documentation-sort-by-scores} is 388the variable @code{apropos-documentation-sort-by-scores} is
393@code{nil}, Apropos lists the symbols found in alphabetical order. 389@code{nil}, apropos lists the symbols found in alphabetical order.
394 390
395@node Library Keywords 391@node Library Keywords
396@section Keyword Search for Lisp Libraries 392@section Keyword Search for Lisp Libraries
@@ -444,23 +440,23 @@ use:
444@section Help for International Language Support 440@section Help for International Language Support
445 441
446 You can use the command @kbd{C-h L} 442 You can use the command @kbd{C-h L}
447(@code{describe-language-environment}) to find out information about 443(@code{describe-language-environment}) to get information about a
448the support for a specific language environment. @xref{Language 444specific language environment. @xref{Language Environments}. This
449Environments}. This tells you which languages this language 445tells you which languages this language environment supports. It also
450environment is useful for, and lists the character sets, coding 446lists the character sets, coding systems, and input methods that work
451systems, and input methods that it operates on. It also shows some 447with this language environment, and finally shows some sample text to
452sample text to illustrate scripts. 448illustrate scripts.
453 449
454 The command @kbd{C-h h} (@code{view-hello-file}) displays the file 450 The command @kbd{C-h h} (@code{view-hello-file}) displays the file
455@file{etc/HELLO}, which shows how to say ``hello'' in many languages. 451@file{etc/HELLO}, which shows how to say ``hello'' in many languages.
456 452
457 The command @kbd{C-h I} (@code{describe-input-method}) describes 453 The command @kbd{C-h I} (@code{describe-input-method}) describes an
458information about input methods---either a specified input method, or by 454input method---either a specified input method, or by default the
459default the input method in use. @xref{Input Methods}. 455input method currently in use. @xref{Input Methods}.
460 456
461 The command @kbd{C-h C} (@code{describe-coding-system}) describes 457 The command @kbd{C-h C} (@code{describe-coding-system}) describes
462information about coding systems---either a specified coding system, or 458coding systems---either a specified coding system, or the ones
463the ones currently in use. @xref{Coding Systems}. 459currently in use. @xref{Coding Systems}.
464 460
465@node Help Mode 461@node Help Mode
466@section Help Mode Commands 462@section Help Mode Commands
@@ -487,36 +483,36 @@ Show all documentation about the symbol at point.
487@end table 483@end table
488 484
489 When a function name (@pxref{M-x,, Running Commands by Name}), 485 When a function name (@pxref{M-x,, Running Commands by Name}),
490variable name (@pxref{Variables}), or face name (@pxref{Faces}) appears 486variable name (@pxref{Variables}), or face name (@pxref{Faces})
491in the documentation, it normally appears inside paired single-quotes. 487appears in the documentation, it normally appears inside paired
492You can click on the name with @kbd{Mouse-1} or @kbd{Mouse-2}, or move 488single-quotes. To view the documentation of that command, variable or
493point there and type @key{RET}, to view the documentation of that 489face, you can click on the name with @kbd{Mouse-1} or @kbd{Mouse-2},
494command, variable or face. Use @kbd{C-c C-b} to retrace your steps. 490or move point there and type @key{RET}. Use @kbd{C-c C-b} to retrace
491your steps.
495 492
496@cindex URL, viewing in help 493@cindex URL, viewing in help
497@cindex help, viewing web pages 494@cindex help, viewing web pages
498@cindex viewing web pages in help 495@cindex viewing web pages in help
499@cindex web pages, viewing in help 496@cindex web pages, viewing in help
500@findex browse-url 497@findex browse-url
501 You can follow cross references to URLs (web pages) as well. When 498 You can follow cross references to URLs (web pages) also. This uses
502you follow a cross reference that is a URL, the @code{browse-url} 499the @code{browse-url} command to view the page in the browser you
503command is used to view the web page in a browser of your choosing. 500choose. @xref{Browse-URL}.
504@xref{Browse-URL}.
505 501
506@kindex @key{TAB} @r{(Help mode)} 502@kindex @key{TAB} @r{(Help mode)}
507@findex help-next-ref 503@findex help-next-ref
508@kindex S-@key{TAB} @r{(Help mode)} 504@kindex S-@key{TAB} @r{(Help mode)}
509@findex help-previous-ref 505@findex help-previous-ref
510 There are convenient commands for moving point to cross references in 506 There are convenient commands to move point to cross references in
511the help text. @key{TAB} (@code{help-next-ref}) moves point down to the 507the help text. @key{TAB} (@code{help-next-ref}) moves point down to
512next cross reference. Use @kbd{S-@key{TAB}} to move point up to the 508the next cross reference. @kbd{S-@key{TAB}} moves up to the previous
513previous cross reference (@code{help-previous-ref}). 509cross reference (@code{help-previous-ref}).
514 510
515 You can view all documentation about any symbol name that appears in 511 To view all documentation about any symbol name that appears in the
516the text, by moving point to the symbol name and typing @kbd{C-c C-c} 512text, move point to the symbol name and type @kbd{C-c C-c}
517(@code{help-follow-symbol}). This shows all available documentation 513(@code{help-follow-symbol}). This shows all available documentation
518about the symbol as a variable, function and/or face. @kbd{C-c C-b} 514about the symbol as a variable, function and/or face. As above, use
519works in this case also, to retrace your steps. 515@kbd{C-c C-b} to retrace your steps.
520 516
521@node Misc Help 517@node Misc Help
522@section Other Help Commands 518@section Other Help Commands
@@ -526,22 +522,18 @@ works in this case also, to retrace your steps.
526@cindex Info 522@cindex Info
527@cindex manuals, on-line 523@cindex manuals, on-line
528@cindex on-line manuals 524@cindex on-line manuals
529 @kbd{C-h i} (@code{info}) runs the Info program, which is used for 525 @kbd{C-h i} (@code{info}) runs the Info program, which browses
530browsing through structured documentation files. The entire Emacs manual 526structured documentation files. The entire Emacs manual is available
531is available within Info. Eventually all the documentation of the GNU 527within Info, along with many other manuals for the GNU system. Type
532system will be available. Type @kbd{h} after entering Info to run 528@kbd{h} after entering Info to run a tutorial on using Info.
533a tutorial on using Info.
534 529
535@cindex find Info manual by its file name 530@cindex find Info manual by its file name
536 With a numeric argument, @kbd{C-h i} selects an Info buffer with the 531 With a numeric argument @var{n}, @kbd{C-h i} selects the Info buffer
537number appended to the default @samp{*info*} buffer name 532@samp{*info*<@var{n}>}. This is useful if you want to browse multiple
538(e.g. @samp{*info*<2>}). This is useful if you want to browse 533Info manuals simultaneously. If you specify just @kbd{C-u} as the
539multiple Info manuals simultaneously. If you specify just @kbd{C-u} 534prefix argument, @kbd{C-h i} prompts for the name of a documentation
540as the prefix argument, @kbd{C-h i} prompts for the name of a 535file, so you can browse a file which doesn't have an entry in the
541documentation file. This way, you can browse a file which doesn't 536top-level Info menu.
542have an entry in the top-level Info menu. It is also handy when you
543need to get to the documentation quickly, and you know the exact name
544of the file.
545 537
546 The help commands @kbd{C-h F @var{function} @key{RET}} and @kbd{C-h 538 The help commands @kbd{C-h F @var{function} @key{RET}} and @kbd{C-h
547K @var{key}}, described above, enter Info and go straight to the 539K @var{key}}, described above, enter Info and go straight to the
@@ -550,56 +542,56 @@ documentation of @var{function} or @var{key}.
550@kindex C-h S 542@kindex C-h S
551@findex info-lookup-symbol 543@findex info-lookup-symbol
552 When editing a program, if you have an Info version of the manual 544 When editing a program, if you have an Info version of the manual
553for the programming language, you can use the command @kbd{C-h S} 545for the programming language, you can use @kbd{C-h S}
554(@code{info-lookup-symbol}) to refer to the manual documentation for a 546(@code{info-lookup-symbol}) to find symbol (keyword, function or
555symbol (keyword, function or variable). The details of how this 547variable) in the proper manual. The details of how this command works
556command works depend on the major mode. 548depend on the major mode.
557 549
558@kindex C-h l 550@kindex C-h l
559@findex view-lossage 551@findex view-lossage
560 If something surprising happens, and you are not sure what commands you 552 If something surprising happens, and you are not sure what you
561typed, use @kbd{C-h l} (@code{view-lossage}). @kbd{C-h l} displays the last 553typed, use @kbd{C-h l} (@code{view-lossage}). @kbd{C-h l} displays
562100 command characters you typed in. If you see commands that you don't 554the last 100 characters you typed in Emacs. If you see commands that
563know, you can use @kbd{C-h c} to find out what they do. 555you don't know, you can use @kbd{C-h c} to find out what they do.
564 556
565@kindex C-h e 557@kindex C-h e
566@findex view-echo-area-messages 558@findex view-echo-area-messages
567 To review messages that recently appeared in the echo area, use 559 To review recent echo area messages, use @kbd{C-h e}
568@kbd{C-h e} (@code{view-echo-area-messages}). This displays the 560(@code{view-echo-area-messages}). This displays the buffer
569buffer @code{*Messages*}, where those messages are kept. 561@code{*Messages*}, where those messages are kept.
570 562
571@kindex C-h m 563@kindex C-h m
572@findex describe-mode 564@findex describe-mode
573 Emacs has numerous major modes, each of which redefines a few keys and 565 Each Emacs major mode typically redefines a few keys and makes other
574makes a few other changes in how editing works. @kbd{C-h m} 566changes in how editing works. @kbd{C-h m} (@code{describe-mode})
575(@code{describe-mode}) displays documentation on the current major mode, 567displays documentation on the current major mode, which normally
576which normally describes all the commands that are changed in this 568describes the commands and features that are changed in this mode.
577mode.
578 569
579@kindex C-h b 570@kindex C-h b
580@findex describe-bindings 571@findex describe-bindings
581 @kbd{C-h b} (@code{describe-bindings}) and @kbd{C-h s} 572 @kbd{C-h b} (@code{describe-bindings}) and @kbd{C-h s}
582(@code{describe-syntax}) present other information about the current 573(@code{describe-syntax}) show other information about the current
583Emacs mode. @kbd{C-h b} displays a list of all the key bindings now in 574environment within Emacs. @kbd{C-h b} displays a list of all the key
584effect, showing the local bindings defined by the current minor modes first, 575bindings now in effect: first the local bindings of the current minor
585then the local bindings defined by the current major mode, and finally 576modes, then the local bindings defined by the current major mode, and
586the global bindings (@pxref{Key Bindings}). @kbd{C-h s} displays the 577finally the global bindings (@pxref{Key Bindings}). @kbd{C-h s}
587contents of the syntax table, with explanations of each character's 578displays the contents of the syntax table, with explanations of each
588syntax (@pxref{Syntax}). 579character's syntax (@pxref{Syntax}).
589 580
590 You can get a similar list for a particular prefix key by typing 581 You can get a list of subcommands for a particular prefix key by
591@kbd{C-h} after the prefix key. (There are a few prefix keys for which 582typing @kbd{C-h} after the prefix key. (There are a few prefix keys
592this does not work---those that provide their own bindings for 583for which this does not work---those that provide their own bindings
593@kbd{C-h}. One of these is @key{ESC}, because @kbd{@key{ESC} C-h} is 584for @kbd{C-h}. One of these is @key{ESC}, because @kbd{@key{ESC} C-h}
594actually @kbd{C-M-h}, which marks a defun.) 585is actually @kbd{C-M-h}, which marks a defun.)
595 586
596@node Help Files 587@node Help Files
597@section Help Files 588@section Help Files
598 589
599 The Emacs help commands described above display the state of data 590 The Emacs help commands described above display dynamic help based
600bases within Emacs. Emacs has a few other help commands that display 591on the current state within Emacs, or refer to manuals. Other help
601pre-written help files. These commands all have the form @kbd{C-h 592commands display pre-written, static help files. These commands all
602C-@var{char}}; that is, @kbd{C-h} followed by a control character. 593have the form @kbd{C-h C-@var{char}}; that is, @kbd{C-h} followed by a
594control character.
603 595
604@kindex C-h C-c 596@kindex C-h C-c
605@findex describe-copying 597@findex describe-copying
@@ -617,31 +609,29 @@ C-@var{char}}; that is, @kbd{C-h} followed by a control character.
617@findex view-emacs-todo 609@findex view-emacs-todo
618@kindex C-h C-w 610@kindex C-h C-w
619@findex describe-no-warranty 611@findex describe-no-warranty
620 The other @kbd{C-h} options display various files containing useful
621information.
622 612
623@table @kbd 613@table @kbd
624@item C-h C-c 614@item C-h C-c
625Displays the Emacs copying conditions (@code{describe-copying}). 615Display the Emacs copying conditions (@code{describe-copying}).
626These are the rules under which you can copy and redistribute Emacs. 616These are the rules under which you can copy and redistribute Emacs.
627@item C-h C-d 617@item C-h C-d
628Displays information on how to download or order the latest version of 618Display how to download or order the latest version of
629Emacs and other GNU software (@code{describe-distribution}). 619Emacs and other GNU software (@code{describe-distribution}).
630@item C-h C-e 620@item C-h C-e
631Displays the list of known Emacs problems, sometimes with suggested 621Display the list of known Emacs problems, sometimes with suggested
632workarounds (@code{view-emacs-problems}). 622workarounds (@code{view-emacs-problems}).
633@item C-h C-f 623@item C-h C-f
634Displays the Emacs frequently-answered-questions list (@code{view-emacs-FAQ}). 624Display the Emacs frequently-answered-questions list (@code{view-emacs-FAQ}).
635@item C-h C-n 625@item C-h C-n
636Displays the Emacs ``news'' file, which lists new Emacs features, most 626Display the Emacs ``news'' file, which lists new features in the most
637recent first (@code{view-emacs-news}). 627recent version of Emacs (@code{view-emacs-news}).
638@item C-h C-p 628@item C-h C-p
639Displays general information about the GNU Project 629Display general information about the GNU Project
640(@code{describe-project}). 630(@code{describe-project}).
641@item C-h C-t 631@item C-h C-t
642Displays the Emacs to-do list (@code{view-todo}). 632Display the Emacs to-do list (@code{view-todo}).
643@item C-h C-w 633@item C-h C-w
644Displays the full details on the complete absence of warranty for GNU 634Display the full details on the complete absence of warranty for GNU
645Emacs (@code{describe-no-warranty}). 635Emacs (@code{describe-no-warranty}).
646@end table 636@end table
647 637
@@ -652,12 +642,12 @@ Emacs (@code{describe-no-warranty}).
652@cindex balloon help 642@cindex balloon help
653 When a region of text is ``active,'' so that you can select it with 643 When a region of text is ``active,'' so that you can select it with
654the mouse or a key like @kbd{RET}, it often has associated help text. 644the mouse or a key like @kbd{RET}, it often has associated help text.
655Areas of the mode line are examples. On graphical displays, the help 645For instance, most parts of the mode line have help text. On
656text is displayed as a ``tooltip'' (sometimes known as ``balloon 646graphical displays, the help text is displayed as a ``tooltip''
657help''), when you move the mouse over the active text. @xref{Tooltips}. 647(sometimes known as ``balloon help''), when you move the mouse over
658On some systems, it is shown in the echo area. On text-only 648the active text. @xref{Tooltips}. On some systems, it is shown in
659terminals, Emacs may not be able to follow the mouse and hence will 649the echo area. On text-only terminals, if Emacs cannot follow the
660not show the help text on mouse-over. 650mouse, it cannot show the help text on mouse-over.
661 651
662@kindex C-h . 652@kindex C-h .
663@findex display-local-help 653@findex display-local-help
diff --git a/man/m-x.texi b/man/m-x.texi
index 9030f809cc3..c4974c5f7b4 100644
--- a/man/m-x.texi
+++ b/man/m-x.texi
@@ -5,31 +5,27 @@
5@node M-x, Help, Minibuffer, Top 5@node M-x, Help, Minibuffer, Top
6@chapter Running Commands by Name 6@chapter Running Commands by Name
7 7
8 Every Emacs command has a name that you can use to run it. Commands 8 Every Emacs command has a name that you can use to run it. For
9that are used often, or that must be quick to type, are also bound to 9convenience, many commands also have key bindings. You can run those
10keys---short sequences of characters---for convenient use. You can 10commands by typing the keys, or run them by name. Most Emacs commands
11run them by typing the keys, or run them by name if you don't remember 11have no key bindings, so the only way to run them is by name.
12the keys. Other Emacs commands that do not need to be quick are not 12(@xref{Key Bindings}, for how to set up key bindings.)
13bound to keys; the only way to run them is by name. @xref{Key
14Bindings}, for the description of how to bind commands to keys.
15 13
16 By convention, a command name consists of one or more words, 14 By convention, a command name consists of one or more words,
17separated by hyphens; for example, @code{auto-fill-mode} or 15separated by hyphens; for example, @code{auto-fill-mode} or
18@code{manual-entry}. The use of English words makes the command name 16@code{manual-entry}. Command names mostly use complete English words
19easier to remember than a key made up of obscure characters, even 17to make them easier to remember.
20though it is more characters to type.
21 18
22@kindex M-x 19@kindex M-x
23 The way to run a command by name is to start with @kbd{M-x}, type the 20 To run a command by name, start with @kbd{M-x}, type the command
24command name, and finish it with @key{RET}. @kbd{M-x} uses the 21name, then terminate it with @key{RET}. @kbd{M-x} uses the minibuffer
25minibuffer to read the command name. @key{RET} exits the minibuffer and 22to read the command name. The string @samp{M-x} appears at the
26runs the command. The string @samp{M-x} appears at the beginning of the 23beginning of the minibuffer as a @dfn{prompt} to remind you to enter a
27minibuffer as a @dfn{prompt} to remind you to enter the name of a 24command name to be run. @key{RET} exits the minibuffer and runs the
28command to be run. @xref{Minibuffer}, for full information on the 25command. @xref{Minibuffer}, for more information on the minibuffer.
29features of the minibuffer.
30 26
31 You can use completion to enter the command name. For example, you 27 You can use completion to enter the command name. For example, you
32can invoke the command @code{forward-char} by name by typing either 28to invoke the command @code{forward-char}, you can type
33 29
34@example 30@example
35M-x forward-char @key{RET} 31M-x forward-char @key{RET}
@@ -44,32 +40,30 @@ M-x forw @key{TAB} c @key{RET}
44 40
45@noindent 41@noindent
46Note that @code{forward-char} is the same command that you invoke with 42Note that @code{forward-char} is the same command that you invoke with
47the key @kbd{C-f}. You can run any Emacs command by name using 43the key @kbd{C-f}. The existence of a key binding does not stop you
48@kbd{M-x}, whether or not any keys are bound to it. 44from running the command by name.
49 45
50 If you type @kbd{C-g} while the command name is being read, that 46 To cancel the @kbd{M-x} and not run a command, type @kbd{C-g} instead
51cancels the @kbd{M-x} command and exits the minibuffer, so you end up 47of entering the command name. This takes you back to command level.
52back at command level.
53 48
54 To pass a numeric argument to the command you are invoking with 49 To pass a numeric argument to the command you are invoking with
55@kbd{M-x}, specify the numeric argument before the @kbd{M-x}. @kbd{M-x} 50@kbd{M-x}, specify the numeric argument before @kbd{M-x}. The
56passes the argument along to the command it runs. The argument value 51argument value appears in the prompt while the command name is being
57appears in the prompt while the command name is being read. 52read, and finally @kbd{M-x} passes the argument to that command.
58 53
59@vindex suggest-key-bindings 54@vindex suggest-key-bindings
60 If the command you type has a key binding of its own, Emacs mentions 55 When the command you run with @kbd{M-x} has a key binding, Emacs
61this in the echo area after running the command. For example, if you 56mentions this in the echo area after running the command. For
62type @kbd{M-x forward-word}, the message says that you can run the 57example, if you type @kbd{M-x forward-word}, the message says that you
63same command more easily by typing @kbd{M-f}. You can turn off these 58can run the same command by typing @kbd{M-f}. You can turn off these
64messages by setting the variable @code{suggest-key-bindings} to 59messages by setting the variable @code{suggest-key-bindings} to
65@code{nil}. 60@code{nil}.
66 61
67 Normally, when describing in this manual a command that is run by 62 In this manual, when we speak of running a command by name, we often
68name, we omit the @key{RET} that is needed to terminate the name. Thus 63omit the @key{RET} that terminates the name. Thus we might say
69we might speak of @kbd{M-x auto-fill-mode} rather than @kbd{M-x 64@kbd{M-x auto-fill-mode} rather than @kbd{M-x auto-fill-mode
70auto-fill-mode @key{RET}}. We mention the @key{RET} only when there is 65@key{RET}}. We mention the @key{RET} only for emphasis, such as when
71a need to emphasize its presence, such as when we show the command 66the command is followed by arguments.
72together with following arguments.
73 67
74@findex execute-extended-command 68@findex execute-extended-command
75 @kbd{M-x} works by running the command 69 @kbd{M-x} works by running the command