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