annotate man/m-x.texi @ 69232:ea4b21409f7f

*** empty log message ***
author Nick Roberts <nickrob@snap.net.nz>
date Wed, 01 Mar 2006 22:42:17 +0000
parents dc2d5a6655a3
children 2bce43489a02 c5406394f567
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1 @c This is part of the Emacs manual.
64890
3723093a21fd Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 60243
diff changeset
2 @c Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1997, 2002, 2003,
68639
dc2d5a6655a3 Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 68511
diff changeset
3 @c 2004, 2005, 2006 Free Software Foundation, Inc.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4 @c See file emacs.texi for copying conditions.
Dave Love <fx@gnu.org>
parents:
diff changeset
5 @node M-x, Help, Minibuffer, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
6 @chapter Running Commands by Name
Dave Love <fx@gnu.org>
parents:
diff changeset
7
36726
d18a841a4a5a Clarify key bindings vs running a command by name.
Richard M. Stallman <rms@gnu.org>
parents: 36658
diff changeset
8 Every Emacs command has a name that you can use to run it. Commands
d18a841a4a5a Clarify key bindings vs running a command by name.
Richard M. Stallman <rms@gnu.org>
parents: 36658
diff changeset
9 that are used often, or that must be quick to type, are also bound to
d18a841a4a5a Clarify key bindings vs running a command by name.
Richard M. Stallman <rms@gnu.org>
parents: 36658
diff changeset
10 keys---short sequences of characters---for convenient use. You can
68511
01315c421f31 (M-x): Minor clarifications
Richard M. Stallman <rms@gnu.org>
parents: 64890
diff changeset
11 run them by typing the keys, or run them by name if you don't remember
01315c421f31 (M-x): Minor clarifications
Richard M. Stallman <rms@gnu.org>
parents: 64890
diff changeset
12 the keys. Other Emacs commands that do not need to be quick are not
01315c421f31 (M-x): Minor clarifications
Richard M. Stallman <rms@gnu.org>
parents: 64890
diff changeset
13 bound to keys; the only way to run them is by name. @xref{Key
01315c421f31 (M-x): Minor clarifications
Richard M. Stallman <rms@gnu.org>
parents: 64890
diff changeset
14 Bindings}, for the description of how to bind commands to keys.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
15
36726
d18a841a4a5a Clarify key bindings vs running a command by name.
Richard M. Stallman <rms@gnu.org>
parents: 36658
diff changeset
16 By convention, a command name consists of one or more words,
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
17 separated by hyphens; for example, @code{auto-fill-mode} or
Dave Love <fx@gnu.org>
parents:
diff changeset
18 @code{manual-entry}. The use of English words makes the command name
36726
d18a841a4a5a Clarify key bindings vs running a command by name.
Richard M. Stallman <rms@gnu.org>
parents: 36658
diff changeset
19 easier to remember than a key made up of obscure characters, even
d18a841a4a5a Clarify key bindings vs running a command by name.
Richard M. Stallman <rms@gnu.org>
parents: 36658
diff changeset
20 though it is more characters to type.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
21
Dave Love <fx@gnu.org>
parents:
diff changeset
22 @kindex M-x
Dave Love <fx@gnu.org>
parents:
diff changeset
23 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
24 command name, and finish it with @key{RET}. @kbd{M-x} uses the
Dave Love <fx@gnu.org>
parents:
diff changeset
25 minibuffer to read the command name. @key{RET} exits the minibuffer and
Dave Love <fx@gnu.org>
parents:
diff changeset
26 runs the command. The string @samp{M-x} appears at the beginning of the
Dave Love <fx@gnu.org>
parents:
diff changeset
27 minibuffer as a @dfn{prompt} to remind you to enter the name of a
Dave Love <fx@gnu.org>
parents:
diff changeset
28 command to be run. @xref{Minibuffer}, for full information on the
Dave Love <fx@gnu.org>
parents:
diff changeset
29 features of the minibuffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
30
36726
d18a841a4a5a Clarify key bindings vs running a command by name.
Richard M. Stallman <rms@gnu.org>
parents: 36658
diff changeset
31 You can use completion to enter the command name. For example, you
d18a841a4a5a Clarify key bindings vs running a command by name.
Richard M. Stallman <rms@gnu.org>
parents: 36658
diff changeset
32 can invoke the command @code{forward-char} by name by typing either
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
33
Dave Love <fx@gnu.org>
parents:
diff changeset
34 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
35 M-x forward-char @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
36 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
37
Dave Love <fx@gnu.org>
parents:
diff changeset
38 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
39 or
Dave Love <fx@gnu.org>
parents:
diff changeset
40
Dave Love <fx@gnu.org>
parents:
diff changeset
41 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
42 M-x forw @key{TAB} c @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
43 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
44
Dave Love <fx@gnu.org>
parents:
diff changeset
45 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
46 Note that @code{forward-char} is the same command that you invoke with
Dave Love <fx@gnu.org>
parents:
diff changeset
47 the key @kbd{C-f}. You can run any Emacs command by name using
Dave Love <fx@gnu.org>
parents:
diff changeset
48 @kbd{M-x}, whether or not any keys are bound to it.
Dave Love <fx@gnu.org>
parents:
diff changeset
49
68511
01315c421f31 (M-x): Minor clarifications
Richard M. Stallman <rms@gnu.org>
parents: 64890
diff changeset
50 If you type @kbd{C-g} while the command name is being read, that
01315c421f31 (M-x): Minor clarifications
Richard M. Stallman <rms@gnu.org>
parents: 64890
diff changeset
51 cancels the @kbd{M-x} command and exits the minibuffer, so you end up
01315c421f31 (M-x): Minor clarifications
Richard M. Stallman <rms@gnu.org>
parents: 64890
diff changeset
52 back at command level.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
53
Dave Love <fx@gnu.org>
parents:
diff changeset
54 To pass a numeric argument to the command you are invoking with
Dave Love <fx@gnu.org>
parents:
diff changeset
55 @kbd{M-x}, specify the numeric argument before the @kbd{M-x}. @kbd{M-x}
Dave Love <fx@gnu.org>
parents:
diff changeset
56 passes the argument along to the command it runs. The argument value
Dave Love <fx@gnu.org>
parents:
diff changeset
57 appears in the prompt while the command name is being read.
Dave Love <fx@gnu.org>
parents:
diff changeset
58
Dave Love <fx@gnu.org>
parents:
diff changeset
59 @vindex suggest-key-bindings
Dave Love <fx@gnu.org>
parents:
diff changeset
60 If the command you type has a key binding of its own, Emacs mentions
68511
01315c421f31 (M-x): Minor clarifications
Richard M. Stallman <rms@gnu.org>
parents: 64890
diff changeset
61 this in the echo area after running the command. For example, if you
01315c421f31 (M-x): Minor clarifications
Richard M. Stallman <rms@gnu.org>
parents: 64890
diff changeset
62 type @kbd{M-x forward-word}, the message says that you can run the
01315c421f31 (M-x): Minor clarifications
Richard M. Stallman <rms@gnu.org>
parents: 64890
diff changeset
63 same command more easily by typing @kbd{M-f}. You can turn off these
01315c421f31 (M-x): Minor clarifications
Richard M. Stallman <rms@gnu.org>
parents: 64890
diff changeset
64 messages by setting the variable @code{suggest-key-bindings} to
01315c421f31 (M-x): Minor clarifications
Richard M. Stallman <rms@gnu.org>
parents: 64890
diff changeset
65 @code{nil}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
66
Dave Love <fx@gnu.org>
parents:
diff changeset
67 Normally, when describing in this manual a command that is run by
Dave Love <fx@gnu.org>
parents:
diff changeset
68 name, we omit the @key{RET} that is needed to terminate the name. Thus
Dave Love <fx@gnu.org>
parents:
diff changeset
69 we might speak of @kbd{M-x auto-fill-mode} rather than @kbd{M-x
Dave Love <fx@gnu.org>
parents:
diff changeset
70 auto-fill-mode @key{RET}}. We mention the @key{RET} only when there is
Dave Love <fx@gnu.org>
parents:
diff changeset
71 a need to emphasize its presence, such as when we show the command
Dave Love <fx@gnu.org>
parents:
diff changeset
72 together with following arguments.
Dave Love <fx@gnu.org>
parents:
diff changeset
73
Dave Love <fx@gnu.org>
parents:
diff changeset
74 @findex execute-extended-command
Dave Love <fx@gnu.org>
parents:
diff changeset
75 @kbd{M-x} works by running the command
Dave Love <fx@gnu.org>
parents:
diff changeset
76 @code{execute-extended-command}, which is responsible for reading the
Dave Love <fx@gnu.org>
parents:
diff changeset
77 name of another command and invoking it.
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 36726
diff changeset
78
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 36726
diff changeset
79 @ignore
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 36726
diff changeset
80 arch-tag: b67bff53-9628-4666-b94e-eda972a7ba56
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 36726
diff changeset
81 @end ignore