1 *cmdline.txt* For Vim version 7.2. Last change: 2009 Oct 25
4 VIM REFERENCE MANUAL by Bram Moolenaar
7 *Cmdline-mode* *Command-line-mode*
8 Command-line mode *Cmdline* *Command-line* *mode-cmdline* *:*
10 Command-line mode is used to enter Ex commands (":"), search patterns
11 ("/" and "?"), and filter commands ("!").
13 Basic command line editing is explained in chapter 20 of the user manual
16 1. Command-line editing |cmdline-editing|
17 2. Command-line completion |cmdline-completion|
18 3. Ex command-lines |cmdline-lines|
19 4. Ex command-line ranges |cmdline-ranges|
20 5. Ex command-line flags |ex-flags|
21 6. Ex special characters |cmdline-special|
22 7. Command-line window |cmdline-window|
24 ==============================================================================
25 1. Command-line editing *cmdline-editing*
27 Normally characters are inserted in front of the cursor position. You can
28 move 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}
32 Note that if your keyboard does not have working cursor keys or any of the
33 other special keys, you can use ":cnoremap" to define another key for them.
34 For 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)
43 When the command line is getting longer than what fits on the screen, only the
44 part that fits will be shown. The cursor can only move in this visible part,
45 thus you cannot edit beyond that.
47 *cmdline-history* *history*
48 The command-lines that you enter are remembered in a history table. You can
49 recall them with the up and down cursor keys. There are actually five
51 - one for ':' commands
52 - one for search strings
54 - one for input lines, typed for the |input()| function.
55 - one for debug mode commands
56 These are completely separate. Each history can only be accessed when
57 entering the same type of line.
58 Use the 'history' option to set the number of lines that are remembered
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
64 - Only commands that are typed are remembered. Ones that completely come from
65 mappings are not put in the history.
66 - 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).
70 {not available when compiled without the |+cmdline_hist| feature}
72 There is an automatic completion of names on the command-line; see
76 CTRL-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.
83 CTRL-Q Same as CTRL-V. But with some terminals it is used for
84 control flow, it doesn't work then.
91 <S-Left> or <C-Left> *c_<C-Left>*
94 <S-Right> or <C-Right> *c_<C-Right>*
96 CTRL-B or <Home> *c_CTRL-B* *c_<Home>*
97 cursor to beginning of command-line
98 CTRL-E or <End> *c_CTRL-E* *c_<End>*
99 cursor to end of command-line
102 <LeftMouse> Move the cursor to the position of the mouse click.
104 CTRL-H *c_<BS>* *c_CTRL-H*
105 <BS> Delete the character in front of the cursor (see |:fixdel| if
106 your <BS> key does not do what you want).
108 <Del> Delete the character under the cursor (at end of line:
109 character before the cursor) (see |:fixdel| if your <Del>
110 key does not do what you want).
112 CTRL-W Delete the |word| before the cursor. This depends on the
115 CTRL-U Remove all characters between the cursor position and
116 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>
122 <Insert> Toggle between insert and overstrike. {not in Vi}
124 {char1} <BS> {char2} or *c_digraph*
125 CTRL-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}
129 CTRL-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
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.
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
153 '=' the expression register: you are prompted to
154 enter an expression (see |expression|)
155 (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)
158 When the result is a |List| the items are used
159 as lines. They can have line breaks inside
161 When the result is a Float it's automatically
162 converted to a String.
163 See |registers| about registers. {not in Vi}
164 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
169 CTRL-R CTRL-F *c_CTRL-R_CTRL-F* *c_<C-R>_<C-F>*
170 CTRL-R CTRL-P *c_CTRL-R_CTRL-P* *c_<C-R>_<C-P>*
171 CTRL-R CTRL-W *c_CTRL-R_CTRL-W* *c_<C-R>_<C-W>*
172 CTRL-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
177 CTRL-W the Word under the cursor
178 CTRL-A the WORD under the cursor; see |WORD|
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.
185 CTRL-F and CTRL-P: {only when +file_in_path feature is
188 *c_CTRL-R_CTRL-R* *c_<C-R>_<C-R>*
189 *c_CTRL-R_CTRL-O* *c_<C-R>_<C-O>*
190 CTRL-R CTRL-R {0-9a-z"%#:-=. CTRL-F CTRL-P CTRL-W CTRL-A}
191 CTRL-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
198 CTRL-\ 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
203 See |c_CTRL-R_=| for inserting the result of an expression.
204 Useful functions are |getcmdtype()|, |getcmdline()| and
206 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.
209 The |sandbox| is used for evaluating the expression to avoid
212 :cmap <F7> <C-\>eAppendSome()<CR>
214 :let cmd = getcmdline() . " Some()"
215 :" place the cursor on the )
216 :call setcmdpos(strlen(cmd))
219 < This doesn't work recursively, thus not when already editing
223 CTRL-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.
227 CTRL-J *c_CTRL-J* *c_<NL>* *c_<CR>*
228 <CR> or <NL> start entered command
230 <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.
233 Note: If your <Esc> key is hard to hit on your keyboard, train
234 yourself to use CTRL-[.
236 CTRL-C quit command-line without executing
239 <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|
244 <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|
249 *c_<S-Up>* *c_<PageUp>*
251 recall older command-line from history
252 {not available when compiled without the |+cmdline_hist|
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|
260 CTRL-D command-line completion (see |cmdline-completion|)
262 command-line completion (see |cmdline-completion|)
263 CTRL-N command-line completion (see |cmdline-completion|)
264 CTRL-P command-line completion (see |cmdline-completion|)
265 CTRL-A command-line completion (see |cmdline-completion|)
266 CTRL-L command-line completion (see |cmdline-completion|)
269 CTRL-_ 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.
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.
286 CTRL-^ Toggle the use of language |:lmap| mappings and/or Input
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
291 When language mappings are defined:
292 - If VAL is 1 (langmap mappings used) it becomes 0 (no langmap
294 - If VAL was not 1 it becomes 1, thus langmap mappings are
296 When no language mappings are defined:
297 - If VAL is 2 (Input Method is used) it becomes 0 (no input
299 - If VAL has another value it becomes 2, thus the Input Method
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.
311 CTRL-] Trigger abbreviation, without inserting a character. {not in
314 For Emacs-style editing on the command-line see |emacs-keys|.
316 The <Up> and <Down> keys take the current command-line as a search string.
317 The beginning of the next/previous command-lines are compared with this
318 string. The first line that matches is the new command-line. When typing
319 these two keys repeatedly, the same string is used again. For example, this
320 can be used to find the previous substitute command: Type ":s" and then <Up>.
321 The same could be done by typing <S-Up> a number of times until the desired
322 command-line is shown. (Note: the shifted arrow keys do not work on all
326 :his[tory] Print the history of last entered commands.
328 {not available when compiled without the |+cmdline_hist|
331 :his[tory] [{name}] [{first}][, [{last}]]
332 List the contents of history {name} which can be:
333 c[md] or : command-line history
334 s[earch] 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
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:
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.
349 A negative number means the relative position of an entry,
350 counted from the newest entry (which has index -1) backwards.
353 List entries 6 to 12 from the search history: >
356 List the recent five entries from all histories: >
359 ==============================================================================
360 2. Command-line completion *cmdline-completion*
362 When editing the command-line, a few commands can be used to complete the
363 word before the cursor. This is available for:
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
370 - Shell command names: After ":!cmd", ":r !cmd" and ":w !cmd". $PATH is used.
371 - 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.
375 When Vim was compiled with the |+cmdline_compl| feature disabled, only file
376 names, directories and help items can be completed. The number of help item
377 matches is limited (currently to 300) to avoid a long delay when there are
380 These are the commands that can be used:
383 CTRL-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
387 The 'wildoptions' option can be set to "tagfile" to list the
388 file of matching tags.
389 *c_CTRL-I* *c_wildchar* *c_<Tab>*
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
399 The behavior can be changed with the 'wildmode' option.
401 CTRL-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>*
404 CTRL-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
409 CTRL-A All names that match the pattern in front of the cursor are
412 CTRL-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.
417 When 'incsearch' is set, entering a search pattern for "/" or
418 "?" and the current match is displayed then CTRL-L will add
419 one character from the end of the current match.
421 The 'wildchar' option defaults to <Tab> (CTRL-E when in Vi compatible mode; in
422 a previous version <Esc> was used). In the pattern standard wildcards '*' and
423 '?' are accepted. '*' matches any string, '?' matches exactly one character.
425 If you like tcsh's autolist completion, you can use this mapping:
426 :cnoremap X <C-L><C-D>
427 (Where X is the command key to use, <C-L> is CTRL-L and <C-D> is CTRL-D)
428 This will find the longest match and then list all matching files.
430 If you like tcsh's autolist completion, you can use the 'wildmode' option to
431 emulate it. For example, this mimics autolist=ambiguous:
432 :set wildmode=longest,list
433 This will find the longest match with the first 'wildchar', then list all
434 matching files with the next.
437 For file name completion you can use the 'suffixes' option to set a priority
438 between files with almost the same name. If there are multiple matches,
439 those files with an extension that is in the 'suffixes' option are ignored.
440 The default is ".bak,~,.o,.h,.info,.swp,.obj", which means that files ending
441 in ".bak", "~", ".o", ".h", ".info", ".swp" and ".obj" are sometimes ignored.
443 An empty entry, two consecutive commas, match a file name that does not
444 contain a ".", thus has no suffix. This is useful to ignore "prog" and prefer
449 pattern: files: match: ~
450 test* test.c test.h test.o test.c
451 test* test.h test.o test.h and test.o
452 test* test.i test.h test.c test.i and test.c
454 It is impossible to ignore suffixes with two dots.
456 If there is more than one matching file (after ignoring the ones matching
457 the 'suffixes' option) the first file name is inserted. You can see that
458 there is only one match when you type 'wildchar' twice and the completed
459 match stays the same. You can get to the other matches by entering
460 'wildchar', CTRL-N or CTRL-P. All files are included, also the ones with
461 extensions matching the 'suffixes' option.
463 To completely ignore files with some extension use 'wildignore'.
465 To match only files that end at the end of the typed text append a "$". For
466 example, to match only files that end in ".c": >
468 This will not match a file ending in ".cpp". Without the "$" it does match.
470 The old value of an option can be obtained by hitting 'wildchar' just after
471 the '='. For example, typing 'wildchar' after ":set dir=" will insert the
472 current value of 'dir'. This overrules file name completion for the options
473 that take a file name.
475 If you would like using <S-Tab> for CTRL-P in an xterm, put this command in
477 xmodmap -e "keysym Tab = Tab Find"
478 And this in your .vimrc: >
481 ==============================================================================
482 3. Ex command-lines *cmdline-lines*
484 The Ex commands have a few specialties:
487 '"' at the start of a line causes the whole line to be ignored. '"'
488 after a command causes the rest of the line to be ignored. This can be used
489 to add comments. Example: >
490 :set ai "set 'autoindent' option
491 It is not possible to add a comment to a shell command ":!cmd" or to the
492 ":map" command and a few others, because they see the '"' as part of their
493 argument. This is mentioned where the command is explained.
496 '|' can be used to separate commands, so you can give multiple commands in one
497 line. If you want to use '|' in an argument, precede it with '\'.
499 These commands see the '|' as their argument, and can therefore not be
500 followed by another Vim command:
532 a user defined command without the "-bar" argument |:command|
534 Note that this is confusing (inherited from Vi): With ":g" the '|' is included
535 in the command, with ":s" it is not.
537 To be able to use another command anyway, use the ":execute" command.
538 Example (append the output of "ls" and jump to the first line): >
539 :execute 'r !ls' | '[
541 There is one exception: When the 'b' flag is present in 'cpoptions', with the
542 ":map" and ":abbr" commands and friends CTRL-V needs to be used instead of
543 '\'. You can also use "<Bar>" instead. See also |map_bar|.
546 :!ls | wc view the output of two commands
547 :r !ls | wc insert the same output in the text
548 :%g/foo/p|> moves all matching lines one shiftwidth
549 :%s/foo/bar/|> moves one line one shiftwidth
550 :map q 10^V| map "q" to "10|"
551 :map q 10\| map \ l map "q" to "10\" and map "\" to "l"
552 (when 'b' is present in 'cpoptions')
554 You can also use <NL> to separate commands in the same way as with '|'. To
555 insert a <NL> use CTRL-V CTRL-J. "^@" will be shown. Using '|' is the
556 preferred method. But for external commands a <NL> must be used, because a
557 '|' is included in the external command. To avoid the special meaning of <NL>
558 it must be preceded with a backslash. Example: >
560 This reads the current date into the file and joins it with the previous line.
562 Note that when the command before the '|' generates an error, the following
563 commands will not be executed.
566 Because of Vi compatibility the following strange commands are supported: >
567 :| print current line (like ":p")
568 :3| print line 3 (like ":3p")
571 A colon is allowed between the range and the command name. It is ignored
572 (this is Vi compatible). For example: >
575 When the character '%' or '#' is used where a file name is expected, they are
576 expanded to the current and alternate file name (see the chapter "editing
579 Embedded spaces in file names are allowed on the Amiga if one file name is
580 expected as argument. Trailing spaces will be ignored, unless escaped with a
581 backslash or CTRL-V. Note that the ":next" command uses spaces to separate
582 file names. Escape the spaces to include them in a file name. Example: >
583 :next foo\ bar goes\ to school\
584 starts editing the three files "foo bar", "goes to" and "school ".
586 When you want to use the special characters '"' or '|' in a command, or want
587 to use '%' or '#' in a file name, precede them with a backslash. The
588 backslash is not required in a range and in the ":substitute" command.
591 The '!' (bang) character after an Ex command makes the command behave in a
592 different way. The '!' should be placed immediately after the command, without
593 any blanks in between. If you insert blanks the '!' will be seen as an
594 argument for the command, which has a different meaning. For example:
595 :w! name write the current buffer to file "name", overwriting
597 :w !name send the current buffer as standard input to command
600 ==============================================================================
601 4. Ex command-line ranges *cmdline-ranges* *[range]* *E16*
603 Some Ex commands accept a line range in front of them. This is noted as
604 [range]. It consists of one or more line specifiers, separated with ',' or
607 The basics are explained in section |10.3| of the user manual.
610 When separated with ';' the cursor position will be set to that line
611 before interpreting the next line specifier. This doesn't happen for ','.
614 < from line 4 till match with "this line" after the cursor line. >
616 < from line 5 till match with "that line" after line 5.
618 The default line specifier for most commands is the cursor position, but the
619 commands ":write" and ":global" have the whole file (1,$) as default.
621 If more line specifiers are given than required for the command, the first
622 one(s) will be ignored.
624 Line numbers may be specified with: *:range* *E14* *{address}*
625 {number} an absolute line number
626 . the current line *:.*
627 $ the last line in the file *:$*
628 % equal to 1,$ (the entire file) *:%*
629 't position of mark t (lowercase) *:'*
630 'T position of mark T (uppercase); when the mark is in
631 another file it cannot be used in a range
632 /{pattern}[/] the next line where {pattern} matches *:/*
633 ?{pattern}[?] the previous line where {pattern} matches *:?*
634 \/ the next line where the previously used search
636 \? the previous line where the previously used search
638 \& the next line where the previously used substitute
641 Each may be followed (several times) by '+' or '-' and an optional number.
642 This number is added or subtracted from the preceding line number. If the
643 number is omitted, 1 is used.
645 The "/" and "?" after {pattern} are required to separate the pattern from
646 anything that follows.
648 The "/" and "?" may be preceded with another address. The search starts from
649 there. The difference from using ';' is that the cursor isn't moved.
651 /pat1//pat2/ Find line containing "pat2" after line containing
652 "pat1", without moving the cursor.
653 7;/pat2/ Find line containing "pat2", after line 7, leaving
654 the cursor in line 7.
656 The {number} must be between 0 and the number of lines in the file. When
657 using a 0 (zero) this is interpreted as a 1 by most commands. Commands that
658 use it as a count do use it as a zero (|:tag|, |:pop|, etc). Some commands
659 interpret the zero as "before the first line" (|:read|, search pattern, etc).
662 .+3 three lines below the cursor
663 /that/+1 the line below the next line containing "that"
664 .,$ from current line until end of file
665 0;/that the first line containing "that", also matches in the
667 1;/that the first line after line 1 containing "that"
669 Some commands allow for a count after the command. This count is used as the
670 number of lines to be used, starting with the line given in the last line
671 specifier (the default is the cursor line). The commands that accept a count
672 are the ones that use a range but do not have a file name argument (because
673 a file name can also be a number).
676 :s/x/X/g 5 substitute 'x' by 'X' in the current line and four
678 :23d 4 delete lines 23, 24, 25 and 26
683 When folds are active the line numbers are rounded off to include the whole
684 closed fold. See |fold-behavior|.
689 A range should have the lower line number first. If this is not the case, Vim
690 will ask you if it should swap the line numbers.
691 Backwards range given, OK to swap ~
692 This is not done within the global command ":g".
694 You can use ":silent" before a command to avoid the question, the range will
695 always be swapped then.
700 When giving a count before entering ":", this is translated into:
702 In words: The 'count' lines at and after the cursor. Example: To delete
704 3:d<CR> is translated into: .,.+2d<CR>
707 Visual Mode and Range *v_:*
709 {Visual}: Starts a command-line with the Visual selected lines as a
710 range. The code ":'<,'>" is used for this range, which makes
711 it possible to select a similar line from the command-line
712 history for repeating a command on different Visually selected
715 ==============================================================================
716 5. Ex command-line flags *ex-flags*
718 These flags are supported by a selection of Ex commands. They print the line
719 that the cursor ends up after executing the command:
721 l output like for |:list|
723 p output like for |:print|
725 The flags can be combined, thus "l#" uses both a line number and |:list| style
728 ==============================================================================
729 6. Ex special characters *cmdline-special*
731 Note: These are special characters in the executed command line. If you want
732 to insert special things while typing you can use the CTRL-R command. For
733 example, "%" stands for the current file name, while CTRL-R % inserts the
734 current file name right away. See |c_CTRL-R|.
736 Note: If you want to avoid the special characters in a Vim script you may want
737 to use |fnameescape()|.
740 In Ex commands, at places where a file name can be used, the following
741 characters have a special meaning. These can also be used in the expression
742 function expand() |expand()|.
743 % Is replaced with the current file name. *:_%* *c_%*
744 # Is replaced with the alternate file name. *:_#* *c_#*
745 #n (where n is a number) is replaced with *:_#0* *:_#n*
746 the file name of buffer n. "#0" is the same as "#". *c_#n*
747 ## Is replaced with all names in the argument list *:_##* *c_##*
748 concatenated, separated by spaces. Each space in a name
749 is preceded with a backslash.
750 #<n (where n is a number > 0) is replaced with old *:_#<* *c_#<*
751 file name n. See |:oldfiles| or |v:oldfiles| to get the
753 {only when compiled with the +eval and +viminfo features}
755 Note that these, except "#<n", give the file name as it was typed. If an
756 absolute path is needed (when using the file name from a different directory),
757 you need to add ":p". See |filename-modifiers|.
759 The "#<n" item returns an absolute path, but it will start with "~/" for files
760 below your home directory.
762 Note that backslashes are inserted before spaces, so that the command will
763 correctly interpret the file name. But this doesn't happen for shell
764 commands. For those you probably have to use quotes (this fails for files
765 that contain a quote and wildcards): >
769 To avoid the special meaning of '%' and '#' insert a backslash before it.
770 Detail: The special meaning is always escaped when there is a backslash before
771 it, no matter how many backslashes.
777 *:<cword>* *:<cWORD>* *:<cfile>* *<cfile>*
778 *:<sfile>* *<sfile>* *:<afile>* *<afile>*
779 *:<abuf>* *<abuf>* *:<amatch>* *<amatch>*
780 *E495* *E496* *E497* *E498* *E499* *E500*
781 Note: these are typed literally, they are not special keys!
782 <cword> is replaced with the word under the cursor (like |star|)
783 <cWORD> is replaced with the WORD under the cursor (see |WORD|)
784 <cfile> is replaced with the path name under the cursor (like what
786 <afile> when executing autocommands, is replaced with the file name
787 for a file read or write
788 <abuf> when executing autocommands, is replaced with the currently
789 effective buffer number (for ":r file" and ":so file" it is
790 the current buffer, the file being read/sourced is not in a
792 <amatch> when executing autocommands, is replaced with the match for
793 which this autocommand was executed. It differs from
794 <afile> only when the file name isn't used to match with
795 (for FileType, Syntax and SpellFileMissing events).
796 <sfile> when executing a ":source" command, is replaced with the
797 file name of the sourced file;
798 when executing a function, is replaced with
799 "function {function-name}"; function call nesting is
801 "function {function-name1}..{function-name2}". Note that
802 filename-modifiers are useless when <sfile> is used inside
806 *:_%:* *::8* *::p* *::.* *::~* *::h* *::t* *::r* *::e* *::s* *::gs*
807 The file name modifiers can be used after "%", "#", "#n", "<cfile>", "<sfile>",
808 "<afile>" or "<abuf>". They are also used with the |fnamemodify()| function.
809 These are not available when Vim has been compiled without the |+modify_fname|
811 These modifiers can be given, in this order:
812 :p Make file name a full path. Must be the first modifier. Also
813 changes "~/" (and "~user/" for Unix and VMS) to the path for
814 the home directory. If the name is a directory a path
815 separator is added at the end. For a file name that does not
816 exist and does not have an absolute path the result is
818 :8 Converts the path to 8.3 short format (currently only on
819 win32). Will act on as much of a path that is an existing
821 :~ Reduce file name to be relative to the home directory, if
822 possible. File name is unmodified if it is not below the home
824 :. Reduce file name to be relative to current directory, if
825 possible. File name is unmodified if it is not below the
827 For maximum shortness, use ":~:.".
828 :h Head of the file name (the last component and any separators
829 removed). Cannot be used with :e, :r or :t.
830 Can be repeated to remove several components at the end.
831 When the file name ends in a path separator, only the path
832 separator is removed. Thus ":p:h" on a directory name results
833 on the directory name itself (without trailing slash).
834 When the file name is an absolute path (starts with "/" for
835 Unix; "x:\" for MS-DOS, WIN32, OS/2; "drive:" for Amiga), that
836 part is not removed. When there is no head (path is relative
837 to current directory) the result is empty.
838 :t Tail of the file name (last component of the name). Must
839 precede any :r or :e.
840 :r Root of the file name (the last extension removed). When
841 there is only an extension (file name that starts with '.',
842 e.g., ".vimrc"), it is not removed. Can be repeated to remove
843 several extensions (last one first).
844 :e Extension of the file name. Only makes sense when used alone.
845 When there is no extension the result is empty.
846 When there is only an extension (file name that starts with
847 '.'), the result is empty. Can be repeated to include more
848 extensions. If there are not enough extensions (but at least
849 one) as much as possible are included.
851 Substitute the first occurrence of "pat" with "sub". This
852 works like the |:s| command. "pat" is a regular expression.
853 Any character can be used for '?', but it must not occur in
855 After this, the previous modifiers can be used again. For
856 example ":p", to make a full path after the substitution.
858 Substitute all occurrences of "path" with "sub". Otherwise
859 this works like ":s".
861 Examples, when the file name is "src/version.c", current dir
863 :p /home/mool/vim/src/version.c
865 :p:~ ~/vim/src/version.c
867 :p:h /home/mool/vim/src
868 :p:h:h /home/mool/vim
872 :p:r /home/mool/vim/src/version
875 :s?version?main? src/main.c
876 :s?version?main?:p /home/mool/vim/src/main.c
877 :p:gs?/?\\? \home\mool\vim\src\version.c
879 Examples, when the file name is "src/version.c.gz": >
880 :p /home/mool/vim/src/version.c.gz
890 *extension-removal* *:_%<*
891 If a "<" is appended to "%", "#", "#n" or "CTRL-V p" the extension of the file
892 name is removed (everything after and including the last '.' in the file
893 name). This is included for backwards compatibility with version 3.0, the
894 ":r" form is preferred. Examples: >
897 %< current file name without extension
898 # alternate file name for current window
899 #< idem, without extension
900 #31 alternate file number 31
901 #31< idem, without extension
902 <cword> word under the cursor
903 <cWORD> WORD under the cursor (see |WORD|)
904 <cfile> path name under the cursor
905 <cfile>< idem, without extension
907 Note: Where a file name is expected wildcards expansion is done. On Unix the
908 shell is used for this, unless it can be done internally (for speed).
909 Backticks also work, like in >
911 (backtick expansion is not possible in |restricted-mode|)
912 But expansion is only done if there are any wildcards before expanding the
913 '%', '#', etc.. This avoids expanding wildcards inside a file name. If you
914 want to expand the result of <cfile>, add a wildcard character to it.
915 Examples: (alternate file name is "?readme?")
918 :e `ls #` :e {files matching "?readme?"}
919 :e #.* :e {files matching "?readme?.*"}
920 :cd <cfile> :cd {file name under cursor}
921 :cd <cfile>* :cd {file name under cursor plus "*" and then expanded}
923 When the expanded argument contains a "!" and it is used for a shell command
924 (":!cmd", ":r !cmd" or ":w !cmd"), the "!" is escaped with a backslash to
925 avoid it being expanded into a previously used command. When the 'shell'
926 option contains "sh", this is done twice, to avoid the shell trying to expand
930 For filesystems that use a backslash as directory separator (MS-DOS, Windows,
931 OS/2), it's a bit difficult to recognize a backslash that is used to escape
932 the special meaning of the next character. The general rule is: If the
933 backslash is followed by a normal file name character, it does not have a
934 special meaning. Therefore "\file\foo" is a valid file name, you don't have
935 to type the backslash twice.
937 An exception is the '$' sign. It is a valid character in a file name. But
938 to avoid a file name like "$home" to be interpreted as an environment variable,
939 it needs to be preceded by a backslash. Therefore you need to use "/\$home"
940 for the file "$home" in the root directory. A few examples:
942 FILE NAME INTERPRETED AS ~
943 $home expanded to value of environment var $home
944 \$home file "$home" in current directory
945 /\$home file "$home" in root directory
946 \\$home file "\\", followed by expanded $home
948 ==============================================================================
949 6. Command-line window *cmdline-window* *cmdwin*
950 *command-line-window*
951 In the command-line window the command line can be edited just like editing
952 text in any window. It is a special kind of window, because you cannot leave
954 {not available when compiled without the |+cmdline_hist| or |+vertsplit|
958 OPEN *c_CTRL-F* *q:* *q/* *q?*
960 There are two ways to open the command-line window:
961 1. From Command-line mode, use the key specified with the 'cedit' option.
962 The default is CTRL-F when 'compatible' is not set.
963 2. From Normal mode, use the "q:", "q/" or "q?" command.
964 This starts editing an Ex command-line ("q:") or search string ("q/" or
965 "q?"). Note that this is not possible while recording is in progress (the
966 "q" stops recording then).
968 When the window opens it is filled with the command-line history. The last
969 line contains the command as typed so far. The left column will show a
970 character that indicates the type of command-line being edited, see
973 Vim will be in Normal mode when the editor is opened, except when 'insertmode'
976 The height of the window is specified with 'cmdwinheight' (or smaller if there
977 is no room). The window is always full width and is positioned just above the
983 You can now use commands to move around and edit the text in the window. Both
984 in Normal mode and Insert mode.
986 It is possible to use ":", "/" and other commands that use the command-line,
987 but it's not possible to open another command-line window then. There is no
990 The command-line window is not a normal window. It is not possible to move to
991 another window or edit another buffer. All commands that would do this are
992 disabled in the command-line window. Of course it _is_ possible to execute
993 any command that you entered in the command-line window. Other text edits are
994 discarded when closing the window.
999 There are several ways to leave the command-line window:
1001 <CR> Execute the command-line under the cursor. Works both in
1002 Insert and in Normal mode.
1003 CTRL-C Continue in Command-line mode. The command-line under the
1004 cursor is used as the command-line. Works both in Insert and
1005 in Normal mode. ":close" also works. There is no redraw,
1006 thus the window will remain visible.
1007 :quit Discard the command line and go back to Normal mode.
1008 ":exit", ":xit" and CTRL-\ CTRL-N also work.
1009 :qall Quit Vim, unless there are changes in some buffer.
1010 :qall! Quit Vim, discarding changes to any buffer.
1012 Once the command-line window is closed the old window sizes are restored. The
1013 executed command applies to the window and buffer where the command-line was
1014 started from. This works as if the command-line window was not there, except
1015 that there will be an extra screen redraw.
1016 The buffer used for the command-line window is deleted. Any changes to lines
1017 other than the one that is executed with <CR> are lost.
1019 If you would like to execute the command under the cursor and then have the
1020 command-line window open again, you may find this mapping useful: >
1022 :autocmd CmdwinEnter * map <buffer> <F5> <CR>q:
1027 The command-line window cannot be used:
1028 - when there already is a command-line window (no nesting)
1029 - for entering an encryption key or when using inputsecret()
1030 - when Vim was not compiled with the +vertsplit feature
1032 Some options are set when the command-line window is opened:
1033 'filetype' "vim", when editing an Ex command-line; this starts Vim syntax
1034 highlighting if it was enabled
1040 It is allowed to write the buffer contents to a file. This is an easy way to
1041 save the command-line history and read it back later.
1043 If the 'wildchar' option is set to <Tab>, and the command-line window is used
1044 for an Ex command, then two mappings will be added to use <Tab> for completion
1045 in the command-line window, like this: >
1046 :imap <buffer> <Tab> <C-X><C-V>
1047 :nmap <buffer> <Tab> a<C-X><C-V>
1048 Note that hitting <Tab> in Normal mode will do completion on the next
1049 character. That way it works at the end of the line.
1050 If you don't want these mappings, disable them with: >
1051 au CmdwinEnter [:>] iunmap <Tab>
1052 au CmdwinEnter [:>] nunmap <Tab>
1053 You could put these lines in your vimrc file.
1055 While in the command-line window you cannot use the mouse to put the cursor in
1056 another window, or drag statuslines of other windows. You can drag the
1057 statusline of the command-line window itself and the statusline above it.
1058 Thus you can resize the command-line window, but not others.
1063 Two autocommand events are used: |CmdwinEnter| and |CmdwinLeave|. Since this
1064 window is of a special type, the WinEnter, WinLeave, BufEnter and BufLeave
1065 events are not triggered. You can use the Cmdwin events to do settings
1066 specifically for the command-line window. Be careful not to cause side
1069 :au CmdwinEnter : let b:cpt_save = &cpt | set cpt=.
1070 :au CmdwinLeave : let &cpt = b:cpt_save
1071 This sets 'complete' to use completion in the current window for |i_CTRL-N|.
1073 :au CmdwinEnter [/?] startinsert
1074 This will make Vim start in Insert mode in the command-line window.
1077 The character used for the pattern indicates the type of command-line:
1079 > debug mode command |debug-mode|
1080 / forward search string
1081 ? backward search string
1082 = expression for "= |expr-register|
1083 @ string for |input()|
1084 - text for |:insert| or |:append|
1086 vim:tw=78:ts=8:ft=help:norl: