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