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