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