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