annotate man/m-x.texi @ 35866:36ae5c21523f

*** empty log message ***
author Stefan Monnier <monnier@iro.umontreal.ca>
date Fri, 02 Feb 2001 18:21:56 +0000
parents ac7e9e5e2ccb
children ca2ae794785e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1 @c This is part of the Emacs manual.
Dave Love <fx@gnu.org>
parents:
diff changeset
2 @c Copyright (C) 1985, 86, 87, 93, 94, 95, 1997 Free Software Foundation, Inc.
Dave Love <fx@gnu.org>
parents:
diff changeset
3 @c See file emacs.texi for copying conditions.
Dave Love <fx@gnu.org>
parents:
diff changeset
4 @node M-x, Help, Minibuffer, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
5 @chapter Running Commands by Name
Dave Love <fx@gnu.org>
parents:
diff changeset
6
Dave Love <fx@gnu.org>
parents:
diff changeset
7 The Emacs commands that are used often or that must be quick to type are
Dave Love <fx@gnu.org>
parents:
diff changeset
8 bound to keys---short sequences of characters---for convenient use. Other
Dave Love <fx@gnu.org>
parents:
diff changeset
9 Emacs commands that do not need to be brief are not bound to keys; to run
Dave Love <fx@gnu.org>
parents:
diff changeset
10 them, you must refer to them by name.
Dave Love <fx@gnu.org>
parents:
diff changeset
11
Dave Love <fx@gnu.org>
parents:
diff changeset
12 A command name is, by convention, made up of one or more words,
Dave Love <fx@gnu.org>
parents:
diff changeset
13 separated by hyphens; for example, @code{auto-fill-mode} or
Dave Love <fx@gnu.org>
parents:
diff changeset
14 @code{manual-entry}. The use of English words makes the command name
Dave Love <fx@gnu.org>
parents:
diff changeset
15 easier to remember than a key made up of obscure characters, even though
Dave Love <fx@gnu.org>
parents:
diff changeset
16 it is more characters to type.
Dave Love <fx@gnu.org>
parents:
diff changeset
17
Dave Love <fx@gnu.org>
parents:
diff changeset
18 @kindex M-x
Dave Love <fx@gnu.org>
parents:
diff changeset
19 The way to run a command by name is to start with @kbd{M-x}, type the
Dave Love <fx@gnu.org>
parents:
diff changeset
20 command name, and finish it with @key{RET}. @kbd{M-x} uses the
Dave Love <fx@gnu.org>
parents:
diff changeset
21 minibuffer to read the command name. @key{RET} exits the minibuffer and
Dave Love <fx@gnu.org>
parents:
diff changeset
22 runs the command. The string @samp{M-x} appears at the beginning of the
Dave Love <fx@gnu.org>
parents:
diff changeset
23 minibuffer as a @dfn{prompt} to remind you to enter the name of a
Dave Love <fx@gnu.org>
parents:
diff changeset
24 command to be run. @xref{Minibuffer}, for full information on the
Dave Love <fx@gnu.org>
parents:
diff changeset
25 features of the minibuffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
26
Dave Love <fx@gnu.org>
parents:
diff changeset
27 You can use completion to enter the command name. For example, the
Dave Love <fx@gnu.org>
parents:
diff changeset
28 command @code{forward-char} can be invoked by name by typing
Dave Love <fx@gnu.org>
parents:
diff changeset
29
Dave Love <fx@gnu.org>
parents:
diff changeset
30 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
31 M-x forward-char @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
32 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
33
Dave Love <fx@gnu.org>
parents:
diff changeset
34 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
35 or
Dave Love <fx@gnu.org>
parents:
diff changeset
36
Dave Love <fx@gnu.org>
parents:
diff changeset
37 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
38 M-x forw @key{TAB} c @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
39 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
40
Dave Love <fx@gnu.org>
parents:
diff changeset
41 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
42 Note that @code{forward-char} is the same command that you invoke with
Dave Love <fx@gnu.org>
parents:
diff changeset
43 the key @kbd{C-f}. You can run any Emacs command by name using
Dave Love <fx@gnu.org>
parents:
diff changeset
44 @kbd{M-x}, whether or not any keys are bound to it.
Dave Love <fx@gnu.org>
parents:
diff changeset
45
Dave Love <fx@gnu.org>
parents:
diff changeset
46 If you type @kbd{C-g} while the command name is being read, you cancel
Dave Love <fx@gnu.org>
parents:
diff changeset
47 the @kbd{M-x} command and get out of the minibuffer, ending up at top level.
Dave Love <fx@gnu.org>
parents:
diff changeset
48
Dave Love <fx@gnu.org>
parents:
diff changeset
49 To pass a numeric argument to the command you are invoking with
Dave Love <fx@gnu.org>
parents:
diff changeset
50 @kbd{M-x}, specify the numeric argument before the @kbd{M-x}. @kbd{M-x}
Dave Love <fx@gnu.org>
parents:
diff changeset
51 passes the argument along to the command it runs. The argument value
Dave Love <fx@gnu.org>
parents:
diff changeset
52 appears in the prompt while the command name is being read.
Dave Love <fx@gnu.org>
parents:
diff changeset
53
Dave Love <fx@gnu.org>
parents:
diff changeset
54 @vindex suggest-key-bindings
Dave Love <fx@gnu.org>
parents:
diff changeset
55 If the command you type has a key binding of its own, Emacs mentions
Dave Love <fx@gnu.org>
parents:
diff changeset
56 this in the echo area, two seconds after the command finishes (if you
Dave Love <fx@gnu.org>
parents:
diff changeset
57 don't type anything else first). For example, if you type @kbd{M-x
Dave Love <fx@gnu.org>
parents:
diff changeset
58 forward-word}, the message says that you can run the same command more
Dave Love <fx@gnu.org>
parents:
diff changeset
59 easily by typing @kbd{M-f}. You can turn off these messages by setting
Dave Love <fx@gnu.org>
parents:
diff changeset
60 @code{suggest-key-bindings} to @code{nil}.
Dave Love <fx@gnu.org>
parents:
diff changeset
61
Dave Love <fx@gnu.org>
parents:
diff changeset
62 Normally, when describing in this manual a command that is run by
Dave Love <fx@gnu.org>
parents:
diff changeset
63 name, we omit the @key{RET} that is needed to terminate the name. Thus
Dave Love <fx@gnu.org>
parents:
diff changeset
64 we might speak of @kbd{M-x auto-fill-mode} rather than @kbd{M-x
Dave Love <fx@gnu.org>
parents:
diff changeset
65 auto-fill-mode @key{RET}}. We mention the @key{RET} only when there is
Dave Love <fx@gnu.org>
parents:
diff changeset
66 a need to emphasize its presence, such as when we show the command
Dave Love <fx@gnu.org>
parents:
diff changeset
67 together with following arguments.
Dave Love <fx@gnu.org>
parents:
diff changeset
68
Dave Love <fx@gnu.org>
parents:
diff changeset
69 @findex execute-extended-command
Dave Love <fx@gnu.org>
parents:
diff changeset
70 @kbd{M-x} works by running the command
Dave Love <fx@gnu.org>
parents:
diff changeset
71 @code{execute-extended-command}, which is responsible for reading the
Dave Love <fx@gnu.org>
parents:
diff changeset
72 name of another command and invoking it.