blob: 7fe2a3442ea5befe95938bdb8120e037a9b91f36 [file] [log] [blame]
Bram Moolenaar256972a2015-12-29 19:10:25 +01001*cmdline.txt* For Vim version 7.4. Last change: 2015 Dec 17
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 Moolenaaradc21822011-04-01 18:03:16 +0200232CTRL-J *c_CTRL-J* *c_<NL>* *c_<CR>* *c_CR*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000233<CR> or <NL> start entered command
Bram Moolenaaradc21822011-04-01 18:03:16 +0200234 *c_<Esc>* *c_Esc*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000235<Esc> When typed and 'x' not present in 'cpoptions', quit
236 Command-line mode without executing. In macros or when 'x'
237 present in 'cpoptions', start entered command.
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000238 Note: If your <Esc> key is hard to hit on your keyboard, train
239 yourself to use CTRL-[.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000240 *c_CTRL-C*
241CTRL-C quit command-line without executing
242
Bram Moolenaaradc21822011-04-01 18:03:16 +0200243 *c_<Up>* *c_Up*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000244<Up> recall older command-line from history, whose beginning
245 matches the current command-line (see below).
246 {not available when compiled without the |+cmdline_hist|
247 feature}
Bram Moolenaaradc21822011-04-01 18:03:16 +0200248 *c_<Down>* *c_Down*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000249<Down> recall more recent command-line from history, whose beginning
250 matches the current command-line (see below).
251 {not available when compiled without the |+cmdline_hist|
252 feature}
253
254 *c_<S-Up>* *c_<PageUp>*
255<S-Up> or <PageUp>
256 recall older command-line from history
257 {not available when compiled without the |+cmdline_hist|
258 feature}
259 *c_<S-Down>* *c_<PageDown>*
260<S-Down> or <PageDown>
261 recall more recent command-line from history
262 {not available when compiled without the |+cmdline_hist|
263 feature}
264
265CTRL-D command-line completion (see |cmdline-completion|)
266'wildchar' option
267 command-line completion (see |cmdline-completion|)
268CTRL-N command-line completion (see |cmdline-completion|)
269CTRL-P command-line completion (see |cmdline-completion|)
270CTRL-A command-line completion (see |cmdline-completion|)
271CTRL-L command-line completion (see |cmdline-completion|)
272
273 *c_CTRL-_*
274CTRL-_ a - switch between Hebrew and English keyboard mode, which is
275 private to the command-line and not related to hkmap.
276 This is useful when Hebrew text entry is required in the
277 command-line, searches, abbreviations, etc. Applies only if
278 Vim is compiled with the |+rightleft| feature and the
279 'allowrevins' option is set.
280 See |rileft.txt|.
281
282 b - switch between Farsi and English keyboard mode, which is
283 private to the command-line and not related to fkmap. In
284 Farsi keyboard mode the characters are inserted in reverse
285 insert manner. This is useful when Farsi text entry is
286 required in the command-line, searches, abbreviations, etc.
287 Applies only if Vim is compiled with the |+farsi| feature.
288 See |farsi.txt|.
289
290 *c_CTRL-^*
291CTRL-^ Toggle the use of language |:lmap| mappings and/or Input
292 Method.
293 When typing a pattern for a search command and 'imsearch' is
294 not -1, VAL is the value of 'imsearch', otherwise VAL is the
295 value of 'iminsert'.
296 When language mappings are defined:
297 - If VAL is 1 (langmap mappings used) it becomes 0 (no langmap
298 mappings used).
299 - If VAL was not 1 it becomes 1, thus langmap mappings are
300 enabled.
301 When no language mappings are defined:
302 - If VAL is 2 (Input Method is used) it becomes 0 (no input
303 method used)
304 - If VAL has another value it becomes 2, thus the Input Method
305 is enabled.
306 These language mappings are normally used to type characters
307 that are different from what the keyboard produces. The
308 'keymap' option can be used to install a whole number of them.
309 When entering a command line, langmap mappings are switched
310 off, since you are expected to type a command. After
311 switching it on with CTRL-^, the new state is not used again
312 for the next command or Search pattern.
313 {not in Vi}
314
Bram Moolenaar9964e462007-05-05 17:54:07 +0000315 *c_CTRL-]*
316CTRL-] Trigger abbreviation, without inserting a character. {not in
317 Vi}
318
Bram Moolenaar071d4272004-06-13 20:20:40 +0000319For Emacs-style editing on the command-line see |emacs-keys|.
320
321The <Up> and <Down> keys take the current command-line as a search string.
322The beginning of the next/previous command-lines are compared with this
323string. The first line that matches is the new command-line. When typing
324these two keys repeatedly, the same string is used again. For example, this
325can be used to find the previous substitute command: Type ":s" and then <Up>.
326The same could be done by typing <S-Up> a number of times until the desired
327command-line is shown. (Note: the shifted arrow keys do not work on all
328terminals)
329
Bram Moolenaar066b6222008-01-04 14:17:47 +0000330 *:his* *:history*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000331:his[tory] Print the history of last entered commands.
332 {not in Vi}
333 {not available when compiled without the |+cmdline_hist|
334 feature}
335
336:his[tory] [{name}] [{first}][, [{last}]]
337 List the contents of history {name} which can be:
Bram Moolenaar5ae636b2012-04-30 18:48:53 +0200338 c[md] or : command-line history
339 s[earch] or / or ? search string history
340 e[xpr] or = expression register history
341 i[nput] or @ input line history
342 d[ebug] or > debug command history
343 a[ll] all of the above
Bram Moolenaar071d4272004-06-13 20:20:40 +0000344 {not in Vi}
345
346 If the numbers {first} and/or {last} are given, the respective
347 range of entries from a history is listed. These numbers can
348 be specified in the following form:
349 *:history-indexing*
350 A positive number represents the absolute index of an entry
351 as it is given in the first column of a :history listing.
352 This number remains fixed even if other entries are deleted.
353
354 A negative number means the relative position of an entry,
355 counted from the newest entry (which has index -1) backwards.
356
357 Examples:
358 List entries 6 to 12 from the search history: >
359 :history / 6,12
360<
361 List the recent five entries from all histories: >
362 :history all -5,
363
Bram Moolenaara939e432013-11-09 05:30:26 +0100364:keepp[atterns] {command} *:keepp* *:keeppatterns*
365 Execute {command}, without adding anything to the search
366 history
367
Bram Moolenaar071d4272004-06-13 20:20:40 +0000368==============================================================================
3692. Command-line completion *cmdline-completion*
370
371When editing the command-line, a few commands can be used to complete the
372word before the cursor. This is available for:
373
374- Command names: At the start of the command-line.
375- Tags: Only after the ":tag" command.
376- File names: Only after a command that accepts a file name or a setting for
377 an option that can be set to a file name. This is called file name
378 completion.
Bram Moolenaara2031822006-03-07 22:29:51 +0000379- Shell command names: After ":!cmd", ":r !cmd" and ":w !cmd". $PATH is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000380- Options: Only after the ":set" command.
381- Mappings: Only after a ":map" or similar command.
382- Variable and function names: Only after a ":if", ":call" or similar command.
383
Bram Moolenaar81af9252010-12-10 20:35:50 +0100384When Vim was compiled without the |+cmdline_compl| feature only file names,
385directories and help items can be completed. The number of help item matches
386is limited (currently to 300) to avoid a long delay when there are very many
387matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000388
389These are the commands that can be used:
390
391 *c_CTRL-D*
392CTRL-D List names that match the pattern in front of the cursor.
393 When showing file names, directories are highlighted (see
394 'highlight' option). Names where 'suffixes' matches are moved
395 to the end.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000396 The 'wildoptions' option can be set to "tagfile" to list the
397 file of matching tags.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000398 *c_CTRL-I* *c_wildchar* *c_<Tab>*
399'wildchar' option
400 A match is done on the pattern in front of the cursor. The
401 match (if there are several, the first match) is inserted
402 in place of the pattern. (Note: does not work inside a
403 macro, because <Tab> or <Esc> are mostly used as 'wildchar',
404 and these have a special meaning in some macros.) When typed
405 again and there were multiple matches, the next
406 match is inserted. After the last match, the first is used
407 again (wrap around).
408 The behavior can be changed with the 'wildmode' option.
409 *c_CTRL-N*
410CTRL-N After using 'wildchar' which got multiple matches, go to next
411 match. Otherwise recall more recent command-line from history.
Bram Moolenaar4d6f32c2016-08-26 19:13:46 +0200412 */_CTRL-N*
413 When 'incsearch' is set, entering a search pattern for "/" or
414 "?" and the current match is displayed then CTRL-N will move
415 to the next match (does not take |search-offset| into account)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000416<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.
Bram Moolenaar4d6f32c2016-08-26 19:13:46 +0200421 */_CTRL-P*
422 When 'incsearch' is set, entering a search pattern for "/" or
423 "?" and the current match is displayed then CTRL-P will move
424 to the previous match (does not take |search-offset| into account).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000425 *c_CTRL-A*
426CTRL-A All names that match the pattern in front of the cursor are
427 inserted.
428 *c_CTRL-L*
429CTRL-L A match is done on the pattern in front of the cursor. If
430 there is one match, it is inserted in place of the pattern.
431 If there are multiple matches the longest common part is
432 inserted in place of the pattern. If the result is shorter
433 than the pattern, no completion is done.
Bram Moolenaar4d6f32c2016-08-26 19:13:46 +0200434 */_CTRL-L*
Bram Moolenaard3667a22006-03-16 21:35:52 +0000435 When 'incsearch' is set, entering a search pattern for "/" or
436 "?" and the current match is displayed then CTRL-L will add
Bram Moolenaara9dc3752010-07-11 20:46:53 +0200437 one character from the end of the current match. If
438 'ignorecase' and 'smartcase' are set and the command line has
439 no uppercase characters, the added character is converted to
440 lowercase.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000441
442The 'wildchar' option defaults to <Tab> (CTRL-E when in Vi compatible mode; in
443a previous version <Esc> was used). In the pattern standard wildcards '*' and
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +0200444'?' are accepted when matching file names. '*' matches any string, '?'
445matches exactly one character.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000446
Bram Moolenaar5dc62522012-02-13 00:05:22 +0100447The 'wildignorecase' option can be set to ignore case in filenames.
448
Bram Moolenaar071d4272004-06-13 20:20:40 +0000449If you like tcsh's autolist completion, you can use this mapping:
450 :cnoremap X <C-L><C-D>
451(Where X is the command key to use, <C-L> is CTRL-L and <C-D> is CTRL-D)
452This will find the longest match and then list all matching files.
453
454If you like tcsh's autolist completion, you can use the 'wildmode' option to
455emulate it. For example, this mimics autolist=ambiguous:
456 :set wildmode=longest,list
457This will find the longest match with the first 'wildchar', then list all
458matching files with the next.
459
460 *suffixes*
461For file name completion you can use the 'suffixes' option to set a priority
462between files with almost the same name. If there are multiple matches,
463those files with an extension that is in the 'suffixes' option are ignored.
464The default is ".bak,~,.o,.h,.info,.swp,.obj", which means that files ending
465in ".bak", "~", ".o", ".h", ".info", ".swp" and ".obj" are sometimes ignored.
Bram Moolenaar055a2ba2009-07-14 19:40:21 +0000466
467An empty entry, two consecutive commas, match a file name that does not
468contain a ".", thus has no suffix. This is useful to ignore "prog" and prefer
469"prog.c".
470
471Examples:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000472
473 pattern: files: match: ~
474 test* test.c test.h test.o test.c
475 test* test.h test.o test.h and test.o
476 test* test.i test.h test.c test.i and test.c
477
Bram Moolenaar055a2ba2009-07-14 19:40:21 +0000478It is impossible to ignore suffixes with two dots.
479
Bram Moolenaar071d4272004-06-13 20:20:40 +0000480If there is more than one matching file (after ignoring the ones matching
481the 'suffixes' option) the first file name is inserted. You can see that
482there is only one match when you type 'wildchar' twice and the completed
483match stays the same. You can get to the other matches by entering
484'wildchar', CTRL-N or CTRL-P. All files are included, also the ones with
485extensions matching the 'suffixes' option.
486
487To completely ignore files with some extension use 'wildignore'.
488
Bram Moolenaar066b6222008-01-04 14:17:47 +0000489To match only files that end at the end of the typed text append a "$". For
490example, to match only files that end in ".c": >
491 :e *.c$
492This will not match a file ending in ".cpp". Without the "$" it does match.
493
Bram Moolenaar071d4272004-06-13 20:20:40 +0000494The old value of an option can be obtained by hitting 'wildchar' just after
495the '='. For example, typing 'wildchar' after ":set dir=" will insert the
496current value of 'dir'. This overrules file name completion for the options
497that take a file name.
498
499If you would like using <S-Tab> for CTRL-P in an xterm, put this command in
500your .cshrc: >
501 xmodmap -e "keysym Tab = Tab Find"
502And this in your .vimrc: >
503 :cmap <Esc>[1~ <C-P>
504
505==============================================================================
5063. Ex command-lines *cmdline-lines*
507
508The Ex commands have a few specialties:
509
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100510 *:quote* *:comment*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000511'"' at the start of a line causes the whole line to be ignored. '"'
512after a command causes the rest of the line to be ignored. This can be used
513to add comments. Example: >
514 :set ai "set 'autoindent' option
515It is not possible to add a comment to a shell command ":!cmd" or to the
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100516":map" command and a few others, because they see the '"' as part of their
517argument. This is mentioned where the command is explained.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000518
519 *:bar* *:\bar*
520'|' can be used to separate commands, so you can give multiple commands in one
521line. If you want to use '|' in an argument, precede it with '\'.
522
523These commands see the '|' as their argument, and can therefore not be
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000524followed by another Vim command:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000525 :argdo
526 :autocmd
527 :bufdo
Bram Moolenaaraa23b372015-09-08 18:46:31 +0200528 :cdo
529 :cfdo
Bram Moolenaar071d4272004-06-13 20:20:40 +0000530 :command
531 :cscope
532 :debug
533 :folddoopen
534 :folddoclosed
535 :function
536 :global
537 :help
538 :helpfind
Bram Moolenaar110bc6b2006-02-10 23:13:40 +0000539 :lcscope
Bram Moolenaaraa23b372015-09-08 18:46:31 +0200540 :ldo
541 :lfdo
Bram Moolenaar071d4272004-06-13 20:20:40 +0000542 :make
543 :normal
544 :perl
545 :perldo
546 :promptfind
547 :promptrepl
548 :pyfile
549 :python
550 :registers
551 :read !
552 :scscope
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200553 :sign
Bram Moolenaar071d4272004-06-13 20:20:40 +0000554 :tcl
555 :tcldo
556 :tclfile
557 :vglobal
558 :windo
559 :write !
560 :[range]!
561 a user defined command without the "-bar" argument |:command|
562
563Note that this is confusing (inherited from Vi): With ":g" the '|' is included
564in the command, with ":s" it is not.
565
566To be able to use another command anyway, use the ":execute" command.
567Example (append the output of "ls" and jump to the first line): >
568 :execute 'r !ls' | '[
569
570There is one exception: When the 'b' flag is present in 'cpoptions', with the
571":map" and ":abbr" commands and friends CTRL-V needs to be used instead of
572'\'. You can also use "<Bar>" instead. See also |map_bar|.
573
574Examples: >
575 :!ls | wc view the output of two commands
576 :r !ls | wc insert the same output in the text
577 :%g/foo/p|> moves all matching lines one shiftwidth
578 :%s/foo/bar/|> moves one line one shiftwidth
579 :map q 10^V| map "q" to "10|"
580 :map q 10\| map \ l map "q" to "10\" and map "\" to "l"
581 (when 'b' is present in 'cpoptions')
582
583You can also use <NL> to separate commands in the same way as with '|'. To
584insert a <NL> use CTRL-V CTRL-J. "^@" will be shown. Using '|' is the
585preferred method. But for external commands a <NL> must be used, because a
586'|' is included in the external command. To avoid the special meaning of <NL>
587it must be preceded with a backslash. Example: >
588 :r !date<NL>-join
589This reads the current date into the file and joins it with the previous line.
590
591Note that when the command before the '|' generates an error, the following
592commands will not be executed.
593
594
595Because of Vi compatibility the following strange commands are supported: >
596 :| print current line (like ":p")
597 :3| print line 3 (like ":3p")
598 :3 goto line 3
599
600A colon is allowed between the range and the command name. It is ignored
601(this is Vi compatible). For example: >
602 :1,$:s/pat/string
603
604When the character '%' or '#' is used where a file name is expected, they are
605expanded to the current and alternate file name (see the chapter "editing
606files" |:_%| |:_#|).
607
608Embedded spaces in file names are allowed on the Amiga if one file name is
609expected as argument. Trailing spaces will be ignored, unless escaped with a
610backslash or CTRL-V. Note that the ":next" command uses spaces to separate
611file names. Escape the spaces to include them in a file name. Example: >
612 :next foo\ bar goes\ to school\
613starts editing the three files "foo bar", "goes to" and "school ".
614
615When you want to use the special characters '"' or '|' in a command, or want
616to use '%' or '#' in a file name, precede them with a backslash. The
617backslash is not required in a range and in the ":substitute" command.
Bram Moolenaarf9132812015-07-21 19:19:13 +0200618See also |`=|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000619
620 *:_!*
621The '!' (bang) character after an Ex command makes the command behave in a
622different way. The '!' should be placed immediately after the command, without
623any blanks in between. If you insert blanks the '!' will be seen as an
624argument for the command, which has a different meaning. For example:
625 :w! name write the current buffer to file "name", overwriting
626 any existing file
627 :w !name send the current buffer as standard input to command
628 "name"
629
630==============================================================================
Bram Moolenaara5792f52005-11-23 21:25:05 +00006314. Ex command-line ranges *cmdline-ranges* *[range]* *E16*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000632
633Some Ex commands accept a line range in front of them. This is noted as
634[range]. It consists of one or more line specifiers, separated with ',' or
635';'.
636
637The basics are explained in section |10.3| of the user manual.
638
639 *:,* *:;*
640When separated with ';' the cursor position will be set to that line
641before interpreting the next line specifier. This doesn't happen for ','.
642Examples: >
643 4,/this line/
644< from line 4 till match with "this line" after the cursor line. >
645 5;/that line/
646< from line 5 till match with "that line" after line 5.
647
648The default line specifier for most commands is the cursor position, but the
649commands ":write" and ":global" have the whole file (1,$) as default.
650
651If more line specifiers are given than required for the command, the first
652one(s) will be ignored.
653
654Line numbers may be specified with: *:range* *E14* *{address}*
655 {number} an absolute line number
656 . the current line *:.*
657 $ the last line in the file *:$*
658 % equal to 1,$ (the entire file) *:%*
659 't position of mark t (lowercase) *:'*
660 'T position of mark T (uppercase); when the mark is in
661 another file it cannot be used in a range
662 /{pattern}[/] the next line where {pattern} matches *:/*
663 ?{pattern}[?] the previous line where {pattern} matches *:?*
664 \/ the next line where the previously used search
665 pattern matches
666 \? the previous line where the previously used search
667 pattern matches
668 \& the next line where the previously used substitute
669 pattern matches
670
671Each may be followed (several times) by '+' or '-' and an optional number.
672This number is added or subtracted from the preceding line number. If the
673number is omitted, 1 is used.
674
675The "/" and "?" after {pattern} are required to separate the pattern from
676anything that follows.
677
678The "/" and "?" may be preceded with another address. The search starts from
679there. The difference from using ';' is that the cursor isn't moved.
680Examples: >
681 /pat1//pat2/ Find line containing "pat2" after line containing
682 "pat1", without moving the cursor.
683 7;/pat2/ Find line containing "pat2", after line 7, leaving
684 the cursor in line 7.
685
686The {number} must be between 0 and the number of lines in the file. When
687using a 0 (zero) this is interpreted as a 1 by most commands. Commands that
688use it as a count do use it as a zero (|:tag|, |:pop|, etc). Some commands
689interpret the zero as "before the first line" (|:read|, search pattern, etc).
690
691Examples: >
692 .+3 three lines below the cursor
693 /that/+1 the line below the next line containing "that"
694 .,$ from current line until end of file
695 0;/that the first line containing "that", also matches in the
696 first line.
697 1;/that the first line after line 1 containing "that"
698
699Some commands allow for a count after the command. This count is used as the
700number of lines to be used, starting with the line given in the last line
701specifier (the default is the cursor line). The commands that accept a count
702are the ones that use a range but do not have a file name argument (because
703a file name can also be a number).
704
705Examples: >
706 :s/x/X/g 5 substitute 'x' by 'X' in the current line and four
707 following lines
708 :23d 4 delete lines 23, 24, 25 and 26
709
710
711Folds and Range
712
713When folds are active the line numbers are rounded off to include the whole
714closed fold. See |fold-behavior|.
715
716
Bram Moolenaara5792f52005-11-23 21:25:05 +0000717Reverse Range *E493*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000718
719A range should have the lower line number first. If this is not the case, Vim
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000720will ask you if it should swap the line numbers.
Bram Moolenaara5792f52005-11-23 21:25:05 +0000721 Backwards range given, OK to swap ~
722This is not done within the global command ":g".
723
724You can use ":silent" before a command to avoid the question, the range will
725always be swapped then.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000726
727
728Count and Range *N:*
729
730When giving a count before entering ":", this is translated into:
731 :.,.+(count - 1)
732In words: The 'count' lines at and after the cursor. Example: To delete
733three lines: >
734 3:d<CR> is translated into: .,.+2d<CR>
735<
736
737Visual Mode and Range *v_:*
738
739{Visual}: Starts a command-line with the Visual selected lines as a
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100740 range. The code `:'<,'>` is used for this range, which makes
Bram Moolenaar071d4272004-06-13 20:20:40 +0000741 it possible to select a similar line from the command-line
742 history for repeating a command on different Visually selected
743 lines.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100744 When Visual mode was already ended, a short way to use the
745 Visual area for a range is `:*`. This requires that "*" does
746 not appear in 'cpo', see |cpo-star|. Otherwise you will have
747 to type `:'<,'>`
748
Bram Moolenaar071d4272004-06-13 20:20:40 +0000749
750==============================================================================
Bram Moolenaardf177f62005-02-22 08:39:57 +00007515. Ex command-line flags *ex-flags*
752
753These flags are supported by a selection of Ex commands. They print the line
754that the cursor ends up after executing the command:
755
756 l output like for |:list|
757 # add line number
758 p output like for |:print|
759
760The flags can be combined, thus "l#" uses both a line number and |:list| style
761output.
762
763==============================================================================
7646. Ex special characters *cmdline-special*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000765
Bram Moolenaar8fa04452005-12-23 22:13:51 +0000766Note: These are special characters in the executed command line. If you want
767to insert special things while typing you can use the CTRL-R command. For
768example, "%" stands for the current file name, while CTRL-R % inserts the
769current file name right away. See |c_CTRL-R|.
770
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200771Note: If you want to avoid the effects of special characters in a Vim script
772you may want to use |fnameescape()|. Also see |`=|.
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000773
Bram Moolenaar8fa04452005-12-23 22:13:51 +0000774
Bram Moolenaar071d4272004-06-13 20:20:40 +0000775In Ex commands, at places where a file name can be used, the following
776characters have a special meaning. These can also be used in the expression
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200777function |expand()|.
Bram Moolenaard812df62008-11-09 12:46:09 +0000778 % Is replaced with the current file name. *:_%* *c_%*
779 # Is replaced with the alternate file name. *:_#* *c_#*
Bram Moolenaar36782082013-11-28 13:53:34 +0100780 This is remembered for every window.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100781 #n (where n is a number) is replaced with *:_#0* *:_#n*
782 the file name of buffer n. "#0" is the same as "#". *c_#n*
Bram Moolenaard812df62008-11-09 12:46:09 +0000783 ## Is replaced with all names in the argument list *:_##* *c_##*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000784 concatenated, separated by spaces. Each space in a name
785 is preceded with a backslash.
Bram Moolenaard812df62008-11-09 12:46:09 +0000786 #<n (where n is a number > 0) is replaced with old *:_#<* *c_#<*
787 file name n. See |:oldfiles| or |v:oldfiles| to get the
788 number. *E809*
Bram Moolenaardb84e452010-08-15 13:50:43 +0200789 {only when compiled with the |+eval| and |+viminfo| features}
Bram Moolenaard812df62008-11-09 12:46:09 +0000790
791Note that these, except "#<n", give the file name as it was typed. If an
792absolute path is needed (when using the file name from a different directory),
793you need to add ":p". See |filename-modifiers|.
794
795The "#<n" item returns an absolute path, but it will start with "~/" for files
796below your home directory.
797
Bram Moolenaar071d4272004-06-13 20:20:40 +0000798Note that backslashes are inserted before spaces, so that the command will
799correctly interpret the file name. But this doesn't happen for shell
Bram Moolenaard812df62008-11-09 12:46:09 +0000800commands. For those you probably have to use quotes (this fails for files
801that contain a quote and wildcards): >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000802 :!ls "%"
803 :r !spell "%"
804
805To avoid the special meaning of '%' and '#' insert a backslash before it.
806Detail: The special meaning is always escaped when there is a backslash before
807it, no matter how many backslashes.
808 you type: result ~
809 # alternate.file
810 \# #
811 \\# \#
Bram Moolenaarf9132812015-07-21 19:19:13 +0200812Also see |`=|.
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200813
Bram Moolenaar071d4272004-06-13 20:20:40 +0000814 *:<cword>* *:<cWORD>* *:<cfile>* *<cfile>*
815 *:<sfile>* *<sfile>* *:<afile>* *<afile>*
816 *:<abuf>* *<abuf>* *:<amatch>* *<amatch>*
Bram Moolenaar00654022011-02-25 14:42:19 +0100817 *<slnum>* *E495* *E496* *E497* *E499* *E500*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818Note: these are typed literally, they are not special keys!
819 <cword> is replaced with the word under the cursor (like |star|)
820 <cWORD> is replaced with the WORD under the cursor (see |WORD|)
821 <cfile> is replaced with the path name under the cursor (like what
822 |gf| uses)
Bram Moolenaar81af9252010-12-10 20:35:50 +0100823 <afile> When executing autocommands, is replaced with the file name
824 for a file read or write.
825 <abuf> When executing autocommands, is replaced with the currently
Bram Moolenaara2031822006-03-07 22:29:51 +0000826 effective buffer number (for ":r file" and ":so file" it is
827 the current buffer, the file being read/sourced is not in a
828 buffer).
Bram Moolenaar81af9252010-12-10 20:35:50 +0100829 <amatch> When executing autocommands, is replaced with the match for
Bram Moolenaar53180ce2005-07-05 21:48:14 +0000830 which this autocommand was executed. It differs from
Bram Moolenaar071d4272004-06-13 20:20:40 +0000831 <afile> only when the file name isn't used to match with
Bram Moolenaarb8a7b562006-02-01 21:47:16 +0000832 (for FileType, Syntax and SpellFileMissing events).
Bram Moolenaar81af9252010-12-10 20:35:50 +0100833 <sfile> When executing a ":source" command, is replaced with the
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200834 file name of the sourced file. *E498*
Bram Moolenaarca635012015-09-25 20:34:21 +0200835 When executing a function, is replaced with:
836 "function {function-name}[{lnum}]"
837 function call nesting is indicated like this:
838 "function {function-name1}[{lnum}]..{function-name2}[{lnum}]"
839 Note that filename-modifiers are useless when <sfile> is
840 used inside a function.
Bram Moolenaar81af9252010-12-10 20:35:50 +0100841 <slnum> When executing a ":source" command, is replaced with the
842 line number. *E842*
843 When executing a function it's the line number relative to
844 the start of the function.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000845
846 *filename-modifiers*
Bram Moolenaar251835e2014-02-24 02:51:51 +0100847*:_%:* *::8* *::p* *::.* *::~* *::h* *::t* *::r* *::e* *::s* *::gs* *::S*
848 *%:8* *%:p* *%:.* *%:~* *%:h* *%:t* *%:r* *%:e* *%:s* *%:gs* *%:S*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000849The file name modifiers can be used after "%", "#", "#n", "<cfile>", "<sfile>",
850"<afile>" or "<abuf>". They are also used with the |fnamemodify()| function.
851These are not available when Vim has been compiled without the |+modify_fname|
852feature.
853These modifiers can be given, in this order:
854 :p Make file name a full path. Must be the first modifier. Also
855 changes "~/" (and "~user/" for Unix and VMS) to the path for
856 the home directory. If the name is a directory a path
857 separator is added at the end. For a file name that does not
858 exist and does not have an absolute path the result is
Bram Moolenaar30b65812012-07-12 22:01:11 +0200859 unpredictable. On MS-Windows an 8.3 filename is expanded to
860 the long name.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000861 :8 Converts the path to 8.3 short format (currently only on
Bram Moolenaar30b65812012-07-12 22:01:11 +0200862 MS-Windows). Will act on as much of a path that is an
863 existing path.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000864 :~ Reduce file name to be relative to the home directory, if
865 possible. File name is unmodified if it is not below the home
866 directory.
867 :. Reduce file name to be relative to current directory, if
868 possible. File name is unmodified if it is not below the
869 current directory.
870 For maximum shortness, use ":~:.".
871 :h Head of the file name (the last component and any separators
872 removed). Cannot be used with :e, :r or :t.
873 Can be repeated to remove several components at the end.
874 When the file name ends in a path separator, only the path
875 separator is removed. Thus ":p:h" on a directory name results
876 on the directory name itself (without trailing slash).
877 When the file name is an absolute path (starts with "/" for
878 Unix; "x:\" for MS-DOS, WIN32, OS/2; "drive:" for Amiga), that
879 part is not removed. When there is no head (path is relative
880 to current directory) the result is empty.
881 :t Tail of the file name (last component of the name). Must
882 precede any :r or :e.
883 :r Root of the file name (the last extension removed). When
884 there is only an extension (file name that starts with '.',
885 e.g., ".vimrc"), it is not removed. Can be repeated to remove
886 several extensions (last one first).
887 :e Extension of the file name. Only makes sense when used alone.
888 When there is no extension the result is empty.
889 When there is only an extension (file name that starts with
890 '.'), the result is empty. Can be repeated to include more
891 extensions. If there are not enough extensions (but at least
892 one) as much as possible are included.
893 :s?pat?sub?
894 Substitute the first occurrence of "pat" with "sub". This
895 works like the |:s| command. "pat" is a regular expression.
896 Any character can be used for '?', but it must not occur in
897 "pat" or "sub".
898 After this, the previous modifiers can be used again. For
899 example ":p", to make a full path after the substitution.
900 :gs?pat?sub?
Bram Moolenaaradc21822011-04-01 18:03:16 +0200901 Substitute all occurrences of "pat" with "sub". Otherwise
Bram Moolenaar071d4272004-06-13 20:20:40 +0000902 this works like ":s".
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200903 :S Escape special characters for use with a shell command (see
Bram Moolenaar251835e2014-02-24 02:51:51 +0100904 |shellescape()|). Must be the last one. Examples: >
905 :!dir <cfile>:S
906 :call system('chmod +w -- ' . expand('%:S'))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000907
908Examples, when the file name is "src/version.c", current dir
909"/home/mool/vim": >
910 :p /home/mool/vim/src/version.c
911 :p:. src/version.c
912 :p:~ ~/vim/src/version.c
913 :h src
914 :p:h /home/mool/vim/src
915 :p:h:h /home/mool/vim
916 :t version.c
917 :p:t version.c
918 :r src/version
919 :p:r /home/mool/vim/src/version
920 :t:r version
921 :e c
922 :s?version?main? src/main.c
923 :s?version?main?:p /home/mool/vim/src/main.c
924 :p:gs?/?\\? \home\mool\vim\src\version.c
925
926Examples, when the file name is "src/version.c.gz": >
927 :p /home/mool/vim/src/version.c.gz
928 :e gz
929 :e:e c.gz
930 :e:e:e c.gz
931 :e:e:r c
932 :r src/version.c
933 :r:e c
934 :r:r src/version
935 :r:r:r src/version
936<
937 *extension-removal* *:_%<*
938If a "<" is appended to "%", "#", "#n" or "CTRL-V p" the extension of the file
939name is removed (everything after and including the last '.' in the file
940name). This is included for backwards compatibility with version 3.0, the
941":r" form is preferred. Examples: >
942
943 % current file name
944 %< current file name without extension
945 # alternate file name for current window
946 #< idem, without extension
947 #31 alternate file number 31
948 #31< idem, without extension
949 <cword> word under the cursor
950 <cWORD> WORD under the cursor (see |WORD|)
951 <cfile> path name under the cursor
952 <cfile>< idem, without extension
953
954Note: Where a file name is expected wildcards expansion is done. On Unix the
955shell is used for this, unless it can be done internally (for speed).
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200956Unless in |restricted-mode|, backticks work also, like in >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000957 :n `echo *.c`
Bram Moolenaar071d4272004-06-13 20:20:40 +0000958But expansion is only done if there are any wildcards before expanding the
959'%', '#', etc.. This avoids expanding wildcards inside a file name. If you
960want to expand the result of <cfile>, add a wildcard character to it.
961Examples: (alternate file name is "?readme?")
962 command expands to ~
963 :e # :e ?readme?
964 :e `ls #` :e {files matching "?readme?"}
965 :e #.* :e {files matching "?readme?.*"}
966 :cd <cfile> :cd {file name under cursor}
967 :cd <cfile>* :cd {file name under cursor plus "*" and then expanded}
Bram Moolenaarf9132812015-07-21 19:19:13 +0200968Also see |`=|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000969
970When the expanded argument contains a "!" and it is used for a shell command
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000971(":!cmd", ":r !cmd" or ":w !cmd"), the "!" is escaped with a backslash to
972avoid it being expanded into a previously used command. When the 'shell'
973option contains "sh", this is done twice, to avoid the shell trying to expand
974the "!".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000975
976 *filename-backslash*
977For filesystems that use a backslash as directory separator (MS-DOS, Windows,
978OS/2), it's a bit difficult to recognize a backslash that is used to escape
979the special meaning of the next character. The general rule is: If the
980backslash is followed by a normal file name character, it does not have a
981special meaning. Therefore "\file\foo" is a valid file name, you don't have
982to type the backslash twice.
983
984An exception is the '$' sign. It is a valid character in a file name. But
985to avoid a file name like "$home" to be interpreted as an environment variable,
986it needs to be preceded by a backslash. Therefore you need to use "/\$home"
987for the file "$home" in the root directory. A few examples:
988
989 FILE NAME INTERPRETED AS ~
990 $home expanded to value of environment var $home
991 \$home file "$home" in current directory
992 /\$home file "$home" in root directory
993 \\$home file "\\", followed by expanded $home
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200994
Bram Moolenaarf9132812015-07-21 19:19:13 +0200995Also see |`=|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000996
997==============================================================================
Bram Moolenaarac7bd632013-03-19 11:35:58 +01009987. Command-line window *cmdline-window* *cmdwin*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100999 *command-line-window*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001000In the command-line window the command line can be edited just like editing
1001text in any window. It is a special kind of window, because you cannot leave
1002it in a normal way.
1003{not available when compiled without the |+cmdline_hist| or |+vertsplit|
1004feature}
1005
1006
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001007OPEN *c_CTRL-F* *q:* *q/* *q?*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001008
1009There are two ways to open the command-line window:
10101. From Command-line mode, use the key specified with the 'cedit' option.
1011 The default is CTRL-F when 'compatible' is not set.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +010010122. From Normal mode, use the "q:", "q/" or "q?" command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001013 This starts editing an Ex command-line ("q:") or search string ("q/" or
1014 "q?"). Note that this is not possible while recording is in progress (the
1015 "q" stops recording then).
1016
1017When the window opens it is filled with the command-line history. The last
1018line contains the command as typed so far. The left column will show a
1019character that indicates the type of command-line being edited, see
1020|cmdwin-char|.
1021
1022Vim will be in Normal mode when the editor is opened, except when 'insertmode'
1023is set.
1024
1025The height of the window is specified with 'cmdwinheight' (or smaller if there
1026is no room). The window is always full width and is positioned just above the
1027command-line.
1028
1029
1030EDIT
1031
1032You can now use commands to move around and edit the text in the window. Both
1033in Normal mode and Insert mode.
1034
1035It is possible to use ":", "/" and other commands that use the command-line,
1036but it's not possible to open another command-line window then. There is no
1037nesting.
1038 *E11*
1039The command-line window is not a normal window. It is not possible to move to
1040another window or edit another buffer. All commands that would do this are
1041disabled in the command-line window. Of course it _is_ possible to execute
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001042any command that you entered in the command-line window. Other text edits are
1043discarded when closing the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001044
1045
1046CLOSE *E199*
1047
1048There are several ways to leave the command-line window:
1049
1050<CR> Execute the command-line under the cursor. Works both in
1051 Insert and in Normal mode.
1052CTRL-C Continue in Command-line mode. The command-line under the
1053 cursor is used as the command-line. Works both in Insert and
1054 in Normal mode. ":close" also works. There is no redraw,
1055 thus the window will remain visible.
1056:quit Discard the command line and go back to Normal mode.
1057 ":exit", ":xit" and CTRL-\ CTRL-N also work.
1058:qall Quit Vim, unless there are changes in some buffer.
1059:qall! Quit Vim, discarding changes to any buffer.
1060
1061Once the command-line window is closed the old window sizes are restored. The
1062executed command applies to the window and buffer where the command-line was
1063started from. This works as if the command-line window was not there, except
1064that there will be an extra screen redraw.
1065The buffer used for the command-line window is deleted. Any changes to lines
1066other than the one that is executed with <CR> are lost.
1067
Bram Moolenaar36fc5352006-03-04 21:49:37 +00001068If you would like to execute the command under the cursor and then have the
1069command-line window open again, you may find this mapping useful: >
1070
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001071 :autocmd CmdwinEnter * map <buffer> <F5> <CR>q:
Bram Moolenaar36fc5352006-03-04 21:49:37 +00001072
Bram Moolenaar071d4272004-06-13 20:20:40 +00001073
1074VARIOUS
1075
1076The command-line window cannot be used:
1077- when there already is a command-line window (no nesting)
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001078- for entering an encryption key or when using inputsecret()
Bram Moolenaardb84e452010-08-15 13:50:43 +02001079- when Vim was not compiled with the |+vertsplit| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001080
1081Some options are set when the command-line window is opened:
1082'filetype' "vim", when editing an Ex command-line; this starts Vim syntax
1083 highlighting if it was enabled
1084'rightleft' off
1085'modifiable' on
1086'buftype' "nofile"
1087'swapfile' off
1088
1089It is allowed to write the buffer contents to a file. This is an easy way to
1090save the command-line history and read it back later.
1091
1092If the 'wildchar' option is set to <Tab>, and the command-line window is used
1093for an Ex command, then two mappings will be added to use <Tab> for completion
1094in the command-line window, like this: >
1095 :imap <buffer> <Tab> <C-X><C-V>
1096 :nmap <buffer> <Tab> a<C-X><C-V>
1097Note that hitting <Tab> in Normal mode will do completion on the next
1098character. That way it works at the end of the line.
1099If you don't want these mappings, disable them with: >
1100 au CmdwinEnter [:>] iunmap <Tab>
1101 au CmdwinEnter [:>] nunmap <Tab>
1102You could put these lines in your vimrc file.
1103
1104While in the command-line window you cannot use the mouse to put the cursor in
1105another window, or drag statuslines of other windows. You can drag the
1106statusline of the command-line window itself and the statusline above it.
1107Thus you can resize the command-line window, but not others.
1108
Bram Moolenaarfb539272014-08-22 19:21:47 +02001109The |getcmdwintype()| function returns the type of the command-line being
1110edited as described in |cmdwin-char|.
1111
Bram Moolenaar071d4272004-06-13 20:20:40 +00001112
1113AUTOCOMMANDS
1114
1115Two autocommand events are used: |CmdwinEnter| and |CmdwinLeave|. Since this
1116window is of a special type, the WinEnter, WinLeave, BufEnter and BufLeave
1117events are not triggered. You can use the Cmdwin events to do settings
1118specifically for the command-line window. Be careful not to cause side
1119effects!
1120Example: >
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001121 :au CmdwinEnter : let b:cpt_save = &cpt | set cpt=.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001122 :au CmdwinLeave : let &cpt = b:cpt_save
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001123This sets 'complete' to use completion in the current window for |i_CTRL-N|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001124Another example: >
1125 :au CmdwinEnter [/?] startinsert
1126This will make Vim start in Insert mode in the command-line window.
1127
1128 *cmdwin-char*
1129The character used for the pattern indicates the type of command-line:
1130 : normal Ex command
1131 > debug mode command |debug-mode|
1132 / forward search string
1133 ? backward search string
1134 = expression for "= |expr-register|
1135 @ string for |input()|
1136 - text for |:insert| or |:append|
1137
1138 vim:tw=78:ts=8:ft=help:norl: