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