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