blob: aab2a3e32e57df82bd6a54f5dc4e329a02ceba0e [file] [log] [blame]
Bram Moolenaar2ec618c2016-10-01 14:47:05 +02001*cmdline.txt* For Vim version 8.0. Last change: 2016 Sep 27
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
Bram Moolenaar6e932462014-09-09 18:48:09 +020059(default: 50).
Bram Moolenaar071d4272004-06-13 20:20:40 +000060Notes:
61- When you enter a command-line that is exactly the same as an older one, the
62 old one is removed (to avoid repeated commands moving older commands out of
63 the history).
64- Only commands that are typed are remembered. Ones that completely come from
Bram Moolenaar3577c6f2008-06-24 21:16:56 +000065 mappings are not put in the history.
Bram Moolenaar071d4272004-06-13 20:20:40 +000066- All searches are put in the search history, including the ones that come
67 from commands like "*" and "#". But for a mapping, only the last search is
68 remembered (to avoid that long mappings trash the history).
69{Vi: no history}
70{not available when compiled without the |+cmdline_hist| feature}
71
72There is an automatic completion of names on the command-line; see
73|cmdline-completion|.
74
75 *c_CTRL-V*
76CTRL-V Insert next non-digit literally. Up to three digits form the
77 decimal value of a single byte. The non-digit and the three
78 digits are not considered for mapping. This works the same
79 way as in Insert mode (see above, |i_CTRL-V|).
80 Note: Under Windows CTRL-V is often mapped to paste text.
81 Use CTRL-Q instead then.
82 *c_CTRL-Q*
83CTRL-Q Same as CTRL-V. But with some terminals it is used for
84 control flow, it doesn't work then.
85
Bram Moolenaaradc21822011-04-01 18:03:16 +020086 *c_<Left>* *c_Left*
Bram Moolenaar071d4272004-06-13 20:20:40 +000087<Left> cursor left
Bram Moolenaaradc21822011-04-01 18:03:16 +020088 *c_<Right>* *c_Right*
Bram Moolenaar071d4272004-06-13 20:20:40 +000089<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
Bram Moolenaaradc21822011-04-01 18:03:16 +020096CTRL-B or <Home> *c_CTRL-B* *c_<Home>* *c_Home*
Bram Moolenaar071d4272004-06-13 20:20:40 +000097 cursor to beginning of command-line
Bram Moolenaaradc21822011-04-01 18:03:16 +020098CTRL-E or <End> *c_CTRL-E* *c_<End>* *c_End*
Bram Moolenaar071d4272004-06-13 20:20:40 +000099 cursor to end of command-line
100
101 *c_<LeftMouse>*
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000102<LeftMouse> Move the cursor to the position of the mouse click.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000103
Bram Moolenaar256972a2015-12-29 19:10:25 +0100104 *c_<MiddleMouse>*
105<MiddleMouse> Paste the contents of the clipboard (for X11 the primary
106 selection). This is similar to using CTRL-R *, but no CR
107 characters are inserted between lines.
108
Bram Moolenaaradc21822011-04-01 18:03:16 +0200109CTRL-H *c_<BS>* *c_CTRL-H* *c_BS*
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000110<BS> Delete the character in front of the cursor (see |:fixdel| if
Bram Moolenaar071d4272004-06-13 20:20:40 +0000111 your <BS> key does not do what you want).
Bram Moolenaaradc21822011-04-01 18:03:16 +0200112 *c_<Del>* *c_Del*
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000113<Del> Delete the character under the cursor (at end of line:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000114 character before the cursor) (see |:fixdel| if your <Del>
115 key does not do what you want).
116 *c_CTRL-W*
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000117CTRL-W Delete the |word| before the cursor. This depends on the
118 'iskeyword' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000119 *c_CTRL-U*
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000120CTRL-U Remove all characters between the cursor position and
Bram Moolenaar071d4272004-06-13 20:20:40 +0000121 the beginning of the line. Previous versions of vim
122 deleted all characters on the line. If that is the
123 preferred behavior, add the following to your .vimrc: >
124 :cnoremap <C-U> <C-E><C-U>
125<
Bram Moolenaaradc21822011-04-01 18:03:16 +0200126 *c_<Insert>* *c_Insert*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000127<Insert> Toggle between insert and overstrike. {not in Vi}
128
129{char1} <BS> {char2} or *c_digraph*
130CTRL-K {char1} {char2} *c_CTRL-K*
131 enter digraph (see |digraphs|). When {char1} is a special
132 key, the code for that key is inserted in <> form. {not in Vi}
133
134CTRL-R {0-9a-z"%#:-=.} *c_CTRL-R* *c_<C-R>*
135 Insert the contents of a numbered or named register. Between
136 typing CTRL-R and the second character '"' will be displayed
137 to indicate that you are expected to enter the name of a
138 register.
139 The text is inserted as if you typed it, but mappings and
140 abbreviations are not used. Command-line completion through
141 'wildchar' is not triggered though. And characters that end
142 the command line are inserted literally (<Esc>, <CR>, <NL>,
143 <C-C>). A <BS> or CTRL-W could still end the command line
144 though, and remaining characters will then be interpreted in
145 another mode, which might not be what you intended.
146 Special registers:
147 '"' the unnamed register, containing the text of
148 the last delete or yank
149 '%' the current file name
150 '#' the alternate file name
151 '*' the clipboard contents (X11: primary selection)
152 '+' the clipboard contents
153 '/' the last search pattern
154 ':' the last command-line
155 '-' the last small (less than a line) delete
156 '.' the last inserted text
157 *c_CTRL-R_=*
158 '=' the expression register: you are prompted to
159 enter an expression (see |expression|)
Bram Moolenaar05a7bb32006-01-19 22:09:32 +0000160 (doesn't work at the expression prompt; some
161 things such as changing the buffer or current
162 window are not allowed to avoid side effects)
Bram Moolenaard812df62008-11-09 12:46:09 +0000163 When the result is a |List| the items are used
164 as lines. They can have line breaks inside
165 too.
166 When the result is a Float it's automatically
167 converted to a String.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000168 See |registers| about registers. {not in Vi}
Bram Moolenaarfd371682005-01-14 21:42:54 +0000169 Implementation detail: When using the |expression| register
170 and invoking setcmdpos(), this sets the position before
171 inserting the resulting string. Use CTRL-R CTRL-R to set the
172 position afterwards.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000173
174CTRL-R CTRL-F *c_CTRL-R_CTRL-F* *c_<C-R>_<C-F>*
175CTRL-R CTRL-P *c_CTRL-R_CTRL-P* *c_<C-R>_<C-P>*
176CTRL-R CTRL-W *c_CTRL-R_CTRL-W* *c_<C-R>_<C-W>*
177CTRL-R CTRL-A *c_CTRL-R_CTRL-A* *c_<C-R>_<C-A>*
178 Insert the object under the cursor:
179 CTRL-F the Filename under the cursor
180 CTRL-P the Filename under the cursor, expanded with
181 'path' as in |gf|
182 CTRL-W the Word under the cursor
183 CTRL-A the WORD under the cursor; see |WORD|
Bram Moolenaard3667a22006-03-16 21:35:52 +0000184
185 When 'incsearch' is set the cursor position at the end of the
186 currently displayed match is used. With CTRL-W the part of
187 the word that was already typed is not inserted again.
188
Bram Moolenaar071d4272004-06-13 20:20:40 +0000189 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +0200190 CTRL-F and CTRL-P: {only when |+file_in_path| feature is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000191 included}
192
193 *c_CTRL-R_CTRL-R* *c_<C-R>_<C-R>*
194 *c_CTRL-R_CTRL-O* *c_<C-R>_<C-O>*
195CTRL-R CTRL-R {0-9a-z"%#:-=. CTRL-F CTRL-P CTRL-W CTRL-A}
196CTRL-R CTRL-O {0-9a-z"%#:-=. CTRL-F CTRL-P CTRL-W CTRL-A}
197 Insert register or object under the cursor. Works like
198 |c_CTRL-R| but inserts the text literally. For example, if
199 register a contains "xy^Hz" (where ^H is a backspace),
200 "CTRL-R a" will insert "xz" while "CTRL-R CTRL-R a" will
201 insert "xy^Hz".
202
203CTRL-\ e {expr} *c_CTRL-\_e*
204 Evaluate {expr} and replace the whole command line with the
205 result. You will be prompted for the expression, type <Enter>
206 to finish it. It's most useful in mappings though. See
207 |expression|.
208 See |c_CTRL-R_=| for inserting the result of an expression.
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +0000209 Useful functions are |getcmdtype()|, |getcmdline()| and
210 |getcmdpos()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000211 The cursor position is unchanged, except when the cursor was
212 at the end of the line, then it stays at the end.
213 |setcmdpos()| can be used to set the cursor position.
Bram Moolenaar4770d092006-01-12 23:22:24 +0000214 The |sandbox| is used for evaluating the expression to avoid
215 nasty side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000216 Example: >
217 :cmap <F7> <C-\>eAppendSome()<CR>
218 :func AppendSome()
219 :let cmd = getcmdline() . " Some()"
220 :" place the cursor on the )
221 :call setcmdpos(strlen(cmd))
222 :return cmd
223 :endfunc
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +0000224< This doesn't work recursively, thus not when already editing
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200225 an expression. But it is possible to use in a mapping.
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +0000226
Bram Moolenaar071d4272004-06-13 20:20:40 +0000227 *c_CTRL-Y*
228CTRL-Y When there is a modeless selection, copy the selection into
229 the clipboard. |modeless-selection|
230 If there is no selection CTRL-Y is inserted as a character.
231
Bram Moolenaar2ec618c2016-10-01 14:47:05 +0200232CTRL-M or CTRL-J *c_CTRL-M* *c_CTRL-J* *c_<NL>* *c_<CR>* *c_CR*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000233<CR> or <NL> start entered command
Bram Moolenaar2ec618c2016-10-01 14:47:05 +0200234
235CTRL-[ *c_CTRL-[* *c_<Esc>* *c_Esc*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000236<Esc> When typed and 'x' not present in 'cpoptions', quit
237 Command-line mode without executing. In macros or when 'x'
238 present in 'cpoptions', start entered command.
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000239 Note: If your <Esc> key is hard to hit on your keyboard, train
240 yourself to use CTRL-[.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000241 *c_CTRL-C*
242CTRL-C quit command-line without executing
243
Bram Moolenaaradc21822011-04-01 18:03:16 +0200244 *c_<Up>* *c_Up*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000245<Up> recall older command-line from history, whose beginning
246 matches the current command-line (see below).
247 {not available when compiled without the |+cmdline_hist|
248 feature}
Bram Moolenaaradc21822011-04-01 18:03:16 +0200249 *c_<Down>* *c_Down*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000250<Down> recall more recent command-line from history, whose beginning
251 matches the current command-line (see below).
252 {not available when compiled without the |+cmdline_hist|
253 feature}
254
255 *c_<S-Up>* *c_<PageUp>*
256<S-Up> or <PageUp>
257 recall older command-line from history
258 {not available when compiled without the |+cmdline_hist|
259 feature}
260 *c_<S-Down>* *c_<PageDown>*
261<S-Down> or <PageDown>
262 recall more recent command-line from history
263 {not available when compiled without the |+cmdline_hist|
264 feature}
265
266CTRL-D command-line completion (see |cmdline-completion|)
267'wildchar' option
268 command-line completion (see |cmdline-completion|)
269CTRL-N command-line completion (see |cmdline-completion|)
270CTRL-P command-line completion (see |cmdline-completion|)
271CTRL-A command-line completion (see |cmdline-completion|)
272CTRL-L command-line completion (see |cmdline-completion|)
273
274 *c_CTRL-_*
275CTRL-_ a - switch between Hebrew and English keyboard mode, which is
276 private to the command-line and not related to hkmap.
277 This is useful when Hebrew text entry is required in the
278 command-line, searches, abbreviations, etc. Applies only if
279 Vim is compiled with the |+rightleft| feature and the
280 'allowrevins' option is set.
281 See |rileft.txt|.
282
283 b - switch between Farsi and English keyboard mode, which is
284 private to the command-line and not related to fkmap. In
285 Farsi keyboard mode the characters are inserted in reverse
286 insert manner. This is useful when Farsi text entry is
287 required in the command-line, searches, abbreviations, etc.
288 Applies only if Vim is compiled with the |+farsi| feature.
289 See |farsi.txt|.
290
291 *c_CTRL-^*
292CTRL-^ Toggle the use of language |:lmap| mappings and/or Input
293 Method.
294 When typing a pattern for a search command and 'imsearch' is
295 not -1, VAL is the value of 'imsearch', otherwise VAL is the
296 value of 'iminsert'.
297 When language mappings are defined:
298 - If VAL is 1 (langmap mappings used) it becomes 0 (no langmap
299 mappings used).
300 - If VAL was not 1 it becomes 1, thus langmap mappings are
301 enabled.
302 When no language mappings are defined:
303 - If VAL is 2 (Input Method is used) it becomes 0 (no input
304 method used)
305 - If VAL has another value it becomes 2, thus the Input Method
306 is enabled.
307 These language mappings are normally used to type characters
308 that are different from what the keyboard produces. The
309 'keymap' option can be used to install a whole number of them.
310 When entering a command line, langmap mappings are switched
311 off, since you are expected to type a command. After
312 switching it on with CTRL-^, the new state is not used again
313 for the next command or Search pattern.
314 {not in Vi}
315
Bram Moolenaar9964e462007-05-05 17:54:07 +0000316 *c_CTRL-]*
317CTRL-] Trigger abbreviation, without inserting a character. {not in
318 Vi}
319
Bram Moolenaar071d4272004-06-13 20:20:40 +0000320For Emacs-style editing on the command-line see |emacs-keys|.
321
322The <Up> and <Down> keys take the current command-line as a search string.
323The beginning of the next/previous command-lines are compared with this
324string. The first line that matches is the new command-line. When typing
325these two keys repeatedly, the same string is used again. For example, this
326can be used to find the previous substitute command: Type ":s" and then <Up>.
327The same could be done by typing <S-Up> a number of times until the desired
328command-line is shown. (Note: the shifted arrow keys do not work on all
329terminals)
330
Bram Moolenaar066b6222008-01-04 14:17:47 +0000331 *:his* *:history*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000332:his[tory] Print the history of last entered commands.
333 {not in Vi}
334 {not available when compiled without the |+cmdline_hist|
335 feature}
336
337:his[tory] [{name}] [{first}][, [{last}]]
338 List the contents of history {name} which can be:
Bram Moolenaar5ae636b2012-04-30 18:48:53 +0200339 c[md] or : command-line history
340 s[earch] or / or ? search string history
341 e[xpr] or = expression register history
342 i[nput] or @ input line history
343 d[ebug] or > debug command history
344 a[ll] all of the above
Bram Moolenaar071d4272004-06-13 20:20:40 +0000345 {not in Vi}
346
347 If the numbers {first} and/or {last} are given, the respective
348 range of entries from a history is listed. These numbers can
349 be specified in the following form:
350 *:history-indexing*
351 A positive number represents the absolute index of an entry
352 as it is given in the first column of a :history listing.
353 This number remains fixed even if other entries are deleted.
354
355 A negative number means the relative position of an entry,
356 counted from the newest entry (which has index -1) backwards.
357
358 Examples:
359 List entries 6 to 12 from the search history: >
360 :history / 6,12
361<
Bram Moolenaareebd84e2016-12-01 17:57:44 +0100362 List the penultimate entry from all histories: >
363 :history all -2
364<
365 List the most recent two entries from all histories: >
366 :history all -2,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000367
Bram Moolenaara939e432013-11-09 05:30:26 +0100368:keepp[atterns] {command} *:keepp* *:keeppatterns*
369 Execute {command}, without adding anything to the search
370 history
371
Bram Moolenaar071d4272004-06-13 20:20:40 +0000372==============================================================================
3732. Command-line completion *cmdline-completion*
374
375When editing the command-line, a few commands can be used to complete the
376word before the cursor. This is available for:
377
378- Command names: At the start of the command-line.
379- Tags: Only after the ":tag" command.
380- File names: Only after a command that accepts a file name or a setting for
381 an option that can be set to a file name. This is called file name
382 completion.
Bram Moolenaara2031822006-03-07 22:29:51 +0000383- Shell command names: After ":!cmd", ":r !cmd" and ":w !cmd". $PATH is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000384- Options: Only after the ":set" command.
385- Mappings: Only after a ":map" or similar command.
386- Variable and function names: Only after a ":if", ":call" or similar command.
387
Bram Moolenaar81af9252010-12-10 20:35:50 +0100388When Vim was compiled without the |+cmdline_compl| feature only file names,
389directories and help items can be completed. The number of help item matches
390is limited (currently to 300) to avoid a long delay when there are very many
391matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000392
393These are the commands that can be used:
394
395 *c_CTRL-D*
396CTRL-D List names that match the pattern in front of the cursor.
397 When showing file names, directories are highlighted (see
398 'highlight' option). Names where 'suffixes' matches are moved
399 to the end.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000400 The 'wildoptions' option can be set to "tagfile" to list the
401 file of matching tags.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000402 *c_CTRL-I* *c_wildchar* *c_<Tab>*
403'wildchar' option
404 A match is done on the pattern in front of the cursor. The
405 match (if there are several, the first match) is inserted
406 in place of the pattern. (Note: does not work inside a
407 macro, because <Tab> or <Esc> are mostly used as 'wildchar',
408 and these have a special meaning in some macros.) When typed
409 again and there were multiple matches, the next
410 match is inserted. After the last match, the first is used
411 again (wrap around).
412 The behavior can be changed with the 'wildmode' option.
413 *c_CTRL-N*
414CTRL-N After using 'wildchar' which got multiple matches, go to next
415 match. Otherwise recall more recent command-line from history.
416<S-Tab> *c_CTRL-P* *c_<S-Tab>*
417CTRL-P After using 'wildchar' which got multiple matches, go to
418 previous match. Otherwise recall older command-line from
419 history. <S-Tab> only works with the GUI, on the Amiga and
420 with MS-DOS.
421 *c_CTRL-A*
422CTRL-A All names that match the pattern in front of the cursor are
423 inserted.
424 *c_CTRL-L*
425CTRL-L A match is done on the pattern in front of the cursor. If
426 there is one match, it is inserted in place of the pattern.
427 If there are multiple matches the longest common part is
428 inserted in place of the pattern. If the result is shorter
429 than the pattern, no completion is done.
Bram Moolenaar4d6f32c2016-08-26 19:13:46 +0200430 */_CTRL-L*
Bram Moolenaard3667a22006-03-16 21:35:52 +0000431 When 'incsearch' is set, entering a search pattern for "/" or
432 "?" and the current match is displayed then CTRL-L will add
Bram Moolenaara9dc3752010-07-11 20:46:53 +0200433 one character from the end of the current match. If
434 'ignorecase' and 'smartcase' are set and the command line has
435 no uppercase characters, the added character is converted to
436 lowercase.
Bram Moolenaar11956692016-08-27 16:26:56 +0200437 *c_CTRL-G* */_CTRL-G*
438CTRL-G When 'incsearch' is set, entering a search pattern for "/" or
439 "?" and the current match is displayed then CTRL-G will move
440 to the next match (does not take |search-offset| into account)
441 Use CTRL-T to move to the previous match. Hint: on a regular
442 keyboard T is above G.
443 *c_CTRL-T* */_CTRL-T*
444CTRL-T When 'incsearch' is set, entering a search pattern for "/" or
445 "?" and the current match is displayed then CTRL-T will move
446 to the previous match (does not take |search-offset| into
447 account).
448 Use CTRL-G to move to the next match. Hint: on a regular
449 keyboard T is above G.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000450
451The 'wildchar' option defaults to <Tab> (CTRL-E when in Vi compatible mode; in
452a previous version <Esc> was used). In the pattern standard wildcards '*' and
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +0200453'?' are accepted when matching file names. '*' matches any string, '?'
454matches exactly one character.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000455
Bram Moolenaar5dc62522012-02-13 00:05:22 +0100456The 'wildignorecase' option can be set to ignore case in filenames.
457
Bram Moolenaar071d4272004-06-13 20:20:40 +0000458If you like tcsh's autolist completion, you can use this mapping:
459 :cnoremap X <C-L><C-D>
460(Where X is the command key to use, <C-L> is CTRL-L and <C-D> is CTRL-D)
461This will find the longest match and then list all matching files.
462
463If you like tcsh's autolist completion, you can use the 'wildmode' option to
464emulate it. For example, this mimics autolist=ambiguous:
465 :set wildmode=longest,list
466This will find the longest match with the first 'wildchar', then list all
467matching files with the next.
468
469 *suffixes*
470For file name completion you can use the 'suffixes' option to set a priority
471between files with almost the same name. If there are multiple matches,
472those files with an extension that is in the 'suffixes' option are ignored.
473The default is ".bak,~,.o,.h,.info,.swp,.obj", which means that files ending
474in ".bak", "~", ".o", ".h", ".info", ".swp" and ".obj" are sometimes ignored.
Bram Moolenaar055a2ba2009-07-14 19:40:21 +0000475
476An empty entry, two consecutive commas, match a file name that does not
477contain a ".", thus has no suffix. This is useful to ignore "prog" and prefer
478"prog.c".
479
480Examples:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000481
482 pattern: files: match: ~
483 test* test.c test.h test.o test.c
484 test* test.h test.o test.h and test.o
485 test* test.i test.h test.c test.i and test.c
486
Bram Moolenaar055a2ba2009-07-14 19:40:21 +0000487It is impossible to ignore suffixes with two dots.
488
Bram Moolenaar071d4272004-06-13 20:20:40 +0000489If there is more than one matching file (after ignoring the ones matching
490the 'suffixes' option) the first file name is inserted. You can see that
491there is only one match when you type 'wildchar' twice and the completed
492match stays the same. You can get to the other matches by entering
493'wildchar', CTRL-N or CTRL-P. All files are included, also the ones with
494extensions matching the 'suffixes' option.
495
496To completely ignore files with some extension use 'wildignore'.
497
Bram Moolenaar066b6222008-01-04 14:17:47 +0000498To match only files that end at the end of the typed text append a "$". For
499example, to match only files that end in ".c": >
500 :e *.c$
501This will not match a file ending in ".cpp". Without the "$" it does match.
502
Bram Moolenaar071d4272004-06-13 20:20:40 +0000503The old value of an option can be obtained by hitting 'wildchar' just after
504the '='. For example, typing 'wildchar' after ":set dir=" will insert the
505current value of 'dir'. This overrules file name completion for the options
506that take a file name.
507
508If you would like using <S-Tab> for CTRL-P in an xterm, put this command in
509your .cshrc: >
510 xmodmap -e "keysym Tab = Tab Find"
511And this in your .vimrc: >
512 :cmap <Esc>[1~ <C-P>
513
514==============================================================================
5153. Ex command-lines *cmdline-lines*
516
517The Ex commands have a few specialties:
518
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100519 *:quote* *:comment*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000520'"' at the start of a line causes the whole line to be ignored. '"'
521after a command causes the rest of the line to be ignored. This can be used
522to add comments. Example: >
523 :set ai "set 'autoindent' option
524It is not possible to add a comment to a shell command ":!cmd" or to the
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100525":map" command and a few others, because they see the '"' as part of their
526argument. This is mentioned where the command is explained.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000527
528 *:bar* *:\bar*
529'|' can be used to separate commands, so you can give multiple commands in one
530line. If you want to use '|' in an argument, precede it with '\'.
531
532These commands see the '|' as their argument, and can therefore not be
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000533followed by another Vim command:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000534 :argdo
535 :autocmd
536 :bufdo
Bram Moolenaaraa23b372015-09-08 18:46:31 +0200537 :cdo
538 :cfdo
Bram Moolenaar071d4272004-06-13 20:20:40 +0000539 :command
540 :cscope
541 :debug
542 :folddoopen
543 :folddoclosed
544 :function
545 :global
546 :help
547 :helpfind
Bram Moolenaar110bc6b2006-02-10 23:13:40 +0000548 :lcscope
Bram Moolenaaraa23b372015-09-08 18:46:31 +0200549 :ldo
550 :lfdo
Bram Moolenaar071d4272004-06-13 20:20:40 +0000551 :make
552 :normal
553 :perl
554 :perldo
555 :promptfind
556 :promptrepl
557 :pyfile
558 :python
559 :registers
560 :read !
561 :scscope
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200562 :sign
Bram Moolenaar071d4272004-06-13 20:20:40 +0000563 :tcl
564 :tcldo
565 :tclfile
566 :vglobal
567 :windo
568 :write !
569 :[range]!
570 a user defined command without the "-bar" argument |:command|
571
572Note that this is confusing (inherited from Vi): With ":g" the '|' is included
573in the command, with ":s" it is not.
574
575To be able to use another command anyway, use the ":execute" command.
576Example (append the output of "ls" and jump to the first line): >
577 :execute 'r !ls' | '[
578
579There is one exception: When the 'b' flag is present in 'cpoptions', with the
580":map" and ":abbr" commands and friends CTRL-V needs to be used instead of
581'\'. You can also use "<Bar>" instead. See also |map_bar|.
582
583Examples: >
584 :!ls | wc view the output of two commands
585 :r !ls | wc insert the same output in the text
586 :%g/foo/p|> moves all matching lines one shiftwidth
587 :%s/foo/bar/|> moves one line one shiftwidth
588 :map q 10^V| map "q" to "10|"
589 :map q 10\| map \ l map "q" to "10\" and map "\" to "l"
590 (when 'b' is present in 'cpoptions')
591
592You can also use <NL> to separate commands in the same way as with '|'. To
593insert a <NL> use CTRL-V CTRL-J. "^@" will be shown. Using '|' is the
594preferred method. But for external commands a <NL> must be used, because a
595'|' is included in the external command. To avoid the special meaning of <NL>
596it must be preceded with a backslash. Example: >
597 :r !date<NL>-join
598This reads the current date into the file and joins it with the previous line.
599
600Note that when the command before the '|' generates an error, the following
601commands will not be executed.
602
603
604Because of Vi compatibility the following strange commands are supported: >
605 :| print current line (like ":p")
606 :3| print line 3 (like ":3p")
607 :3 goto line 3
608
609A colon is allowed between the range and the command name. It is ignored
610(this is Vi compatible). For example: >
611 :1,$:s/pat/string
612
613When the character '%' or '#' is used where a file name is expected, they are
614expanded to the current and alternate file name (see the chapter "editing
615files" |:_%| |:_#|).
616
617Embedded spaces in file names are allowed on the Amiga if one file name is
618expected as argument. Trailing spaces will be ignored, unless escaped with a
619backslash or CTRL-V. Note that the ":next" command uses spaces to separate
620file names. Escape the spaces to include them in a file name. Example: >
621 :next foo\ bar goes\ to school\
622starts editing the three files "foo bar", "goes to" and "school ".
623
624When you want to use the special characters '"' or '|' in a command, or want
625to use '%' or '#' in a file name, precede them with a backslash. The
626backslash is not required in a range and in the ":substitute" command.
Bram Moolenaarf9132812015-07-21 19:19:13 +0200627See also |`=|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000628
629 *:_!*
630The '!' (bang) character after an Ex command makes the command behave in a
631different way. The '!' should be placed immediately after the command, without
632any blanks in between. If you insert blanks the '!' will be seen as an
633argument for the command, which has a different meaning. For example:
634 :w! name write the current buffer to file "name", overwriting
635 any existing file
636 :w !name send the current buffer as standard input to command
637 "name"
638
639==============================================================================
Bram Moolenaara5792f52005-11-23 21:25:05 +00006404. Ex command-line ranges *cmdline-ranges* *[range]* *E16*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000641
642Some Ex commands accept a line range in front of them. This is noted as
643[range]. It consists of one or more line specifiers, separated with ',' or
644';'.
645
646The basics are explained in section |10.3| of the user manual.
647
648 *:,* *:;*
649When separated with ';' the cursor position will be set to that line
650before interpreting the next line specifier. This doesn't happen for ','.
651Examples: >
652 4,/this line/
653< from line 4 till match with "this line" after the cursor line. >
654 5;/that line/
655< from line 5 till match with "that line" after line 5.
656
657The default line specifier for most commands is the cursor position, but the
658commands ":write" and ":global" have the whole file (1,$) as default.
659
660If more line specifiers are given than required for the command, the first
661one(s) will be ignored.
662
663Line numbers may be specified with: *:range* *E14* *{address}*
664 {number} an absolute line number
665 . the current line *:.*
666 $ the last line in the file *:$*
667 % equal to 1,$ (the entire file) *:%*
668 't position of mark t (lowercase) *:'*
669 'T position of mark T (uppercase); when the mark is in
670 another file it cannot be used in a range
671 /{pattern}[/] the next line where {pattern} matches *:/*
672 ?{pattern}[?] the previous line where {pattern} matches *:?*
673 \/ the next line where the previously used search
674 pattern matches
675 \? the previous line where the previously used search
676 pattern matches
677 \& the next line where the previously used substitute
678 pattern matches
679
680Each may be followed (several times) by '+' or '-' and an optional number.
681This number is added or subtracted from the preceding line number. If the
682number is omitted, 1 is used.
683
684The "/" and "?" after {pattern} are required to separate the pattern from
685anything that follows.
686
687The "/" and "?" may be preceded with another address. The search starts from
688there. The difference from using ';' is that the cursor isn't moved.
689Examples: >
690 /pat1//pat2/ Find line containing "pat2" after line containing
691 "pat1", without moving the cursor.
692 7;/pat2/ Find line containing "pat2", after line 7, leaving
693 the cursor in line 7.
694
695The {number} must be between 0 and the number of lines in the file. When
696using a 0 (zero) this is interpreted as a 1 by most commands. Commands that
697use it as a count do use it as a zero (|:tag|, |:pop|, etc). Some commands
698interpret the zero as "before the first line" (|:read|, search pattern, etc).
699
700Examples: >
701 .+3 three lines below the cursor
702 /that/+1 the line below the next line containing "that"
703 .,$ from current line until end of file
704 0;/that the first line containing "that", also matches in the
705 first line.
706 1;/that the first line after line 1 containing "that"
707
708Some commands allow for a count after the command. This count is used as the
709number of lines to be used, starting with the line given in the last line
710specifier (the default is the cursor line). The commands that accept a count
711are the ones that use a range but do not have a file name argument (because
712a file name can also be a number).
713
714Examples: >
715 :s/x/X/g 5 substitute 'x' by 'X' in the current line and four
716 following lines
717 :23d 4 delete lines 23, 24, 25 and 26
718
719
720Folds and Range
721
722When folds are active the line numbers are rounded off to include the whole
723closed fold. See |fold-behavior|.
724
725
Bram Moolenaara5792f52005-11-23 21:25:05 +0000726Reverse Range *E493*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000727
728A range should have the lower line number first. If this is not the case, Vim
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000729will ask you if it should swap the line numbers.
Bram Moolenaara5792f52005-11-23 21:25:05 +0000730 Backwards range given, OK to swap ~
731This is not done within the global command ":g".
732
733You can use ":silent" before a command to avoid the question, the range will
734always be swapped then.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000735
736
737Count and Range *N:*
738
739When giving a count before entering ":", this is translated into:
740 :.,.+(count - 1)
741In words: The 'count' lines at and after the cursor. Example: To delete
742three lines: >
743 3:d<CR> is translated into: .,.+2d<CR>
744<
745
746Visual Mode and Range *v_:*
747
748{Visual}: Starts a command-line with the Visual selected lines as a
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100749 range. The code `:'<,'>` is used for this range, which makes
Bram Moolenaar071d4272004-06-13 20:20:40 +0000750 it possible to select a similar line from the command-line
751 history for repeating a command on different Visually selected
752 lines.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100753 When Visual mode was already ended, a short way to use the
754 Visual area for a range is `:*`. This requires that "*" does
755 not appear in 'cpo', see |cpo-star|. Otherwise you will have
756 to type `:'<,'>`
757
Bram Moolenaar071d4272004-06-13 20:20:40 +0000758
759==============================================================================
Bram Moolenaardf177f62005-02-22 08:39:57 +00007605. Ex command-line flags *ex-flags*
761
762These flags are supported by a selection of Ex commands. They print the line
763that the cursor ends up after executing the command:
764
765 l output like for |:list|
766 # add line number
767 p output like for |:print|
768
769The flags can be combined, thus "l#" uses both a line number and |:list| style
770output.
771
772==============================================================================
7736. Ex special characters *cmdline-special*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000774
Bram Moolenaar8fa04452005-12-23 22:13:51 +0000775Note: These are special characters in the executed command line. If you want
776to insert special things while typing you can use the CTRL-R command. For
777example, "%" stands for the current file name, while CTRL-R % inserts the
778current file name right away. See |c_CTRL-R|.
779
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200780Note: If you want to avoid the effects of special characters in a Vim script
781you may want to use |fnameescape()|. Also see |`=|.
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000782
Bram Moolenaar8fa04452005-12-23 22:13:51 +0000783
Bram Moolenaar071d4272004-06-13 20:20:40 +0000784In Ex commands, at places where a file name can be used, the following
785characters have a special meaning. These can also be used in the expression
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200786function |expand()|.
Bram Moolenaard812df62008-11-09 12:46:09 +0000787 % Is replaced with the current file name. *:_%* *c_%*
788 # Is replaced with the alternate file name. *:_#* *c_#*
Bram Moolenaar36782082013-11-28 13:53:34 +0100789 This is remembered for every window.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100790 #n (where n is a number) is replaced with *:_#0* *:_#n*
791 the file name of buffer n. "#0" is the same as "#". *c_#n*
Bram Moolenaard812df62008-11-09 12:46:09 +0000792 ## Is replaced with all names in the argument list *:_##* *c_##*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000793 concatenated, separated by spaces. Each space in a name
794 is preceded with a backslash.
Bram Moolenaard812df62008-11-09 12:46:09 +0000795 #<n (where n is a number > 0) is replaced with old *:_#<* *c_#<*
796 file name n. See |:oldfiles| or |v:oldfiles| to get the
797 number. *E809*
Bram Moolenaardb84e452010-08-15 13:50:43 +0200798 {only when compiled with the |+eval| and |+viminfo| features}
Bram Moolenaard812df62008-11-09 12:46:09 +0000799
800Note that these, except "#<n", give the file name as it was typed. If an
801absolute path is needed (when using the file name from a different directory),
802you need to add ":p". See |filename-modifiers|.
803
804The "#<n" item returns an absolute path, but it will start with "~/" for files
805below your home directory.
806
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807Note that backslashes are inserted before spaces, so that the command will
808correctly interpret the file name. But this doesn't happen for shell
Bram Moolenaard812df62008-11-09 12:46:09 +0000809commands. For those you probably have to use quotes (this fails for files
810that contain a quote and wildcards): >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811 :!ls "%"
812 :r !spell "%"
813
814To avoid the special meaning of '%' and '#' insert a backslash before it.
815Detail: The special meaning is always escaped when there is a backslash before
816it, no matter how many backslashes.
817 you type: result ~
818 # alternate.file
819 \# #
820 \\# \#
Bram Moolenaarf9132812015-07-21 19:19:13 +0200821Also see |`=|.
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200822
Bram Moolenaar071d4272004-06-13 20:20:40 +0000823 *:<cword>* *:<cWORD>* *:<cfile>* *<cfile>*
824 *:<sfile>* *<sfile>* *:<afile>* *<afile>*
825 *:<abuf>* *<abuf>* *:<amatch>* *<amatch>*
Bram Moolenaar00654022011-02-25 14:42:19 +0100826 *<slnum>* *E495* *E496* *E497* *E499* *E500*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000827Note: these are typed literally, they are not special keys!
828 <cword> is replaced with the word under the cursor (like |star|)
829 <cWORD> is replaced with the WORD under the cursor (see |WORD|)
830 <cfile> is replaced with the path name under the cursor (like what
831 |gf| uses)
Bram Moolenaar81af9252010-12-10 20:35:50 +0100832 <afile> When executing autocommands, is replaced with the file name
833 for a file read or write.
834 <abuf> When executing autocommands, is replaced with the currently
Bram Moolenaara2031822006-03-07 22:29:51 +0000835 effective buffer number (for ":r file" and ":so file" it is
836 the current buffer, the file being read/sourced is not in a
837 buffer).
Bram Moolenaar81af9252010-12-10 20:35:50 +0100838 <amatch> When executing autocommands, is replaced with the match for
Bram Moolenaar53180ce2005-07-05 21:48:14 +0000839 which this autocommand was executed. It differs from
Bram Moolenaar071d4272004-06-13 20:20:40 +0000840 <afile> only when the file name isn't used to match with
Bram Moolenaarb8a7b562006-02-01 21:47:16 +0000841 (for FileType, Syntax and SpellFileMissing events).
Bram Moolenaar81af9252010-12-10 20:35:50 +0100842 <sfile> When executing a ":source" command, is replaced with the
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200843 file name of the sourced file. *E498*
Bram Moolenaarca635012015-09-25 20:34:21 +0200844 When executing a function, is replaced with:
845 "function {function-name}[{lnum}]"
846 function call nesting is indicated like this:
847 "function {function-name1}[{lnum}]..{function-name2}[{lnum}]"
848 Note that filename-modifiers are useless when <sfile> is
849 used inside a function.
Bram Moolenaar81af9252010-12-10 20:35:50 +0100850 <slnum> When executing a ":source" command, is replaced with the
851 line number. *E842*
852 When executing a function it's the line number relative to
853 the start of the function.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000854
855 *filename-modifiers*
Bram Moolenaar251835e2014-02-24 02:51:51 +0100856*:_%:* *::8* *::p* *::.* *::~* *::h* *::t* *::r* *::e* *::s* *::gs* *::S*
857 *%:8* *%:p* *%:.* *%:~* *%:h* *%:t* *%:r* *%:e* *%:s* *%:gs* *%:S*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000858The file name modifiers can be used after "%", "#", "#n", "<cfile>", "<sfile>",
859"<afile>" or "<abuf>". They are also used with the |fnamemodify()| function.
860These are not available when Vim has been compiled without the |+modify_fname|
861feature.
862These modifiers can be given, in this order:
863 :p Make file name a full path. Must be the first modifier. Also
864 changes "~/" (and "~user/" for Unix and VMS) to the path for
865 the home directory. If the name is a directory a path
866 separator is added at the end. For a file name that does not
867 exist and does not have an absolute path the result is
Bram Moolenaar30b65812012-07-12 22:01:11 +0200868 unpredictable. On MS-Windows an 8.3 filename is expanded to
869 the long name.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000870 :8 Converts the path to 8.3 short format (currently only on
Bram Moolenaar30b65812012-07-12 22:01:11 +0200871 MS-Windows). Will act on as much of a path that is an
872 existing path.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000873 :~ Reduce file name to be relative to the home directory, if
874 possible. File name is unmodified if it is not below the home
875 directory.
876 :. Reduce file name to be relative to current directory, if
877 possible. File name is unmodified if it is not below the
878 current directory.
879 For maximum shortness, use ":~:.".
880 :h Head of the file name (the last component and any separators
881 removed). Cannot be used with :e, :r or :t.
882 Can be repeated to remove several components at the end.
883 When the file name ends in a path separator, only the path
884 separator is removed. Thus ":p:h" on a directory name results
885 on the directory name itself (without trailing slash).
886 When the file name is an absolute path (starts with "/" for
887 Unix; "x:\" for MS-DOS, WIN32, OS/2; "drive:" for Amiga), that
888 part is not removed. When there is no head (path is relative
889 to current directory) the result is empty.
890 :t Tail of the file name (last component of the name). Must
891 precede any :r or :e.
892 :r Root of the file name (the last extension removed). When
893 there is only an extension (file name that starts with '.',
894 e.g., ".vimrc"), it is not removed. Can be repeated to remove
895 several extensions (last one first).
896 :e Extension of the file name. Only makes sense when used alone.
897 When there is no extension the result is empty.
898 When there is only an extension (file name that starts with
899 '.'), the result is empty. Can be repeated to include more
900 extensions. If there are not enough extensions (but at least
901 one) as much as possible are included.
902 :s?pat?sub?
903 Substitute the first occurrence of "pat" with "sub". This
904 works like the |:s| command. "pat" is a regular expression.
905 Any character can be used for '?', but it must not occur in
906 "pat" or "sub".
907 After this, the previous modifiers can be used again. For
908 example ":p", to make a full path after the substitution.
909 :gs?pat?sub?
Bram Moolenaaradc21822011-04-01 18:03:16 +0200910 Substitute all occurrences of "pat" with "sub". Otherwise
Bram Moolenaar071d4272004-06-13 20:20:40 +0000911 this works like ":s".
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200912 :S Escape special characters for use with a shell command (see
Bram Moolenaar251835e2014-02-24 02:51:51 +0100913 |shellescape()|). Must be the last one. Examples: >
914 :!dir <cfile>:S
915 :call system('chmod +w -- ' . expand('%:S'))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000916
917Examples, when the file name is "src/version.c", current dir
918"/home/mool/vim": >
919 :p /home/mool/vim/src/version.c
920 :p:. src/version.c
921 :p:~ ~/vim/src/version.c
922 :h src
923 :p:h /home/mool/vim/src
924 :p:h:h /home/mool/vim
925 :t version.c
926 :p:t version.c
927 :r src/version
928 :p:r /home/mool/vim/src/version
929 :t:r version
930 :e c
931 :s?version?main? src/main.c
932 :s?version?main?:p /home/mool/vim/src/main.c
933 :p:gs?/?\\? \home\mool\vim\src\version.c
934
935Examples, when the file name is "src/version.c.gz": >
936 :p /home/mool/vim/src/version.c.gz
937 :e gz
938 :e:e c.gz
939 :e:e:e c.gz
940 :e:e:r c
941 :r src/version.c
942 :r:e c
943 :r:r src/version
944 :r:r:r src/version
945<
946 *extension-removal* *:_%<*
947If a "<" is appended to "%", "#", "#n" or "CTRL-V p" the extension of the file
948name is removed (everything after and including the last '.' in the file
949name). This is included for backwards compatibility with version 3.0, the
950":r" form is preferred. Examples: >
951
952 % current file name
953 %< current file name without extension
954 # alternate file name for current window
955 #< idem, without extension
956 #31 alternate file number 31
957 #31< idem, without extension
958 <cword> word under the cursor
959 <cWORD> WORD under the cursor (see |WORD|)
960 <cfile> path name under the cursor
961 <cfile>< idem, without extension
962
963Note: Where a file name is expected wildcards expansion is done. On Unix the
964shell is used for this, unless it can be done internally (for speed).
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200965Unless in |restricted-mode|, backticks work also, like in >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000966 :n `echo *.c`
Bram Moolenaar071d4272004-06-13 20:20:40 +0000967But expansion is only done if there are any wildcards before expanding the
968'%', '#', etc.. This avoids expanding wildcards inside a file name. If you
969want to expand the result of <cfile>, add a wildcard character to it.
970Examples: (alternate file name is "?readme?")
971 command expands to ~
972 :e # :e ?readme?
973 :e `ls #` :e {files matching "?readme?"}
974 :e #.* :e {files matching "?readme?.*"}
975 :cd <cfile> :cd {file name under cursor}
976 :cd <cfile>* :cd {file name under cursor plus "*" and then expanded}
Bram Moolenaarf9132812015-07-21 19:19:13 +0200977Also see |`=|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000978
979When the expanded argument contains a "!" and it is used for a shell command
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000980(":!cmd", ":r !cmd" or ":w !cmd"), the "!" is escaped with a backslash to
981avoid it being expanded into a previously used command. When the 'shell'
982option contains "sh", this is done twice, to avoid the shell trying to expand
983the "!".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000984
985 *filename-backslash*
986For filesystems that use a backslash as directory separator (MS-DOS, Windows,
987OS/2), it's a bit difficult to recognize a backslash that is used to escape
988the special meaning of the next character. The general rule is: If the
989backslash is followed by a normal file name character, it does not have a
990special meaning. Therefore "\file\foo" is a valid file name, you don't have
991to type the backslash twice.
992
993An exception is the '$' sign. It is a valid character in a file name. But
994to avoid a file name like "$home" to be interpreted as an environment variable,
995it needs to be preceded by a backslash. Therefore you need to use "/\$home"
996for the file "$home" in the root directory. A few examples:
997
998 FILE NAME INTERPRETED AS ~
999 $home expanded to value of environment var $home
1000 \$home file "$home" in current directory
1001 /\$home file "$home" in root directory
1002 \\$home file "\\", followed by expanded $home
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +02001003
Bram Moolenaarf9132812015-07-21 19:19:13 +02001004Also see |`=|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005
1006==============================================================================
Bram Moolenaarac7bd632013-03-19 11:35:58 +010010077. Command-line window *cmdline-window* *cmdwin*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001008 *command-line-window*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001009In the command-line window the command line can be edited just like editing
1010text in any window. It is a special kind of window, because you cannot leave
1011it in a normal way.
1012{not available when compiled without the |+cmdline_hist| or |+vertsplit|
1013feature}
1014
1015
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001016OPEN *c_CTRL-F* *q:* *q/* *q?*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001017
1018There are two ways to open the command-line window:
10191. From Command-line mode, use the key specified with the 'cedit' option.
1020 The default is CTRL-F when 'compatible' is not set.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +010010212. From Normal mode, use the "q:", "q/" or "q?" command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001022 This starts editing an Ex command-line ("q:") or search string ("q/" or
1023 "q?"). Note that this is not possible while recording is in progress (the
1024 "q" stops recording then).
1025
1026When the window opens it is filled with the command-line history. The last
1027line contains the command as typed so far. The left column will show a
1028character that indicates the type of command-line being edited, see
1029|cmdwin-char|.
1030
1031Vim will be in Normal mode when the editor is opened, except when 'insertmode'
1032is set.
1033
1034The height of the window is specified with 'cmdwinheight' (or smaller if there
1035is no room). The window is always full width and is positioned just above the
1036command-line.
1037
1038
1039EDIT
1040
1041You can now use commands to move around and edit the text in the window. Both
1042in Normal mode and Insert mode.
1043
1044It is possible to use ":", "/" and other commands that use the command-line,
1045but it's not possible to open another command-line window then. There is no
1046nesting.
1047 *E11*
1048The command-line window is not a normal window. It is not possible to move to
1049another window or edit another buffer. All commands that would do this are
1050disabled in the command-line window. Of course it _is_ possible to execute
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001051any command that you entered in the command-line window. Other text edits are
1052discarded when closing the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001053
1054
1055CLOSE *E199*
1056
1057There are several ways to leave the command-line window:
1058
1059<CR> Execute the command-line under the cursor. Works both in
1060 Insert and in Normal mode.
1061CTRL-C Continue in Command-line mode. The command-line under the
1062 cursor is used as the command-line. Works both in Insert and
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01001063 in Normal mode. There is no redraw, thus the window will
1064 remain visible.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001065:quit Discard the command line and go back to Normal mode.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01001066 ":close", ":exit", ":xit" and CTRL-\ CTRL-N also work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001067:qall Quit Vim, unless there are changes in some buffer.
1068:qall! Quit Vim, discarding changes to any buffer.
1069
1070Once the command-line window is closed the old window sizes are restored. The
1071executed command applies to the window and buffer where the command-line was
1072started from. This works as if the command-line window was not there, except
1073that there will be an extra screen redraw.
1074The buffer used for the command-line window is deleted. Any changes to lines
1075other than the one that is executed with <CR> are lost.
1076
Bram Moolenaar36fc5352006-03-04 21:49:37 +00001077If you would like to execute the command under the cursor and then have the
1078command-line window open again, you may find this mapping useful: >
1079
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001080 :autocmd CmdwinEnter * map <buffer> <F5> <CR>q:
Bram Moolenaar36fc5352006-03-04 21:49:37 +00001081
Bram Moolenaar071d4272004-06-13 20:20:40 +00001082
1083VARIOUS
1084
1085The command-line window cannot be used:
1086- when there already is a command-line window (no nesting)
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001087- for entering an encryption key or when using inputsecret()
Bram Moolenaardb84e452010-08-15 13:50:43 +02001088- when Vim was not compiled with the |+vertsplit| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001089
1090Some options are set when the command-line window is opened:
1091'filetype' "vim", when editing an Ex command-line; this starts Vim syntax
1092 highlighting if it was enabled
1093'rightleft' off
1094'modifiable' on
1095'buftype' "nofile"
1096'swapfile' off
1097
1098It is allowed to write the buffer contents to a file. This is an easy way to
1099save the command-line history and read it back later.
1100
1101If the 'wildchar' option is set to <Tab>, and the command-line window is used
1102for an Ex command, then two mappings will be added to use <Tab> for completion
1103in the command-line window, like this: >
1104 :imap <buffer> <Tab> <C-X><C-V>
1105 :nmap <buffer> <Tab> a<C-X><C-V>
1106Note that hitting <Tab> in Normal mode will do completion on the next
1107character. That way it works at the end of the line.
1108If you don't want these mappings, disable them with: >
1109 au CmdwinEnter [:>] iunmap <Tab>
1110 au CmdwinEnter [:>] nunmap <Tab>
1111You could put these lines in your vimrc file.
1112
1113While in the command-line window you cannot use the mouse to put the cursor in
1114another window, or drag statuslines of other windows. You can drag the
1115statusline of the command-line window itself and the statusline above it.
1116Thus you can resize the command-line window, but not others.
1117
Bram Moolenaarfb539272014-08-22 19:21:47 +02001118The |getcmdwintype()| function returns the type of the command-line being
1119edited as described in |cmdwin-char|.
1120
Bram Moolenaar071d4272004-06-13 20:20:40 +00001121
1122AUTOCOMMANDS
1123
1124Two autocommand events are used: |CmdwinEnter| and |CmdwinLeave|. Since this
1125window is of a special type, the WinEnter, WinLeave, BufEnter and BufLeave
1126events are not triggered. You can use the Cmdwin events to do settings
1127specifically for the command-line window. Be careful not to cause side
1128effects!
1129Example: >
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001130 :au CmdwinEnter : let b:cpt_save = &cpt | set cpt=.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001131 :au CmdwinLeave : let &cpt = b:cpt_save
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001132This sets 'complete' to use completion in the current window for |i_CTRL-N|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001133Another example: >
1134 :au CmdwinEnter [/?] startinsert
1135This will make Vim start in Insert mode in the command-line window.
1136
1137 *cmdwin-char*
1138The character used for the pattern indicates the type of command-line:
1139 : normal Ex command
1140 > debug mode command |debug-mode|
1141 / forward search string
1142 ? backward search string
1143 = expression for "= |expr-register|
1144 @ string for |input()|
1145 - text for |:insert| or |:append|
1146
1147 vim:tw=78:ts=8:ft=help:norl: