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