blob: 36a71cfccc1ff0360809ee8033346bb6390fa08a [file] [log] [blame]
Bram Moolenaar3b1db362013-08-10 15:00:24 +02001*cmdline.txt* For Vim version 7.4. Last change: 2013 Mar 16
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7 *Cmdline-mode* *Command-line-mode*
8Command-line mode *Cmdline* *Command-line* *mode-cmdline* *:*
9
10Command-line mode is used to enter Ex commands (":"), search patterns
11("/" and "?"), and filter commands ("!").
12
13Basic command line editing is explained in chapter 20 of the user manual
14|usr_20.txt|.
15
161. Command-line editing |cmdline-editing|
172. Command-line completion |cmdline-completion|
183. Ex command-lines |cmdline-lines|
194. Ex command-line ranges |cmdline-ranges|
Bram Moolenaardf177f62005-02-22 08:39:57 +0000205. Ex command-line flags |ex-flags|
216. Ex special characters |cmdline-special|
227. Command-line window |cmdline-window|
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24==============================================================================
251. Command-line editing *cmdline-editing*
26
27Normally characters are inserted in front of the cursor position. You can
28move around in the command-line with the left and right cursor keys. With the
29<Insert> key, you can toggle between inserting and overstriking characters.
30{Vi: can only alter the last character in the line}
31
32Note that if your keyboard does not have working cursor keys or any of the
33other special keys, you can use ":cnoremap" to define another key for them.
34For example, to define tcsh style editing keys: *tcsh-style* >
35 :cnoremap <C-A> <Home>
36 :cnoremap <C-F> <Right>
37 :cnoremap <C-B> <Left>
38 :cnoremap <Esc>b <S-Left>
39 :cnoremap <Esc>f <S-Right>
40(<> notation |<>|; type all this literally)
41
42 *cmdline-too-long*
43When the command line is getting longer than what fits on the screen, only the
44part that fits will be shown. The cursor can only move in this visible part,
45thus you cannot edit beyond that.
46
47 *cmdline-history* *history*
48The command-lines that you enter are remembered in a history table. You can
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +000049recall them with the up and down cursor keys. There are actually five
Bram Moolenaar071d4272004-06-13 20:20:40 +000050history tables:
51- one for ':' commands
52- one for search strings
53- one for expressions
54- one for input lines, typed for the |input()| function.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +000055- one for debug mode commands
Bram Moolenaar071d4272004-06-13 20:20:40 +000056These are completely separate. Each history can only be accessed when
57entering the same type of line.
58Use the 'history' option to set the number of lines that are remembered
59(default: 20).
60Notes:
61- When you enter a command-line that is exactly the same as an older one, the
62 old one is removed (to avoid repeated commands moving older commands out of
63 the history).
64- Only commands that are typed are remembered. Ones that completely come from
Bram Moolenaar3577c6f2008-06-24 21:16:56 +000065 mappings are not put in the history.
Bram Moolenaar071d4272004-06-13 20:20:40 +000066- All searches are put in the search history, including the ones that come
67 from commands like "*" and "#". But for a mapping, only the last search is
68 remembered (to avoid that long mappings trash the history).
69{Vi: no history}
70{not available when compiled without the |+cmdline_hist| feature}
71
72There is an automatic completion of names on the command-line; see
73|cmdline-completion|.
74
75 *c_CTRL-V*
76CTRL-V Insert next non-digit literally. Up to three digits form the
77 decimal value of a single byte. The non-digit and the three
78 digits are not considered for mapping. This works the same
79 way as in Insert mode (see above, |i_CTRL-V|).
80 Note: Under Windows CTRL-V is often mapped to paste text.
81 Use CTRL-Q instead then.
82 *c_CTRL-Q*
83CTRL-Q Same as CTRL-V. But with some terminals it is used for
84 control flow, it doesn't work then.
85
Bram Moolenaaradc21822011-04-01 18:03:16 +020086 *c_<Left>* *c_Left*
Bram Moolenaar071d4272004-06-13 20:20:40 +000087<Left> cursor left
Bram Moolenaaradc21822011-04-01 18:03:16 +020088 *c_<Right>* *c_Right*
Bram Moolenaar071d4272004-06-13 20:20:40 +000089<Right> cursor right
90 *c_<S-Left>*
91<S-Left> or <C-Left> *c_<C-Left>*
92 cursor one WORD left
93 *c_<S-Right>*
94<S-Right> or <C-Right> *c_<C-Right>*
95 cursor one WORD right
Bram Moolenaaradc21822011-04-01 18:03:16 +020096CTRL-B or <Home> *c_CTRL-B* *c_<Home>* *c_Home*
Bram Moolenaar071d4272004-06-13 20:20:40 +000097 cursor to beginning of command-line
Bram Moolenaaradc21822011-04-01 18:03:16 +020098CTRL-E or <End> *c_CTRL-E* *c_<End>* *c_End*
Bram Moolenaar071d4272004-06-13 20:20:40 +000099 cursor to end of command-line
100
101 *c_<LeftMouse>*
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000102<LeftMouse> Move the cursor to the position of the mouse click.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000103
Bram Moolenaaradc21822011-04-01 18:03:16 +0200104CTRL-H *c_<BS>* *c_CTRL-H* *c_BS*
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000105<BS> Delete the character in front of the cursor (see |:fixdel| if
Bram Moolenaar071d4272004-06-13 20:20:40 +0000106 your <BS> key does not do what you want).
Bram Moolenaaradc21822011-04-01 18:03:16 +0200107 *c_<Del>* *c_Del*
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000108<Del> Delete the character under the cursor (at end of line:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000109 character before the cursor) (see |:fixdel| if your <Del>
110 key does not do what you want).
111 *c_CTRL-W*
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000112CTRL-W Delete the |word| before the cursor. This depends on the
113 'iskeyword' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000114 *c_CTRL-U*
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000115CTRL-U Remove all characters between the cursor position and
Bram Moolenaar071d4272004-06-13 20:20:40 +0000116 the beginning of the line. Previous versions of vim
117 deleted all characters on the line. If that is the
118 preferred behavior, add the following to your .vimrc: >
119 :cnoremap <C-U> <C-E><C-U>
120<
Bram Moolenaaradc21822011-04-01 18:03:16 +0200121 *c_<Insert>* *c_Insert*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000122<Insert> Toggle between insert and overstrike. {not in Vi}
123
124{char1} <BS> {char2} or *c_digraph*
125CTRL-K {char1} {char2} *c_CTRL-K*
126 enter digraph (see |digraphs|). When {char1} is a special
127 key, the code for that key is inserted in <> form. {not in Vi}
128
129CTRL-R {0-9a-z"%#:-=.} *c_CTRL-R* *c_<C-R>*
130 Insert the contents of a numbered or named register. Between
131 typing CTRL-R and the second character '"' will be displayed
132 to indicate that you are expected to enter the name of a
133 register.
134 The text is inserted as if you typed it, but mappings and
135 abbreviations are not used. Command-line completion through
136 'wildchar' is not triggered though. And characters that end
137 the command line are inserted literally (<Esc>, <CR>, <NL>,
138 <C-C>). A <BS> or CTRL-W could still end the command line
139 though, and remaining characters will then be interpreted in
140 another mode, which might not be what you intended.
141 Special registers:
142 '"' the unnamed register, containing the text of
143 the last delete or yank
144 '%' the current file name
145 '#' the alternate file name
146 '*' the clipboard contents (X11: primary selection)
147 '+' the clipboard contents
148 '/' the last search pattern
149 ':' the last command-line
150 '-' the last small (less than a line) delete
151 '.' the last inserted text
152 *c_CTRL-R_=*
153 '=' the expression register: you are prompted to
154 enter an expression (see |expression|)
Bram Moolenaar05a7bb32006-01-19 22:09:32 +0000155 (doesn't work at the expression prompt; some
156 things such as changing the buffer or current
157 window are not allowed to avoid side effects)
Bram Moolenaard812df62008-11-09 12:46:09 +0000158 When the result is a |List| the items are used
159 as lines. They can have line breaks inside
160 too.
161 When the result is a Float it's automatically
162 converted to a String.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000163 See |registers| about registers. {not in Vi}
Bram Moolenaarfd371682005-01-14 21:42:54 +0000164 Implementation detail: When using the |expression| register
165 and invoking setcmdpos(), this sets the position before
166 inserting the resulting string. Use CTRL-R CTRL-R to set the
167 position afterwards.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000168
169CTRL-R CTRL-F *c_CTRL-R_CTRL-F* *c_<C-R>_<C-F>*
170CTRL-R CTRL-P *c_CTRL-R_CTRL-P* *c_<C-R>_<C-P>*
171CTRL-R CTRL-W *c_CTRL-R_CTRL-W* *c_<C-R>_<C-W>*
172CTRL-R CTRL-A *c_CTRL-R_CTRL-A* *c_<C-R>_<C-A>*
173 Insert the object under the cursor:
174 CTRL-F the Filename under the cursor
175 CTRL-P the Filename under the cursor, expanded with
176 'path' as in |gf|
177 CTRL-W the Word under the cursor
178 CTRL-A the WORD under the cursor; see |WORD|
Bram Moolenaard3667a22006-03-16 21:35:52 +0000179
180 When 'incsearch' is set the cursor position at the end of the
181 currently displayed match is used. With CTRL-W the part of
182 the word that was already typed is not inserted again.
183
Bram Moolenaar071d4272004-06-13 20:20:40 +0000184 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +0200185 CTRL-F and CTRL-P: {only when |+file_in_path| feature is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000186 included}
187
188 *c_CTRL-R_CTRL-R* *c_<C-R>_<C-R>*
189 *c_CTRL-R_CTRL-O* *c_<C-R>_<C-O>*
190CTRL-R CTRL-R {0-9a-z"%#:-=. CTRL-F CTRL-P CTRL-W CTRL-A}
191CTRL-R CTRL-O {0-9a-z"%#:-=. CTRL-F CTRL-P CTRL-W CTRL-A}
192 Insert register or object under the cursor. Works like
193 |c_CTRL-R| but inserts the text literally. For example, if
194 register a contains "xy^Hz" (where ^H is a backspace),
195 "CTRL-R a" will insert "xz" while "CTRL-R CTRL-R a" will
196 insert "xy^Hz".
197
198CTRL-\ e {expr} *c_CTRL-\_e*
199 Evaluate {expr} and replace the whole command line with the
200 result. You will be prompted for the expression, type <Enter>
201 to finish it. It's most useful in mappings though. See
202 |expression|.
203 See |c_CTRL-R_=| for inserting the result of an expression.
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +0000204 Useful functions are |getcmdtype()|, |getcmdline()| and
205 |getcmdpos()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000206 The cursor position is unchanged, except when the cursor was
207 at the end of the line, then it stays at the end.
208 |setcmdpos()| can be used to set the cursor position.
Bram Moolenaar4770d092006-01-12 23:22:24 +0000209 The |sandbox| is used for evaluating the expression to avoid
210 nasty side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000211 Example: >
212 :cmap <F7> <C-\>eAppendSome()<CR>
213 :func AppendSome()
214 :let cmd = getcmdline() . " Some()"
215 :" place the cursor on the )
216 :call setcmdpos(strlen(cmd))
217 :return cmd
218 :endfunc
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +0000219< This doesn't work recursively, thus not when already editing
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200220 an expression. But it is possible to use in a mapping.
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +0000221
Bram Moolenaar071d4272004-06-13 20:20:40 +0000222 *c_CTRL-Y*
223CTRL-Y When there is a modeless selection, copy the selection into
224 the clipboard. |modeless-selection|
225 If there is no selection CTRL-Y is inserted as a character.
226
Bram Moolenaaradc21822011-04-01 18:03:16 +0200227CTRL-J *c_CTRL-J* *c_<NL>* *c_<CR>* *c_CR*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000228<CR> or <NL> start entered command
Bram Moolenaaradc21822011-04-01 18:03:16 +0200229 *c_<Esc>* *c_Esc*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000230<Esc> When typed and 'x' not present in 'cpoptions', quit
231 Command-line mode without executing. In macros or when 'x'
232 present in 'cpoptions', start entered command.
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000233 Note: If your <Esc> key is hard to hit on your keyboard, train
234 yourself to use CTRL-[.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000235 *c_CTRL-C*
236CTRL-C quit command-line without executing
237
Bram Moolenaaradc21822011-04-01 18:03:16 +0200238 *c_<Up>* *c_Up*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000239<Up> recall older command-line from history, whose beginning
240 matches the current command-line (see below).
241 {not available when compiled without the |+cmdline_hist|
242 feature}
Bram Moolenaaradc21822011-04-01 18:03:16 +0200243 *c_<Down>* *c_Down*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000244<Down> recall more recent command-line from history, whose beginning
245 matches the current command-line (see below).
246 {not available when compiled without the |+cmdline_hist|
247 feature}
248
249 *c_<S-Up>* *c_<PageUp>*
250<S-Up> or <PageUp>
251 recall older command-line from history
252 {not available when compiled without the |+cmdline_hist|
253 feature}
254 *c_<S-Down>* *c_<PageDown>*
255<S-Down> or <PageDown>
256 recall more recent command-line from history
257 {not available when compiled without the |+cmdline_hist|
258 feature}
259
260CTRL-D command-line completion (see |cmdline-completion|)
261'wildchar' option
262 command-line completion (see |cmdline-completion|)
263CTRL-N command-line completion (see |cmdline-completion|)
264CTRL-P command-line completion (see |cmdline-completion|)
265CTRL-A command-line completion (see |cmdline-completion|)
266CTRL-L command-line completion (see |cmdline-completion|)
267
268 *c_CTRL-_*
269CTRL-_ a - switch between Hebrew and English keyboard mode, which is
270 private to the command-line and not related to hkmap.
271 This is useful when Hebrew text entry is required in the
272 command-line, searches, abbreviations, etc. Applies only if
273 Vim is compiled with the |+rightleft| feature and the
274 'allowrevins' option is set.
275 See |rileft.txt|.
276
277 b - switch between Farsi and English keyboard mode, which is
278 private to the command-line and not related to fkmap. In
279 Farsi keyboard mode the characters are inserted in reverse
280 insert manner. This is useful when Farsi text entry is
281 required in the command-line, searches, abbreviations, etc.
282 Applies only if Vim is compiled with the |+farsi| feature.
283 See |farsi.txt|.
284
285 *c_CTRL-^*
286CTRL-^ Toggle the use of language |:lmap| mappings and/or Input
287 Method.
288 When typing a pattern for a search command and 'imsearch' is
289 not -1, VAL is the value of 'imsearch', otherwise VAL is the
290 value of 'iminsert'.
291 When language mappings are defined:
292 - If VAL is 1 (langmap mappings used) it becomes 0 (no langmap
293 mappings used).
294 - If VAL was not 1 it becomes 1, thus langmap mappings are
295 enabled.
296 When no language mappings are defined:
297 - If VAL is 2 (Input Method is used) it becomes 0 (no input
298 method used)
299 - If VAL has another value it becomes 2, thus the Input Method
300 is enabled.
301 These language mappings are normally used to type characters
302 that are different from what the keyboard produces. The
303 'keymap' option can be used to install a whole number of them.
304 When entering a command line, langmap mappings are switched
305 off, since you are expected to type a command. After
306 switching it on with CTRL-^, the new state is not used again
307 for the next command or Search pattern.
308 {not in Vi}
309
Bram Moolenaar9964e462007-05-05 17:54:07 +0000310 *c_CTRL-]*
311CTRL-] Trigger abbreviation, without inserting a character. {not in
312 Vi}
313
Bram Moolenaar071d4272004-06-13 20:20:40 +0000314For Emacs-style editing on the command-line see |emacs-keys|.
315
316The <Up> and <Down> keys take the current command-line as a search string.
317The beginning of the next/previous command-lines are compared with this
318string. The first line that matches is the new command-line. When typing
319these two keys repeatedly, the same string is used again. For example, this
320can be used to find the previous substitute command: Type ":s" and then <Up>.
321The same could be done by typing <S-Up> a number of times until the desired
322command-line is shown. (Note: the shifted arrow keys do not work on all
323terminals)
324
Bram Moolenaar066b6222008-01-04 14:17:47 +0000325 *:his* *:history*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000326:his[tory] Print the history of last entered commands.
327 {not in Vi}
328 {not available when compiled without the |+cmdline_hist|
329 feature}
330
331:his[tory] [{name}] [{first}][, [{last}]]
332 List the contents of history {name} which can be:
Bram Moolenaar5ae636b2012-04-30 18:48:53 +0200333 c[md] or : command-line history
334 s[earch] or / or ? search string history
335 e[xpr] or = expression register history
336 i[nput] or @ input line history
337 d[ebug] or > debug command history
338 a[ll] all of the above
Bram Moolenaar071d4272004-06-13 20:20:40 +0000339 {not in Vi}
340
341 If the numbers {first} and/or {last} are given, the respective
342 range of entries from a history is listed. These numbers can
343 be specified in the following form:
344 *:history-indexing*
345 A positive number represents the absolute index of an entry
346 as it is given in the first column of a :history listing.
347 This number remains fixed even if other entries are deleted.
348
349 A negative number means the relative position of an entry,
350 counted from the newest entry (which has index -1) backwards.
351
352 Examples:
353 List entries 6 to 12 from the search history: >
354 :history / 6,12
355<
356 List the recent five entries from all histories: >
357 :history all -5,
358
359==============================================================================
3602. Command-line completion *cmdline-completion*
361
362When editing the command-line, a few commands can be used to complete the
363word before the cursor. This is available for:
364
365- Command names: At the start of the command-line.
366- Tags: Only after the ":tag" command.
367- File names: Only after a command that accepts a file name or a setting for
368 an option that can be set to a file name. This is called file name
369 completion.
Bram Moolenaara2031822006-03-07 22:29:51 +0000370- Shell command names: After ":!cmd", ":r !cmd" and ":w !cmd". $PATH is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000371- Options: Only after the ":set" command.
372- Mappings: Only after a ":map" or similar command.
373- Variable and function names: Only after a ":if", ":call" or similar command.
374
Bram Moolenaar81af9252010-12-10 20:35:50 +0100375When Vim was compiled without the |+cmdline_compl| feature only file names,
376directories and help items can be completed. The number of help item matches
377is limited (currently to 300) to avoid a long delay when there are very many
378matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000379
380These are the commands that can be used:
381
382 *c_CTRL-D*
383CTRL-D List names that match the pattern in front of the cursor.
384 When showing file names, directories are highlighted (see
385 'highlight' option). Names where 'suffixes' matches are moved
386 to the end.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000387 The 'wildoptions' option can be set to "tagfile" to list the
388 file of matching tags.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000389 *c_CTRL-I* *c_wildchar* *c_<Tab>*
390'wildchar' option
391 A match is done on the pattern in front of the cursor. The
392 match (if there are several, the first match) is inserted
393 in place of the pattern. (Note: does not work inside a
394 macro, because <Tab> or <Esc> are mostly used as 'wildchar',
395 and these have a special meaning in some macros.) When typed
396 again and there were multiple matches, the next
397 match is inserted. After the last match, the first is used
398 again (wrap around).
399 The behavior can be changed with the 'wildmode' option.
400 *c_CTRL-N*
401CTRL-N After using 'wildchar' which got multiple matches, go to next
402 match. Otherwise recall more recent command-line from history.
403<S-Tab> *c_CTRL-P* *c_<S-Tab>*
404CTRL-P After using 'wildchar' which got multiple matches, go to
405 previous match. Otherwise recall older command-line from
406 history. <S-Tab> only works with the GUI, on the Amiga and
407 with MS-DOS.
408 *c_CTRL-A*
409CTRL-A All names that match the pattern in front of the cursor are
410 inserted.
411 *c_CTRL-L*
412CTRL-L A match is done on the pattern in front of the cursor. If
413 there is one match, it is inserted in place of the pattern.
414 If there are multiple matches the longest common part is
415 inserted in place of the pattern. If the result is shorter
416 than the pattern, no completion is done.
Bram Moolenaard3667a22006-03-16 21:35:52 +0000417 When 'incsearch' is set, entering a search pattern for "/" or
418 "?" and the current match is displayed then CTRL-L will add
Bram Moolenaara9dc3752010-07-11 20:46:53 +0200419 one character from the end of the current match. If
420 'ignorecase' and 'smartcase' are set and the command line has
421 no uppercase characters, the added character is converted to
422 lowercase.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000423
424The 'wildchar' option defaults to <Tab> (CTRL-E when in Vi compatible mode; in
425a previous version <Esc> was used). In the pattern standard wildcards '*' and
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +0200426'?' are accepted when matching file names. '*' matches any string, '?'
427matches exactly one character.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000428
Bram Moolenaar5dc62522012-02-13 00:05:22 +0100429The 'wildignorecase' option can be set to ignore case in filenames.
430
Bram Moolenaar071d4272004-06-13 20:20:40 +0000431If you like tcsh's autolist completion, you can use this mapping:
432 :cnoremap X <C-L><C-D>
433(Where X is the command key to use, <C-L> is CTRL-L and <C-D> is CTRL-D)
434This will find the longest match and then list all matching files.
435
436If you like tcsh's autolist completion, you can use the 'wildmode' option to
437emulate it. For example, this mimics autolist=ambiguous:
438 :set wildmode=longest,list
439This will find the longest match with the first 'wildchar', then list all
440matching files with the next.
441
442 *suffixes*
443For file name completion you can use the 'suffixes' option to set a priority
444between files with almost the same name. If there are multiple matches,
445those files with an extension that is in the 'suffixes' option are ignored.
446The default is ".bak,~,.o,.h,.info,.swp,.obj", which means that files ending
447in ".bak", "~", ".o", ".h", ".info", ".swp" and ".obj" are sometimes ignored.
Bram Moolenaar055a2ba2009-07-14 19:40:21 +0000448
449An empty entry, two consecutive commas, match a file name that does not
450contain a ".", thus has no suffix. This is useful to ignore "prog" and prefer
451"prog.c".
452
453Examples:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000454
455 pattern: files: match: ~
456 test* test.c test.h test.o test.c
457 test* test.h test.o test.h and test.o
458 test* test.i test.h test.c test.i and test.c
459
Bram Moolenaar055a2ba2009-07-14 19:40:21 +0000460It is impossible to ignore suffixes with two dots.
461
Bram Moolenaar071d4272004-06-13 20:20:40 +0000462If there is more than one matching file (after ignoring the ones matching
463the 'suffixes' option) the first file name is inserted. You can see that
464there is only one match when you type 'wildchar' twice and the completed
465match stays the same. You can get to the other matches by entering
466'wildchar', CTRL-N or CTRL-P. All files are included, also the ones with
467extensions matching the 'suffixes' option.
468
469To completely ignore files with some extension use 'wildignore'.
470
Bram Moolenaar066b6222008-01-04 14:17:47 +0000471To match only files that end at the end of the typed text append a "$". For
472example, to match only files that end in ".c": >
473 :e *.c$
474This will not match a file ending in ".cpp". Without the "$" it does match.
475
Bram Moolenaar071d4272004-06-13 20:20:40 +0000476The old value of an option can be obtained by hitting 'wildchar' just after
477the '='. For example, typing 'wildchar' after ":set dir=" will insert the
478current value of 'dir'. This overrules file name completion for the options
479that take a file name.
480
481If you would like using <S-Tab> for CTRL-P in an xterm, put this command in
482your .cshrc: >
483 xmodmap -e "keysym Tab = Tab Find"
484And this in your .vimrc: >
485 :cmap <Esc>[1~ <C-P>
486
487==============================================================================
4883. Ex command-lines *cmdline-lines*
489
490The Ex commands have a few specialties:
491
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100492 *:quote* *:comment*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000493'"' at the start of a line causes the whole line to be ignored. '"'
494after a command causes the rest of the line to be ignored. This can be used
495to add comments. Example: >
496 :set ai "set 'autoindent' option
497It is not possible to add a comment to a shell command ":!cmd" or to the
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100498":map" command and a few others, because they see the '"' as part of their
499argument. This is mentioned where the command is explained.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000500
501 *:bar* *:\bar*
502'|' can be used to separate commands, so you can give multiple commands in one
503line. If you want to use '|' in an argument, precede it with '\'.
504
505These commands see the '|' as their argument, and can therefore not be
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000506followed by another Vim command:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000507 :argdo
508 :autocmd
509 :bufdo
510 :command
511 :cscope
512 :debug
513 :folddoopen
514 :folddoclosed
515 :function
516 :global
517 :help
518 :helpfind
Bram Moolenaar110bc6b2006-02-10 23:13:40 +0000519 :lcscope
Bram Moolenaar071d4272004-06-13 20:20:40 +0000520 :make
521 :normal
522 :perl
523 :perldo
524 :promptfind
525 :promptrepl
526 :pyfile
527 :python
528 :registers
529 :read !
530 :scscope
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200531 :sign
Bram Moolenaar071d4272004-06-13 20:20:40 +0000532 :tcl
533 :tcldo
534 :tclfile
535 :vglobal
536 :windo
537 :write !
538 :[range]!
539 a user defined command without the "-bar" argument |:command|
540
541Note that this is confusing (inherited from Vi): With ":g" the '|' is included
542in the command, with ":s" it is not.
543
544To be able to use another command anyway, use the ":execute" command.
545Example (append the output of "ls" and jump to the first line): >
546 :execute 'r !ls' | '[
547
548There is one exception: When the 'b' flag is present in 'cpoptions', with the
549":map" and ":abbr" commands and friends CTRL-V needs to be used instead of
550'\'. You can also use "<Bar>" instead. See also |map_bar|.
551
552Examples: >
553 :!ls | wc view the output of two commands
554 :r !ls | wc insert the same output in the text
555 :%g/foo/p|> moves all matching lines one shiftwidth
556 :%s/foo/bar/|> moves one line one shiftwidth
557 :map q 10^V| map "q" to "10|"
558 :map q 10\| map \ l map "q" to "10\" and map "\" to "l"
559 (when 'b' is present in 'cpoptions')
560
561You can also use <NL> to separate commands in the same way as with '|'. To
562insert a <NL> use CTRL-V CTRL-J. "^@" will be shown. Using '|' is the
563preferred method. But for external commands a <NL> must be used, because a
564'|' is included in the external command. To avoid the special meaning of <NL>
565it must be preceded with a backslash. Example: >
566 :r !date<NL>-join
567This reads the current date into the file and joins it with the previous line.
568
569Note that when the command before the '|' generates an error, the following
570commands will not be executed.
571
572
573Because of Vi compatibility the following strange commands are supported: >
574 :| print current line (like ":p")
575 :3| print line 3 (like ":3p")
576 :3 goto line 3
577
578A colon is allowed between the range and the command name. It is ignored
579(this is Vi compatible). For example: >
580 :1,$:s/pat/string
581
582When the character '%' or '#' is used where a file name is expected, they are
583expanded to the current and alternate file name (see the chapter "editing
584files" |:_%| |:_#|).
585
586Embedded spaces in file names are allowed on the Amiga if one file name is
587expected as argument. Trailing spaces will be ignored, unless escaped with a
588backslash or CTRL-V. Note that the ":next" command uses spaces to separate
589file names. Escape the spaces to include them in a file name. Example: >
590 :next foo\ bar goes\ to school\
591starts editing the three files "foo bar", "goes to" and "school ".
592
593When you want to use the special characters '"' or '|' in a command, or want
594to use '%' or '#' in a file name, precede them with a backslash. The
595backslash is not required in a range and in the ":substitute" command.
596
597 *:_!*
598The '!' (bang) character after an Ex command makes the command behave in a
599different way. The '!' should be placed immediately after the command, without
600any blanks in between. If you insert blanks the '!' will be seen as an
601argument for the command, which has a different meaning. For example:
602 :w! name write the current buffer to file "name", overwriting
603 any existing file
604 :w !name send the current buffer as standard input to command
605 "name"
606
607==============================================================================
Bram Moolenaara5792f52005-11-23 21:25:05 +00006084. Ex command-line ranges *cmdline-ranges* *[range]* *E16*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000609
610Some Ex commands accept a line range in front of them. This is noted as
611[range]. It consists of one or more line specifiers, separated with ',' or
612';'.
613
614The basics are explained in section |10.3| of the user manual.
615
616 *:,* *:;*
617When separated with ';' the cursor position will be set to that line
618before interpreting the next line specifier. This doesn't happen for ','.
619Examples: >
620 4,/this line/
621< from line 4 till match with "this line" after the cursor line. >
622 5;/that line/
623< from line 5 till match with "that line" after line 5.
624
625The default line specifier for most commands is the cursor position, but the
626commands ":write" and ":global" have the whole file (1,$) as default.
627
628If more line specifiers are given than required for the command, the first
629one(s) will be ignored.
630
631Line numbers may be specified with: *:range* *E14* *{address}*
632 {number} an absolute line number
633 . the current line *:.*
634 $ the last line in the file *:$*
635 % equal to 1,$ (the entire file) *:%*
636 't position of mark t (lowercase) *:'*
637 'T position of mark T (uppercase); when the mark is in
638 another file it cannot be used in a range
639 /{pattern}[/] the next line where {pattern} matches *:/*
640 ?{pattern}[?] the previous line where {pattern} matches *:?*
641 \/ the next line where the previously used search
642 pattern matches
643 \? the previous line where the previously used search
644 pattern matches
645 \& the next line where the previously used substitute
646 pattern matches
647
648Each may be followed (several times) by '+' or '-' and an optional number.
649This number is added or subtracted from the preceding line number. If the
650number is omitted, 1 is used.
651
652The "/" and "?" after {pattern} are required to separate the pattern from
653anything that follows.
654
655The "/" and "?" may be preceded with another address. The search starts from
656there. The difference from using ';' is that the cursor isn't moved.
657Examples: >
658 /pat1//pat2/ Find line containing "pat2" after line containing
659 "pat1", without moving the cursor.
660 7;/pat2/ Find line containing "pat2", after line 7, leaving
661 the cursor in line 7.
662
663The {number} must be between 0 and the number of lines in the file. When
664using a 0 (zero) this is interpreted as a 1 by most commands. Commands that
665use it as a count do use it as a zero (|:tag|, |:pop|, etc). Some commands
666interpret the zero as "before the first line" (|:read|, search pattern, etc).
667
668Examples: >
669 .+3 three lines below the cursor
670 /that/+1 the line below the next line containing "that"
671 .,$ from current line until end of file
672 0;/that the first line containing "that", also matches in the
673 first line.
674 1;/that the first line after line 1 containing "that"
675
676Some commands allow for a count after the command. This count is used as the
677number of lines to be used, starting with the line given in the last line
678specifier (the default is the cursor line). The commands that accept a count
679are the ones that use a range but do not have a file name argument (because
680a file name can also be a number).
681
682Examples: >
683 :s/x/X/g 5 substitute 'x' by 'X' in the current line and four
684 following lines
685 :23d 4 delete lines 23, 24, 25 and 26
686
687
688Folds and Range
689
690When folds are active the line numbers are rounded off to include the whole
691closed fold. See |fold-behavior|.
692
693
Bram Moolenaara5792f52005-11-23 21:25:05 +0000694Reverse Range *E493*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695
696A range should have the lower line number first. If this is not the case, Vim
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000697will ask you if it should swap the line numbers.
Bram Moolenaara5792f52005-11-23 21:25:05 +0000698 Backwards range given, OK to swap ~
699This is not done within the global command ":g".
700
701You can use ":silent" before a command to avoid the question, the range will
702always be swapped then.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000703
704
705Count and Range *N:*
706
707When giving a count before entering ":", this is translated into:
708 :.,.+(count - 1)
709In words: The 'count' lines at and after the cursor. Example: To delete
710three lines: >
711 3:d<CR> is translated into: .,.+2d<CR>
712<
713
714Visual Mode and Range *v_:*
715
716{Visual}: Starts a command-line with the Visual selected lines as a
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100717 range. The code `:'<,'>` is used for this range, which makes
Bram Moolenaar071d4272004-06-13 20:20:40 +0000718 it possible to select a similar line from the command-line
719 history for repeating a command on different Visually selected
720 lines.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100721 When Visual mode was already ended, a short way to use the
722 Visual area for a range is `:*`. This requires that "*" does
723 not appear in 'cpo', see |cpo-star|. Otherwise you will have
724 to type `:'<,'>`
725
Bram Moolenaar071d4272004-06-13 20:20:40 +0000726
727==============================================================================
Bram Moolenaardf177f62005-02-22 08:39:57 +00007285. Ex command-line flags *ex-flags*
729
730These flags are supported by a selection of Ex commands. They print the line
731that the cursor ends up after executing the command:
732
733 l output like for |:list|
734 # add line number
735 p output like for |:print|
736
737The flags can be combined, thus "l#" uses both a line number and |:list| style
738output.
739
740==============================================================================
7416. Ex special characters *cmdline-special*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000742
Bram Moolenaar8fa04452005-12-23 22:13:51 +0000743Note: These are special characters in the executed command line. If you want
744to insert special things while typing you can use the CTRL-R command. For
745example, "%" stands for the current file name, while CTRL-R % inserts the
746current file name right away. See |c_CTRL-R|.
747
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000748Note: If you want to avoid the special characters in a Vim script you may want
749to use |fnameescape()|.
750
Bram Moolenaar8fa04452005-12-23 22:13:51 +0000751
Bram Moolenaar071d4272004-06-13 20:20:40 +0000752In Ex commands, at places where a file name can be used, the following
753characters have a special meaning. These can also be used in the expression
754function expand() |expand()|.
Bram Moolenaard812df62008-11-09 12:46:09 +0000755 % Is replaced with the current file name. *:_%* *c_%*
756 # Is replaced with the alternate file name. *:_#* *c_#*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100757 #n (where n is a number) is replaced with *:_#0* *:_#n*
758 the file name of buffer n. "#0" is the same as "#". *c_#n*
Bram Moolenaard812df62008-11-09 12:46:09 +0000759 ## Is replaced with all names in the argument list *:_##* *c_##*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000760 concatenated, separated by spaces. Each space in a name
761 is preceded with a backslash.
Bram Moolenaard812df62008-11-09 12:46:09 +0000762 #<n (where n is a number > 0) is replaced with old *:_#<* *c_#<*
763 file name n. See |:oldfiles| or |v:oldfiles| to get the
764 number. *E809*
Bram Moolenaardb84e452010-08-15 13:50:43 +0200765 {only when compiled with the |+eval| and |+viminfo| features}
Bram Moolenaard812df62008-11-09 12:46:09 +0000766
767Note that these, except "#<n", give the file name as it was typed. If an
768absolute path is needed (when using the file name from a different directory),
769you need to add ":p". See |filename-modifiers|.
770
771The "#<n" item returns an absolute path, but it will start with "~/" for files
772below your home directory.
773
Bram Moolenaar071d4272004-06-13 20:20:40 +0000774Note that backslashes are inserted before spaces, so that the command will
775correctly interpret the file name. But this doesn't happen for shell
Bram Moolenaard812df62008-11-09 12:46:09 +0000776commands. For those you probably have to use quotes (this fails for files
777that contain a quote and wildcards): >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000778 :!ls "%"
779 :r !spell "%"
780
781To avoid the special meaning of '%' and '#' insert a backslash before it.
782Detail: The special meaning is always escaped when there is a backslash before
783it, no matter how many backslashes.
784 you type: result ~
785 # alternate.file
786 \# #
787 \\# \#
788
789 *:<cword>* *:<cWORD>* *:<cfile>* *<cfile>*
790 *:<sfile>* *<sfile>* *:<afile>* *<afile>*
791 *:<abuf>* *<abuf>* *:<amatch>* *<amatch>*
Bram Moolenaar00654022011-02-25 14:42:19 +0100792 *<slnum>* *E495* *E496* *E497* *E499* *E500*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000793Note: these are typed literally, they are not special keys!
794 <cword> is replaced with the word under the cursor (like |star|)
795 <cWORD> is replaced with the WORD under the cursor (see |WORD|)
796 <cfile> is replaced with the path name under the cursor (like what
797 |gf| uses)
Bram Moolenaar81af9252010-12-10 20:35:50 +0100798 <afile> When executing autocommands, is replaced with the file name
799 for a file read or write.
800 <abuf> When executing autocommands, is replaced with the currently
Bram Moolenaara2031822006-03-07 22:29:51 +0000801 effective buffer number (for ":r file" and ":so file" it is
802 the current buffer, the file being read/sourced is not in a
803 buffer).
Bram Moolenaar81af9252010-12-10 20:35:50 +0100804 <amatch> When executing autocommands, is replaced with the match for
Bram Moolenaar53180ce2005-07-05 21:48:14 +0000805 which this autocommand was executed. It differs from
Bram Moolenaar071d4272004-06-13 20:20:40 +0000806 <afile> only when the file name isn't used to match with
Bram Moolenaarb8a7b562006-02-01 21:47:16 +0000807 (for FileType, Syntax and SpellFileMissing events).
Bram Moolenaar81af9252010-12-10 20:35:50 +0100808 <sfile> When executing a ":source" command, is replaced with the
809 file name of the sourced file. *E498*
810 When executing a function, is replaced with
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811 "function {function-name}"; function call nesting is
812 indicated like this:
813 "function {function-name1}..{function-name2}". Note that
814 filename-modifiers are useless when <sfile> is used inside
815 a function.
Bram Moolenaar81af9252010-12-10 20:35:50 +0100816 <slnum> When executing a ":source" command, is replaced with the
817 line number. *E842*
818 When executing a function it's the line number relative to
819 the start of the function.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000820
821 *filename-modifiers*
822 *:_%:* *::8* *::p* *::.* *::~* *::h* *::t* *::r* *::e* *::s* *::gs*
Bram Moolenaar55debbe2010-05-23 23:34:36 +0200823 *%:8* *%:p* *%:.* *%:~* *%:h* *%:t* *%:r* *%:e* *%:s* *%:gs*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000824The file name modifiers can be used after "%", "#", "#n", "<cfile>", "<sfile>",
825"<afile>" or "<abuf>". They are also used with the |fnamemodify()| function.
826These are not available when Vim has been compiled without the |+modify_fname|
827feature.
828These modifiers can be given, in this order:
829 :p Make file name a full path. Must be the first modifier. Also
830 changes "~/" (and "~user/" for Unix and VMS) to the path for
831 the home directory. If the name is a directory a path
832 separator is added at the end. For a file name that does not
833 exist and does not have an absolute path the result is
Bram Moolenaar30b65812012-07-12 22:01:11 +0200834 unpredictable. On MS-Windows an 8.3 filename is expanded to
835 the long name.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000836 :8 Converts the path to 8.3 short format (currently only on
Bram Moolenaar30b65812012-07-12 22:01:11 +0200837 MS-Windows). Will act on as much of a path that is an
838 existing path.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000839 :~ Reduce file name to be relative to the home directory, if
840 possible. File name is unmodified if it is not below the home
841 directory.
842 :. Reduce file name to be relative to current directory, if
843 possible. File name is unmodified if it is not below the
844 current directory.
845 For maximum shortness, use ":~:.".
846 :h Head of the file name (the last component and any separators
847 removed). Cannot be used with :e, :r or :t.
848 Can be repeated to remove several components at the end.
849 When the file name ends in a path separator, only the path
850 separator is removed. Thus ":p:h" on a directory name results
851 on the directory name itself (without trailing slash).
852 When the file name is an absolute path (starts with "/" for
853 Unix; "x:\" for MS-DOS, WIN32, OS/2; "drive:" for Amiga), that
854 part is not removed. When there is no head (path is relative
855 to current directory) the result is empty.
856 :t Tail of the file name (last component of the name). Must
857 precede any :r or :e.
858 :r Root of the file name (the last extension removed). When
859 there is only an extension (file name that starts with '.',
860 e.g., ".vimrc"), it is not removed. Can be repeated to remove
861 several extensions (last one first).
862 :e Extension of the file name. Only makes sense when used alone.
863 When there is no extension the result is empty.
864 When there is only an extension (file name that starts with
865 '.'), the result is empty. Can be repeated to include more
866 extensions. If there are not enough extensions (but at least
867 one) as much as possible are included.
868 :s?pat?sub?
869 Substitute the first occurrence of "pat" with "sub". This
870 works like the |:s| command. "pat" is a regular expression.
871 Any character can be used for '?', but it must not occur in
872 "pat" or "sub".
873 After this, the previous modifiers can be used again. For
874 example ":p", to make a full path after the substitution.
875 :gs?pat?sub?
Bram Moolenaaradc21822011-04-01 18:03:16 +0200876 Substitute all occurrences of "pat" with "sub". Otherwise
Bram Moolenaar071d4272004-06-13 20:20:40 +0000877 this works like ":s".
878
879Examples, when the file name is "src/version.c", current dir
880"/home/mool/vim": >
881 :p /home/mool/vim/src/version.c
882 :p:. src/version.c
883 :p:~ ~/vim/src/version.c
884 :h src
885 :p:h /home/mool/vim/src
886 :p:h:h /home/mool/vim
887 :t version.c
888 :p:t version.c
889 :r src/version
890 :p:r /home/mool/vim/src/version
891 :t:r version
892 :e c
893 :s?version?main? src/main.c
894 :s?version?main?:p /home/mool/vim/src/main.c
895 :p:gs?/?\\? \home\mool\vim\src\version.c
896
897Examples, when the file name is "src/version.c.gz": >
898 :p /home/mool/vim/src/version.c.gz
899 :e gz
900 :e:e c.gz
901 :e:e:e c.gz
902 :e:e:r c
903 :r src/version.c
904 :r:e c
905 :r:r src/version
906 :r:r:r src/version
907<
908 *extension-removal* *:_%<*
909If a "<" is appended to "%", "#", "#n" or "CTRL-V p" the extension of the file
910name is removed (everything after and including the last '.' in the file
911name). This is included for backwards compatibility with version 3.0, the
912":r" form is preferred. Examples: >
913
914 % current file name
915 %< current file name without extension
916 # alternate file name for current window
917 #< idem, without extension
918 #31 alternate file number 31
919 #31< idem, without extension
920 <cword> word under the cursor
921 <cWORD> WORD under the cursor (see |WORD|)
922 <cfile> path name under the cursor
923 <cfile>< idem, without extension
924
925Note: Where a file name is expected wildcards expansion is done. On Unix the
926shell is used for this, unless it can be done internally (for speed).
927Backticks also work, like in >
928 :n `echo *.c`
929(backtick expansion is not possible in |restricted-mode|)
930But expansion is only done if there are any wildcards before expanding the
931'%', '#', etc.. This avoids expanding wildcards inside a file name. If you
932want to expand the result of <cfile>, add a wildcard character to it.
933Examples: (alternate file name is "?readme?")
934 command expands to ~
935 :e # :e ?readme?
936 :e `ls #` :e {files matching "?readme?"}
937 :e #.* :e {files matching "?readme?.*"}
938 :cd <cfile> :cd {file name under cursor}
939 :cd <cfile>* :cd {file name under cursor plus "*" and then expanded}
940
941When the expanded argument contains a "!" and it is used for a shell command
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000942(":!cmd", ":r !cmd" or ":w !cmd"), the "!" is escaped with a backslash to
943avoid it being expanded into a previously used command. When the 'shell'
944option contains "sh", this is done twice, to avoid the shell trying to expand
945the "!".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000946
947 *filename-backslash*
948For filesystems that use a backslash as directory separator (MS-DOS, Windows,
949OS/2), it's a bit difficult to recognize a backslash that is used to escape
950the special meaning of the next character. The general rule is: If the
951backslash is followed by a normal file name character, it does not have a
952special meaning. Therefore "\file\foo" is a valid file name, you don't have
953to type the backslash twice.
954
955An exception is the '$' sign. It is a valid character in a file name. But
956to avoid a file name like "$home" to be interpreted as an environment variable,
957it needs to be preceded by a backslash. Therefore you need to use "/\$home"
958for the file "$home" in the root directory. A few examples:
959
960 FILE NAME INTERPRETED AS ~
961 $home expanded to value of environment var $home
962 \$home file "$home" in current directory
963 /\$home file "$home" in root directory
964 \\$home file "\\", followed by expanded $home
965
966==============================================================================
Bram Moolenaarac7bd632013-03-19 11:35:58 +01009677. Command-line window *cmdline-window* *cmdwin*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100968 *command-line-window*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000969In the command-line window the command line can be edited just like editing
970text in any window. It is a special kind of window, because you cannot leave
971it in a normal way.
972{not available when compiled without the |+cmdline_hist| or |+vertsplit|
973feature}
974
975
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100976OPEN *c_CTRL-F* *q:* *q/* *q?*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000977
978There are two ways to open the command-line window:
9791. From Command-line mode, use the key specified with the 'cedit' option.
980 The default is CTRL-F when 'compatible' is not set.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009812. From Normal mode, use the "q:", "q/" or "q?" command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000982 This starts editing an Ex command-line ("q:") or search string ("q/" or
983 "q?"). Note that this is not possible while recording is in progress (the
984 "q" stops recording then).
985
986When the window opens it is filled with the command-line history. The last
987line contains the command as typed so far. The left column will show a
988character that indicates the type of command-line being edited, see
989|cmdwin-char|.
990
991Vim will be in Normal mode when the editor is opened, except when 'insertmode'
992is set.
993
994The height of the window is specified with 'cmdwinheight' (or smaller if there
995is no room). The window is always full width and is positioned just above the
996command-line.
997
998
999EDIT
1000
1001You can now use commands to move around and edit the text in the window. Both
1002in Normal mode and Insert mode.
1003
1004It is possible to use ":", "/" and other commands that use the command-line,
1005but it's not possible to open another command-line window then. There is no
1006nesting.
1007 *E11*
1008The command-line window is not a normal window. It is not possible to move to
1009another window or edit another buffer. All commands that would do this are
1010disabled in the command-line window. Of course it _is_ possible to execute
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001011any command that you entered in the command-line window. Other text edits are
1012discarded when closing the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001013
1014
1015CLOSE *E199*
1016
1017There are several ways to leave the command-line window:
1018
1019<CR> Execute the command-line under the cursor. Works both in
1020 Insert and in Normal mode.
1021CTRL-C Continue in Command-line mode. The command-line under the
1022 cursor is used as the command-line. Works both in Insert and
1023 in Normal mode. ":close" also works. There is no redraw,
1024 thus the window will remain visible.
1025:quit Discard the command line and go back to Normal mode.
1026 ":exit", ":xit" and CTRL-\ CTRL-N also work.
1027:qall Quit Vim, unless there are changes in some buffer.
1028:qall! Quit Vim, discarding changes to any buffer.
1029
1030Once the command-line window is closed the old window sizes are restored. The
1031executed command applies to the window and buffer where the command-line was
1032started from. This works as if the command-line window was not there, except
1033that there will be an extra screen redraw.
1034The buffer used for the command-line window is deleted. Any changes to lines
1035other than the one that is executed with <CR> are lost.
1036
Bram Moolenaar36fc5352006-03-04 21:49:37 +00001037If you would like to execute the command under the cursor and then have the
1038command-line window open again, you may find this mapping useful: >
1039
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001040 :autocmd CmdwinEnter * map <buffer> <F5> <CR>q:
Bram Moolenaar36fc5352006-03-04 21:49:37 +00001041
Bram Moolenaar071d4272004-06-13 20:20:40 +00001042
1043VARIOUS
1044
1045The command-line window cannot be used:
1046- when there already is a command-line window (no nesting)
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001047- for entering an encryption key or when using inputsecret()
Bram Moolenaardb84e452010-08-15 13:50:43 +02001048- when Vim was not compiled with the |+vertsplit| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001049
1050Some options are set when the command-line window is opened:
1051'filetype' "vim", when editing an Ex command-line; this starts Vim syntax
1052 highlighting if it was enabled
1053'rightleft' off
1054'modifiable' on
1055'buftype' "nofile"
1056'swapfile' off
1057
1058It is allowed to write the buffer contents to a file. This is an easy way to
1059save the command-line history and read it back later.
1060
1061If the 'wildchar' option is set to <Tab>, and the command-line window is used
1062for an Ex command, then two mappings will be added to use <Tab> for completion
1063in the command-line window, like this: >
1064 :imap <buffer> <Tab> <C-X><C-V>
1065 :nmap <buffer> <Tab> a<C-X><C-V>
1066Note that hitting <Tab> in Normal mode will do completion on the next
1067character. That way it works at the end of the line.
1068If you don't want these mappings, disable them with: >
1069 au CmdwinEnter [:>] iunmap <Tab>
1070 au CmdwinEnter [:>] nunmap <Tab>
1071You could put these lines in your vimrc file.
1072
1073While in the command-line window you cannot use the mouse to put the cursor in
1074another window, or drag statuslines of other windows. You can drag the
1075statusline of the command-line window itself and the statusline above it.
1076Thus you can resize the command-line window, but not others.
1077
1078
1079AUTOCOMMANDS
1080
1081Two autocommand events are used: |CmdwinEnter| and |CmdwinLeave|. Since this
1082window is of a special type, the WinEnter, WinLeave, BufEnter and BufLeave
1083events are not triggered. You can use the Cmdwin events to do settings
1084specifically for the command-line window. Be careful not to cause side
1085effects!
1086Example: >
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001087 :au CmdwinEnter : let b:cpt_save = &cpt | set cpt=.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001088 :au CmdwinLeave : let &cpt = b:cpt_save
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001089This sets 'complete' to use completion in the current window for |i_CTRL-N|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001090Another example: >
1091 :au CmdwinEnter [/?] startinsert
1092This will make Vim start in Insert mode in the command-line window.
1093
1094 *cmdwin-char*
1095The character used for the pattern indicates the type of command-line:
1096 : normal Ex command
1097 > debug mode command |debug-mode|
1098 / forward search string
1099 ? backward search string
1100 = expression for "= |expr-register|
1101 @ string for |input()|
1102 - text for |:insert| or |:append|
1103
1104 vim:tw=78:ts=8:ft=help:norl: