blob: 839536b21f16dabe2f3319bec50cb81fe78653d2 [file] [log] [blame]
Bram Moolenaard812df62008-11-09 12:46:09 +00001*cmdline.txt* For Vim version 7.2. Last change: 2008 Sep 18
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
86 *c_<Left>*
87<Left> cursor left
88 *c_<Right>*
89<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
96CTRL-B or <Home> *c_CTRL-B* *c_<Home>*
97 cursor to beginning of command-line
98CTRL-E or <End> *c_CTRL-E* *c_<End>*
99 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
104CTRL-H *c_<BS>* *c_CTRL-H*
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).
107 *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<
121 Note: if the command-line becomes empty with one of the
122 delete commands, Command-line mode is quit.
123 *c_<Insert>*
124<Insert> Toggle between insert and overstrike. {not in Vi}
125
126{char1} <BS> {char2} or *c_digraph*
127CTRL-K {char1} {char2} *c_CTRL-K*
128 enter digraph (see |digraphs|). When {char1} is a special
129 key, the code for that key is inserted in <> form. {not in Vi}
130
131CTRL-R {0-9a-z"%#:-=.} *c_CTRL-R* *c_<C-R>*
132 Insert the contents of a numbered or named register. Between
133 typing CTRL-R and the second character '"' will be displayed
134 to indicate that you are expected to enter the name of a
135 register.
136 The text is inserted as if you typed it, but mappings and
137 abbreviations are not used. Command-line completion through
138 'wildchar' is not triggered though. And characters that end
139 the command line are inserted literally (<Esc>, <CR>, <NL>,
140 <C-C>). A <BS> or CTRL-W could still end the command line
141 though, and remaining characters will then be interpreted in
142 another mode, which might not be what you intended.
143 Special registers:
144 '"' the unnamed register, containing the text of
145 the last delete or yank
146 '%' the current file name
147 '#' the alternate file name
148 '*' the clipboard contents (X11: primary selection)
149 '+' the clipboard contents
150 '/' the last search pattern
151 ':' the last command-line
152 '-' the last small (less than a line) delete
153 '.' the last inserted text
154 *c_CTRL-R_=*
155 '=' the expression register: you are prompted to
156 enter an expression (see |expression|)
Bram Moolenaar05a7bb32006-01-19 22:09:32 +0000157 (doesn't work at the expression prompt; some
158 things such as changing the buffer or current
159 window are not allowed to avoid side effects)
Bram Moolenaard812df62008-11-09 12:46:09 +0000160 When the result is a |List| the items are used
161 as lines. They can have line breaks inside
162 too.
163 When the result is a Float it's automatically
164 converted to a String.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000165 See |registers| about registers. {not in Vi}
Bram Moolenaarfd371682005-01-14 21:42:54 +0000166 Implementation detail: When using the |expression| register
167 and invoking setcmdpos(), this sets the position before
168 inserting the resulting string. Use CTRL-R CTRL-R to set the
169 position afterwards.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000170
171CTRL-R CTRL-F *c_CTRL-R_CTRL-F* *c_<C-R>_<C-F>*
172CTRL-R CTRL-P *c_CTRL-R_CTRL-P* *c_<C-R>_<C-P>*
173CTRL-R CTRL-W *c_CTRL-R_CTRL-W* *c_<C-R>_<C-W>*
174CTRL-R CTRL-A *c_CTRL-R_CTRL-A* *c_<C-R>_<C-A>*
175 Insert the object under the cursor:
176 CTRL-F the Filename under the cursor
177 CTRL-P the Filename under the cursor, expanded with
178 'path' as in |gf|
179 CTRL-W the Word under the cursor
180 CTRL-A the WORD under the cursor; see |WORD|
Bram Moolenaard3667a22006-03-16 21:35:52 +0000181
182 When 'incsearch' is set the cursor position at the end of the
183 currently displayed match is used. With CTRL-W the part of
184 the word that was already typed is not inserted again.
185
Bram Moolenaar071d4272004-06-13 20:20:40 +0000186 {not in Vi}
187 CTRL-F and CTRL-P: {only when +file_in_path feature is
188 included}
189
190 *c_CTRL-R_CTRL-R* *c_<C-R>_<C-R>*
191 *c_CTRL-R_CTRL-O* *c_<C-R>_<C-O>*
192CTRL-R CTRL-R {0-9a-z"%#:-=. CTRL-F CTRL-P CTRL-W CTRL-A}
193CTRL-R CTRL-O {0-9a-z"%#:-=. CTRL-F CTRL-P CTRL-W CTRL-A}
194 Insert register or object under the cursor. Works like
195 |c_CTRL-R| but inserts the text literally. For example, if
196 register a contains "xy^Hz" (where ^H is a backspace),
197 "CTRL-R a" will insert "xz" while "CTRL-R CTRL-R a" will
198 insert "xy^Hz".
199
200CTRL-\ e {expr} *c_CTRL-\_e*
201 Evaluate {expr} and replace the whole command line with the
202 result. You will be prompted for the expression, type <Enter>
203 to finish it. It's most useful in mappings though. See
204 |expression|.
205 See |c_CTRL-R_=| for inserting the result of an expression.
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +0000206 Useful functions are |getcmdtype()|, |getcmdline()| and
207 |getcmdpos()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000208 The cursor position is unchanged, except when the cursor was
209 at the end of the line, then it stays at the end.
210 |setcmdpos()| can be used to set the cursor position.
Bram Moolenaar4770d092006-01-12 23:22:24 +0000211 The |sandbox| is used for evaluating the expression to avoid
212 nasty side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000213 Example: >
214 :cmap <F7> <C-\>eAppendSome()<CR>
215 :func AppendSome()
216 :let cmd = getcmdline() . " Some()"
217 :" place the cursor on the )
218 :call setcmdpos(strlen(cmd))
219 :return cmd
220 :endfunc
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +0000221< This doesn't work recursively, thus not when already editing
222 an expression.
223
Bram Moolenaar071d4272004-06-13 20:20:40 +0000224 *c_CTRL-Y*
225CTRL-Y When there is a modeless selection, copy the selection into
226 the clipboard. |modeless-selection|
227 If there is no selection CTRL-Y is inserted as a character.
228
229CTRL-J *c_CTRL-J* *c_<NL>* *c_<CR>*
230<CR> or <NL> start entered command
231 *c_<Esc>*
232<Esc> When typed and 'x' not present in 'cpoptions', quit
233 Command-line mode without executing. In macros or when 'x'
234 present in 'cpoptions', start entered command.
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000235 Note: If your <Esc> key is hard to hit on your keyboard, train
236 yourself to use CTRL-[.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000237 *c_CTRL-C*
238CTRL-C quit command-line without executing
239
240 *c_<Up>*
241<Up> recall older command-line from history, whose beginning
242 matches the current command-line (see below).
243 {not available when compiled without the |+cmdline_hist|
244 feature}
245 *c_<Down>*
246<Down> recall more recent command-line from history, whose beginning
247 matches the current command-line (see below).
248 {not available when compiled without the |+cmdline_hist|
249 feature}
250
251 *c_<S-Up>* *c_<PageUp>*
252<S-Up> or <PageUp>
253 recall older command-line from history
254 {not available when compiled without the |+cmdline_hist|
255 feature}
256 *c_<S-Down>* *c_<PageDown>*
257<S-Down> or <PageDown>
258 recall more recent command-line from history
259 {not available when compiled without the |+cmdline_hist|
260 feature}
261
262CTRL-D command-line completion (see |cmdline-completion|)
263'wildchar' option
264 command-line completion (see |cmdline-completion|)
265CTRL-N command-line completion (see |cmdline-completion|)
266CTRL-P command-line completion (see |cmdline-completion|)
267CTRL-A command-line completion (see |cmdline-completion|)
268CTRL-L command-line completion (see |cmdline-completion|)
269
270 *c_CTRL-_*
271CTRL-_ a - switch between Hebrew and English keyboard mode, which is
272 private to the command-line and not related to hkmap.
273 This is useful when Hebrew text entry is required in the
274 command-line, searches, abbreviations, etc. Applies only if
275 Vim is compiled with the |+rightleft| feature and the
276 'allowrevins' option is set.
277 See |rileft.txt|.
278
279 b - switch between Farsi and English keyboard mode, which is
280 private to the command-line and not related to fkmap. In
281 Farsi keyboard mode the characters are inserted in reverse
282 insert manner. This is useful when Farsi text entry is
283 required in the command-line, searches, abbreviations, etc.
284 Applies only if Vim is compiled with the |+farsi| feature.
285 See |farsi.txt|.
286
287 *c_CTRL-^*
288CTRL-^ Toggle the use of language |:lmap| mappings and/or Input
289 Method.
290 When typing a pattern for a search command and 'imsearch' is
291 not -1, VAL is the value of 'imsearch', otherwise VAL is the
292 value of 'iminsert'.
293 When language mappings are defined:
294 - If VAL is 1 (langmap mappings used) it becomes 0 (no langmap
295 mappings used).
296 - If VAL was not 1 it becomes 1, thus langmap mappings are
297 enabled.
298 When no language mappings are defined:
299 - If VAL is 2 (Input Method is used) it becomes 0 (no input
300 method used)
301 - If VAL has another value it becomes 2, thus the Input Method
302 is enabled.
303 These language mappings are normally used to type characters
304 that are different from what the keyboard produces. The
305 'keymap' option can be used to install a whole number of them.
306 When entering a command line, langmap mappings are switched
307 off, since you are expected to type a command. After
308 switching it on with CTRL-^, the new state is not used again
309 for the next command or Search pattern.
310 {not in Vi}
311
Bram Moolenaar9964e462007-05-05 17:54:07 +0000312 *c_CTRL-]*
313CTRL-] Trigger abbreviation, without inserting a character. {not in
314 Vi}
315
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316For Emacs-style editing on the command-line see |emacs-keys|.
317
318The <Up> and <Down> keys take the current command-line as a search string.
319The beginning of the next/previous command-lines are compared with this
320string. The first line that matches is the new command-line. When typing
321these two keys repeatedly, the same string is used again. For example, this
322can be used to find the previous substitute command: Type ":s" and then <Up>.
323The same could be done by typing <S-Up> a number of times until the desired
324command-line is shown. (Note: the shifted arrow keys do not work on all
325terminals)
326
Bram Moolenaar066b6222008-01-04 14:17:47 +0000327 *:his* *:history*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000328:his[tory] Print the history of last entered commands.
329 {not in Vi}
330 {not available when compiled without the |+cmdline_hist|
331 feature}
332
333:his[tory] [{name}] [{first}][, [{last}]]
334 List the contents of history {name} which can be:
335 c[md] or : command-line history
336 s[earch] or / search string history
337 e[xpr] or = expression register history
338 i[nput] or @ input line history
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000339 d[ebug] or > debug command history
Bram Moolenaar071d4272004-06-13 20:20:40 +0000340 a[ll] all of the above
341 {not in Vi}
342
343 If the numbers {first} and/or {last} are given, the respective
344 range of entries from a history is listed. These numbers can
345 be specified in the following form:
346 *:history-indexing*
347 A positive number represents the absolute index of an entry
348 as it is given in the first column of a :history listing.
349 This number remains fixed even if other entries are deleted.
350
351 A negative number means the relative position of an entry,
352 counted from the newest entry (which has index -1) backwards.
353
354 Examples:
355 List entries 6 to 12 from the search history: >
356 :history / 6,12
357<
358 List the recent five entries from all histories: >
359 :history all -5,
360
361==============================================================================
3622. Command-line completion *cmdline-completion*
363
364When editing the command-line, a few commands can be used to complete the
365word before the cursor. This is available for:
366
367- Command names: At the start of the command-line.
368- Tags: Only after the ":tag" command.
369- File names: Only after a command that accepts a file name or a setting for
370 an option that can be set to a file name. This is called file name
371 completion.
Bram Moolenaara2031822006-03-07 22:29:51 +0000372- Shell command names: After ":!cmd", ":r !cmd" and ":w !cmd". $PATH is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000373- Options: Only after the ":set" command.
374- Mappings: Only after a ":map" or similar command.
375- Variable and function names: Only after a ":if", ":call" or similar command.
376
377When Vim was compiled with the |+cmdline_compl| feature disabled, only file
Bram Moolenaarc236c162008-07-13 17:41:49 +0000378names, directories and help items can be completed. The number of help item
379matches is limited (currently to 300) to avoid a long delay when there are
380very many matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000381
382These are the commands that can be used:
383
384 *c_CTRL-D*
385CTRL-D List names that match the pattern in front of the cursor.
386 When showing file names, directories are highlighted (see
387 'highlight' option). Names where 'suffixes' matches are moved
388 to the end.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000389 The 'wildoptions' option can be set to "tagfile" to list the
390 file of matching tags.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000391 *c_CTRL-I* *c_wildchar* *c_<Tab>*
392'wildchar' option
393 A match is done on the pattern in front of the cursor. The
394 match (if there are several, the first match) is inserted
395 in place of the pattern. (Note: does not work inside a
396 macro, because <Tab> or <Esc> are mostly used as 'wildchar',
397 and these have a special meaning in some macros.) When typed
398 again and there were multiple matches, the next
399 match is inserted. After the last match, the first is used
400 again (wrap around).
401 The behavior can be changed with the 'wildmode' option.
402 *c_CTRL-N*
403CTRL-N After using 'wildchar' which got multiple matches, go to next
404 match. Otherwise recall more recent command-line from history.
405<S-Tab> *c_CTRL-P* *c_<S-Tab>*
406CTRL-P After using 'wildchar' which got multiple matches, go to
407 previous match. Otherwise recall older command-line from
408 history. <S-Tab> only works with the GUI, on the Amiga and
409 with MS-DOS.
410 *c_CTRL-A*
411CTRL-A All names that match the pattern in front of the cursor are
412 inserted.
413 *c_CTRL-L*
414CTRL-L A match is done on the pattern in front of the cursor. If
415 there is one match, it is inserted in place of the pattern.
416 If there are multiple matches the longest common part is
417 inserted in place of the pattern. If the result is shorter
418 than the pattern, no completion is done.
Bram Moolenaard3667a22006-03-16 21:35:52 +0000419 When 'incsearch' is set, entering a search pattern for "/" or
420 "?" and the current match is displayed then CTRL-L will add
421 one character from the end of the current match.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000422
423The 'wildchar' option defaults to <Tab> (CTRL-E when in Vi compatible mode; in
424a previous version <Esc> was used). In the pattern standard wildcards '*' and
425'?' are accepted. '*' matches any string, '?' matches exactly one character.
426
427If you like tcsh's autolist completion, you can use this mapping:
428 :cnoremap X <C-L><C-D>
429(Where X is the command key to use, <C-L> is CTRL-L and <C-D> is CTRL-D)
430This will find the longest match and then list all matching files.
431
432If you like tcsh's autolist completion, you can use the 'wildmode' option to
433emulate it. For example, this mimics autolist=ambiguous:
434 :set wildmode=longest,list
435This will find the longest match with the first 'wildchar', then list all
436matching files with the next.
437
438 *suffixes*
439For file name completion you can use the 'suffixes' option to set a priority
440between files with almost the same name. If there are multiple matches,
441those files with an extension that is in the 'suffixes' option are ignored.
442The default is ".bak,~,.o,.h,.info,.swp,.obj", which means that files ending
443in ".bak", "~", ".o", ".h", ".info", ".swp" and ".obj" are sometimes ignored.
444It is impossible to ignore suffixes with two dots. Examples:
445
446 pattern: files: match: ~
447 test* test.c test.h test.o test.c
448 test* test.h test.o test.h and test.o
449 test* test.i test.h test.c test.i and test.c
450
451If there is more than one matching file (after ignoring the ones matching
452the 'suffixes' option) the first file name is inserted. You can see that
453there is only one match when you type 'wildchar' twice and the completed
454match stays the same. You can get to the other matches by entering
455'wildchar', CTRL-N or CTRL-P. All files are included, also the ones with
456extensions matching the 'suffixes' option.
457
458To completely ignore files with some extension use 'wildignore'.
459
Bram Moolenaar066b6222008-01-04 14:17:47 +0000460To match only files that end at the end of the typed text append a "$". For
461example, to match only files that end in ".c": >
462 :e *.c$
463This will not match a file ending in ".cpp". Without the "$" it does match.
464
Bram Moolenaar071d4272004-06-13 20:20:40 +0000465The old value of an option can be obtained by hitting 'wildchar' just after
466the '='. For example, typing 'wildchar' after ":set dir=" will insert the
467current value of 'dir'. This overrules file name completion for the options
468that take a file name.
469
470If you would like using <S-Tab> for CTRL-P in an xterm, put this command in
471your .cshrc: >
472 xmodmap -e "keysym Tab = Tab Find"
473And this in your .vimrc: >
474 :cmap <Esc>[1~ <C-P>
475
476==============================================================================
4773. Ex command-lines *cmdline-lines*
478
479The Ex commands have a few specialties:
480
481 *:quote*
482'"' at the start of a line causes the whole line to be ignored. '"'
483after a command causes the rest of the line to be ignored. This can be used
484to add comments. Example: >
485 :set ai "set 'autoindent' option
486It is not possible to add a comment to a shell command ":!cmd" or to the
487":map" command and friends, because they see the '"' as part of their
488argument.
489
490 *:bar* *:\bar*
491'|' can be used to separate commands, so you can give multiple commands in one
492line. If you want to use '|' in an argument, precede it with '\'.
493
494These commands see the '|' as their argument, and can therefore not be
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000495followed by another Vim command:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000496 :argdo
497 :autocmd
498 :bufdo
499 :command
500 :cscope
501 :debug
502 :folddoopen
503 :folddoclosed
504 :function
505 :global
506 :help
507 :helpfind
Bram Moolenaar110bc6b2006-02-10 23:13:40 +0000508 :lcscope
Bram Moolenaar071d4272004-06-13 20:20:40 +0000509 :make
510 :normal
511 :perl
512 :perldo
513 :promptfind
514 :promptrepl
515 :pyfile
516 :python
517 :registers
518 :read !
519 :scscope
520 :tcl
521 :tcldo
522 :tclfile
523 :vglobal
524 :windo
525 :write !
526 :[range]!
527 a user defined command without the "-bar" argument |:command|
528
529Note that this is confusing (inherited from Vi): With ":g" the '|' is included
530in the command, with ":s" it is not.
531
532To be able to use another command anyway, use the ":execute" command.
533Example (append the output of "ls" and jump to the first line): >
534 :execute 'r !ls' | '[
535
536There is one exception: When the 'b' flag is present in 'cpoptions', with the
537":map" and ":abbr" commands and friends CTRL-V needs to be used instead of
538'\'. You can also use "<Bar>" instead. See also |map_bar|.
539
540Examples: >
541 :!ls | wc view the output of two commands
542 :r !ls | wc insert the same output in the text
543 :%g/foo/p|> moves all matching lines one shiftwidth
544 :%s/foo/bar/|> moves one line one shiftwidth
545 :map q 10^V| map "q" to "10|"
546 :map q 10\| map \ l map "q" to "10\" and map "\" to "l"
547 (when 'b' is present in 'cpoptions')
548
549You can also use <NL> to separate commands in the same way as with '|'. To
550insert a <NL> use CTRL-V CTRL-J. "^@" will be shown. Using '|' is the
551preferred method. But for external commands a <NL> must be used, because a
552'|' is included in the external command. To avoid the special meaning of <NL>
553it must be preceded with a backslash. Example: >
554 :r !date<NL>-join
555This reads the current date into the file and joins it with the previous line.
556
557Note that when the command before the '|' generates an error, the following
558commands will not be executed.
559
560
561Because of Vi compatibility the following strange commands are supported: >
562 :| print current line (like ":p")
563 :3| print line 3 (like ":3p")
564 :3 goto line 3
565
566A colon is allowed between the range and the command name. It is ignored
567(this is Vi compatible). For example: >
568 :1,$:s/pat/string
569
570When the character '%' or '#' is used where a file name is expected, they are
571expanded to the current and alternate file name (see the chapter "editing
572files" |:_%| |:_#|).
573
574Embedded spaces in file names are allowed on the Amiga if one file name is
575expected as argument. Trailing spaces will be ignored, unless escaped with a
576backslash or CTRL-V. Note that the ":next" command uses spaces to separate
577file names. Escape the spaces to include them in a file name. Example: >
578 :next foo\ bar goes\ to school\
579starts editing the three files "foo bar", "goes to" and "school ".
580
581When you want to use the special characters '"' or '|' in a command, or want
582to use '%' or '#' in a file name, precede them with a backslash. The
583backslash is not required in a range and in the ":substitute" command.
584
585 *:_!*
586The '!' (bang) character after an Ex command makes the command behave in a
587different way. The '!' should be placed immediately after the command, without
588any blanks in between. If you insert blanks the '!' will be seen as an
589argument for the command, which has a different meaning. For example:
590 :w! name write the current buffer to file "name", overwriting
591 any existing file
592 :w !name send the current buffer as standard input to command
593 "name"
594
595==============================================================================
Bram Moolenaara5792f52005-11-23 21:25:05 +00005964. Ex command-line ranges *cmdline-ranges* *[range]* *E16*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000597
598Some Ex commands accept a line range in front of them. This is noted as
599[range]. It consists of one or more line specifiers, separated with ',' or
600';'.
601
602The basics are explained in section |10.3| of the user manual.
603
604 *:,* *:;*
605When separated with ';' the cursor position will be set to that line
606before interpreting the next line specifier. This doesn't happen for ','.
607Examples: >
608 4,/this line/
609< from line 4 till match with "this line" after the cursor line. >
610 5;/that line/
611< from line 5 till match with "that line" after line 5.
612
613The default line specifier for most commands is the cursor position, but the
614commands ":write" and ":global" have the whole file (1,$) as default.
615
616If more line specifiers are given than required for the command, the first
617one(s) will be ignored.
618
619Line numbers may be specified with: *:range* *E14* *{address}*
620 {number} an absolute line number
621 . the current line *:.*
622 $ the last line in the file *:$*
623 % equal to 1,$ (the entire file) *:%*
624 't position of mark t (lowercase) *:'*
625 'T position of mark T (uppercase); when the mark is in
626 another file it cannot be used in a range
627 /{pattern}[/] the next line where {pattern} matches *:/*
628 ?{pattern}[?] the previous line where {pattern} matches *:?*
629 \/ the next line where the previously used search
630 pattern matches
631 \? the previous line where the previously used search
632 pattern matches
633 \& the next line where the previously used substitute
634 pattern matches
635
636Each may be followed (several times) by '+' or '-' and an optional number.
637This number is added or subtracted from the preceding line number. If the
638number is omitted, 1 is used.
639
640The "/" and "?" after {pattern} are required to separate the pattern from
641anything that follows.
642
643The "/" and "?" may be preceded with another address. The search starts from
644there. The difference from using ';' is that the cursor isn't moved.
645Examples: >
646 /pat1//pat2/ Find line containing "pat2" after line containing
647 "pat1", without moving the cursor.
648 7;/pat2/ Find line containing "pat2", after line 7, leaving
649 the cursor in line 7.
650
651The {number} must be between 0 and the number of lines in the file. When
652using a 0 (zero) this is interpreted as a 1 by most commands. Commands that
653use it as a count do use it as a zero (|:tag|, |:pop|, etc). Some commands
654interpret the zero as "before the first line" (|:read|, search pattern, etc).
655
656Examples: >
657 .+3 three lines below the cursor
658 /that/+1 the line below the next line containing "that"
659 .,$ from current line until end of file
660 0;/that the first line containing "that", also matches in the
661 first line.
662 1;/that the first line after line 1 containing "that"
663
664Some commands allow for a count after the command. This count is used as the
665number of lines to be used, starting with the line given in the last line
666specifier (the default is the cursor line). The commands that accept a count
667are the ones that use a range but do not have a file name argument (because
668a file name can also be a number).
669
670Examples: >
671 :s/x/X/g 5 substitute 'x' by 'X' in the current line and four
672 following lines
673 :23d 4 delete lines 23, 24, 25 and 26
674
675
676Folds and Range
677
678When folds are active the line numbers are rounded off to include the whole
679closed fold. See |fold-behavior|.
680
681
Bram Moolenaara5792f52005-11-23 21:25:05 +0000682Reverse Range *E493*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000683
684A range should have the lower line number first. If this is not the case, Vim
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000685will ask you if it should swap the line numbers.
Bram Moolenaara5792f52005-11-23 21:25:05 +0000686 Backwards range given, OK to swap ~
687This is not done within the global command ":g".
688
689You can use ":silent" before a command to avoid the question, the range will
690always be swapped then.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000691
692
693Count and Range *N:*
694
695When giving a count before entering ":", this is translated into:
696 :.,.+(count - 1)
697In words: The 'count' lines at and after the cursor. Example: To delete
698three lines: >
699 3:d<CR> is translated into: .,.+2d<CR>
700<
701
702Visual Mode and Range *v_:*
703
704{Visual}: Starts a command-line with the Visual selected lines as a
705 range. The code ":'<,'>" is used for this range, which makes
706 it possible to select a similar line from the command-line
707 history for repeating a command on different Visually selected
708 lines.
709
710==============================================================================
Bram Moolenaardf177f62005-02-22 08:39:57 +00007115. Ex command-line flags *ex-flags*
712
713These flags are supported by a selection of Ex commands. They print the line
714that the cursor ends up after executing the command:
715
716 l output like for |:list|
717 # add line number
718 p output like for |:print|
719
720The flags can be combined, thus "l#" uses both a line number and |:list| style
721output.
722
723==============================================================================
7246. Ex special characters *cmdline-special*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000725
Bram Moolenaar8fa04452005-12-23 22:13:51 +0000726Note: These are special characters in the executed command line. If you want
727to insert special things while typing you can use the CTRL-R command. For
728example, "%" stands for the current file name, while CTRL-R % inserts the
729current file name right away. See |c_CTRL-R|.
730
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000731Note: If you want to avoid the special characters in a Vim script you may want
732to use |fnameescape()|.
733
Bram Moolenaar8fa04452005-12-23 22:13:51 +0000734
Bram Moolenaar071d4272004-06-13 20:20:40 +0000735In Ex commands, at places where a file name can be used, the following
736characters have a special meaning. These can also be used in the expression
737function expand() |expand()|.
Bram Moolenaard812df62008-11-09 12:46:09 +0000738 % Is replaced with the current file name. *:_%* *c_%*
739 # Is replaced with the alternate file name. *:_#* *c_#*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000740 #n (where n is a number) is replaced with the file name of
Bram Moolenaard812df62008-11-09 12:46:09 +0000741 buffer n. "#0" is the same as "#".
742 ## Is replaced with all names in the argument list *:_##* *c_##*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000743 concatenated, separated by spaces. Each space in a name
744 is preceded with a backslash.
Bram Moolenaard812df62008-11-09 12:46:09 +0000745 #<n (where n is a number > 0) is replaced with old *:_#<* *c_#<*
746 file name n. See |:oldfiles| or |v:oldfiles| to get the
747 number. *E809*
748 {only when compiled with the +eval and +viminfo features}
749
750Note that these, except "#<n", give the file name as it was typed. If an
751absolute path is needed (when using the file name from a different directory),
752you need to add ":p". See |filename-modifiers|.
753
754The "#<n" item returns an absolute path, but it will start with "~/" for files
755below your home directory.
756
Bram Moolenaar071d4272004-06-13 20:20:40 +0000757Note that backslashes are inserted before spaces, so that the command will
758correctly interpret the file name. But this doesn't happen for shell
Bram Moolenaard812df62008-11-09 12:46:09 +0000759commands. For those you probably have to use quotes (this fails for files
760that contain a quote and wildcards): >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000761 :!ls "%"
762 :r !spell "%"
763
764To avoid the special meaning of '%' and '#' insert a backslash before it.
765Detail: The special meaning is always escaped when there is a backslash before
766it, no matter how many backslashes.
767 you type: result ~
768 # alternate.file
769 \# #
770 \\# \#
771
772 *:<cword>* *:<cWORD>* *:<cfile>* *<cfile>*
773 *:<sfile>* *<sfile>* *:<afile>* *<afile>*
774 *:<abuf>* *<abuf>* *:<amatch>* *<amatch>*
775 *E495* *E496* *E497* *E498* *E499* *E500*
776Note: these are typed literally, they are not special keys!
777 <cword> is replaced with the word under the cursor (like |star|)
778 <cWORD> is replaced with the WORD under the cursor (see |WORD|)
779 <cfile> is replaced with the path name under the cursor (like what
780 |gf| uses)
781 <afile> when executing autocommands, is replaced with the file name
782 for a file read or write
783 <abuf> when executing autocommands, is replaced with the currently
Bram Moolenaara2031822006-03-07 22:29:51 +0000784 effective buffer number (for ":r file" and ":so file" it is
785 the current buffer, the file being read/sourced is not in a
786 buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000787 <amatch> when executing autocommands, is replaced with the match for
Bram Moolenaar53180ce2005-07-05 21:48:14 +0000788 which this autocommand was executed. It differs from
Bram Moolenaar071d4272004-06-13 20:20:40 +0000789 <afile> only when the file name isn't used to match with
Bram Moolenaarb8a7b562006-02-01 21:47:16 +0000790 (for FileType, Syntax and SpellFileMissing events).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000791 <sfile> when executing a ":source" command, is replaced with the
792 file name of the sourced file;
793 when executing a function, is replaced with
794 "function {function-name}"; function call nesting is
795 indicated like this:
796 "function {function-name1}..{function-name2}". Note that
797 filename-modifiers are useless when <sfile> is used inside
798 a function.
799
800 *filename-modifiers*
801 *:_%:* *::8* *::p* *::.* *::~* *::h* *::t* *::r* *::e* *::s* *::gs*
802The file name modifiers can be used after "%", "#", "#n", "<cfile>", "<sfile>",
803"<afile>" or "<abuf>". They are also used with the |fnamemodify()| function.
804These are not available when Vim has been compiled without the |+modify_fname|
805feature.
806These modifiers can be given, in this order:
807 :p Make file name a full path. Must be the first modifier. Also
808 changes "~/" (and "~user/" for Unix and VMS) to the path for
809 the home directory. If the name is a directory a path
810 separator is added at the end. For a file name that does not
811 exist and does not have an absolute path the result is
812 unpredictable.
813 :8 Converts the path to 8.3 short format (currently only on
814 win32). Will act on as much of a path that is an existing
815 path.
816 :~ Reduce file name to be relative to the home directory, if
817 possible. File name is unmodified if it is not below the home
818 directory.
819 :. Reduce file name to be relative to current directory, if
820 possible. File name is unmodified if it is not below the
821 current directory.
822 For maximum shortness, use ":~:.".
823 :h Head of the file name (the last component and any separators
824 removed). Cannot be used with :e, :r or :t.
825 Can be repeated to remove several components at the end.
826 When the file name ends in a path separator, only the path
827 separator is removed. Thus ":p:h" on a directory name results
828 on the directory name itself (without trailing slash).
829 When the file name is an absolute path (starts with "/" for
830 Unix; "x:\" for MS-DOS, WIN32, OS/2; "drive:" for Amiga), that
831 part is not removed. When there is no head (path is relative
832 to current directory) the result is empty.
833 :t Tail of the file name (last component of the name). Must
834 precede any :r or :e.
835 :r Root of the file name (the last extension removed). When
836 there is only an extension (file name that starts with '.',
837 e.g., ".vimrc"), it is not removed. Can be repeated to remove
838 several extensions (last one first).
839 :e Extension of the file name. Only makes sense when used alone.
840 When there is no extension the result is empty.
841 When there is only an extension (file name that starts with
842 '.'), the result is empty. Can be repeated to include more
843 extensions. If there are not enough extensions (but at least
844 one) as much as possible are included.
845 :s?pat?sub?
846 Substitute the first occurrence of "pat" with "sub". This
847 works like the |:s| command. "pat" is a regular expression.
848 Any character can be used for '?', but it must not occur in
849 "pat" or "sub".
850 After this, the previous modifiers can be used again. For
851 example ":p", to make a full path after the substitution.
852 :gs?pat?sub?
853 Substitute all occurrences of "path" with "sub". Otherwise
854 this works like ":s".
855
856Examples, when the file name is "src/version.c", current dir
857"/home/mool/vim": >
858 :p /home/mool/vim/src/version.c
859 :p:. src/version.c
860 :p:~ ~/vim/src/version.c
861 :h src
862 :p:h /home/mool/vim/src
863 :p:h:h /home/mool/vim
864 :t version.c
865 :p:t version.c
866 :r src/version
867 :p:r /home/mool/vim/src/version
868 :t:r version
869 :e c
870 :s?version?main? src/main.c
871 :s?version?main?:p /home/mool/vim/src/main.c
872 :p:gs?/?\\? \home\mool\vim\src\version.c
873
874Examples, when the file name is "src/version.c.gz": >
875 :p /home/mool/vim/src/version.c.gz
876 :e gz
877 :e:e c.gz
878 :e:e:e c.gz
879 :e:e:r c
880 :r src/version.c
881 :r:e c
882 :r:r src/version
883 :r:r:r src/version
884<
885 *extension-removal* *:_%<*
886If a "<" is appended to "%", "#", "#n" or "CTRL-V p" the extension of the file
887name is removed (everything after and including the last '.' in the file
888name). This is included for backwards compatibility with version 3.0, the
889":r" form is preferred. Examples: >
890
891 % current file name
892 %< current file name without extension
893 # alternate file name for current window
894 #< idem, without extension
895 #31 alternate file number 31
896 #31< idem, without extension
897 <cword> word under the cursor
898 <cWORD> WORD under the cursor (see |WORD|)
899 <cfile> path name under the cursor
900 <cfile>< idem, without extension
901
902Note: Where a file name is expected wildcards expansion is done. On Unix the
903shell is used for this, unless it can be done internally (for speed).
904Backticks also work, like in >
905 :n `echo *.c`
906(backtick expansion is not possible in |restricted-mode|)
907But expansion is only done if there are any wildcards before expanding the
908'%', '#', etc.. This avoids expanding wildcards inside a file name. If you
909want to expand the result of <cfile>, add a wildcard character to it.
910Examples: (alternate file name is "?readme?")
911 command expands to ~
912 :e # :e ?readme?
913 :e `ls #` :e {files matching "?readme?"}
914 :e #.* :e {files matching "?readme?.*"}
915 :cd <cfile> :cd {file name under cursor}
916 :cd <cfile>* :cd {file name under cursor plus "*" and then expanded}
917
918When the expanded argument contains a "!" and it is used for a shell command
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000919(":!cmd", ":r !cmd" or ":w !cmd"), the "!" is escaped with a backslash to
920avoid it being expanded into a previously used command. When the 'shell'
921option contains "sh", this is done twice, to avoid the shell trying to expand
922the "!".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000923
924 *filename-backslash*
925For filesystems that use a backslash as directory separator (MS-DOS, Windows,
926OS/2), it's a bit difficult to recognize a backslash that is used to escape
927the special meaning of the next character. The general rule is: If the
928backslash is followed by a normal file name character, it does not have a
929special meaning. Therefore "\file\foo" is a valid file name, you don't have
930to type the backslash twice.
931
932An exception is the '$' sign. It is a valid character in a file name. But
933to avoid a file name like "$home" to be interpreted as an environment variable,
934it needs to be preceded by a backslash. Therefore you need to use "/\$home"
935for the file "$home" in the root directory. A few examples:
936
937 FILE NAME INTERPRETED AS ~
938 $home expanded to value of environment var $home
939 \$home file "$home" in current directory
940 /\$home file "$home" in root directory
941 \\$home file "\\", followed by expanded $home
942
943==============================================================================
9446. Command-line window *cmdline-window* *cmdwin*
945
946In the command-line window the command line can be edited just like editing
947text in any window. It is a special kind of window, because you cannot leave
948it in a normal way.
949{not available when compiled without the |+cmdline_hist| or |+vertsplit|
950feature}
951
952
953OPEN
954
955There are two ways to open the command-line window:
9561. From Command-line mode, use the key specified with the 'cedit' option.
957 The default is CTRL-F when 'compatible' is not set.
9582. From Normal mode, use the "q:", "q/" or "q?" command. *q:* *q/* *q?*
959 This starts editing an Ex command-line ("q:") or search string ("q/" or
960 "q?"). Note that this is not possible while recording is in progress (the
961 "q" stops recording then).
962
963When the window opens it is filled with the command-line history. The last
964line contains the command as typed so far. The left column will show a
965character that indicates the type of command-line being edited, see
966|cmdwin-char|.
967
968Vim will be in Normal mode when the editor is opened, except when 'insertmode'
969is set.
970
971The height of the window is specified with 'cmdwinheight' (or smaller if there
972is no room). The window is always full width and is positioned just above the
973command-line.
974
975
976EDIT
977
978You can now use commands to move around and edit the text in the window. Both
979in Normal mode and Insert mode.
980
981It is possible to use ":", "/" and other commands that use the command-line,
982but it's not possible to open another command-line window then. There is no
983nesting.
984 *E11*
985The command-line window is not a normal window. It is not possible to move to
986another window or edit another buffer. All commands that would do this are
987disabled in the command-line window. Of course it _is_ possible to execute
988any command that you entered in the command-line window.
989
990
991CLOSE *E199*
992
993There are several ways to leave the command-line window:
994
995<CR> Execute the command-line under the cursor. Works both in
996 Insert and in Normal mode.
997CTRL-C Continue in Command-line mode. The command-line under the
998 cursor is used as the command-line. Works both in Insert and
999 in Normal mode. ":close" also works. There is no redraw,
1000 thus the window will remain visible.
1001:quit Discard the command line and go back to Normal mode.
1002 ":exit", ":xit" and CTRL-\ CTRL-N also work.
1003:qall Quit Vim, unless there are changes in some buffer.
1004:qall! Quit Vim, discarding changes to any buffer.
1005
1006Once the command-line window is closed the old window sizes are restored. The
1007executed command applies to the window and buffer where the command-line was
1008started from. This works as if the command-line window was not there, except
1009that there will be an extra screen redraw.
1010The buffer used for the command-line window is deleted. Any changes to lines
1011other than the one that is executed with <CR> are lost.
1012
Bram Moolenaar36fc5352006-03-04 21:49:37 +00001013If you would like to execute the command under the cursor and then have the
1014command-line window open again, you may find this mapping useful: >
1015
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001016 :autocmd CmdwinEnter * map <buffer> <F5> <CR>q:
Bram Moolenaar36fc5352006-03-04 21:49:37 +00001017
Bram Moolenaar071d4272004-06-13 20:20:40 +00001018
1019VARIOUS
1020
1021The command-line window cannot be used:
1022- when there already is a command-line window (no nesting)
1023- for entering a encryption key or when using inputsecret()
1024- when Vim was not compiled with the +vertsplit feature
1025
1026Some options are set when the command-line window is opened:
1027'filetype' "vim", when editing an Ex command-line; this starts Vim syntax
1028 highlighting if it was enabled
1029'rightleft' off
1030'modifiable' on
1031'buftype' "nofile"
1032'swapfile' off
1033
1034It is allowed to write the buffer contents to a file. This is an easy way to
1035save the command-line history and read it back later.
1036
1037If the 'wildchar' option is set to <Tab>, and the command-line window is used
1038for an Ex command, then two mappings will be added to use <Tab> for completion
1039in the command-line window, like this: >
1040 :imap <buffer> <Tab> <C-X><C-V>
1041 :nmap <buffer> <Tab> a<C-X><C-V>
1042Note that hitting <Tab> in Normal mode will do completion on the next
1043character. That way it works at the end of the line.
1044If you don't want these mappings, disable them with: >
1045 au CmdwinEnter [:>] iunmap <Tab>
1046 au CmdwinEnter [:>] nunmap <Tab>
1047You could put these lines in your vimrc file.
1048
1049While in the command-line window you cannot use the mouse to put the cursor in
1050another window, or drag statuslines of other windows. You can drag the
1051statusline of the command-line window itself and the statusline above it.
1052Thus you can resize the command-line window, but not others.
1053
1054
1055AUTOCOMMANDS
1056
1057Two autocommand events are used: |CmdwinEnter| and |CmdwinLeave|. Since this
1058window is of a special type, the WinEnter, WinLeave, BufEnter and BufLeave
1059events are not triggered. You can use the Cmdwin events to do settings
1060specifically for the command-line window. Be careful not to cause side
1061effects!
1062Example: >
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001063 :au CmdwinEnter : let b:cpt_save = &cpt | set cpt=.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001064 :au CmdwinLeave : let &cpt = b:cpt_save
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001065This sets 'complete' to use completion in the current window for |i_CTRL-N|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001066Another example: >
1067 :au CmdwinEnter [/?] startinsert
1068This will make Vim start in Insert mode in the command-line window.
1069
1070 *cmdwin-char*
1071The character used for the pattern indicates the type of command-line:
1072 : normal Ex command
1073 > debug mode command |debug-mode|
1074 / forward search string
1075 ? backward search string
1076 = expression for "= |expr-register|
1077 @ string for |input()|
1078 - text for |:insert| or |:append|
1079
1080 vim:tw=78:ts=8:ft=help:norl: