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