annotate man/xemacs/mini.texi @ 398:74fd4e045ea6 r21-2-29

Import from CVS: tag r21-2-29
author cvs
date Mon, 13 Aug 2007 11:13:30 +0200
parents 376386a54a3c
children 501cfd01ee6d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
1
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
2 @node Minibuffer, M-x, Undo, Top
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
3 @chapter The Minibuffer
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
4 @cindex minibuffer
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
5
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
6 The @dfn{minibuffer} is the facility used by XEmacs commands to read
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
7 arguments more complicated than a single number. Minibuffer arguments
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
8 can be file names, buffer names, Lisp function names, XEmacs command
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
9 names, Lisp expressions, and many other things, depending on the command
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
10 reading the argument. You can use the usual XEmacs editing commands in
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
11 the minibuffer to edit the argument text.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
12
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
13 @cindex prompt
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
14 When the minibuffer is in use, it appears in the echo area, and the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
15 cursor moves there. The beginning of the minibuffer line displays a
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
16 @dfn{prompt} which says what kind of input you should supply and how it
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
17 will be used. Often this prompt is derived from the name of the command
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
18 that the argument is for. The prompt normally ends with a colon.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
19
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
20 @cindex default argument
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
21 Sometimes a @dfn{default argument} appears in parentheses after the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
22 colon; it, too, is part of the prompt. The default is used as the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
23 argument value if you enter an empty argument (e.g., by just typing @key{RET}).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
24 For example, commands that read buffer names always show a default, which
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
25 is the name of the buffer that will be used if you type just @key{RET}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
26
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
27 @kindex C-g
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
28 The simplest way to enter a minibuffer argument is to type the text
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
29 you want, terminated by @key{RET} which exits the minibuffer. You can
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
30 cancel the command that wants the argument, and get out of the
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
31 minibuffer, by typing @kbd{C-g}.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
32
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
33 Since the minibuffer uses the screen space of the echo area, it can
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
34 conflict with other ways XEmacs customarily uses the echo area. Here is
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
35 how XEmacs handles such conflicts:
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
36
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
37 @itemize @bullet
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
38 @item
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
39 If a command gets an error while you are in the minibuffer, this does
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
40 not cancel the minibuffer. However, the echo area is needed for the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
41 error message and therefore the minibuffer itself is hidden for a
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
42 while. It comes back after a few seconds, or as soon as you type
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
43 anything.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
44
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
45 @item
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
46 If in the minibuffer you use a command whose purpose is to print a
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
47 message in the echo area, such as @kbd{C-x =}, the message is printed
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
48 normally, and the minibuffer is hidden for a while. It comes back
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
49 after a few seconds, or as soon as you type anything.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
50
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
51 @item
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
52 Echoing of keystrokes does not take place while the minibuffer is in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
53 use.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
54 @end itemize
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
55
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
56 @menu
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
57 * File: Minibuffer File. Entering file names with the minibuffer.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
58 * Edit: Minibuffer Edit. How to edit in the minibuffer.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
59 * Completion:: An abbreviation facility for minibuffer input.
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
60 * Minibuffer History:: Reusing recent minibuffer arguments.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
61 * Repetition:: Re-executing commands that used the minibuffer.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
62 @end menu
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
63
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
64 @node Minibuffer File, Minibuffer Edit, Minibuffer, Minibuffer
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
65 @section Minibuffers for File Names
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
66
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
67 Sometimes the minibuffer starts out with text in it. For example, when
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
68 you are supposed to give a file name, the minibuffer starts out containing
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
69 the @dfn{default directory}, which ends with a slash. This is to inform
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
70 you which directory the file will be found in if you do not specify a
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
71 directory.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
72
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
73 For example, the minibuffer might start out with these contents:
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
74
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
75 @example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
76 Find File: /u2/emacs/src/
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
77 @end example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
78
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
79 @noindent
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
80 where @samp{Find File:@: } is the prompt. Typing @kbd{buffer.c}
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
81 specifies the file @file{/u2/emacs/src/buffer.c}. To find files in
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
82 nearby directories, use @kbd{..}; thus, if you type
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
83 @kbd{../lisp/simple.el}, you will get the file named
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
84 @file{/u2/emacs/lisp/simple.el}. Alternatively, you can kill with
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
85 @kbd{M-@key{DEL}} the directory names you don't want (@pxref{Words}).
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
86
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
87 If you don't want any of the default, you can kill it with @kbd{C-a
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
88 C-k}. But you don't need to kill the default; you can simply ignore it.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
89 Insert an absolute file name, one starting with a slash or a tilde,
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
90 after the default directory. For example, to specify the file
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
91 @file{/etc/termcap}, just insert that name, giving these minibuffer
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
92 contents:
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
93
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
94 @example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
95 Find File: /u2/emacs/src//etc/termcap
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
96 @end example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
97
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
98 @noindent
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
99 @cindex // in file name
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
100 @cindex double slash in file name
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
101 @cindex slashes repeated in file name
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
102 XEmacs gives a special meaning to a double slash (which is not normally
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
103 a useful thing to write): it means, ``ignore everything before the
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
104 second slash in the pair.'' Thus, @samp{/u2/emacs/src/} is ignored in
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
105 the example above, and you get the file @file{/etc/termcap}.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
106
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
107 @vindex insert-default-directory
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
108 If you set @code{insert-default-directory} to @code{nil}, the default
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
109 directory is not inserted in the minibuffer. This way, the minibuffer
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
110 starts out empty. But the name you type, if relative, is still
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
111 interpreted with respect to the same default directory.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
112
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
113 @node Minibuffer Edit, Completion, Minibuffer File, Minibuffer
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
114 @section Editing in the Minibuffer
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
115
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
116 The minibuffer is an XEmacs buffer (albeit a peculiar one), and the
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
117 usual XEmacs commands are available for editing the text of an argument
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
118 you are entering.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
119
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
120 Since @key{RET} in the minibuffer is defined to exit the minibuffer,
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
121 you can't use it to insert a newline in the minibuffer. To do that,
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
122 type @kbd{C-o} or @kbd{C-q C-j}. (Recall that a newline is really the
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
123 character control-J.)
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
124
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
125 The minibuffer has its own window which always has space on the screen
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
126 but acts as if it were not there when the minibuffer is not in use.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
127 When the minibuffer is in use, its window is just like the others; you
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
128 can switch to another window with @kbd{C-x o}, edit text in other
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
129 windows and perhaps even visit more files, before returning to the
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
130 minibuffer to submit the argument. You can kill text in another window,
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
131 return to the minibuffer window, and then yank the text to use it in the
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
132 argument. @xref{Windows}.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
133
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
134 There are some restrictions on the use of the minibuffer window,
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
135 however. You cannot switch buffers in it---the minibuffer and its
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
136 window are permanently attached. Also, you cannot split or kill the
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
137 minibuffer window. But you can make it taller in the normal fashion with
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
138 @kbd{C-x ^}.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
139
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
140 @kindex C-M-v
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
141 If while in the minibuffer you issue a command that displays help text
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
142 of any sort in another window, you can use the @kbd{C-M-v} command while
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
143 in the minibuffer to scroll the help text. This lasts until you exit
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
144 the minibuffer. This feature is especially useful if a completing
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
145 minibuffer gives you a list of possible completions. @xref{Other Window}.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
146
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
147 @vindex minibuffer-confirm-incomplete
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
148 If the variable @code{minibuffer-confirm-incomplete} is @code{t}, you
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
149 are asked for confirmation if there is no known completion for the text
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
150 you typed. For example, if you attempted to visit a non-existent file,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
151 the minibuffer might read:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
152 @example
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
153 Find File: chocolate_bar.c [no completions, confirm]
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
154 @end example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
155 If you press @kbd{Return} again, that confirms the filename. Otherwise,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
156 you can continue editing it.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
157
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
158 XEmacs supports recursive use of the minibuffer. However, it is easy
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
159 to do this by accident (because of autorepeating keyboards, for example)
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
160 and get confused. Therefore, most XEmacs commands that use the
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
161 minibuffer refuse to operate if the minibuffer window is selected. If
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
162 the minibuffer is active but you have switched to a different window,
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
163 recursive use of the minibuffer is allowed---if you know enough to try
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
164 to do this, you probably will not get confused.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
165
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
166 @vindex enable-recursive-minibuffers
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
167 If you set the variable @code{enable-recursive-minibuffers} to a
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
168 non-@code{nil}, recursive use of the minibuffer is always allowed.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
169
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
170 @node Completion, Minibuffer History, Minibuffer Edit, Minibuffer
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
171 @section Completion
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
172 @cindex completion
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
173
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
174 For certain kinds of arguments, you can use @dfn{completion} to enter
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
175 the argument value. Completion means that you type part of the
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
176 argument, then XEmacs visibly fills in the rest, or as much as
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
177 can be determined from the part you have typed.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
178
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
179 When completion is available, certain keys---@key{TAB}, @key{RET}, and
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
180 @key{SPC}---are rebound to complete the text present in the
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
181 minibuffer into a longer string that it stands for, by matching it
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
182 against a set of @dfn{completion alternatives} provided by the command
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
183 reading the argument. @kbd{?} is defined to display a list of possible
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
184 completions of what you have inserted.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
185
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
186 For example, when @kbd{M-x} uses the minibuffer to read the name of a
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
187 command, it provides a list of all available XEmacs command names to
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
188 complete against. The completion keys match the text in the minibuffer
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
189 against all the command names, find any additional name characters
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
190 implied by the ones already present in the minibuffer, and add those
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
191 characters to the ones you have given. This is what makes it possible
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
192 to type @kbd{M-x inse @key{SPC} b @key{RET}} instead of @kbd{M-x
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
193 insert-buffer @key{RET}} (for example).
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
194
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
195 Case is normally significant in completion because it is significant
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
196 in most of the names that you can complete (buffer names, file names and
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
197 command names). Thus, @samp{fo} does not complete to @samp{Foo}. When
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
198 you are completing a name in which case does not matter, case may be
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
199 ignored for completion's sake if specified by program.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
200
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
201 When a completion list is displayed, the completions will highlight as
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
202 you move the mouse over them. Clicking the middle mouse button on any
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
203 highlighted completion will ``select'' it just as if you had typed it in
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
204 and hit @key{RET}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
205
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
206 @menu
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
207 * Example: Completion Example.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
208 * Commands: Completion Commands.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
209 * Strict Completion::
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
210 * Options: Completion Options.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
211 @end menu
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
212
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
213 @node Completion Example, Completion Commands, Completion, Completion
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
214 @subsection Completion Example
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
215
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
216 @kindex TAB
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
217 @findex minibuffer-complete
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
218 A concrete example may help here. If you type @kbd{M-x au @key{TAB}},
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
219 the @key{TAB} looks for alternatives (in this case, command names) that
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
220 start with @samp{au}. There are several, including
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
221 @code{auto-fill-mode} and @code{auto-save-mode}---but they are all the
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
222 same as far as @code{auto}, so the @samp{au} in the minibuffer changes
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
223 to @samp{auto}.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
224
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
225 If you type @key{TAB} again immediately, there are multiple
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
226 possibilities for the very next character---it could be any of
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
227 @samp{c-}---so no more characters are added; instead, @key{TAB}
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
228 displays a list of all possible completions in another window.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
229
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
230 If you go on to type @kbd{f @key{TAB}}, this @key{TAB} sees
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
231 @samp{auto-f}. The only command name starting this way is
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
232 @code{auto-fill-mode}, so completion fills in the rest of that. You now
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
233 have @samp{auto-fill-mode} in the minibuffer after typing just @kbd{au
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
234 @key{TAB} f @key{TAB}}. Note that @key{TAB} has this effect because in
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
235 the minibuffer it is bound to the command @code{minibuffer-complete}
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
236 when completion is available.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
237
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
238 @node Completion Commands, Strict Completion, Completion Example, Completion
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
239 @subsection Completion Commands
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
240
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
241 Here is a list of the completion commands defined in the minibuffer
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
242 when completion is available.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
243
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
244 @table @kbd
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
245 @item @key{TAB}
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
246 Complete the text in the minibuffer as much as possible
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
247 (@code{minibuffer-complete}).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
248 @item @key{SPC}
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
249 Complete the minibuffer text, but don't go beyond one word
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
250 (@code{minibuffer-complete-word}).
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
251 @item @key{RET}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
252 Submit the text in the minibuffer as the argument, possibly completing
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
253 first as described below (@code{minibuffer-complete-and-exit}).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
254 @item ?
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
255 Print a list of all possible completions of the text in the minibuffer
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
256 (@code{minibuffer-list-completions}).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
257 @item @key{button2}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
258 Select the highlighted text under the mouse as a minibuffer response.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
259 When the minibuffer is being used to prompt the user for a completion,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
260 any valid completions which are visible on the screen will be highlighted
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
261 when the mouse moves over them. Clicking @key{button2} will select the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
262 highlighted completion and exit the minibuffer.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
263 (@code{minibuf-select-highlighted-completion}).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
264 @end table
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
265
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
266 @kindex SPC
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
267 @findex minibuffer-complete-word
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
268 @key{SPC} completes much like @key{TAB}, but never goes beyond the
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
269 next hyphen or space. If you have @samp{auto-f} in the minibuffer and
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
270 type @key{SPC}, it finds that the completion is @samp{auto-fill-mode},
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
271 but it stops completing after @samp{fill-}. This gives
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
272 @samp{auto-fill-}. Another @key{SPC} at this point completes all the
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
273 way to @samp{auto-fill-mode}. @key{SPC} in the minibuffer when
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
274 completion is available runs the command
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
275 @code{minibuffer-complete-word}.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
276
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
277 Here are some commands you can use to choose a completion from a
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
278 window that displays a list of completions:
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
279
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
280 @table @kbd
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
281 @findex mouse-choose-completion
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
282 @item button2up
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
283 Clicking mouse button 2 on a completion in the list of possible
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
284 completions chooses that completion (@code{mouse-choose-completion}).
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
285 You normally use this command while point is in the minibuffer; but you
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
286 must click in the list of completions, not in the minibuffer itself.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
287
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
288 @findex choose-completion
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
289 @item @key{RET}
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
290 Typing @key{RET} @emph{in the completion list buffer} chooses the
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
291 completion that point is in or next to (@code{choose-completion}). To
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
292 use this command, you must first switch windows to the window that shows
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
293 the list of completions.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
294
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
295 @findex next-list-mode-item
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
296 @item @key{RIGHT}
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
297 @itemx @key{TAB}
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
298 @itemx C-f
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
299 Typing the right-arrow key @key{RIGHT}, @key{TAB} or @kbd{C-f} @emph{in
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
300 the completion list buffer} moves point to the following completion
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
301 (@code{next-list-mode-item}).
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
302
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
303 @findex previous-list-mode-item
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
304 @item @key{LEFT}
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
305 @itemx C-b
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
306 Typing the left-arrow key @key{LEFT} or @kbd{C-b} @emph{in the
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
307 completion list buffer} moves point toward the beginning of the buffer,
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
308 to the previous completion (@code{previous-list-mode-item}).
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
309 @end table
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
310
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
311 @node Strict Completion, Completion Options, Completion Commands, Completion
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
312 @subsection Strict Completion
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
313
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
314 There are three different ways that @key{RET} can work in completing
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
315 minibuffers, depending on how the argument will be used.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
316
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
317 @itemize @bullet
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
318 @item
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
319 @dfn{Strict} completion is used when it is meaningless to give any
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
320 argument except one of the known alternatives. For example, when
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
321 @kbd{C-x k} reads the name of a buffer to kill, it is meaningless to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
322 give anything but the name of an existing buffer. In strict
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
323 completion, @key{RET} refuses to exit if the text in the minibuffer
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
324 does not complete to an exact match.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
325
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
326 @item
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
327 @dfn{Cautious} completion is similar to strict completion, except that
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
328 @key{RET} exits only if the text was an exact match already, not
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
329 needing completion. If the text is not an exact match, @key{RET} does
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
330 not exit, but it does complete the text. If it completes to an exact
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
331 match, a second @key{RET} will exit.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
332
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
333 Cautious completion is used for reading file names for files that must
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
334 already exist.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
335
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
336 @item
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
337 @dfn{Permissive} completion is used when any string whatever is
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
338 meaningful, and the list of completion alternatives is just a guide.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
339 For example, when @kbd{C-x C-f} reads the name of a file to visit, any
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
340 file name is allowed, in case you want to create a file. In
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
341 permissive completion, @key{RET} takes the text in the minibuffer
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
342 exactly as given, without completing it.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
343 @end itemize
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
344
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
345 The completion commands display a list of all possible completions in
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
346 a window whenever there is more than one possibility for the very next
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
347 character. Also, typing @kbd{?} explicitly requests such a list. If
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
348 the list of completions is long, you can scroll it with @kbd{C-M-v}
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
349 (@pxref{Other Window}).
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
350
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
351 @node Completion Options, , Strict Completion, Completion
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
352 @subsection Completion Options
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
353
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
354 @vindex completion-ignored-extensions
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
355 When completion is done on file names, certain file names are usually
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
356 ignored. The variable @code{completion-ignored-extensions} contains a
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
357 list of strings; a file whose name ends in any of those strings is
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
358 ignored as a possible completion. The standard value of this variable
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
359 has several elements including @code{".o"}, @code{".elc"}, @code{".dvi"}
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
360 and @code{"~"}. The effect is that, for example, @samp{foo} can
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
361 complete to @samp{foo.c} even though @samp{foo.o} exists as well.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
362 However, if @emph{all} the possible completions end in ``ignored''
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
363 strings, then they are not ignored. Ignored extensions do not apply to
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
364 lists of completions---those always mention all possible completions.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
365
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
366 @vindex completion-auto-help
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
367 If a completion command finds the next character is undetermined, it
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
368 automatically displays a list of all possible completions. If the variable
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
369 @code{completion-auto-help} is set to @code{nil}, this does not happen,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
370 and you must type @kbd{?} to display the possible completions.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
371
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
372 @vindex minibuffer-confirm-incomplete
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
373 If the variable @code{minibuffer-confirm-incomplete} is set to @code{t},
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
374 then in contexts where @code{completing-read} allows answers that are
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
375 not valid completions, an extra @key{RET} must be typed to confirm the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
376 response. This is helpful for catching typos.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
377
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
378 @node Minibuffer History, Repetition, Completion, Minibuffer
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
379 @section Minibuffer History
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
380 @cindex minibuffer history
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
381 @cindex history of minibuffer input
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
382
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
383 Every argument that you enter with the minibuffer is saved on a
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
384 @dfn{minibuffer history list} so that you can use it again later in
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
385 another argument. Special commands load the text of an earlier argument
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
386 in the minibuffer. They discard the old minibuffer contents, so you can
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
387 think of them as moving through the history of previous arguments.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
388
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
389 @table @kbd
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
390 @item @key{UP}
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
391 @itemx M-p
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
392 Move to the next earlier argument string saved in the minibuffer history
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
393 (@code{previous-history-element}).
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
394 @item @key{DOWN}
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
395 @itemx M-n
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
396 Move to the next later argument string saved in the minibuffer history
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
397 (@code{next-history-element}).
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
398 @item M-r @var{regexp} @key{RET}
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
399 Move to an earlier saved argument in the minibuffer history that has a
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
400 match for @var{regexp} (@code{previous-matching-history-element}).
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
401 @item M-s @var{regexp} @key{RET}
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
402 Move to a later saved argument in the minibuffer history that has a
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
403 match for @var{regexp} (@code{next-matching-history-element}).
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
404 @end table
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
405
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
406 @kindex M-p @r{(minibuffer history)}
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
407 @kindex M-n @r{(minibuffer history)}
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
408 @findex next-history-element
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
409 @findex previous-history-element
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
410 The simplest way to reuse the saved arguments in the history list is
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
411 to move through the history list one element at a time. While in the
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
412 minibuffer, use @kbd{M-p} or up-arrow (@code{previous-history-element})
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
413 to ``move to'' the next earlier minibuffer input, and use @kbd{M-n} or
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
414 down-arrow (@code{next-history-element}) to ``move to'' the next later
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
415 input.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
416
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
417 The previous input that you fetch from the history entirely replaces
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
418 the contents of the minibuffer. To use it as the argument, exit the
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
419 minibuffer as usual with @key{RET}. You can also edit the text before
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
420 you reuse it; this does not change the history element that you
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
421 ``moved'' to, but your new argument does go at the end of the history
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
422 list in its own right.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
423
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
424 For many minibuffer arguments there is a ``default'' value. In some
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
425 cases, the minibuffer history commands know the default value. Then you
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
426 can insert the default value into the minibuffer as text by using
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
427 @kbd{M-n} to move ``into the future'' in the history.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
428
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
429 @findex previous-matching-history-element
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
430 @findex next-matching-history-element
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
431 @kindex M-r @r{(minibuffer history)}
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
432 @kindex M-s @r{(minibuffer history)}
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
433 There are also commands to search forward or backward through the
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
434 history; they search for history elements that match a regular
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
435 expression that you specify with the minibuffer. @kbd{M-r}
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
436 (@code{previous-matching-history-element}) searches older elements in
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
437 the history, while @kbd{M-s} (@code{next-matching-history-element})
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
438 searches newer elements. By special dispensation, these commands can
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
439 use the minibuffer to read their arguments even though you are already
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
440 in the minibuffer when you issue them. As with incremental searching,
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
441 an uppercase letter in the regular expression makes the search
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
442 case-sensitive (@pxref{Search Case}).
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
443
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
444 All uses of the minibuffer record your input on a history list, but
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
445 there are separate history lists for different kinds of arguments. For
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
446 example, there is a list for file names, used by all the commands that
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
447 read file names.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
448
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
449 There are several other very specific history lists, including one for
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
450 command names read by @kbd{M-x}, one for buffer names, one for arguments
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
451 of commands like @code{query-replace}, and one for compilation commands
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
452 read by @code{compile}. Finally, there is one ``miscellaneous'' history
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
453 list that most minibuffer arguments use.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
454
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
455 @c Do wee need this?
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
456 @ignore
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
457 @vindex history-length
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
458 The variable @code{history-length} specifies the maximum length of a
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
459 minibuffer history list; once a list gets that long, the oldest element
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
460 is deleted each time an element is added. If the value of
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
461 @code{history-length} is @code{t}, though, there is no maximum length
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
462 and elements are never deleted.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
463 @end ignore
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
464
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
465 @node Repetition, , Minibuffer History, Minibuffer
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
466 @section Repeating Minibuffer Commands
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
467 @cindex command history
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
468 @cindex history of commands
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
469
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
470 Every command that uses the minibuffer at least once is recorded on a
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
471 special history list, together with the values of its arguments, so that
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
472 you can repeat the entire command. In particular, every use of
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
473 @kbd{M-x} is recorded there, since @kbd{M-x} uses the minibuffer to read
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
474 the command name.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
475
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
476 @findex list-command-history
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
477 @c widecommands
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
478 @table @kbd
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
479 @item C-x @key{ESC} @key{ESC}
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
480 Re-execute a recent minibuffer command (@code{repeat-complex-command}).
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
481 @item M-p
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
482 Within @kbd{C-x @key{ESC}}, move to previous recorded command
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
483 (@code{previous-history-element}).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
484 @item M-n
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
485 Within @kbd{C-x @key{ESC}}, move to the next (more recent) recorded
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
486 command (@code{next-history-element}).
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
487 @item M-x list-command-history
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
488 Display the entire command history, showing all the commands
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
489 @kbd{C-x @key{ESC} @key{ESC}} can repeat, most recent first.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
490 @end table
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
491
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
492 @kindex C-x ESC ESC
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
493 @findex repeat-complex-command
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
494 @kbd{C-x @key{ESC} @key{ESC}} is used to re-execute a recent
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
495 minibuffer-using command. With no argument, it repeats the last such
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
496 command. A numeric argument specifies which command to repeat; one
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
497 means the last one, and larger numbers specify earlier ones.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
498
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
499 @kbd{C-x @key{ESC} @key{ESC}} works by turning the previous command
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
500 into a Lisp expression and then entering a minibuffer initialized with
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
501 the text for that expression. If you type just @key{RET}, the command
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
502 is repeated as before. You can also change the command by editing the
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
503 Lisp expression. Whatever expression you finally submit is what will be
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
504 executed. The repeated command is added to the front of the command
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
505 history unless it is identical to the most recently executed command
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
506 already there.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
507
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
508 Even if you don't understand Lisp syntax, it will probably be obvious
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
509 which command is displayed for repetition. If you do not change the text,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
510 you can be sure the command will repeat exactly as before.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
511
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
512 @kindex M-n
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
513 @kindex M-p
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
514 @findex next-complex-command
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
515 @findex previous-complex-command
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
516 If you are in the minibuffer for @kbd{C-x @key{ESC} @key{ESC}} and the
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
517 command shown to you is not the one you want to repeat, you can move
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
518 around the list of previous commands using @kbd{M-n} and @kbd{M-p}.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
519 @kbd{M-p} replaces the contents of the minibuffer with the next earlier
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
520 recorded command, and @kbd{M-n} replaces it with the next later command.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
521 After finding the desired previous command, you can edit its expression
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
522 and then resubmit it by typing @key{RET}. Any editing you have done on
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
523 the command to be repeated is lost if you use @kbd{M-n} or @kbd{M-p}.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
524
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
525 @kbd{M-n} and @kbd{M-p} are specially defined within @kbd{C-x @key{ESC}
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents: 0
diff changeset
526 @key{ESC}} to run the commands @code{previous-history-element} and
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
527 @code{next-history-element}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
528
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
529 @vindex command-history
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
530 The list of previous commands using the minibuffer is stored as a Lisp
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
531 list in the variable @code{command-history}. Each element of the list
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
532 is a Lisp expression which describes one command and its arguments.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
533 Lisp programs can reexecute a command by feeding the corresponding
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
534 @code{command-history} element to @code{eval}.