blob: a0e37b53c174891f6535570f9af02fbca838035c [file] [log] [blame]
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001*cmdline.txt* For Vim version 8.0. Last change: 2017 Sep 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 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 Moolenaar74675a62017-07-15 13:53:23 +0200458The 'wildmenu' option can be set to show the matches just above the command
459line.
460
Bram Moolenaar071d4272004-06-13 20:20:40 +0000461If you like tcsh's autolist completion, you can use this mapping:
462 :cnoremap X <C-L><C-D>
463(Where X is the command key to use, <C-L> is CTRL-L and <C-D> is CTRL-D)
464This will find the longest match and then list all matching files.
465
466If you like tcsh's autolist completion, you can use the 'wildmode' option to
467emulate it. For example, this mimics autolist=ambiguous:
468 :set wildmode=longest,list
469This will find the longest match with the first 'wildchar', then list all
470matching files with the next.
471
472 *suffixes*
473For file name completion you can use the 'suffixes' option to set a priority
474between files with almost the same name. If there are multiple matches,
475those files with an extension that is in the 'suffixes' option are ignored.
476The default is ".bak,~,.o,.h,.info,.swp,.obj", which means that files ending
477in ".bak", "~", ".o", ".h", ".info", ".swp" and ".obj" are sometimes ignored.
Bram Moolenaar055a2ba2009-07-14 19:40:21 +0000478
479An empty entry, two consecutive commas, match a file name that does not
480contain a ".", thus has no suffix. This is useful to ignore "prog" and prefer
481"prog.c".
482
483Examples:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000484
485 pattern: files: match: ~
486 test* test.c test.h test.o test.c
487 test* test.h test.o test.h and test.o
488 test* test.i test.h test.c test.i and test.c
489
Bram Moolenaar055a2ba2009-07-14 19:40:21 +0000490It is impossible to ignore suffixes with two dots.
491
Bram Moolenaar071d4272004-06-13 20:20:40 +0000492If there is more than one matching file (after ignoring the ones matching
493the 'suffixes' option) the first file name is inserted. You can see that
494there is only one match when you type 'wildchar' twice and the completed
495match stays the same. You can get to the other matches by entering
496'wildchar', CTRL-N or CTRL-P. All files are included, also the ones with
497extensions matching the 'suffixes' option.
498
499To completely ignore files with some extension use 'wildignore'.
500
Bram Moolenaar066b6222008-01-04 14:17:47 +0000501To match only files that end at the end of the typed text append a "$". For
502example, to match only files that end in ".c": >
503 :e *.c$
504This will not match a file ending in ".cpp". Without the "$" it does match.
505
Bram Moolenaar071d4272004-06-13 20:20:40 +0000506The old value of an option can be obtained by hitting 'wildchar' just after
507the '='. For example, typing 'wildchar' after ":set dir=" will insert the
508current value of 'dir'. This overrules file name completion for the options
509that take a file name.
510
511If you would like using <S-Tab> for CTRL-P in an xterm, put this command in
512your .cshrc: >
513 xmodmap -e "keysym Tab = Tab Find"
514And this in your .vimrc: >
515 :cmap <Esc>[1~ <C-P>
516
517==============================================================================
5183. Ex command-lines *cmdline-lines*
519
520The Ex commands have a few specialties:
521
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100522 *:quote* *:comment*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000523'"' at the start of a line causes the whole line to be ignored. '"'
524after a command causes the rest of the line to be ignored. This can be used
525to add comments. Example: >
526 :set ai "set 'autoindent' option
527It is not possible to add a comment to a shell command ":!cmd" or to the
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100528":map" command and a few others, because they see the '"' as part of their
529argument. This is mentioned where the command is explained.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000530
531 *:bar* *:\bar*
532'|' can be used to separate commands, so you can give multiple commands in one
533line. If you want to use '|' in an argument, precede it with '\'.
534
535These commands see the '|' as their argument, and can therefore not be
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000536followed by another Vim command:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537 :argdo
538 :autocmd
539 :bufdo
Bram Moolenaaraa23b372015-09-08 18:46:31 +0200540 :cdo
541 :cfdo
Bram Moolenaar071d4272004-06-13 20:20:40 +0000542 :command
543 :cscope
544 :debug
545 :folddoopen
546 :folddoclosed
547 :function
548 :global
549 :help
550 :helpfind
Bram Moolenaar110bc6b2006-02-10 23:13:40 +0000551 :lcscope
Bram Moolenaaraa23b372015-09-08 18:46:31 +0200552 :ldo
553 :lfdo
Bram Moolenaar071d4272004-06-13 20:20:40 +0000554 :make
555 :normal
556 :perl
557 :perldo
558 :promptfind
559 :promptrepl
560 :pyfile
561 :python
562 :registers
563 :read !
564 :scscope
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200565 :sign
Bram Moolenaar071d4272004-06-13 20:20:40 +0000566 :tcl
567 :tcldo
568 :tclfile
569 :vglobal
570 :windo
571 :write !
572 :[range]!
573 a user defined command without the "-bar" argument |:command|
574
575Note that this is confusing (inherited from Vi): With ":g" the '|' is included
576in the command, with ":s" it is not.
577
578To be able to use another command anyway, use the ":execute" command.
579Example (append the output of "ls" and jump to the first line): >
580 :execute 'r !ls' | '[
581
582There is one exception: When the 'b' flag is present in 'cpoptions', with the
583":map" and ":abbr" commands and friends CTRL-V needs to be used instead of
584'\'. You can also use "<Bar>" instead. See also |map_bar|.
585
586Examples: >
587 :!ls | wc view the output of two commands
588 :r !ls | wc insert the same output in the text
589 :%g/foo/p|> moves all matching lines one shiftwidth
590 :%s/foo/bar/|> moves one line one shiftwidth
591 :map q 10^V| map "q" to "10|"
592 :map q 10\| map \ l map "q" to "10\" and map "\" to "l"
593 (when 'b' is present in 'cpoptions')
594
595You can also use <NL> to separate commands in the same way as with '|'. To
596insert a <NL> use CTRL-V CTRL-J. "^@" will be shown. Using '|' is the
597preferred method. But for external commands a <NL> must be used, because a
598'|' is included in the external command. To avoid the special meaning of <NL>
599it must be preceded with a backslash. Example: >
600 :r !date<NL>-join
601This reads the current date into the file and joins it with the previous line.
602
603Note that when the command before the '|' generates an error, the following
604commands will not be executed.
605
606
607Because of Vi compatibility the following strange commands are supported: >
608 :| print current line (like ":p")
609 :3| print line 3 (like ":3p")
610 :3 goto line 3
611
612A colon is allowed between the range and the command name. It is ignored
613(this is Vi compatible). For example: >
614 :1,$:s/pat/string
615
616When the character '%' or '#' is used where a file name is expected, they are
617expanded to the current and alternate file name (see the chapter "editing
618files" |:_%| |:_#|).
619
620Embedded spaces in file names are allowed on the Amiga if one file name is
621expected as argument. Trailing spaces will be ignored, unless escaped with a
622backslash or CTRL-V. Note that the ":next" command uses spaces to separate
623file names. Escape the spaces to include them in a file name. Example: >
624 :next foo\ bar goes\ to school\
625starts editing the three files "foo bar", "goes to" and "school ".
626
627When you want to use the special characters '"' or '|' in a command, or want
628to use '%' or '#' in a file name, precede them with a backslash. The
629backslash is not required in a range and in the ":substitute" command.
Bram Moolenaarf9132812015-07-21 19:19:13 +0200630See also |`=|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000631
632 *:_!*
633The '!' (bang) character after an Ex command makes the command behave in a
634different way. The '!' should be placed immediately after the command, without
635any blanks in between. If you insert blanks the '!' will be seen as an
636argument for the command, which has a different meaning. For example:
637 :w! name write the current buffer to file "name", overwriting
638 any existing file
639 :w !name send the current buffer as standard input to command
640 "name"
641
642==============================================================================
Bram Moolenaara5792f52005-11-23 21:25:05 +00006434. Ex command-line ranges *cmdline-ranges* *[range]* *E16*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000644
645Some Ex commands accept a line range in front of them. This is noted as
646[range]. It consists of one or more line specifiers, separated with ',' or
647';'.
648
649The basics are explained in section |10.3| of the user manual.
650
651 *:,* *:;*
652When separated with ';' the cursor position will be set to that line
653before interpreting the next line specifier. This doesn't happen for ','.
654Examples: >
655 4,/this line/
656< from line 4 till match with "this line" after the cursor line. >
657 5;/that line/
658< from line 5 till match with "that line" after line 5.
659
660The default line specifier for most commands is the cursor position, but the
661commands ":write" and ":global" have the whole file (1,$) as default.
662
663If more line specifiers are given than required for the command, the first
664one(s) will be ignored.
665
666Line numbers may be specified with: *:range* *E14* *{address}*
667 {number} an absolute line number
668 . the current line *:.*
669 $ the last line in the file *:$*
670 % equal to 1,$ (the entire file) *:%*
671 't position of mark t (lowercase) *:'*
672 'T position of mark T (uppercase); when the mark is in
673 another file it cannot be used in a range
674 /{pattern}[/] the next line where {pattern} matches *:/*
675 ?{pattern}[?] the previous line where {pattern} matches *:?*
676 \/ the next line where the previously used search
677 pattern matches
678 \? the previous line where the previously used search
679 pattern matches
680 \& the next line where the previously used substitute
681 pattern matches
682
683Each may be followed (several times) by '+' or '-' and an optional number.
684This number is added or subtracted from the preceding line number. If the
685number is omitted, 1 is used.
686
687The "/" and "?" after {pattern} are required to separate the pattern from
688anything that follows.
689
690The "/" and "?" may be preceded with another address. The search starts from
691there. The difference from using ';' is that the cursor isn't moved.
692Examples: >
693 /pat1//pat2/ Find line containing "pat2" after line containing
694 "pat1", without moving the cursor.
695 7;/pat2/ Find line containing "pat2", after line 7, leaving
696 the cursor in line 7.
697
698The {number} must be between 0 and the number of lines in the file. When
699using a 0 (zero) this is interpreted as a 1 by most commands. Commands that
700use it as a count do use it as a zero (|:tag|, |:pop|, etc). Some commands
701interpret the zero as "before the first line" (|:read|, search pattern, etc).
702
703Examples: >
704 .+3 three lines below the cursor
705 /that/+1 the line below the next line containing "that"
706 .,$ from current line until end of file
707 0;/that the first line containing "that", also matches in the
708 first line.
709 1;/that the first line after line 1 containing "that"
710
711Some commands allow for a count after the command. This count is used as the
712number of lines to be used, starting with the line given in the last line
713specifier (the default is the cursor line). The commands that accept a count
714are the ones that use a range but do not have a file name argument (because
715a file name can also be a number).
716
717Examples: >
718 :s/x/X/g 5 substitute 'x' by 'X' in the current line and four
719 following lines
720 :23d 4 delete lines 23, 24, 25 and 26
721
722
723Folds and Range
724
725When folds are active the line numbers are rounded off to include the whole
726closed fold. See |fold-behavior|.
727
728
Bram Moolenaara5792f52005-11-23 21:25:05 +0000729Reverse Range *E493*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000730
731A range should have the lower line number first. If this is not the case, Vim
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000732will ask you if it should swap the line numbers.
Bram Moolenaara5792f52005-11-23 21:25:05 +0000733 Backwards range given, OK to swap ~
734This is not done within the global command ":g".
735
736You can use ":silent" before a command to avoid the question, the range will
737always be swapped then.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000738
739
740Count and Range *N:*
741
742When giving a count before entering ":", this is translated into:
743 :.,.+(count - 1)
744In words: The 'count' lines at and after the cursor. Example: To delete
745three lines: >
746 3:d<CR> is translated into: .,.+2d<CR>
747<
748
749Visual Mode and Range *v_:*
750
751{Visual}: Starts a command-line with the Visual selected lines as a
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100752 range. The code `:'<,'>` is used for this range, which makes
Bram Moolenaar071d4272004-06-13 20:20:40 +0000753 it possible to select a similar line from the command-line
754 history for repeating a command on different Visually selected
755 lines.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100756 When Visual mode was already ended, a short way to use the
757 Visual area for a range is `:*`. This requires that "*" does
758 not appear in 'cpo', see |cpo-star|. Otherwise you will have
759 to type `:'<,'>`
760
Bram Moolenaar071d4272004-06-13 20:20:40 +0000761
762==============================================================================
Bram Moolenaardf177f62005-02-22 08:39:57 +00007635. Ex command-line flags *ex-flags*
764
765These flags are supported by a selection of Ex commands. They print the line
766that the cursor ends up after executing the command:
767
768 l output like for |:list|
769 # add line number
770 p output like for |:print|
771
772The flags can be combined, thus "l#" uses both a line number and |:list| style
773output.
774
775==============================================================================
7766. Ex special characters *cmdline-special*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000777
Bram Moolenaar8fa04452005-12-23 22:13:51 +0000778Note: These are special characters in the executed command line. If you want
779to insert special things while typing you can use the CTRL-R command. For
780example, "%" stands for the current file name, while CTRL-R % inserts the
781current file name right away. See |c_CTRL-R|.
782
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200783Note: If you want to avoid the effects of special characters in a Vim script
784you may want to use |fnameescape()|. Also see |`=|.
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000785
Bram Moolenaar8fa04452005-12-23 22:13:51 +0000786
Bram Moolenaar071d4272004-06-13 20:20:40 +0000787In Ex commands, at places where a file name can be used, the following
788characters have a special meaning. These can also be used in the expression
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200789function |expand()|.
Bram Moolenaard812df62008-11-09 12:46:09 +0000790 % Is replaced with the current file name. *:_%* *c_%*
791 # Is replaced with the alternate file name. *:_#* *c_#*
Bram Moolenaar36782082013-11-28 13:53:34 +0100792 This is remembered for every window.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100793 #n (where n is a number) is replaced with *:_#0* *:_#n*
794 the file name of buffer n. "#0" is the same as "#". *c_#n*
Bram Moolenaard812df62008-11-09 12:46:09 +0000795 ## Is replaced with all names in the argument list *:_##* *c_##*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000796 concatenated, separated by spaces. Each space in a name
797 is preceded with a backslash.
Bram Moolenaard812df62008-11-09 12:46:09 +0000798 #<n (where n is a number > 0) is replaced with old *:_#<* *c_#<*
799 file name n. See |:oldfiles| or |v:oldfiles| to get the
800 number. *E809*
Bram Moolenaardb84e452010-08-15 13:50:43 +0200801 {only when compiled with the |+eval| and |+viminfo| features}
Bram Moolenaard812df62008-11-09 12:46:09 +0000802
803Note that these, except "#<n", give the file name as it was typed. If an
804absolute path is needed (when using the file name from a different directory),
805you need to add ":p". See |filename-modifiers|.
806
807The "#<n" item returns an absolute path, but it will start with "~/" for files
808below your home directory.
809
Bram Moolenaar071d4272004-06-13 20:20:40 +0000810Note that backslashes are inserted before spaces, so that the command will
811correctly interpret the file name. But this doesn't happen for shell
Bram Moolenaard812df62008-11-09 12:46:09 +0000812commands. For those you probably have to use quotes (this fails for files
813that contain a quote and wildcards): >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000814 :!ls "%"
815 :r !spell "%"
816
817To avoid the special meaning of '%' and '#' insert a backslash before it.
818Detail: The special meaning is always escaped when there is a backslash before
819it, no matter how many backslashes.
820 you type: result ~
821 # alternate.file
822 \# #
823 \\# \#
Bram Moolenaarf9132812015-07-21 19:19:13 +0200824Also see |`=|.
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200825
Bram Moolenaar071d4272004-06-13 20:20:40 +0000826 *:<cword>* *:<cWORD>* *:<cfile>* *<cfile>*
827 *:<sfile>* *<sfile>* *:<afile>* *<afile>*
828 *:<abuf>* *<abuf>* *:<amatch>* *<amatch>*
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200829 *:<cexpr>* *<cexpr>*
Bram Moolenaar00654022011-02-25 14:42:19 +0100830 *<slnum>* *E495* *E496* *E497* *E499* *E500*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000831Note: these are typed literally, they are not special keys!
832 <cword> is replaced with the word under the cursor (like |star|)
833 <cWORD> is replaced with the WORD under the cursor (see |WORD|)
Bram Moolenaar65f08472017-09-10 18:16:20 +0200834 <cexpr> is replaced with the word under the cursor, including more
835 to form a C expression. E.g., when the cursor is on "arg"
836 of "ptr->arg" then the result is "ptr->arg"; when the
837 cursor is on "]" of "list[idx]" then the result is
838 "list[idx]". This is used for |v:beval_text|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000839 <cfile> is replaced with the path name under the cursor (like what
840 |gf| uses)
Bram Moolenaar81af9252010-12-10 20:35:50 +0100841 <afile> When executing autocommands, is replaced with the file name
842 for a file read or write.
843 <abuf> When executing autocommands, is replaced with the currently
Bram Moolenaara2031822006-03-07 22:29:51 +0000844 effective buffer number (for ":r file" and ":so file" it is
845 the current buffer, the file being read/sourced is not in a
846 buffer).
Bram Moolenaar81af9252010-12-10 20:35:50 +0100847 <amatch> When executing autocommands, is replaced with the match for
Bram Moolenaar53180ce2005-07-05 21:48:14 +0000848 which this autocommand was executed. It differs from
Bram Moolenaar071d4272004-06-13 20:20:40 +0000849 <afile> only when the file name isn't used to match with
Bram Moolenaarb8a7b562006-02-01 21:47:16 +0000850 (for FileType, Syntax and SpellFileMissing events).
Bram Moolenaar81af9252010-12-10 20:35:50 +0100851 <sfile> When executing a ":source" command, is replaced with the
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200852 file name of the sourced file. *E498*
Bram Moolenaarca635012015-09-25 20:34:21 +0200853 When executing a function, is replaced with:
854 "function {function-name}[{lnum}]"
855 function call nesting is indicated like this:
856 "function {function-name1}[{lnum}]..{function-name2}[{lnum}]"
857 Note that filename-modifiers are useless when <sfile> is
858 used inside a function.
Bram Moolenaar81af9252010-12-10 20:35:50 +0100859 <slnum> When executing a ":source" command, is replaced with the
860 line number. *E842*
861 When executing a function it's the line number relative to
862 the start of the function.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000863
864 *filename-modifiers*
Bram Moolenaar251835e2014-02-24 02:51:51 +0100865*:_%:* *::8* *::p* *::.* *::~* *::h* *::t* *::r* *::e* *::s* *::gs* *::S*
866 *%:8* *%:p* *%:.* *%:~* *%:h* *%:t* *%:r* *%:e* *%:s* *%:gs* *%:S*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867The file name modifiers can be used after "%", "#", "#n", "<cfile>", "<sfile>",
868"<afile>" or "<abuf>". They are also used with the |fnamemodify()| function.
869These are not available when Vim has been compiled without the |+modify_fname|
870feature.
871These modifiers can be given, in this order:
872 :p Make file name a full path. Must be the first modifier. Also
873 changes "~/" (and "~user/" for Unix and VMS) to the path for
874 the home directory. If the name is a directory a path
875 separator is added at the end. For a file name that does not
876 exist and does not have an absolute path the result is
Bram Moolenaar30b65812012-07-12 22:01:11 +0200877 unpredictable. On MS-Windows an 8.3 filename is expanded to
878 the long name.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000879 :8 Converts the path to 8.3 short format (currently only on
Bram Moolenaar30b65812012-07-12 22:01:11 +0200880 MS-Windows). Will act on as much of a path that is an
881 existing path.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000882 :~ Reduce file name to be relative to the home directory, if
883 possible. File name is unmodified if it is not below the home
884 directory.
885 :. Reduce file name to be relative to current directory, if
886 possible. File name is unmodified if it is not below the
887 current directory.
888 For maximum shortness, use ":~:.".
889 :h Head of the file name (the last component and any separators
890 removed). Cannot be used with :e, :r or :t.
891 Can be repeated to remove several components at the end.
892 When the file name ends in a path separator, only the path
893 separator is removed. Thus ":p:h" on a directory name results
894 on the directory name itself (without trailing slash).
895 When the file name is an absolute path (starts with "/" for
896 Unix; "x:\" for MS-DOS, WIN32, OS/2; "drive:" for Amiga), that
897 part is not removed. When there is no head (path is relative
898 to current directory) the result is empty.
899 :t Tail of the file name (last component of the name). Must
900 precede any :r or :e.
901 :r Root of the file name (the last extension removed). When
902 there is only an extension (file name that starts with '.',
903 e.g., ".vimrc"), it is not removed. Can be repeated to remove
904 several extensions (last one first).
905 :e Extension of the file name. Only makes sense when used alone.
906 When there is no extension the result is empty.
907 When there is only an extension (file name that starts with
908 '.'), the result is empty. Can be repeated to include more
909 extensions. If there are not enough extensions (but at least
910 one) as much as possible are included.
911 :s?pat?sub?
912 Substitute the first occurrence of "pat" with "sub". This
913 works like the |:s| command. "pat" is a regular expression.
914 Any character can be used for '?', but it must not occur in
915 "pat" or "sub".
916 After this, the previous modifiers can be used again. For
917 example ":p", to make a full path after the substitution.
918 :gs?pat?sub?
Bram Moolenaaradc21822011-04-01 18:03:16 +0200919 Substitute all occurrences of "pat" with "sub". Otherwise
Bram Moolenaar071d4272004-06-13 20:20:40 +0000920 this works like ":s".
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200921 :S Escape special characters for use with a shell command (see
Bram Moolenaar251835e2014-02-24 02:51:51 +0100922 |shellescape()|). Must be the last one. Examples: >
923 :!dir <cfile>:S
924 :call system('chmod +w -- ' . expand('%:S'))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925
926Examples, when the file name is "src/version.c", current dir
927"/home/mool/vim": >
928 :p /home/mool/vim/src/version.c
929 :p:. src/version.c
930 :p:~ ~/vim/src/version.c
931 :h src
932 :p:h /home/mool/vim/src
933 :p:h:h /home/mool/vim
934 :t version.c
935 :p:t version.c
936 :r src/version
937 :p:r /home/mool/vim/src/version
938 :t:r version
939 :e c
940 :s?version?main? src/main.c
941 :s?version?main?:p /home/mool/vim/src/main.c
942 :p:gs?/?\\? \home\mool\vim\src\version.c
943
944Examples, when the file name is "src/version.c.gz": >
945 :p /home/mool/vim/src/version.c.gz
946 :e gz
947 :e:e c.gz
948 :e:e:e c.gz
949 :e:e:r c
950 :r src/version.c
951 :r:e c
952 :r:r src/version
953 :r:r:r src/version
954<
955 *extension-removal* *:_%<*
956If a "<" is appended to "%", "#", "#n" or "CTRL-V p" the extension of the file
957name is removed (everything after and including the last '.' in the file
958name). This is included for backwards compatibility with version 3.0, the
959":r" form is preferred. Examples: >
960
961 % current file name
962 %< current file name without extension
963 # alternate file name for current window
964 #< idem, without extension
965 #31 alternate file number 31
966 #31< idem, without extension
967 <cword> word under the cursor
968 <cWORD> WORD under the cursor (see |WORD|)
969 <cfile> path name under the cursor
970 <cfile>< idem, without extension
971
972Note: Where a file name is expected wildcards expansion is done. On Unix the
973shell is used for this, unless it can be done internally (for speed).
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200974Unless in |restricted-mode|, backticks work also, like in >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000975 :n `echo *.c`
Bram Moolenaar071d4272004-06-13 20:20:40 +0000976But expansion is only done if there are any wildcards before expanding the
977'%', '#', etc.. This avoids expanding wildcards inside a file name. If you
978want to expand the result of <cfile>, add a wildcard character to it.
979Examples: (alternate file name is "?readme?")
980 command expands to ~
981 :e # :e ?readme?
982 :e `ls #` :e {files matching "?readme?"}
983 :e #.* :e {files matching "?readme?.*"}
984 :cd <cfile> :cd {file name under cursor}
985 :cd <cfile>* :cd {file name under cursor plus "*" and then expanded}
Bram Moolenaarf9132812015-07-21 19:19:13 +0200986Also see |`=|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000987
988When the expanded argument contains a "!" and it is used for a shell command
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000989(":!cmd", ":r !cmd" or ":w !cmd"), the "!" is escaped with a backslash to
990avoid it being expanded into a previously used command. When the 'shell'
991option contains "sh", this is done twice, to avoid the shell trying to expand
992the "!".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000993
994 *filename-backslash*
995For filesystems that use a backslash as directory separator (MS-DOS, Windows,
996OS/2), it's a bit difficult to recognize a backslash that is used to escape
997the special meaning of the next character. The general rule is: If the
998backslash is followed by a normal file name character, it does not have a
999special meaning. Therefore "\file\foo" is a valid file name, you don't have
1000to type the backslash twice.
1001
1002An exception is the '$' sign. It is a valid character in a file name. But
1003to avoid a file name like "$home" to be interpreted as an environment variable,
1004it needs to be preceded by a backslash. Therefore you need to use "/\$home"
1005for the file "$home" in the root directory. A few examples:
1006
1007 FILE NAME INTERPRETED AS ~
1008 $home expanded to value of environment var $home
1009 \$home file "$home" in current directory
1010 /\$home file "$home" in root directory
1011 \\$home file "\\", followed by expanded $home
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +02001012
Bram Moolenaarf9132812015-07-21 19:19:13 +02001013Also see |`=|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001014
1015==============================================================================
Bram Moolenaarac7bd632013-03-19 11:35:58 +010010167. Command-line window *cmdline-window* *cmdwin*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001017 *command-line-window*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001018In the command-line window the command line can be edited just like editing
1019text in any window. It is a special kind of window, because you cannot leave
1020it in a normal way.
1021{not available when compiled without the |+cmdline_hist| or |+vertsplit|
1022feature}
1023
1024
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001025OPEN *c_CTRL-F* *q:* *q/* *q?*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001026
1027There are two ways to open the command-line window:
10281. From Command-line mode, use the key specified with the 'cedit' option.
1029 The default is CTRL-F when 'compatible' is not set.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +010010302. From Normal mode, use the "q:", "q/" or "q?" command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001031 This starts editing an Ex command-line ("q:") or search string ("q/" or
1032 "q?"). Note that this is not possible while recording is in progress (the
1033 "q" stops recording then).
1034
1035When the window opens it is filled with the command-line history. The last
1036line contains the command as typed so far. The left column will show a
1037character that indicates the type of command-line being edited, see
1038|cmdwin-char|.
1039
1040Vim will be in Normal mode when the editor is opened, except when 'insertmode'
1041is set.
1042
1043The height of the window is specified with 'cmdwinheight' (or smaller if there
1044is no room). The window is always full width and is positioned just above the
1045command-line.
1046
1047
1048EDIT
1049
1050You can now use commands to move around and edit the text in the window. Both
1051in Normal mode and Insert mode.
1052
1053It is possible to use ":", "/" and other commands that use the command-line,
1054but it's not possible to open another command-line window then. There is no
1055nesting.
1056 *E11*
1057The command-line window is not a normal window. It is not possible to move to
1058another window or edit another buffer. All commands that would do this are
1059disabled in the command-line window. Of course it _is_ possible to execute
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001060any command that you entered in the command-line window. Other text edits are
1061discarded when closing the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001062
1063
1064CLOSE *E199*
1065
1066There are several ways to leave the command-line window:
1067
1068<CR> Execute the command-line under the cursor. Works both in
1069 Insert and in Normal mode.
1070CTRL-C Continue in Command-line mode. The command-line under the
1071 cursor is used as the command-line. Works both in Insert and
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01001072 in Normal mode. There is no redraw, thus the window will
1073 remain visible.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001074:quit Discard the command line and go back to Normal mode.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01001075 ":close", ":exit", ":xit" and CTRL-\ CTRL-N also work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001076:qall Quit Vim, unless there are changes in some buffer.
1077:qall! Quit Vim, discarding changes to any buffer.
1078
1079Once the command-line window is closed the old window sizes are restored. The
1080executed command applies to the window and buffer where the command-line was
1081started from. This works as if the command-line window was not there, except
1082that there will be an extra screen redraw.
1083The buffer used for the command-line window is deleted. Any changes to lines
1084other than the one that is executed with <CR> are lost.
1085
Bram Moolenaar36fc5352006-03-04 21:49:37 +00001086If you would like to execute the command under the cursor and then have the
1087command-line window open again, you may find this mapping useful: >
1088
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001089 :autocmd CmdwinEnter * map <buffer> <F5> <CR>q:
Bram Moolenaar36fc5352006-03-04 21:49:37 +00001090
Bram Moolenaar071d4272004-06-13 20:20:40 +00001091
1092VARIOUS
1093
1094The command-line window cannot be used:
1095- when there already is a command-line window (no nesting)
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001096- for entering an encryption key or when using inputsecret()
Bram Moolenaardb84e452010-08-15 13:50:43 +02001097- when Vim was not compiled with the |+vertsplit| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001098
1099Some options are set when the command-line window is opened:
1100'filetype' "vim", when editing an Ex command-line; this starts Vim syntax
1101 highlighting if it was enabled
1102'rightleft' off
1103'modifiable' on
1104'buftype' "nofile"
1105'swapfile' off
1106
1107It is allowed to write the buffer contents to a file. This is an easy way to
1108save the command-line history and read it back later.
1109
1110If the 'wildchar' option is set to <Tab>, and the command-line window is used
1111for an Ex command, then two mappings will be added to use <Tab> for completion
1112in the command-line window, like this: >
1113 :imap <buffer> <Tab> <C-X><C-V>
1114 :nmap <buffer> <Tab> a<C-X><C-V>
1115Note that hitting <Tab> in Normal mode will do completion on the next
1116character. That way it works at the end of the line.
1117If you don't want these mappings, disable them with: >
1118 au CmdwinEnter [:>] iunmap <Tab>
1119 au CmdwinEnter [:>] nunmap <Tab>
1120You could put these lines in your vimrc file.
1121
1122While in the command-line window you cannot use the mouse to put the cursor in
1123another window, or drag statuslines of other windows. You can drag the
1124statusline of the command-line window itself and the statusline above it.
1125Thus you can resize the command-line window, but not others.
1126
Bram Moolenaarfb539272014-08-22 19:21:47 +02001127The |getcmdwintype()| function returns the type of the command-line being
1128edited as described in |cmdwin-char|.
1129
Bram Moolenaar071d4272004-06-13 20:20:40 +00001130
1131AUTOCOMMANDS
1132
1133Two autocommand events are used: |CmdwinEnter| and |CmdwinLeave|. Since this
1134window is of a special type, the WinEnter, WinLeave, BufEnter and BufLeave
1135events are not triggered. You can use the Cmdwin events to do settings
1136specifically for the command-line window. Be careful not to cause side
1137effects!
1138Example: >
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001139 :au CmdwinEnter : let b:cpt_save = &cpt | set cpt=.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001140 :au CmdwinLeave : let &cpt = b:cpt_save
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001141This sets 'complete' to use completion in the current window for |i_CTRL-N|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001142Another example: >
1143 :au CmdwinEnter [/?] startinsert
1144This will make Vim start in Insert mode in the command-line window.
1145
1146 *cmdwin-char*
1147The character used for the pattern indicates the type of command-line:
1148 : normal Ex command
1149 > debug mode command |debug-mode|
1150 / forward search string
1151 ? backward search string
1152 = expression for "= |expr-register|
1153 @ string for |input()|
1154 - text for |:insert| or |:append|
1155
1156 vim:tw=78:ts=8:ft=help:norl: