C-x 5 1
[emacs.git] / man / mini.texi
blob27a240446c359b09954efd5aa25ae6cceffa22e3
1 @c This is part of the Emacs manual.
2 @c Copyright (C) 1985, 86, 87, 93, 94, 95, 97, 2000
3 @c   Free Software Foundation, Inc.
4 @c See file emacs.texi for copying conditions.
5 @node Minibuffer, M-x, Basic, Top
6 @chapter The Minibuffer
7 @cindex minibuffer
9   The @dfn{minibuffer} is the facility used by Emacs commands to read
10 arguments more complicated than a single number.  Minibuffer arguments
11 can be file names, buffer names, Lisp function names, Emacs command
12 names, Lisp expressions, and many other things, depending on the command
13 reading the argument.  You can use the usual Emacs editing commands in
14 the minibuffer to edit the argument text.
16 @cindex prompt
17   When the minibuffer is in use, it appears in the echo area, and the
18 terminal's cursor moves there.  The beginning of the minibuffer line
19 displays a @dfn{prompt} which says what kind of input you should supply and
20 how it will be used.  Often this prompt is derived from the name of the
21 command that the argument is for.  The prompt normally ends with a colon.
23 @cindex default argument
24   Sometimes a @dfn{default argument} appears in parentheses after the
25 colon; it too is part of the prompt.  The default will be used as the
26 argument value if you enter an empty argument (for example, just type
27 @key{RET}).  For example, commands that read buffer names always show a
28 default, which is the name of the buffer that will be used if you type
29 just @key{RET}.
31   The simplest way to enter a minibuffer argument is to type the text
32 you want, terminated by @key{RET} which exits the minibuffer.  You can
33 cancel the command that wants the argument, and get out of the
34 minibuffer, by typing @kbd{C-g}.
36   Since the minibuffer uses the screen space of the echo area, it can
37 conflict with other ways Emacs customarily uses the echo area.  Here is how
38 Emacs handles such conflicts:
40 @itemize @bullet
41 @item
42 If a command gets an error while you are in the minibuffer, this does
43 not cancel the minibuffer.  However, the echo area is needed for the
44 error message and therefore the minibuffer itself is hidden for a
45 while.  It comes back after a few seconds, or as soon as you type
46 anything.
48 @item
49 If in the minibuffer you use a command whose purpose is to print a
50 message in the echo area, such as @kbd{C-x =}, the message is printed
51 normally, and the minibuffer is hidden for a while.  It comes back
52 after a few seconds, or as soon as you type anything.
54 @item
55 Echoing of keystrokes does not take place while the minibuffer is in
56 use.
57 @end itemize
59 @menu
60 * File: Minibuffer File.  Entering file names with the minibuffer.
61 * Edit: Minibuffer Edit.  How to edit in the minibuffer.
62 * Completion::            An abbreviation facility for minibuffer input.
63 * Minibuffer History::    Reusing recent minibuffer arguments.
64 * Repetition::            Re-executing commands that used the minibuffer.
65 @end menu
67 @node Minibuffer File
68 @section Minibuffers for File Names
70   Sometimes the minibuffer starts out with text in it.  For example, when
71 you are supposed to give a file name, the minibuffer starts out containing
72 the @dfn{default directory}, which ends with a slash.  This is to inform
73 you which directory the file will be found in if you do not specify a
74 directory.
76 @c Separate paragraph to clean up ugly pagebreak--rms
77 @need 1500
78   For example, the minibuffer might start out with these contents:
80 @example
81 Find File: /u2/emacs/src/
82 @end example
84 @noindent
85 where @samp{Find File:@: } is the prompt.  Typing @kbd{buffer.c}
86 specifies the file @file{/u2/emacs/src/buffer.c}.  To find files in
87 nearby directories, use @kbd{..}; thus, if you type
88 @kbd{../lisp/simple.el}, you will get the file named
89 @file{/u2/emacs/lisp/simple.el}.  Alternatively, you can kill with
90 @kbd{M-@key{DEL}} the directory names you don't want (@pxref{Words}).
92   If you don't want any of the default, you can kill it with @kbd{C-a
93 C-k}.  But you don't need to kill the default; you can simply ignore it.
94 Insert an absolute file name, one starting with a slash or a tilde,
95 after the default directory.  For example, to specify the file
96 @file{/etc/termcap}, just insert that name, giving these minibuffer
97 contents:
99 @example
100 Find File: /u2/emacs/src//etc/termcap
101 @end example
103 @noindent
104 @cindex // in file name
105 @cindex double slash in file name
106 @cindex slashes repeated in file name
107 GNU Emacs gives a special meaning to a double slash (which is not
108 normally a useful thing to write): it means, ``ignore everything before
109 the second slash in the pair.''  Thus, @samp{/u2/emacs/src/} is ignored
110 in the example above, and you get the file @file{/etc/termcap}.
112   If you set @code{insert-default-directory} to @code{nil}, the default
113 directory is not inserted in the minibuffer.  This way, the minibuffer
114 starts out empty.  But the name you type, if relative, is still
115 interpreted with respect to the same default directory.
117 @node Minibuffer Edit
118 @section Editing in the Minibuffer
120   The minibuffer is an Emacs buffer (albeit a peculiar one), and the usual
121 Emacs commands are available for editing the text of an argument you are
122 entering.
124   Since @key{RET} in the minibuffer is defined to exit the minibuffer,
125 you can't use it to insert a newline in the minibuffer.  To do that,
126 type @kbd{C-o} or @kbd{C-q C-j}.  (Recall that a newline is really the
127 character control-J.)
129   The minibuffer has its own window which always has space on the screen
130 but acts as if it were not there when the minibuffer is not in use.  When
131 the minibuffer is in use, its window is just like the others; you can
132 switch to another window with @kbd{C-x o}, edit text in other windows and
133 perhaps even visit more files, before returning to the minibuffer to submit
134 the argument.  You can kill text in another window, return to the
135 minibuffer window, and then yank the text to use it in the argument.
136 @xref{Windows}.
138 @cindex height of minibuffer
139 @cindex size of minibuffer
140 @cindex growing minibuffer
141 @cindex resizing minibuffer
142 @vindex max-mini-window-height
143   There are some restrictions on the use of the minibuffer window,
144 however.  You cannot switch buffers in it---the minibuffer and its
145 window are permanently attached.  Also, you cannot split or kill the
146 minibuffer window.  But you can make it taller in the normal fashion
147 with @kbd{C-x ^}.  The minibuffer window expands vertically as necessary
148 to hold the text that you put in the minibuffer.  Customize the variable
149 @code{max-mini-window-height} to control the maximum height for resizing
150 the minibuffer window.
152 @vindex minibuffer-scroll-overlap
153   Scrolling works specially in the minibuffer window.  When the
154 minibuffer is just one line high, and it contains a long line of text
155 that won't fit on the screen, scrolling automatically maintains an
156 overlap of a certain number of characters from one continuation line to
157 the next.  The variable @code{minibuffer-scroll-overlap} specifies how
158 many characters of overlap; the default is 20.
160   If while in the minibuffer you issue a command that displays help text
161 of any sort in another window, you can use the @kbd{C-M-v} command while
162 in the minibuffer to scroll the help text.  This lasts until you exit
163 the minibuffer.  This feature is especially useful if a completing
164 minibuffer gives you a list of possible completions.  @xref{Other Window}.
166 @vindex enable-recursive-minibuffers
167   Emacs normally disallows most commands that use the minibuffer while
168 the minibuffer is active.  This rule is to prevent recursive minibuffers
169 from confusing novice users.  If you want to be able to use such
170 commands in the minibuffer, set the variable
171 @code{enable-recursive-minibuffers} to a non-@code{nil} value.
173 @node Completion
174 @section Completion
175 @cindex completion
177   For certain kinds of arguments, you can use @dfn{completion} to enter
178 the argument value.  Completion means that you type part of the
179 argument, then Emacs visibly fills in the rest, or as much as
180 can be determined from the part you have typed.
182   When completion is available, certain keys---@key{TAB}, @key{RET}, and
183 @key{SPC}---are rebound to complete the text present in the minibuffer
184 into a longer string that it stands for, by matching it against a set of
185 @dfn{completion alternatives} provided by the command reading the
186 argument.  @kbd{?} is defined to display a list of possible completions
187 of what you have inserted.
189   For example, when @kbd{M-x} uses the minibuffer to read the name of a
190 command, it provides a list of all available Emacs command names to
191 complete against.  The completion keys match the text in the minibuffer
192 against all the command names, find any additional name characters
193 implied by the ones already present in the minibuffer, and add those
194 characters to the ones you have given.  This is what makes it possible
195 to type @kbd{M-x ins @key{SPC} b @key{RET}} instead of @kbd{M-x
196 insert-buffer @key{RET}} (for example).
198   Case is normally significant in completion, because it is significant
199 in most of the names that you can complete (buffer names, file names and
200 command names).  Thus, @samp{fo} does not complete to @samp{Foo}.
201 Completion does ignore case distinctions for certain arguments in which
202 case does not matter.
204 @menu
205 * Example: Completion Example.
206 * Commands: Completion Commands.
207 * Strict Completion::
208 * Options: Completion Options.
209 @end menu
211 @node Completion Example
212 @subsection Completion Example
214 @kindex TAB @r{(completion)}
215 @findex minibuffer-complete
216   A concrete example may help here.  If you type @kbd{M-x au @key{TAB}},
217 the @key{TAB} looks for alternatives (in this case, command names) that
218 start with @samp{au}.  There are several, including
219 @code{auto-fill-mode} and @code{auto-save-mode}---but they are all the
220 same as far as @code{auto-}, so the @samp{au} in the minibuffer changes
221 to @samp{auto-}.@refill
223   If you type @key{TAB} again immediately, there are multiple
224 possibilities for the very next character---it could be any of
225 @samp{cfilrs}---so no more characters are added; instead, @key{TAB}
226 displays a list of all possible completions in another window.
228   If you go on to type @kbd{f @key{TAB}}, this @key{TAB} sees
229 @samp{auto-f}.  The only command name starting this way is
230 @code{auto-fill-mode}, so completion fills in the rest of that.  You now
231 have @samp{auto-fill-mode} in the minibuffer after typing just @kbd{au
232 @key{TAB} f @key{TAB}}.  Note that @key{TAB} has this effect because in
233 the minibuffer it is bound to the command @code{minibuffer-complete}
234 when completion is available.
236 @node Completion Commands
237 @subsection Completion Commands
239   Here is a list of the completion commands defined in the minibuffer
240 when completion is available.
242 @table @kbd
243 @item @key{TAB}
244 Complete the text in the minibuffer as much as possible
245 (@code{minibuffer-complete}).
246 @item @key{SPC}
247 Complete the minibuffer text, but don't go beyond one word
248 (@code{minibuffer-complete-word}).
249 @item @key{RET}
250 Submit the text in the minibuffer as the argument, possibly completing
251 first as described below (@code{minibuffer-complete-and-exit}).
252 @item ?
253 Print a list of all possible completions of the text in the minibuffer
254 (@code{minibuffer-list-completions}).
255 @end table
257 @kindex SPC
258 @findex minibuffer-complete-word
259   @key{SPC} completes much like @key{TAB}, but never goes beyond the
260 next hyphen or space.  If you have @samp{auto-f} in the minibuffer and
261 type @key{SPC}, it finds that the completion is @samp{auto-fill-mode},
262 but it stops completing after @samp{fill-}.  This gives
263 @samp{auto-fill-}.  Another @key{SPC} at this point completes all the
264 way to @samp{auto-fill-mode}.  @key{SPC} in the minibuffer when
265 completion is available runs the command
266 @code{minibuffer-complete-word}.
268   Here are some commands you can use to choose a completion from a
269 window that displays a list of completions:
271 @table @kbd
272 @findex mouse-choose-completion
273 @item Mouse-2
274 Clicking mouse button 2 on a completion in the list of possible
275 completions chooses that completion (@code{mouse-choose-completion}).
276 You normally use this command while point is in the minibuffer; but you
277 must click in the list of completions, not in the minibuffer itself.
279 @findex switch-to-completions
280 @item @key{PRIOR}
281 @itemx M-v
282 Typing @key{PRIOR} or @key{PAGE-UP}, or @kbd{M-v}, while in the
283 minibuffer, selects the window showing the completion list buffer
284 (@code{switch-to-completions}).  This paves the way for using the
285 commands below.  (Selecting that window in the usual ways has the same
286 effect, but this way is more convenient.)
288 @findex choose-completion
289 @item @key{RET}
290 Typing @key{RET} @emph{in the completion list buffer} chooses the
291 completion that point is in or next to (@code{choose-completion}).  To
292 use this command, you must first switch windows to the window that shows
293 the list of completions.
295 @findex next-completion
296 @item @key{RIGHT}
297 Typing the right-arrow key @key{RIGHT} @emph{in the completion list
298 buffer} moves point to the following completion (@code{next-completion}).
300 @findex previous-completion
301 @item @key{LEFT}
302 Typing the left-arrow key @key{LEFT} @emph{in the completion list
303 buffer} moves point toward the beginning of the buffer, to the previous
304 completion (@code{previous-completion}).
305 @end table
307 @node Strict Completion
308 @subsection Strict Completion
310   There are three different ways that @key{RET} can work in completing
311 minibuffers, depending on how the argument will be used.
313 @itemize @bullet
314 @item
315 @dfn{Strict} completion is used when it is meaningless to give any
316 argument except one of the known alternatives.  For example, when
317 @kbd{C-x k} reads the name of a buffer to kill, it is meaningless to
318 give anything but the name of an existing buffer.  In strict
319 completion, @key{RET} refuses to exit if the text in the minibuffer
320 does not complete to an exact match.
322 @item
323 @dfn{Cautious} completion is similar to strict completion, except that
324 @key{RET} exits only if the text was an exact match already, not
325 needing completion.  If the text is not an exact match, @key{RET} does
326 not exit, but it does complete the text.  If it completes to an exact
327 match, a second @key{RET} will exit.
329 Cautious completion is used for reading file names for files that must
330 already exist.
332 @item
333 @dfn{Permissive} completion is used when any string whatever is
334 meaningful, and the list of completion alternatives is just a guide.
335 For example, when @kbd{C-x C-f} reads the name of a file to visit, any
336 file name is allowed, in case you want to create a file.  In
337 permissive completion, @key{RET} takes the text in the minibuffer
338 exactly as given, without completing it.
339 @end itemize
341   The completion commands display a list of all possible completions in
342 a window whenever there is more than one possibility for the very next
343 character.  Also, typing @kbd{?} explicitly requests such a list.  If
344 the list of completions is long, you can scroll it with @kbd{C-M-v}
345 (@pxref{Other Window}).
347 @node Completion Options
348 @subsection Completion Options
350 @vindex completion-ignored-extensions
351   When completion is done on file names, certain file names are usually
352 ignored.  The variable @code{completion-ignored-extensions} contains a
353 list of strings; a file whose name ends in any of those strings is
354 ignored as a possible completion.  The standard value of this variable
355 has several elements including @code{".o"}, @code{".elc"}, @code{".dvi"}
356 and @code{"~"}.  The effect is that, for example, @samp{foo} can
357 complete to @samp{foo.c} even though @samp{foo.o} exists as well.
358 However, if @emph{all} the possible completions end in ``ignored''
359 strings, then they are not ignored.  Ignored extensions do not apply to
360 lists of completions---those always mention all possible completions.
362 @vindex completion-auto-help
363   Normally, a completion command that finds the next character is undetermined
364 automatically displays a list of all possible completions.  If the variable
365 @code{completion-auto-help} is set to @code{nil}, this does not happen,
366 and you must type @kbd{?} to display the possible completions.
368 @pindex complete
369 @cindex Partial Completion mode
370 @vindex partial-completion-mode
371 @findex partial-completion-mode
372 @vindex PC-include-file-path
373 @vindex PC-disable-includes
374   The @code{complete} library implements a more powerful kind of
375 completion that can complete multiple words at a time.  For example, it
376 can complete the command name abbreviation @code{p-b} into
377 @code{print-buffer}, because no other command starts with two words
378 whose initials are @samp{p} and @samp{b}.  To enable this, use the
379 command @kbd{M-x partial-completion-mode} or customize the option
380 @code{partial-completion-mode}.  Unless the option
381 @code{PC-disable-includes} is @code{t}, Partial Completion mode also
382 extends @kbd{M-x find-file} so that the @samp{<@dots{}>} sequence is
383 interpreted as a file on the path @code{PC-include-file-path} and
384 partial completion of file names is possible.  Partial completion of
385 directories in file names requires @samp{*}s to indicate the
386 completions: @file{/u*/b*/f*} might expand to @file{/usr/bin/foo}.  When
387 Partial Completion mode is active, the Meta versions of the @kbd{TAB},
388 @kbd{SPC}, @kbd{RET} and @kbd{?} keys act as those keys do by default
389 for completion.
391 @cindex Icomplete mode
392 @findex icomplete-mode
393   Icomplete mode presents a constantly-updated display that tells you
394 what completions are available for the text you've entered so far.  The
395 command to enable or disable this minor mode is @kbd{M-x
396 icomplete-mode}.
398 @node Minibuffer History
399 @section Minibuffer History
400 @cindex minibuffer history
401 @cindex history of minibuffer input
403   Every argument that you enter with the minibuffer is saved on a
404 @dfn{minibuffer history list} so that you can use it again later in
405 another argument.  Special commands load the text of an earlier argument
406 in the minibuffer.  They discard the old minibuffer contents, so you can
407 think of them as moving through the history of previous arguments.
409 @table @kbd
410 @item @key{UP}
411 @itemx M-p
412 Move to the next earlier argument string saved in the minibuffer history
413 (@code{previous-history-element}).
414 @item @key{DOWN}
415 @itemx M-n
416 Move to the next later argument string saved in the minibuffer history
417 (@code{next-history-element}).
418 @item M-r @var{regexp} @key{RET}
419 Move to an earlier saved argument in the minibuffer history that has a
420 match for @var{regexp} (@code{previous-matching-history-element}).
421 @item M-s @var{regexp} @key{RET}
422 Move to a later saved argument in the minibuffer history that has a
423 match for @var{regexp} (@code{next-matching-history-element}).
424 @end table
426 @kindex M-p @r{(minibuffer history)}
427 @kindex M-n @r{(minibuffer history)}
428 @findex next-history-element
429 @findex previous-history-element
430   The simplest way to reuse the saved arguments in the history list is
431 to move through the history list one element at a time.  While in the
432 minibuffer, use @kbd{M-p} or up-arrow (@code{previous-history-element})
433 to ``move to'' the next earlier minibuffer input, and use @kbd{M-n} or
434 down-arrow (@code{next-history-element}) to ``move to'' the next later
435 input.
437   The previous input that you fetch from the history entirely replaces
438 the contents of the minibuffer.  To use it as the argument, exit the
439 minibuffer as usual with @key{RET}.  You can also edit the text before
440 you reuse it; this does not change the history element that you
441 ``moved'' to, but your new argument does go at the end of the history
442 list in its own right.
444   For many minibuffer arguments there is a ``default'' value.  In some
445 cases, the minibuffer history commands know the default value.  Then you
446 can insert the default value into the minibuffer as text by using
447 @kbd{M-n} to move ``into the future'' in the history.  Eventually we
448 hope to make this feature available whenever the minibuffer has a
449 default value.
451 @findex previous-matching-history-element
452 @findex next-matching-history-element
453 @kindex M-r @r{(minibuffer history)}
454 @kindex M-s @r{(minibuffer history)}
455   There are also commands to search forward or backward through the
456 history; they search for history elements that match a regular
457 expression that you specify with the minibuffer.  @kbd{M-r}
458 (@code{previous-matching-history-element}) searches older elements in
459 the history, while @kbd{M-s} (@code{next-matching-history-element})
460 searches newer elements.  By special dispensation, these commands can
461 use the minibuffer to read their arguments even though you are already
462 in the minibuffer when you issue them.  As with incremental searching,
463 an uppercase letter in the regular expression makes the search
464 case-sensitive (@pxref{Search Case}).
466 @ignore
467   We may change the precise way these commands read their arguments.
468 Perhaps they will search for a match for the string given so far in the
469 minibuffer; perhaps they will search for a literal match rather than a
470 regular expression match; perhaps they will only accept matches at the
471 beginning of a history element; perhaps they will read the string to
472 search for incrementally like @kbd{C-s}.  To find out what interface is
473 actually available, type @kbd{C-h f previous-matching-history-element}.
474 @end ignore
476   All uses of the minibuffer record your input on a history list, but
477 there are separate history lists for different kinds of arguments.  For
478 example, there is a list for file names, used by all the commands that
479 read file names.  (As a special feature, this history list records
480 the absolute file name, no more and no less, even if that is not how
481 you entered the file name.)
483   There are several other very specific history lists, including one for
484 command names read by @kbd{M-x}, one for buffer names, one for arguments
485 of commands like @code{query-replace}, and one for compilation commands
486 read by @code{compile}.  Finally, there is one ``miscellaneous'' history
487 list that most minibuffer arguments use.
489 @vindex history-length
490   The variable @code{history-length} specifies the maximum length of a
491 minibuffer history list; once a list gets that long, the oldest element
492 is deleted each time an element is added.  If the value of
493 @code{history-length} is @code{t}, though, there is no maximum length
494 and elements are never deleted.
496 @node Repetition
497 @section Repeating Minibuffer Commands
498 @cindex command history
499 @cindex history of commands
501   Every command that uses the minibuffer at least once is recorded on a
502 special history list, together with the values of its arguments, so that
503 you can repeat the entire command.  In particular, every use of
504 @kbd{M-x} is recorded there, since @kbd{M-x} uses the minibuffer to read
505 the command name.
507 @findex list-command-history
508 @c widecommands
509 @table @kbd
510 @item C-x @key{ESC} @key{ESC}
511 Re-execute a recent minibuffer command (@code{repeat-complex-command}).
512 @item M-x list-command-history
513 Display the entire command history, showing all the commands
514 @kbd{C-x @key{ESC} @key{ESC}} can repeat, most recent first.
515 @end table
517 @kindex C-x ESC ESC
518 @findex repeat-complex-command
519   @kbd{C-x @key{ESC} @key{ESC}} is used to re-execute a recent
520 minibuffer-using command.  With no argument, it repeats the last such
521 command.  A numeric argument specifies which command to repeat; one
522 means the last one, and larger numbers specify earlier ones.
524   @kbd{C-x @key{ESC} @key{ESC}} works by turning the previous command
525 into a Lisp expression and then entering a minibuffer initialized with
526 the text for that expression.  If you type just @key{RET}, the command
527 is repeated as before.  You can also change the command by editing the
528 Lisp expression.  Whatever expression you finally submit is what will be
529 executed.  The repeated command is added to the front of the command
530 history unless it is identical to the most recently executed command
531 already there.
533   Even if you don't understand Lisp syntax, it will probably be obvious
534 which command is displayed for repetition.  If you do not change the
535 text, it will repeat exactly as before.
537   Once inside the minibuffer for @kbd{C-x @key{ESC} @key{ESC}}, you can
538 use the minibuffer history commands (@kbd{M-p}, @kbd{M-n}, @kbd{M-r},
539 @kbd{M-s}; @pxref{Minibuffer History}) to move through the history list
540 of saved entire commands.  After finding the desired previous command,
541 you can edit its expression as usual and then resubmit it by typing
542 @key{RET} as usual.
544 @vindex command-history
545   The list of previous minibuffer-using commands is stored as a Lisp
546 list in the variable @code{command-history}.  Each element is a Lisp
547 expression which describes one command and its arguments.  Lisp programs
548 can re-execute a command by calling @code{eval} with the
549 @code{command-history} element.