blob: 93431f8fccd9cb83530e03fa7ed8686cebad03fa [file] [log] [blame]
David Mandelberg3d1a4372025-03-08 17:06:50 +01001*cmdline.txt* For Vim version 9.1. Last change: 2025 Mar 08
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.
Bram Moolenaar071d4272004-06-13 20:20:40 +000030
31Note that if your keyboard does not have working cursor keys or any of the
32other special keys, you can use ":cnoremap" to define another key for them.
33For example, to define tcsh style editing keys: *tcsh-style* >
34 :cnoremap <C-A> <Home>
35 :cnoremap <C-F> <Right>
36 :cnoremap <C-B> <Left>
37 :cnoremap <Esc>b <S-Left>
38 :cnoremap <Esc>f <S-Right>
39(<> notation |<>|; type all this literally)
40
41 *cmdline-too-long*
42When the command line is getting longer than what fits on the screen, only the
43part that fits will be shown. The cursor can only move in this visible part,
44thus you cannot edit beyond that.
45
46 *cmdline-history* *history*
47The command-lines that you enter are remembered in a history table. You can
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +000048recall them with the up and down cursor keys. There are actually five
Bram Moolenaar071d4272004-06-13 20:20:40 +000049history tables:
50- one for ':' commands
51- one for search strings
52- one for expressions
53- one for input lines, typed for the |input()| function.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +000054- one for debug mode commands
Bram Moolenaar071d4272004-06-13 20:20:40 +000055These are completely separate. Each history can only be accessed when
56entering the same type of line.
57Use the 'history' option to set the number of lines that are remembered
Bram Moolenaar6e932462014-09-09 18:48:09 +020058(default: 50).
Bram Moolenaar071d4272004-06-13 20:20:40 +000059Notes:
60- When you enter a command-line that is exactly the same as an older one, the
61 old one is removed (to avoid repeated commands moving older commands out of
62 the history).
63- Only commands that are typed are remembered. Ones that completely come from
Bram Moolenaar3577c6f2008-06-24 21:16:56 +000064 mappings are not put in the history.
Bram Moolenaar071d4272004-06-13 20:20:40 +000065- All searches are put in the search history, including the ones that come
66 from commands like "*" and "#". But for a mapping, only the last search is
67 remembered (to avoid that long mappings trash the history).
Bram Moolenaar071d4272004-06-13 20:20:40 +000068{not available when compiled without the |+cmdline_hist| feature}
69
70There is an automatic completion of names on the command-line; see
71|cmdline-completion|.
72
73 *c_CTRL-V*
74CTRL-V Insert next non-digit literally. Up to three digits form the
75 decimal value of a single byte. The non-digit and the three
76 digits are not considered for mapping. This works the same
77 way as in Insert mode (see above, |i_CTRL-V|).
Bram Moolenaar6f345a12019-12-17 21:27:18 +010078 Note: Under MS-Windows CTRL-V is often mapped to paste text.
Bram Moolenaar071d4272004-06-13 20:20:40 +000079 Use CTRL-Q instead then.
Bram Moolenaarfc4ea2a2019-11-26 19:33:22 +010080 When |modifyOtherKeys| is enabled then special Escape sequence
81 is converted back to what it was without |modifyOtherKeys|,
82 unless the Shift key is also pressed.
Bram Moolenaar071d4272004-06-13 20:20:40 +000083 *c_CTRL-Q*
84CTRL-Q Same as CTRL-V. But with some terminals it is used for
85 control flow, it doesn't work then.
86
Bram Moolenaarfc4ea2a2019-11-26 19:33:22 +010087CTRL-SHIFT-V *c_CTRL-SHIFT-V* *c_CTRL-SHIFT-Q*
88CTRL-SHIFT-Q Works just like CTRL-V, unless |modifyOtherKeys| is active,
89 then it inserts the Escape sequence for a key with modifiers.
zeertzjqbad8a012022-04-29 16:44:00 +010090 In the GUI the |key-notation| is inserted without simplifying.
zeertzjqd89770e2025-03-09 08:38:35 +010091 Note: When CTRL-SHIFT-V is intercepted by your system (e.g.,
92 to paste text) you can often use CTRL-SHIFT-Q instead.
93 However, in some terminals (e.g. GNOME Terminal), CTRL-SHIFT-Q
David Mandelberg3d1a4372025-03-08 17:06:50 +010094 quits the terminal without confirmation.
Bram Moolenaarfc4ea2a2019-11-26 19:33:22 +010095
Bram Moolenaaradc21822011-04-01 18:03:16 +020096 *c_<Left>* *c_Left*
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -070097<Left> cursor left. See 'wildmenu' for behavior during wildmenu
98 completion mode.
Bram Moolenaaradc21822011-04-01 18:03:16 +020099 *c_<Right>* *c_Right*
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -0700100<Right> cursor right. See 'wildmenu' for behavior during wildmenu
101 completion mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000102 *c_<S-Left>*
103<S-Left> or <C-Left> *c_<C-Left>*
104 cursor one WORD left
105 *c_<S-Right>*
106<S-Right> or <C-Right> *c_<C-Right>*
107 cursor one WORD right
Bram Moolenaaradc21822011-04-01 18:03:16 +0200108CTRL-B or <Home> *c_CTRL-B* *c_<Home>* *c_Home*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000109 cursor to beginning of command-line
Bram Moolenaaradc21822011-04-01 18:03:16 +0200110CTRL-E or <End> *c_CTRL-E* *c_<End>* *c_End*
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -0700111 cursor to end of command-line. See 'wildmenu' for behavior
112 during wildmenu completion mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000113
114 *c_<LeftMouse>*
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000115<LeftMouse> Move the cursor to the position of the mouse click.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000116
Bram Moolenaar256972a2015-12-29 19:10:25 +0100117 *c_<MiddleMouse>*
118<MiddleMouse> Paste the contents of the clipboard (for X11 the primary
119 selection). This is similar to using CTRL-R *, but no CR
120 characters are inserted between lines.
121
Bram Moolenaaradc21822011-04-01 18:03:16 +0200122CTRL-H *c_<BS>* *c_CTRL-H* *c_BS*
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000123<BS> Delete the character in front of the cursor (see |:fixdel| if
Bram Moolenaar071d4272004-06-13 20:20:40 +0000124 your <BS> key does not do what you want).
Bram Moolenaaradc21822011-04-01 18:03:16 +0200125 *c_<Del>* *c_Del*
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000126<Del> Delete the character under the cursor (at end of line:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000127 character before the cursor) (see |:fixdel| if your <Del>
128 key does not do what you want).
129 *c_CTRL-W*
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000130CTRL-W Delete the |word| before the cursor. This depends on the
131 'iskeyword' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000132 *c_CTRL-U*
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000133CTRL-U Remove all characters between the cursor position and
Bram Moolenaar071d4272004-06-13 20:20:40 +0000134 the beginning of the line. Previous versions of vim
135 deleted all characters on the line. If that is the
136 preferred behavior, add the following to your .vimrc: >
137 :cnoremap <C-U> <C-E><C-U>
138<
Bram Moolenaaradc21822011-04-01 18:03:16 +0200139 *c_<Insert>* *c_Insert*
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200140<Insert> Toggle between insert and overstrike.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000141
142{char1} <BS> {char2} or *c_digraph*
143CTRL-K {char1} {char2} *c_CTRL-K*
144 enter digraph (see |digraphs|). When {char1} is a special
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200145 key, the code for that key is inserted in <> form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000146
Bram Moolenaar5be4cee2019-09-27 19:34:08 +0200147CTRL-R {register} *c_CTRL-R* *c_<C-R>*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000148 Insert the contents of a numbered or named register. Between
149 typing CTRL-R and the second character '"' will be displayed
150 to indicate that you are expected to enter the name of a
151 register.
152 The text is inserted as if you typed it, but mappings and
153 abbreviations are not used. Command-line completion through
154 'wildchar' is not triggered though. And characters that end
155 the command line are inserted literally (<Esc>, <CR>, <NL>,
156 <C-C>). A <BS> or CTRL-W could still end the command line
157 though, and remaining characters will then be interpreted in
158 another mode, which might not be what you intended.
159 Special registers:
160 '"' the unnamed register, containing the text of
161 the last delete or yank
162 '%' the current file name
163 '#' the alternate file name
164 '*' the clipboard contents (X11: primary selection)
165 '+' the clipboard contents
166 '/' the last search pattern
167 ':' the last command-line
168 '-' the last small (less than a line) delete
169 '.' the last inserted text
170 *c_CTRL-R_=*
171 '=' the expression register: you are prompted to
172 enter an expression (see |expression|)
Bram Moolenaar05a7bb32006-01-19 22:09:32 +0000173 (doesn't work at the expression prompt; some
174 things such as changing the buffer or current
175 window are not allowed to avoid side effects)
Bram Moolenaard812df62008-11-09 12:46:09 +0000176 When the result is a |List| the items are used
177 as lines. They can have line breaks inside
178 too.
179 When the result is a Float it's automatically
180 converted to a String.
Bram Moolenaar6aa57292021-08-14 21:25:52 +0200181 Note that when you only want to move the
182 cursor and not insert anything, you must make
183 sure the expression evaluates to an empty
184 string. E.g.: >
185 <C-R><C-R>=setcmdpos(2)[-1]<CR>
186< See |registers| about registers.
Bram Moolenaarfd371682005-01-14 21:42:54 +0000187 Implementation detail: When using the |expression| register
188 and invoking setcmdpos(), this sets the position before
189 inserting the resulting string. Use CTRL-R CTRL-R to set the
190 position afterwards.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000191
192CTRL-R CTRL-F *c_CTRL-R_CTRL-F* *c_<C-R>_<C-F>*
193CTRL-R CTRL-P *c_CTRL-R_CTRL-P* *c_<C-R>_<C-P>*
194CTRL-R CTRL-W *c_CTRL-R_CTRL-W* *c_<C-R>_<C-W>*
195CTRL-R CTRL-A *c_CTRL-R_CTRL-A* *c_<C-R>_<C-A>*
Bram Moolenaare2c8d832018-05-01 19:24:03 +0200196CTRL-R CTRL-L *c_CTRL-R_CTRL-L* *c_<C-R>_<C-L>*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000197 Insert the object under the cursor:
198 CTRL-F the Filename under the cursor
199 CTRL-P the Filename under the cursor, expanded with
200 'path' as in |gf|
201 CTRL-W the Word under the cursor
202 CTRL-A the WORD under the cursor; see |WORD|
Bram Moolenaare2c8d832018-05-01 19:24:03 +0200203 CTRL-L the line under the cursor
Bram Moolenaard3667a22006-03-16 21:35:52 +0000204
205 When 'incsearch' is set the cursor position at the end of the
206 currently displayed match is used. With CTRL-W the part of
207 the word that was already typed is not inserted again.
208
Bram Moolenaar071d4272004-06-13 20:20:40 +0000209 *c_CTRL-R_CTRL-R* *c_<C-R>_<C-R>*
210 *c_CTRL-R_CTRL-O* *c_<C-R>_<C-O>*
Bram Moolenaar5be4cee2019-09-27 19:34:08 +0200211CTRL-R CTRL-R {register CTRL-F CTRL-P CTRL-W CTRL-A CTRL-L}
212CTRL-R CTRL-O {register CTRL-F CTRL-P CTRL-W CTRL-A CTRL-L}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000213 Insert register or object under the cursor. Works like
214 |c_CTRL-R| but inserts the text literally. For example, if
215 register a contains "xy^Hz" (where ^H is a backspace),
216 "CTRL-R a" will insert "xz" while "CTRL-R CTRL-R a" will
217 insert "xy^Hz".
218
219CTRL-\ e {expr} *c_CTRL-\_e*
220 Evaluate {expr} and replace the whole command line with the
221 result. You will be prompted for the expression, type <Enter>
222 to finish it. It's most useful in mappings though. See
223 |expression|.
224 See |c_CTRL-R_=| for inserting the result of an expression.
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +0000225 Useful functions are |getcmdtype()|, |getcmdline()| and
226 |getcmdpos()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000227 The cursor position is unchanged, except when the cursor was
228 at the end of the line, then it stays at the end.
229 |setcmdpos()| can be used to set the cursor position.
Bram Moolenaar4770d092006-01-12 23:22:24 +0000230 The |sandbox| is used for evaluating the expression to avoid
231 nasty side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000232 Example: >
233 :cmap <F7> <C-\>eAppendSome()<CR>
234 :func AppendSome()
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000235 :let cmd = getcmdline() .. " Some()"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000236 :" place the cursor on the )
237 :call setcmdpos(strlen(cmd))
238 :return cmd
239 :endfunc
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +0000240< This doesn't work recursively, thus not when already editing
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200241 an expression. But it is possible to use in a mapping.
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +0000242
Bram Moolenaar071d4272004-06-13 20:20:40 +0000243 *c_CTRL-Y*
244CTRL-Y When there is a modeless selection, copy the selection into
245 the clipboard. |modeless-selection|
246 If there is no selection CTRL-Y is inserted as a character.
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -0700247 See 'wildmenu' for behavior during wildmenu completion mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000248
Bram Moolenaar2ec618c2016-10-01 14:47:05 +0200249CTRL-M or CTRL-J *c_CTRL-M* *c_CTRL-J* *c_<NL>* *c_<CR>* *c_CR*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000250<CR> or <NL> start entered command
Bram Moolenaar2ec618c2016-10-01 14:47:05 +0200251
252CTRL-[ *c_CTRL-[* *c_<Esc>* *c_Esc*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000253<Esc> When typed and 'x' not present in 'cpoptions', quit
254 Command-line mode without executing. In macros or when 'x'
255 present in 'cpoptions', start entered command.
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000256 Note: If your <Esc> key is hard to hit on your keyboard, train
257 yourself to use CTRL-[.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000258 *c_CTRL-C*
259CTRL-C quit command-line without executing
260
Bram Moolenaaradc21822011-04-01 18:03:16 +0200261 *c_<Up>* *c_Up*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000262<Up> recall older command-line from history, whose beginning
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -0700263 matches the current command-line (see below). See 'wildmenu'
264 for behavior during wildmenu completion mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000265 {not available when compiled without the |+cmdline_hist|
266 feature}
Bram Moolenaaradc21822011-04-01 18:03:16 +0200267 *c_<Down>* *c_Down*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268<Down> recall more recent command-line from history, whose beginning
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -0700269 matches the current command-line (see below). See 'wildmenu'
270 for behavior during wildmenu completion mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000271 {not available when compiled without the |+cmdline_hist|
272 feature}
273
274 *c_<S-Up>* *c_<PageUp>*
275<S-Up> or <PageUp>
276 recall older command-line from history
277 {not available when compiled without the |+cmdline_hist|
278 feature}
279 *c_<S-Down>* *c_<PageDown>*
280<S-Down> or <PageDown>
281 recall more recent command-line from history
282 {not available when compiled without the |+cmdline_hist|
283 feature}
284
285CTRL-D command-line completion (see |cmdline-completion|)
286'wildchar' option
287 command-line completion (see |cmdline-completion|)
288CTRL-N command-line completion (see |cmdline-completion|)
289CTRL-P command-line completion (see |cmdline-completion|)
290CTRL-A command-line completion (see |cmdline-completion|)
291CTRL-L command-line completion (see |cmdline-completion|)
292
293 *c_CTRL-_*
294CTRL-_ a - switch between Hebrew and English keyboard mode, which is
295 private to the command-line and not related to hkmap.
296 This is useful when Hebrew text entry is required in the
297 command-line, searches, abbreviations, etc. Applies only if
298 Vim is compiled with the |+rightleft| feature and the
299 'allowrevins' option is set.
300 See |rileft.txt|.
301
302 b - switch between Farsi and English keyboard mode, which is
303 private to the command-line and not related to fkmap. In
304 Farsi keyboard mode the characters are inserted in reverse
305 insert manner. This is useful when Farsi text entry is
306 required in the command-line, searches, abbreviations, etc.
307 Applies only if Vim is compiled with the |+farsi| feature.
308 See |farsi.txt|.
309
310 *c_CTRL-^*
311CTRL-^ Toggle the use of language |:lmap| mappings and/or Input
312 Method.
313 When typing a pattern for a search command and 'imsearch' is
314 not -1, VAL is the value of 'imsearch', otherwise VAL is the
315 value of 'iminsert'.
316 When language mappings are defined:
317 - If VAL is 1 (langmap mappings used) it becomes 0 (no langmap
318 mappings used).
319 - If VAL was not 1 it becomes 1, thus langmap mappings are
320 enabled.
321 When no language mappings are defined:
322 - If VAL is 2 (Input Method is used) it becomes 0 (no input
323 method used)
324 - If VAL has another value it becomes 2, thus the Input Method
325 is enabled.
326 These language mappings are normally used to type characters
327 that are different from what the keyboard produces. The
328 'keymap' option can be used to install a whole number of them.
329 When entering a command line, langmap mappings are switched
330 off, since you are expected to type a command. After
331 switching it on with CTRL-^, the new state is not used again
332 for the next command or Search pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000333
Bram Moolenaar9964e462007-05-05 17:54:07 +0000334 *c_CTRL-]*
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200335CTRL-] Trigger abbreviation, without inserting a character.
Bram Moolenaar9964e462007-05-05 17:54:07 +0000336
Bram Moolenaar071d4272004-06-13 20:20:40 +0000337For Emacs-style editing on the command-line see |emacs-keys|.
338
339The <Up> and <Down> keys take the current command-line as a search string.
340The beginning of the next/previous command-lines are compared with this
341string. The first line that matches is the new command-line. When typing
342these two keys repeatedly, the same string is used again. For example, this
343can be used to find the previous substitute command: Type ":s" and then <Up>.
344The same could be done by typing <S-Up> a number of times until the desired
345command-line is shown. (Note: the shifted arrow keys do not work on all
346terminals)
347
Bram Moolenaar066b6222008-01-04 14:17:47 +0000348 *:his* *:history*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000349:his[tory] Print the history of last entered commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000350 {not available when compiled without the |+cmdline_hist|
351 feature}
352
353:his[tory] [{name}] [{first}][, [{last}]]
354 List the contents of history {name} which can be:
Bram Moolenaar5ae636b2012-04-30 18:48:53 +0200355 c[md] or : command-line history
356 s[earch] or / or ? search string history
357 e[xpr] or = expression register history
358 i[nput] or @ input line history
359 d[ebug] or > debug command history
360 a[ll] all of the above
Bram Moolenaar071d4272004-06-13 20:20:40 +0000361
362 If the numbers {first} and/or {last} are given, the respective
363 range of entries from a history is listed. These numbers can
364 be specified in the following form:
365 *:history-indexing*
366 A positive number represents the absolute index of an entry
367 as it is given in the first column of a :history listing.
368 This number remains fixed even if other entries are deleted.
Christian Brabandtac637872023-11-14 20:45:48 +0100369 (see |E1510|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000370
371 A negative number means the relative position of an entry,
372 counted from the newest entry (which has index -1) backwards.
373
374 Examples:
375 List entries 6 to 12 from the search history: >
376 :history / 6,12
377<
Bram Moolenaareebd84e2016-12-01 17:57:44 +0100378 List the penultimate entry from all histories: >
379 :history all -2
380<
381 List the most recent two entries from all histories: >
382 :history all -2,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000383
Bram Moolenaara939e432013-11-09 05:30:26 +0100384:keepp[atterns] {command} *:keepp* *:keeppatterns*
385 Execute {command}, without adding anything to the search
zeertzjqe44e6442024-08-20 20:20:43 +0200386 history and, in case of |:s| or |:&|, without modifying the
387 last substitute pattern or substitute string.
Bram Moolenaara939e432013-11-09 05:30:26 +0100388
Bram Moolenaar071d4272004-06-13 20:20:40 +0000389==============================================================================
3902. Command-line completion *cmdline-completion*
391
392When editing the command-line, a few commands can be used to complete the
393word before the cursor. This is available for:
394
395- Command names: At the start of the command-line.
Yee Cheng Chin989426b2023-10-14 11:46:51 +0200396- |++opt| values.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000397- Tags: Only after the ":tag" command.
398- File names: Only after a command that accepts a file name or a setting for
399 an option that can be set to a file name. This is called file name
400 completion.
Bram Moolenaara2031822006-03-07 22:29:51 +0000401- Shell command names: After ":!cmd", ":r !cmd" and ":w !cmd". $PATH is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000402- Options: Only after the ":set" command.
403- Mappings: Only after a ":map" or similar command.
404- Variable and function names: Only after a ":if", ":call" or similar command.
405
Bram Moolenaar0a52df52019-08-18 22:26:31 +0200406The number of help item matches is limited (currently to 300) to avoid a long
407delay when there are very many matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000408
409These are the commands that can be used:
410
411 *c_CTRL-D*
412CTRL-D List names that match the pattern in front of the cursor.
413 When showing file names, directories are highlighted (see
414 'highlight' option). Names where 'suffixes' matches are moved
415 to the end.
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000416 The 'wildoptions' option can be set to "tagfile" to list the
417 file of matching tags.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000418 *c_CTRL-I* *c_wildchar* *c_<Tab>*
419'wildchar' option
420 A match is done on the pattern in front of the cursor. The
421 match (if there are several, the first match) is inserted
422 in place of the pattern. (Note: does not work inside a
423 macro, because <Tab> or <Esc> are mostly used as 'wildchar',
424 and these have a special meaning in some macros.) When typed
425 again and there were multiple matches, the next
426 match is inserted. After the last match, the first is used
427 again (wrap around).
428 The behavior can be changed with the 'wildmode' option.
Bram Moolenaar7db25fe2018-05-13 00:02:36 +0200429 *c_<S-Tab>*
430<S-Tab> Like 'wildchar' or <Tab>, but begin with the last match and
431 then go to the previous match.
432 <S-Tab> does not work everywhere.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000433 *c_CTRL-N*
434CTRL-N After using 'wildchar' which got multiple matches, go to next
435 match. Otherwise recall more recent command-line from history.
Bram Moolenaar7db25fe2018-05-13 00:02:36 +0200436 *c_CTRL-P*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000437CTRL-P After using 'wildchar' which got multiple matches, go to
438 previous match. Otherwise recall older command-line from
Bram Moolenaar7db25fe2018-05-13 00:02:36 +0200439 history.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000440 *c_CTRL-A*
441CTRL-A All names that match the pattern in front of the cursor are
442 inserted.
443 *c_CTRL-L*
444CTRL-L A match is done on the pattern in front of the cursor. If
445 there is one match, it is inserted in place of the pattern.
446 If there are multiple matches the longest common part is
447 inserted in place of the pattern. If the result is shorter
448 than the pattern, no completion is done.
Bram Moolenaar4d6f32c2016-08-26 19:13:46 +0200449 */_CTRL-L*
Bram Moolenaard3667a22006-03-16 21:35:52 +0000450 When 'incsearch' is set, entering a search pattern for "/" or
451 "?" and the current match is displayed then CTRL-L will add
Bram Moolenaara9dc3752010-07-11 20:46:53 +0200452 one character from the end of the current match. If
453 'ignorecase' and 'smartcase' are set and the command line has
454 no uppercase characters, the added character is converted to
455 lowercase.
Bram Moolenaar11956692016-08-27 16:26:56 +0200456 *c_CTRL-G* */_CTRL-G*
457CTRL-G When 'incsearch' is set, entering a search pattern for "/" or
458 "?" and the current match is displayed then CTRL-G will move
459 to the next match (does not take |search-offset| into account)
460 Use CTRL-T to move to the previous match. Hint: on a regular
461 keyboard T is above G.
462 *c_CTRL-T* */_CTRL-T*
463CTRL-T When 'incsearch' is set, entering a search pattern for "/" or
464 "?" and the current match is displayed then CTRL-T will move
465 to the previous match (does not take |search-offset| into
466 account).
467 Use CTRL-G to move to the next match. Hint: on a regular
468 keyboard T is above G.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000469
470The 'wildchar' option defaults to <Tab> (CTRL-E when in Vi compatible mode; in
zeertzjq61e984e2023-12-09 15:18:33 +0800471a previous version <Esc> was used). In the pattern standard |wildcards| are
472accepted when matching file names.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000473
Bram Moolenaar259f26a2018-05-15 22:25:40 +0200474When repeating 'wildchar' or CTRL-N you cycle through the matches, eventually
475ending up back to what was typed. If the first match is not what you wanted,
476you can use <S-Tab> or CTRL-P to go straight back to what you typed.
477
Bram Moolenaar74675a62017-07-15 13:53:23 +0200478The 'wildmenu' option can be set to show the matches just above the command
479line.
480
Yee Cheng Chin2bbd0d32023-10-14 02:23:45 -0700481The 'wildoptions' option provides additional configuration to use a popup menu
482for 'wildmenu', and to use fuzzy matching.
483
484The 'wildignorecase' option can be set to ignore case in filenames. For
485completing other texts (e.g. command names), the 'ignorecase' option is used
486instead (fuzzy matching always ignores case, however).
487
Milly89872f52024-10-05 17:16:18 +0200488If you like tcsh's autolist completion, you can use this mapping: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000489 :cnoremap X <C-L><C-D>
490(Where X is the command key to use, <C-L> is CTRL-L and <C-D> is CTRL-D)
491This will find the longest match and then list all matching files.
492
493If you like tcsh's autolist completion, you can use the 'wildmode' option to
Milly89872f52024-10-05 17:16:18 +0200494emulate it. For example, this mimics autolist=ambiguous: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000495 :set wildmode=longest,list
496This will find the longest match with the first 'wildchar', then list all
497matching files with the next.
498
Bram Moolenaareab6dff2020-03-01 19:06:45 +0100499 *complete-script-local-functions*
500When completing user function names, prepend "s:" to find script-local
501functions.
502
Bram Moolenaar071d4272004-06-13 20:20:40 +0000503 *suffixes*
504For file name completion you can use the 'suffixes' option to set a priority
505between files with almost the same name. If there are multiple matches,
506those files with an extension that is in the 'suffixes' option are ignored.
507The default is ".bak,~,.o,.h,.info,.swp,.obj", which means that files ending
508in ".bak", "~", ".o", ".h", ".info", ".swp" and ".obj" are sometimes ignored.
Bram Moolenaar055a2ba2009-07-14 19:40:21 +0000509
510An empty entry, two consecutive commas, match a file name that does not
511contain a ".", thus has no suffix. This is useful to ignore "prog" and prefer
512"prog.c".
513
514Examples:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000515
516 pattern: files: match: ~
517 test* test.c test.h test.o test.c
518 test* test.h test.o test.h and test.o
519 test* test.i test.h test.c test.i and test.c
520
Bram Moolenaar055a2ba2009-07-14 19:40:21 +0000521It is impossible to ignore suffixes with two dots.
522
Bram Moolenaar071d4272004-06-13 20:20:40 +0000523If there is more than one matching file (after ignoring the ones matching
524the 'suffixes' option) the first file name is inserted. You can see that
525there is only one match when you type 'wildchar' twice and the completed
526match stays the same. You can get to the other matches by entering
527'wildchar', CTRL-N or CTRL-P. All files are included, also the ones with
528extensions matching the 'suffixes' option.
529
530To completely ignore files with some extension use 'wildignore'.
531
Bram Moolenaar066b6222008-01-04 14:17:47 +0000532To match only files that end at the end of the typed text append a "$". For
533example, to match only files that end in ".c": >
534 :e *.c$
535This will not match a file ending in ".cpp". Without the "$" it does match.
536
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537If you would like using <S-Tab> for CTRL-P in an xterm, put this command in
538your .cshrc: >
539 xmodmap -e "keysym Tab = Tab Find"
540And this in your .vimrc: >
541 :cmap <Esc>[1~ <C-P>
Yee Cheng Chin900894b2023-09-29 20:42:32 +0200542< *complete-set-option*
543When setting an option using |:set=|, the old value of an option can be
544obtained by hitting 'wildchar' just after the '='. For example, typing
545'wildchar' after ":set dir=" will insert the current value of 'dir'. This
546overrules file name completion for the options that take a file name.
547
548When using |:set=|, |:set+=|, or |:set^=|, string options that have
549pre-defined names or syntax (e.g. 'diffopt', 'listchars') or are a list of
550single-character flags (e.g. 'shortmess') will also present a list of possible
551values for completion when using 'wildchar'.
552
553When using |:set-=|, comma-separated options like 'diffopt' or 'backupdir'
554will show each item separately. Flag list options like 'shortmess' will show
555both the entire old value and the individual flags. Otherwise completion will
556just fill in with the entire old value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000557
558==============================================================================
5593. Ex command-lines *cmdline-lines*
560
561The Ex commands have a few specialties:
562
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100563 *:quote* *:comment*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000564'"' at the start of a line causes the whole line to be ignored. '"'
565after a command causes the rest of the line to be ignored. This can be used
566to add comments. Example: >
567 :set ai "set 'autoindent' option
568It is not possible to add a comment to a shell command ":!cmd" or to the
Bram Moolenaar2c64ca12018-10-19 16:22:31 +0200569":map" command and a few others (mainly commands that expect expressions)
570that see the '"' as part of their argument:
571
572 :argdo
573 :autocmd
574 :bufdo
575 :cexpr (and the like)
Bram Moolenaar2c64ca12018-10-19 16:22:31 +0200576 :cdo (and the like)
577 :command
578 :cscope (and the like)
579 :debug
580 :display
581 :echo (and the like)
582 :elseif
583 :execute
584 :folddoopen
585 :folddoclosed
586 :for
587 :grep (and the like)
588 :help (and the like)
589 :if
590 :let
591 :make
592 :map (and the like including :abbrev commands)
593 :menu (and the like)
594 :mkspell
595 :normal
596 :ownsyntax
597 :popup
598 :promptfind (and the like)
599 :registers
600 :return
601 :sort
602 :syntax
603 :tabdo
604 :tearoff
605 :vimgrep (and the like)
606 :while
607 :windo
Bram Moolenaar071d4272004-06-13 20:20:40 +0000608
609 *:bar* *:\bar*
610'|' can be used to separate commands, so you can give multiple commands in one
611line. If you want to use '|' in an argument, precede it with '\'.
612
613These commands see the '|' as their argument, and can therefore not be
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000614followed by another Vim command:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000615 :argdo
616 :autocmd
617 :bufdo
Bram Moolenaaraa23b372015-09-08 18:46:31 +0200618 :cdo
619 :cfdo
Bram Moolenaar071d4272004-06-13 20:20:40 +0000620 :command
621 :cscope
622 :debug
Bram Moolenaarbc93ceb2020-02-26 13:36:21 +0100623 :eval
Bram Moolenaar071d4272004-06-13 20:20:40 +0000624 :folddoopen
625 :folddoclosed
626 :function
627 :global
628 :help
629 :helpfind
Bram Moolenaar130cbfc2021-04-07 21:07:20 +0200630 :helpgrep
Bram Moolenaar110bc6b2006-02-10 23:13:40 +0000631 :lcscope
Bram Moolenaaraa23b372015-09-08 18:46:31 +0200632 :ldo
633 :lfdo
Bram Moolenaar130cbfc2021-04-07 21:07:20 +0200634 :lhelpgrep
Bram Moolenaar071d4272004-06-13 20:20:40 +0000635 :make
636 :normal
637 :perl
638 :perldo
639 :promptfind
640 :promptrepl
641 :pyfile
642 :python
643 :registers
644 :read !
645 :scscope
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200646 :sign
Bram Moolenaar938ae282023-02-20 20:44:55 +0000647 :tabdo
Bram Moolenaar071d4272004-06-13 20:20:40 +0000648 :tcl
649 :tcldo
650 :tclfile
Bram Moolenaar7ceefb32020-05-01 16:07:38 +0200651 :terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +0000652 :vglobal
653 :windo
654 :write !
655 :[range]!
656 a user defined command without the "-bar" argument |:command|
657
Christian Brabandt11250512024-04-27 12:01:15 +0200658 and the following |Vim9-script| keywords:
Yegappan Lakshmananac773182024-04-27 11:36:12 +0200659 :abstract
660 :class
661 :enum
662 :interface
663
Bram Moolenaar071d4272004-06-13 20:20:40 +0000664Note that this is confusing (inherited from Vi): With ":g" the '|' is included
665in the command, with ":s" it is not.
666
667To be able to use another command anyway, use the ":execute" command.
668Example (append the output of "ls" and jump to the first line): >
669 :execute 'r !ls' | '[
670
671There is one exception: When the 'b' flag is present in 'cpoptions', with the
672":map" and ":abbr" commands and friends CTRL-V needs to be used instead of
673'\'. You can also use "<Bar>" instead. See also |map_bar|.
674
675Examples: >
676 :!ls | wc view the output of two commands
677 :r !ls | wc insert the same output in the text
678 :%g/foo/p|> moves all matching lines one shiftwidth
679 :%s/foo/bar/|> moves one line one shiftwidth
680 :map q 10^V| map "q" to "10|"
681 :map q 10\| map \ l map "q" to "10\" and map "\" to "l"
682 (when 'b' is present in 'cpoptions')
683
684You can also use <NL> to separate commands in the same way as with '|'. To
685insert a <NL> use CTRL-V CTRL-J. "^@" will be shown. Using '|' is the
686preferred method. But for external commands a <NL> must be used, because a
687'|' is included in the external command. To avoid the special meaning of <NL>
688it must be preceded with a backslash. Example: >
689 :r !date<NL>-join
690This reads the current date into the file and joins it with the previous line.
691
692Note that when the command before the '|' generates an error, the following
693commands will not be executed.
694
695
696Because of Vi compatibility the following strange commands are supported: >
697 :| print current line (like ":p")
698 :3| print line 3 (like ":3p")
699 :3 goto line 3
700
701A colon is allowed between the range and the command name. It is ignored
702(this is Vi compatible). For example: >
703 :1,$:s/pat/string
704
705When the character '%' or '#' is used where a file name is expected, they are
706expanded to the current and alternate file name (see the chapter "editing
707files" |:_%| |:_#|).
708
709Embedded spaces in file names are allowed on the Amiga if one file name is
710expected as argument. Trailing spaces will be ignored, unless escaped with a
711backslash or CTRL-V. Note that the ":next" command uses spaces to separate
712file names. Escape the spaces to include them in a file name. Example: >
713 :next foo\ bar goes\ to school\
714starts editing the three files "foo bar", "goes to" and "school ".
715
716When you want to use the special characters '"' or '|' in a command, or want
717to use '%' or '#' in a file name, precede them with a backslash. The
718backslash is not required in a range and in the ":substitute" command.
Bram Moolenaarf9132812015-07-21 19:19:13 +0200719See also |`=|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720
721 *:_!*
722The '!' (bang) character after an Ex command makes the command behave in a
723different way. The '!' should be placed immediately after the command, without
724any blanks in between. If you insert blanks the '!' will be seen as an
725argument for the command, which has a different meaning. For example:
726 :w! name write the current buffer to file "name", overwriting
727 any existing file
728 :w !name send the current buffer as standard input to command
729 "name"
730
731==============================================================================
Bram Moolenaara5792f52005-11-23 21:25:05 +00007324. Ex command-line ranges *cmdline-ranges* *[range]* *E16*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000733
734Some Ex commands accept a line range in front of them. This is noted as
735[range]. It consists of one or more line specifiers, separated with ',' or
736';'.
737
738The basics are explained in section |10.3| of the user manual.
739
Bram Moolenaara4d131d2021-12-27 21:33:07 +0000740In |Vim9| script a range needs to be prefixed with a colon to avoid ambiguity
741with continuation lines. For example, "+" can be used for a range but is also
742a continuation of an expression: >
743 var result = start
744 + print
745If the "+" is a range then it must be prefixed with a colon: >
746 var result = start
747 :+ print
748<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000749 *:,* *:;*
750When separated with ';' the cursor position will be set to that line
751before interpreting the next line specifier. This doesn't happen for ','.
752Examples: >
753 4,/this line/
754< from line 4 till match with "this line" after the cursor line. >
755 5;/that line/
756< from line 5 till match with "that line" after line 5.
757
758The default line specifier for most commands is the cursor position, but the
759commands ":write" and ":global" have the whole file (1,$) as default.
760
761If more line specifiers are given than required for the command, the first
762one(s) will be ignored.
763
Bram Moolenaar088e8e32019-08-08 22:15:18 +0200764Line numbers may be specified with: *:range* *{address}*
Bram Moolenaara2baa732022-02-04 16:09:54 +0000765 {number} an absolute line number *E1247*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000766 . the current line *:.*
767 $ the last line in the file *:$*
768 % equal to 1,$ (the entire file) *:%*
769 't position of mark t (lowercase) *:'*
770 'T position of mark T (uppercase); when the mark is in
771 another file it cannot be used in a range
772 /{pattern}[/] the next line where {pattern} matches *:/*
Bram Moolenaar9954dc32022-11-11 22:58:36 +0000773 also see |:range-pattern| below
Bram Moolenaar071d4272004-06-13 20:20:40 +0000774 ?{pattern}[?] the previous line where {pattern} matches *:?*
Bram Moolenaar9954dc32022-11-11 22:58:36 +0000775 also see |:range-pattern| below
Bram Moolenaar071d4272004-06-13 20:20:40 +0000776 \/ the next line where the previously used search
777 pattern matches
778 \? the previous line where the previously used search
779 pattern matches
780 \& the next line where the previously used substitute
781 pattern matches
782
Bram Moolenaar9954dc32022-11-11 22:58:36 +0000783 *:range-offset*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000784Each may be followed (several times) by '+' or '-' and an optional number.
785This number is added or subtracted from the preceding line number. If the
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000786number is omitted, 1 is used. If there is nothing before the '+' or '-' then
787the current line is used.
Bram Moolenaar9954dc32022-11-11 22:58:36 +0000788 *:range-closed-fold*
789When a line number after the comma is in a closed fold it is adjusted to the
790last line of the fold, thus the whole fold is included.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000791
Bram Moolenaar9954dc32022-11-11 22:58:36 +0000792When a number is added this is done after the adjustment to the last line of
793the fold. This means these lines are additionally included in the range. For
794example: >
795 :3,4+2print
796On this text:
797 1 one ~
798 2 two ~
799 3 three ~
800 4 four FOLDED ~
801 5 five FOLDED ~
802 6 six ~
803 7 seven ~
804 8 eight ~
805Where lines four and five are a closed fold, ends up printing lines 3 to 7.
806The 7 comes from the "4" in the range, which is adjusted to the end of the
807closed fold, which is 5, and then the offset 2 is added.
808
809An example for subtracting (which isn't very useful): >
810 :2,4-1print
811On this text:
812 1 one ~
813 2 two ~
h_eastba77bbb2023-10-03 04:47:13 +0900814 3 three FOLDED ~
Bram Moolenaar9954dc32022-11-11 22:58:36 +0000815 4 four FOLDED ~
816 5 five FOLDED ~
817 6 six FOLDED ~
818 7 seven ~
819 8 eight ~
820Where lines three to six are a closed fold, ends up printing lines 2 to 6.
821The 6 comes from the "4" in the range, which is adjusted to the end of the
822closed fold, which is 6, and then 1 is subtracted, then this is still in the
823closed fold and the last line of that fold is used, which is 6.
824
825 *:range-pattern*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000826The "/" and "?" after {pattern} are required to separate the pattern from
827anything that follows.
828
829The "/" and "?" may be preceded with another address. The search starts from
830there. The difference from using ';' is that the cursor isn't moved.
831Examples: >
832 /pat1//pat2/ Find line containing "pat2" after line containing
833 "pat1", without moving the cursor.
834 7;/pat2/ Find line containing "pat2", after line 7, leaving
835 the cursor in line 7.
836
837The {number} must be between 0 and the number of lines in the file. When
838using a 0 (zero) this is interpreted as a 1 by most commands. Commands that
839use it as a count do use it as a zero (|:tag|, |:pop|, etc). Some commands
840interpret the zero as "before the first line" (|:read|, search pattern, etc).
841
842Examples: >
843 .+3 three lines below the cursor
844 /that/+1 the line below the next line containing "that"
845 .,$ from current line until end of file
846 0;/that the first line containing "that", also matches in the
847 first line.
848 1;/that the first line after line 1 containing "that"
849
850Some commands allow for a count after the command. This count is used as the
851number of lines to be used, starting with the line given in the last line
852specifier (the default is the cursor line). The commands that accept a count
853are the ones that use a range but do not have a file name argument (because
Bram Moolenaar2f0936c2022-01-08 21:51:59 +0000854a file name can also be a number). The count cannot be negative.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000855
856Examples: >
857 :s/x/X/g 5 substitute 'x' by 'X' in the current line and four
858 following lines
859 :23d 4 delete lines 23, 24, 25 and 26
860
861
862Folds and Range
863
864When folds are active the line numbers are rounded off to include the whole
865closed fold. See |fold-behavior|.
866
867
Bram Moolenaara5792f52005-11-23 21:25:05 +0000868Reverse Range *E493*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000869
870A range should have the lower line number first. If this is not the case, Vim
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000871will ask you if it should swap the line numbers.
Bram Moolenaara5792f52005-11-23 21:25:05 +0000872 Backwards range given, OK to swap ~
873This is not done within the global command ":g".
874
875You can use ":silent" before a command to avoid the question, the range will
876always be swapped then.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000877
878
879Count and Range *N:*
880
Bram Moolenaar76db9e02022-11-09 21:21:04 +0000881When giving a count before entering ":", this is translated into: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000882 :.,.+(count - 1)
Bram Moolenaar9fbdbb82022-09-27 17:30:34 +0100883In words: The "count" lines at and after the cursor. Example: To delete
Bram Moolenaar071d4272004-06-13 20:20:40 +0000884three lines: >
885 3:d<CR> is translated into: .,.+2d<CR>
886<
887
Bram Moolenaar22863042021-10-16 15:23:36 +0100888Visual Mode and Range
Bram Moolenaar3ec32172021-05-16 12:39:47 +0200889 *v_:*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000890{Visual}: Starts a command-line with the Visual selected lines as a
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100891 range. The code `:'<,'>` is used for this range, which makes
Bram Moolenaar071d4272004-06-13 20:20:40 +0000892 it possible to select a similar line from the command-line
893 history for repeating a command on different Visually selected
894 lines.
Bram Moolenaar3ec32172021-05-16 12:39:47 +0200895
896:* *:star* *:star-visual-range*
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100897 When Visual mode was already ended, a short way to use the
898 Visual area for a range is `:*`. This requires that "*" does
899 not appear in 'cpo', see |cpo-star|. Otherwise you will have
900 to type `:'<,'>`
Bram Moolenaar3ec32172021-05-16 12:39:47 +0200901 For when "*" is in 'cpo' see |:star-compatible|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000902
903==============================================================================
Bram Moolenaardf177f62005-02-22 08:39:57 +00009045. Ex command-line flags *ex-flags*
905
906These flags are supported by a selection of Ex commands. They print the line
907that the cursor ends up after executing the command:
908
909 l output like for |:list|
910 # add line number
911 p output like for |:print|
912
913The flags can be combined, thus "l#" uses both a line number and |:list| style
914output.
915
916==============================================================================
9176. Ex special characters *cmdline-special*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000918
Bram Moolenaar8fa04452005-12-23 22:13:51 +0000919Note: These are special characters in the executed command line. If you want
920to insert special things while typing you can use the CTRL-R command. For
921example, "%" stands for the current file name, while CTRL-R % inserts the
922current file name right away. See |c_CTRL-R|.
923
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200924Note: If you want to avoid the effects of special characters in a Vim script
925you may want to use |fnameescape()|. Also see |`=|.
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000926
Bram Moolenaar8fa04452005-12-23 22:13:51 +0000927
Bram Moolenaar071d4272004-06-13 20:20:40 +0000928In Ex commands, at places where a file name can be used, the following
929characters have a special meaning. These can also be used in the expression
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200930function |expand()|.
Bram Moolenaard812df62008-11-09 12:46:09 +0000931 % Is replaced with the current file name. *:_%* *c_%*
932 # Is replaced with the alternate file name. *:_#* *c_#*
Bram Moolenaar36782082013-11-28 13:53:34 +0100933 This is remembered for every window.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100934 #n (where n is a number) is replaced with *:_#0* *:_#n*
935 the file name of buffer n. "#0" is the same as "#". *c_#n*
Bram Moolenaard812df62008-11-09 12:46:09 +0000936 ## Is replaced with all names in the argument list *:_##* *c_##*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000937 concatenated, separated by spaces. Each space in a name
938 is preceded with a backslash.
Bram Moolenaard812df62008-11-09 12:46:09 +0000939 #<n (where n is a number > 0) is replaced with old *:_#<* *c_#<*
940 file name n. See |:oldfiles| or |v:oldfiles| to get the
941 number. *E809*
Bram Moolenaardb84e452010-08-15 13:50:43 +0200942 {only when compiled with the |+eval| and |+viminfo| features}
Bram Moolenaar7e6a5152021-01-02 16:39:53 +0100943In |Vim9-script| # is used to start a comment, use %% for the alternate file
944name:
945 % Is replaced with the current file name.
946 %% Is replaced with the alternate file name. *:_%%* *c_%%*
947 %%n (where n is a number) is replaced with *:_%%0* *:_%%n*
948 the file name of buffer n. "%%0" is the same as "%%". *c_%%n*
949 %%% Is replaced with all names in the argument *:_%%%* *c_%%%#*
950 list concatenated, separated by spaces.
951 %%<n (where n is a number > 0) is replaced with old *:_%%<* *c_%%<*
952 file name n.
Bram Moolenaard812df62008-11-09 12:46:09 +0000953
954Note that these, except "#<n", give the file name as it was typed. If an
955absolute path is needed (when using the file name from a different directory),
956you need to add ":p". See |filename-modifiers|.
957
958The "#<n" item returns an absolute path, but it will start with "~/" for files
959below your home directory.
960
Bram Moolenaar071d4272004-06-13 20:20:40 +0000961Note that backslashes are inserted before spaces, so that the command will
962correctly interpret the file name. But this doesn't happen for shell
Bram Moolenaard812df62008-11-09 12:46:09 +0000963commands. For those you probably have to use quotes (this fails for files
964that contain a quote and wildcards): >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000965 :!ls "%"
966 :r !spell "%"
967
968To avoid the special meaning of '%' and '#' insert a backslash before it.
969Detail: The special meaning is always escaped when there is a backslash before
970it, no matter how many backslashes.
971 you type: result ~
972 # alternate.file
973 \# #
974 \\# \#
Bram Moolenaarf9132812015-07-21 19:19:13 +0200975Also see |`=|.
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200976
Bram Moolenaar1d59aa12020-09-19 18:50:13 +0200977 *E499* *E500*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000978Note: these are typed literally, they are not special keys!
Bram Moolenaar1d59aa12020-09-19 18:50:13 +0200979 *:<cword>* *<cword>*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000980 <cword> is replaced with the word under the cursor (like |star|)
Bram Moolenaar1d59aa12020-09-19 18:50:13 +0200981 *:<cWORD>* *<cWORD>*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000982 <cWORD> is replaced with the WORD under the cursor (see |WORD|)
Bram Moolenaar1d59aa12020-09-19 18:50:13 +0200983 *:<cexpr>* *<cexpr>*
Bram Moolenaar65f08472017-09-10 18:16:20 +0200984 <cexpr> is replaced with the word under the cursor, including more
985 to form a C expression. E.g., when the cursor is on "arg"
986 of "ptr->arg" then the result is "ptr->arg"; when the
987 cursor is on "]" of "list[idx]" then the result is
988 "list[idx]". This is used for |v:beval_text|.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +0200989 *:<cfile>* *<cfile>*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000990 <cfile> is replaced with the path name under the cursor (like what
991 |gf| uses)
Bram Moolenaar1d59aa12020-09-19 18:50:13 +0200992 *:<afile>* *<afile>*
Bram Moolenaar81af9252010-12-10 20:35:50 +0100993 <afile> When executing autocommands, is replaced with the file name
Bram Moolenaar01164a62017-11-02 22:58:42 +0100994 of the buffer being manipulated, or the file for a read or
Bram Moolenaarf29c1c62018-09-10 21:05:02 +0200995 write. *E495*
Bram Moolenaar1d59aa12020-09-19 18:50:13 +0200996 *:<abuf>* *<abuf>*
Bram Moolenaar81af9252010-12-10 20:35:50 +0100997 <abuf> When executing autocommands, is replaced with the currently
Bram Moolenaar10e8ff92023-06-10 21:40:39 +0100998 effective buffer number. It is not set for all events,
999 also see |bufnr()|. For ":r file" and ":so file" it is the
1000 current buffer, the file being read/sourced is not in a
1001 buffer. *E496*
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02001002 *:<amatch>* *<amatch>*
Bram Moolenaar81af9252010-12-10 20:35:50 +01001003 <amatch> When executing autocommands, is replaced with the match for
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001004 which this autocommand was executed. *E497*
Bram Moolenaar47003982021-12-05 21:54:04 +00001005 It differs from <afile> when the file name isn't used to
1006 match with (for FileType, Syntax and SpellFileMissing
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001007 events).
Bram Moolenaar47003982021-12-05 21:54:04 +00001008 When the match is with a file name, it is expanded to the
1009 full path.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02001010 *:<sfile>* *<sfile>*
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01001011 <sfile> When executing a `:source` command, is replaced with the
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +02001012 file name of the sourced file. *E498*
Bram Moolenaar6304be62021-11-27 10:57:26 +00001013 When executing a legacy function, is replaced with the call
1014 stack, as with <stack> (this is for backwards
LemonBoy6013d002022-04-09 21:42:10 +01001015 compatibility, using <stack> or <script> is preferred).
Bram Moolenaar6304be62021-11-27 10:57:26 +00001016 In Vim9 script using <sfile> in a function gives error
1017 *E1245* .
Bram Moolenaarca635012015-09-25 20:34:21 +02001018 Note that filename-modifiers are useless when <sfile> is
Bram Moolenaara5d04232020-07-26 15:37:02 +02001019 not used inside a script.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02001020 *:<stack>* *<stack>*
Bram Moolenaara5d04232020-07-26 15:37:02 +02001021 <stack> is replaced with the call stack, using
1022 "function {function-name}[{lnum}]" for a function line
1023 and "script {file-name}[{lnum}]" for a script line, and
1024 ".." in between items. E.g.:
1025 "function {function-name1}[{lnum}]..{function-name2}[{lnum}]"
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00001026 If there is no call stack you get error *E489* .
LemonBoy6013d002022-04-09 21:42:10 +01001027 *:<script>* *<script>*
1028 <script> When executing a `:source` command, is replaced with the file
1029 name of the sourced file. When executing a function, is
1030 replaced with the file name of the script where it is
1031 defined.
1032 If the file name cannot be determined you get error *E1274* .
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02001033 *:<slnum>* *<slnum>*
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01001034 <slnum> When executing a `:source` command, is replaced with the
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001035 line number. *E842*
Bram Moolenaar81af9252010-12-10 20:35:50 +01001036 When executing a function it's the line number relative to
1037 the start of the function.
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02001038 *:<sflnum>* *<sflnum>*
Bram Moolenaarf29c1c62018-09-10 21:05:02 +02001039 <sflnum> When executing a script, is replaced with the line number.
1040 It differs from <slnum> in that <sflnum> is replaced with
1041 the script line number in any situation. *E961*
Bram Moolenaar1d59aa12020-09-19 18:50:13 +02001042 *:<client>* *<client>*
1043 <client> is replaced with the {clinetid} of the last received
1044 message in |server2client()|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001045
1046 *filename-modifiers*
Bram Moolenaar251835e2014-02-24 02:51:51 +01001047*:_%:* *::8* *::p* *::.* *::~* *::h* *::t* *::r* *::e* *::s* *::gs* *::S*
1048 *%:8* *%:p* *%:.* *%:~* *%:h* *%:t* *%:r* *%:e* *%:s* *%:gs* *%:S*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001049The file name modifiers can be used after "%", "#", "#n", "<cfile>", "<sfile>",
1050"<afile>" or "<abuf>". They are also used with the |fnamemodify()| function.
Bram Moolenaar30e9b3c2019-09-07 16:24:12 +02001051
Bram Moolenaar071d4272004-06-13 20:20:40 +00001052These modifiers can be given, in this order:
1053 :p Make file name a full path. Must be the first modifier. Also
1054 changes "~/" (and "~user/" for Unix and VMS) to the path for
1055 the home directory. If the name is a directory a path
1056 separator is added at the end. For a file name that does not
1057 exist and does not have an absolute path the result is
Bram Moolenaar30b65812012-07-12 22:01:11 +02001058 unpredictable. On MS-Windows an 8.3 filename is expanded to
1059 the long name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001060 :8 Converts the path to 8.3 short format (currently only on
Bram Moolenaar30b65812012-07-12 22:01:11 +02001061 MS-Windows). Will act on as much of a path that is an
1062 existing path.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001063 :~ Reduce file name to be relative to the home directory, if
1064 possible. File name is unmodified if it is not below the home
1065 directory.
1066 :. Reduce file name to be relative to current directory, if
1067 possible. File name is unmodified if it is not below the
Bram Moolenaard816cd92020-02-04 22:23:09 +01001068 current directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001069 For maximum shortness, use ":~:.".
1070 :h Head of the file name (the last component and any separators
1071 removed). Cannot be used with :e, :r or :t.
1072 Can be repeated to remove several components at the end.
1073 When the file name ends in a path separator, only the path
1074 separator is removed. Thus ":p:h" on a directory name results
1075 on the directory name itself (without trailing slash).
1076 When the file name is an absolute path (starts with "/" for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001077 Unix; "x:\" for Win32; "drive:" for Amiga), that part is not
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001078 removed. When there is no head (path is relative to current
1079 directory) the result is empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001080 :t Tail of the file name (last component of the name). Must
1081 precede any :r or :e.
1082 :r Root of the file name (the last extension removed). When
1083 there is only an extension (file name that starts with '.',
1084 e.g., ".vimrc"), it is not removed. Can be repeated to remove
1085 several extensions (last one first).
1086 :e Extension of the file name. Only makes sense when used alone.
1087 When there is no extension the result is empty.
1088 When there is only an extension (file name that starts with
1089 '.'), the result is empty. Can be repeated to include more
1090 extensions. If there are not enough extensions (but at least
1091 one) as much as possible are included.
1092 :s?pat?sub?
1093 Substitute the first occurrence of "pat" with "sub". This
1094 works like the |:s| command. "pat" is a regular expression.
1095 Any character can be used for '?', but it must not occur in
1096 "pat" or "sub".
1097 After this, the previous modifiers can be used again. For
1098 example ":p", to make a full path after the substitution.
1099 :gs?pat?sub?
Bram Moolenaaradc21822011-04-01 18:03:16 +02001100 Substitute all occurrences of "pat" with "sub". Otherwise
Bram Moolenaar071d4272004-06-13 20:20:40 +00001101 this works like ":s".
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +02001102 :S Escape special characters for use with a shell command (see
Bram Moolenaar251835e2014-02-24 02:51:51 +01001103 |shellescape()|). Must be the last one. Examples: >
1104 :!dir <cfile>:S
1105 :call system('chmod +w -- ' . expand('%:S'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001106
1107Examples, when the file name is "src/version.c", current dir
1108"/home/mool/vim": >
1109 :p /home/mool/vim/src/version.c
1110 :p:. src/version.c
1111 :p:~ ~/vim/src/version.c
1112 :h src
1113 :p:h /home/mool/vim/src
1114 :p:h:h /home/mool/vim
1115 :t version.c
1116 :p:t version.c
1117 :r src/version
1118 :p:r /home/mool/vim/src/version
1119 :t:r version
1120 :e c
1121 :s?version?main? src/main.c
1122 :s?version?main?:p /home/mool/vim/src/main.c
1123 :p:gs?/?\\? \home\mool\vim\src\version.c
1124
1125Examples, when the file name is "src/version.c.gz": >
1126 :p /home/mool/vim/src/version.c.gz
1127 :e gz
1128 :e:e c.gz
1129 :e:e:e c.gz
1130 :e:e:r c
1131 :r src/version.c
1132 :r:e c
1133 :r:r src/version
1134 :r:r:r src/version
1135<
1136 *extension-removal* *:_%<*
1137If a "<" is appended to "%", "#", "#n" or "CTRL-V p" the extension of the file
1138name is removed (everything after and including the last '.' in the file
1139name). This is included for backwards compatibility with version 3.0, the
1140":r" form is preferred. Examples: >
1141
1142 % current file name
1143 %< current file name without extension
1144 # alternate file name for current window
1145 #< idem, without extension
1146 #31 alternate file number 31
1147 #31< idem, without extension
1148 <cword> word under the cursor
1149 <cWORD> WORD under the cursor (see |WORD|)
1150 <cfile> path name under the cursor
1151 <cfile>< idem, without extension
1152
1153Note: Where a file name is expected wildcards expansion is done. On Unix the
1154shell is used for this, unless it can be done internally (for speed).
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +02001155Unless in |restricted-mode|, backticks work also, like in >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001156 :n `echo *.c`
Bram Moolenaar071d4272004-06-13 20:20:40 +00001157But expansion is only done if there are any wildcards before expanding the
1158'%', '#', etc.. This avoids expanding wildcards inside a file name. If you
1159want to expand the result of <cfile>, add a wildcard character to it.
1160Examples: (alternate file name is "?readme?")
1161 command expands to ~
1162 :e # :e ?readme?
1163 :e `ls #` :e {files matching "?readme?"}
1164 :e #.* :e {files matching "?readme?.*"}
1165 :cd <cfile> :cd {file name under cursor}
1166 :cd <cfile>* :cd {file name under cursor plus "*" and then expanded}
Bram Moolenaarf9132812015-07-21 19:19:13 +02001167Also see |`=|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001168
1169When the expanded argument contains a "!" and it is used for a shell command
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00001170(":!cmd", ":r !cmd" or ":w !cmd"), the "!" is escaped with a backslash to
1171avoid it being expanded into a previously used command. When the 'shell'
1172option contains "sh", this is done twice, to avoid the shell trying to expand
1173the "!".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001174
1175 *filename-backslash*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001176For filesystems that use a backslash as directory separator (MS-Windows), it's
1177a bit difficult to recognize a backslash that is used to escape the special
1178meaning of the next character. The general rule is: If the backslash is
1179followed by a normal file name character, it does not have a special meaning.
1180Therefore "\file\foo" is a valid file name, you don't have to type the
1181backslash twice.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001182
1183An exception is the '$' sign. It is a valid character in a file name. But
1184to avoid a file name like "$home" to be interpreted as an environment variable,
1185it needs to be preceded by a backslash. Therefore you need to use "/\$home"
1186for the file "$home" in the root directory. A few examples:
1187
1188 FILE NAME INTERPRETED AS ~
1189 $home expanded to value of environment var $home
1190 \$home file "$home" in current directory
1191 /\$home file "$home" in root directory
1192 \\$home file "\\", followed by expanded $home
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +02001193
Bram Moolenaarf9132812015-07-21 19:19:13 +02001194Also see |`=|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001195
1196==============================================================================
Bram Moolenaarac7bd632013-03-19 11:35:58 +010011977. Command-line window *cmdline-window* *cmdwin*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001198 *command-line-window*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001199In the command-line window the command line can be edited just like editing
1200text in any window. It is a special kind of window, because you cannot leave
1201it in a normal way.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001202
1203
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001204OPEN *c_CTRL-F* *q:* *q/* *q?*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001205
1206There are two ways to open the command-line window:
12071. From Command-line mode, use the key specified with the 'cedit' option.
1208 The default is CTRL-F when 'compatible' is not set.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +010012092. From Normal mode, use the "q:", "q/" or "q?" command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001210 This starts editing an Ex command-line ("q:") or search string ("q/" or
1211 "q?"). Note that this is not possible while recording is in progress (the
1212 "q" stops recording then).
1213
1214When the window opens it is filled with the command-line history. The last
1215line contains the command as typed so far. The left column will show a
1216character that indicates the type of command-line being edited, see
1217|cmdwin-char|.
1218
1219Vim will be in Normal mode when the editor is opened, except when 'insertmode'
1220is set.
Bram Moolenaar2ecbe532022-07-29 21:36:21 +01001221 *E1292*
1222Once a command-line window is open it is not possible to open another one.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001223
1224The height of the window is specified with 'cmdwinheight' (or smaller if there
1225is no room). The window is always full width and is positioned just above the
1226command-line.
1227
1228
1229EDIT
1230
1231You can now use commands to move around and edit the text in the window. Both
1232in Normal mode and Insert mode.
1233
1234It is possible to use ":", "/" and other commands that use the command-line,
1235but it's not possible to open another command-line window then. There is no
1236nesting.
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02001237 *E11* *E1188*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001238The command-line window is not a normal window. It is not possible to move to
1239another window or edit another buffer. All commands that would do this are
1240disabled in the command-line window. Of course it _is_ possible to execute
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001241any command that you entered in the command-line window. Other text edits are
1242discarded when closing the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001243
1244
1245CLOSE *E199*
1246
1247There are several ways to leave the command-line window:
1248
1249<CR> Execute the command-line under the cursor. Works both in
1250 Insert and in Normal mode.
1251CTRL-C Continue in Command-line mode. The command-line under the
1252 cursor is used as the command-line. Works both in Insert and
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01001253 in Normal mode. There is no redraw, thus the window will
1254 remain visible.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001255:quit Discard the command line and go back to Normal mode.
Bram Moolenaar3d1cde82020-08-15 18:55:18 +02001256 ":close", CTRL-W c, ":exit", ":xit" and CTRL-\ CTRL-N also
1257 work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001258:qall Quit Vim, unless there are changes in some buffer.
1259:qall! Quit Vim, discarding changes to any buffer.
1260
1261Once the command-line window is closed the old window sizes are restored. The
1262executed command applies to the window and buffer where the command-line was
1263started from. This works as if the command-line window was not there, except
1264that there will be an extra screen redraw.
1265The buffer used for the command-line window is deleted. Any changes to lines
1266other than the one that is executed with <CR> are lost.
1267
Bram Moolenaar36fc5352006-03-04 21:49:37 +00001268If you would like to execute the command under the cursor and then have the
1269command-line window open again, you may find this mapping useful: >
1270
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001271 :autocmd CmdwinEnter * map <buffer> <F5> <CR>q:
Bram Moolenaar36fc5352006-03-04 21:49:37 +00001272
Bram Moolenaar071d4272004-06-13 20:20:40 +00001273
1274VARIOUS
1275
1276The command-line window cannot be used:
1277- when there already is a command-line window (no nesting)
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001278- for entering an encryption key or when using inputsecret()
Bram Moolenaar071d4272004-06-13 20:20:40 +00001279
1280Some options are set when the command-line window is opened:
1281'filetype' "vim", when editing an Ex command-line; this starts Vim syntax
1282 highlighting if it was enabled
1283'rightleft' off
1284'modifiable' on
1285'buftype' "nofile"
1286'swapfile' off
1287
1288It is allowed to write the buffer contents to a file. This is an easy way to
1289save the command-line history and read it back later.
1290
1291If the 'wildchar' option is set to <Tab>, and the command-line window is used
1292for an Ex command, then two mappings will be added to use <Tab> for completion
1293in the command-line window, like this: >
Bram Moolenaard592deb2022-06-17 15:42:40 +01001294 :inoremap <buffer> <Tab> <C-X><C-V>
1295 :nnoremap <buffer> <Tab> a<C-X><C-V>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001296Note that hitting <Tab> in Normal mode will do completion on the next
1297character. That way it works at the end of the line.
1298If you don't want these mappings, disable them with: >
1299 au CmdwinEnter [:>] iunmap <Tab>
1300 au CmdwinEnter [:>] nunmap <Tab>
1301You could put these lines in your vimrc file.
1302
1303While in the command-line window you cannot use the mouse to put the cursor in
1304another window, or drag statuslines of other windows. You can drag the
1305statusline of the command-line window itself and the statusline above it.
1306Thus you can resize the command-line window, but not others.
1307
Bram Moolenaarfb539272014-08-22 19:21:47 +02001308The |getcmdwintype()| function returns the type of the command-line being
1309edited as described in |cmdwin-char|.
1310
Bram Moolenaar071d4272004-06-13 20:20:40 +00001311
1312AUTOCOMMANDS
1313
Bram Moolenaar96e38a82019-09-09 18:35:33 +02001314Two autocommand events are used: |CmdwinEnter| and |CmdwinLeave|. You can use
1315the Cmdwin events to do settings specifically for the command-line window.
1316Be careful not to cause side effects!
Bram Moolenaar071d4272004-06-13 20:20:40 +00001317Example: >
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001318 :au CmdwinEnter : let b:cpt_save = &cpt | set cpt=.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001319 :au CmdwinLeave : let &cpt = b:cpt_save
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001320This sets 'complete' to use completion in the current window for |i_CTRL-N|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001321Another example: >
1322 :au CmdwinEnter [/?] startinsert
1323This will make Vim start in Insert mode in the command-line window.
1324
1325 *cmdwin-char*
1326The character used for the pattern indicates the type of command-line:
1327 : normal Ex command
1328 > debug mode command |debug-mode|
1329 / forward search string
1330 ? backward search string
1331 = expression for "= |expr-register|
1332 @ string for |input()|
1333 - text for |:insert| or |:append|
1334
Bram Moolenaar91f84f62018-07-29 15:07:52 +02001335 vim:tw=78:ts=8:noet:ft=help:norl: