Mercurial > vim
annotate runtime/doc/change.txt @ 3507:8201108e9cf0
More runtime file fixes for 'compatible' mode.
| author | Bram Moolenaar <bram@vim.org> |
|---|---|
| date | Tue, 01 May 2012 21:14:34 +0200 |
| parents | 1be42b88900e |
| children | 5c1aaf9b4b1b |
| rev | line source |
|---|---|
|
3507
8201108e9cf0
More runtime file fixes for 'compatible' mode.
Bram Moolenaar <bram@vim.org>
parents:
3493
diff
changeset
|
1 *change.txt* For Vim version 7.3. Last change: 2012 Apr 30 |
| 7 | 2 |
| 3 | |
| 4 VIM REFERENCE MANUAL by Bram Moolenaar | |
| 5 | |
| 6 | |
| 7 This file describes commands that delete or change text. In this context, | |
| 8 changing text means deleting the text and replacing it with other text using | |
| 9 one command. You can undo all of these commands. You can repeat the non-Ex | |
| 10 commands with the "." command. | |
| 11 | |
| 12 1. Deleting text |deleting| | |
| 13 2. Delete and insert |delete-insert| | |
| 14 3. Simple changes |simple-change| *changing* | |
| 15 4. Complex changes |complex-change| | |
| 32 | 16 4.1 Filter commands |filter| |
| 17 4.2 Substitute |:substitute| | |
| 18 4.3 Search and replace |search-replace| | |
| 19 4.4 Changing tabs |change-tabs| | |
| 7 | 20 5. Copying and moving text |copy-move| |
| 21 6. Formatting text |formatting| | |
| 282 | 22 7. Sorting text |sorting| |
| 7 | 23 |
| 24 For inserting text see |insert.txt|. | |
| 25 | |
| 26 ============================================================================== | |
| 27 1. Deleting text *deleting* *E470* | |
| 28 | |
| 29 ["x]<Del> or *<Del>* *x* *dl* | |
| 30 ["x]x Delete [count] characters under and after the cursor | |
| 31 [into register x] (not |linewise|). Does the same as | |
| 32 "dl". | |
| 33 The <Del> key does not take a [count]. Instead, it | |
| 34 deletes the last character of the count. | |
| 35 See |:fixdel| if the <Del> key does not do what you | |
| 36 want. See |'whichwrap'| for deleting a line break | |
| 37 (join lines). {Vi does not support <Del>} | |
| 38 | |
| 39 *X* *dh* | |
| 40 ["x]X Delete [count] characters before the cursor [into | |
| 41 register x] (not |linewise|). Does the same as "dh". | |
| 42 Also see |'whichwrap'|. | |
| 43 | |
| 44 *d* | |
| 45 ["x]d{motion} Delete text that {motion} moves over [into register | |
| 46 x]. See below for exceptions. | |
| 47 | |
| 48 *dd* | |
| 49 ["x]dd Delete [count] lines [into register x] |linewise|. | |
| 50 | |
| 51 *D* | |
| 52 ["x]D Delete the characters under the cursor until the end | |
| 53 of the line and [count]-1 more lines [into register | |
| 54 x]; synonym for "d$". | |
| 55 (not |linewise|) | |
| 164 | 56 When the '#' flag is in 'cpoptions' the count is |
| 57 ignored. | |
| 7 | 58 |
| 59 {Visual}["x]x or *v_x* *v_d* *v_<Del>* | |
| 60 {Visual}["x]d or | |
| 61 {Visual}["x]<Del> Delete the highlighted text [into register x] (for | |
| 62 {Visual} see |Visual-mode|). {not in Vi} | |
| 63 | |
| 64 {Visual}["x]CTRL-H or *v_CTRL-H* *v_<BS>* | |
| 65 {Visual}["x]<BS> When in Select mode: Delete the highlighted text [into | |
| 66 register x]. | |
| 67 | |
| 68 {Visual}["x]X or *v_X* *v_D* *v_b_D* | |
| 69 {Visual}["x]D Delete the highlighted lines [into register x] (for | |
| 70 {Visual} see |Visual-mode|). In Visual block mode, | |
| 71 "D" deletes the highlighted text plus all text until | |
| 72 the end of the line. {not in Vi} | |
| 73 | |
| 3224 | 74 *:d* *:de* *:del* *:delete* *:dl* |
| 7 | 75 :[range]d[elete] [x] Delete [range] lines (default: current line) [into |
| 76 register x]. | |
| 77 | |
| 78 :[range]d[elete] [x] {count} | |
| 79 Delete {count} lines, starting with [range] | |
| 80 (default: current line |cmdline-ranges|) [into | |
| 81 register x]. | |
| 82 | |
| 3492 | 83 These commands delete text. You can repeat them with the `.` command |
| 84 (except `:d`) and undo them. Use Visual mode to delete blocks of text. See | |
| 7 | 85 |registers| for an explanation of registers. |
| 86 | |
| 87 An exception for the d{motion} command: If the motion is not linewise, the | |
| 88 start and end of the motion are not in the same line, and there are only | |
| 89 blanks before the start and after the end of the motion, the delete becomes | |
| 90 linewise. This means that the delete also removes the line of blanks that you | |
| 3256 | 91 might expect to remain. Use the |o_v| operator to force the motion to be |
| 92 characterwise. | |
| 7 | 93 |
| 94 Trying to delete an empty region of text (e.g., "d0" in the first column) | |
| 95 is an error when 'cpoptions' includes the 'E' flag. | |
| 96 | |
| 97 *J* | |
| 98 J Join [count] lines, with a minimum of two lines. | |
| 99 Remove the indent and insert up to two spaces (see | |
| 100 below). | |
| 101 | |
| 102 *v_J* | |
| 103 {Visual}J Join the highlighted lines, with a minimum of two | |
| 104 lines. Remove the indent and insert up to two spaces | |
| 105 (see below). {not in Vi} | |
| 106 | |
| 107 *gJ* | |
| 108 gJ Join [count] lines, with a minimum of two lines. | |
| 109 Don't insert or remove any spaces. {not in Vi} | |
| 110 | |
| 111 *v_gJ* | |
| 112 {Visual}gJ Join the highlighted lines, with a minimum of two | |
| 113 lines. Don't insert or remove any spaces. {not in | |
| 114 Vi} | |
| 115 | |
| 116 *:j* *:join* | |
| 168 | 117 :[range]j[oin][!] [flags] |
| 118 Join [range] lines. Same as "J", except with [!] | |
| 7 | 119 the join does not insert or delete any spaces. |
| 120 If a [range] has equal start and end values, this | |
| 121 command does nothing. The default behavior is to | |
| 122 join the current line with the line below it. | |
| 123 {not in Vi: !} | |
| 168 | 124 See |ex-flags| for [flags]. |
| 7 | 125 |
| 168 | 126 :[range]j[oin][!] {count} [flags] |
| 7 | 127 Join {count} lines, starting with [range] (default: |
| 128 current line |cmdline-ranges|). Same as "J", except | |
| 129 with [!] the join does not insert or delete any | |
| 130 spaces. | |
| 131 {not in Vi: !} | |
| 168 | 132 See |ex-flags| for [flags]. |
| 7 | 133 |
| 134 These commands delete the <EOL> between lines. This has the effect of joining | |
| 3492 | 135 multiple lines into one line. You can repeat these commands (except `:j`) and |
| 7 | 136 undo them. |
| 137 | |
| 138 These commands, except "gJ", insert one space in place of the <EOL> unless | |
| 139 there is trailing white space or the next line starts with a ')'. These | |
| 140 commands, except "gJ", delete any leading white space on the next line. If | |
| 141 the 'joinspaces' option is on, these commands insert two spaces after a '.', | |
| 142 '!' or '?' (but if 'cpoptions' includes the 'j' flag, they insert two spaces | |
| 143 only after a '.'). | |
| 144 The 'B' and 'M' flags in 'formatoptions' change the behavior for inserting | |
| 145 spaces before and after a multi-byte character |fo-table|. | |
| 146 | |
| 147 | |
| 148 ============================================================================== | |
| 149 2. Delete and insert *delete-insert* *replacing* | |
| 150 | |
| 151 *R* | |
| 152 R Enter Replace mode: Each character you type replaces | |
| 153 an existing character, starting with the character | |
| 154 under the cursor. Repeat the entered text [count]-1 | |
| 155 times. See |Replace-mode| for more details. | |
| 156 | |
| 157 *gR* | |
| 158 gR Enter Virtual Replace mode: Each character you type | |
| 159 replaces existing characters in screen space. So a | |
| 160 <Tab> may replace several characters at once. | |
| 161 Repeat the entered text [count]-1 times. See | |
| 162 |Virtual-Replace-mode| for more details. | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
163 {not available when compiled without the |+vreplace| |
| 7 | 164 feature} |
| 165 | |
| 166 *c* | |
| 167 ["x]c{motion} Delete {motion} text [into register x] and start | |
| 168 insert. When 'cpoptions' includes the 'E' flag and | |
| 169 there is no text to delete (e.g., with "cTx" when the | |
| 170 cursor is just after an 'x'), an error occurs and | |
| 171 insert mode does not start (this is Vi compatible). | |
| 172 When 'cpoptions' does not include the 'E' flag, the | |
| 173 "c" command always starts insert mode, even if there | |
| 174 is no text to delete. | |
| 175 | |
| 176 *cc* | |
| 177 ["x]cc Delete [count] lines [into register x] and start | |
| 178 insert |linewise|. If 'autoindent' is on, preserve | |
| 179 the indent of the first line. | |
| 180 | |
| 181 *C* | |
| 182 ["x]C Delete from the cursor position to the end of the | |
| 183 line and [count]-1 more lines [into register x], and | |
| 184 start insert. Synonym for c$ (not |linewise|). | |
| 185 | |
| 186 *s* | |
| 187 ["x]s Delete [count] characters [into register x] and start | |
| 188 insert (s stands for Substitute). Synonym for "cl" | |
| 189 (not |linewise|). | |
| 190 | |
| 191 *S* | |
| 192 ["x]S Delete [count] lines [into register x] and start | |
| 193 insert. Synonym for "cc" |linewise|. | |
| 194 | |
| 195 {Visual}["x]c or *v_c* *v_s* | |
| 196 {Visual}["x]s Delete the highlighted text [into register x] and | |
| 197 start insert (for {Visual} see |Visual-mode|). {not | |
| 198 in Vi} | |
| 199 | |
| 200 *v_r* | |
| 201 {Visual}["x]r{char} Replace all selected characters by {char}. | |
| 202 | |
| 203 *v_C* | |
| 204 {Visual}["x]C Delete the highlighted lines [into register x] and | |
| 205 start insert. In Visual block mode it works | |
| 206 differently |v_b_C|. {not in Vi} | |
| 207 *v_S* | |
| 208 {Visual}["x]S Delete the highlighted lines [into register x] and | |
| 209 start insert (for {Visual} see |Visual-mode|). {not | |
| 210 in Vi} | |
| 211 *v_R* | |
| 212 {Visual}["x]R Currently just like {Visual}["x]S. In a next version | |
| 213 it might work differently. {not in Vi} | |
| 214 | |
| 215 Notes: | |
| 216 - You can end Insert and Replace mode with <Esc>. | |
| 217 - See the section "Insert and Replace mode" |mode-ins-repl| for the other | |
| 218 special characters in these modes. | |
| 219 - The effect of [count] takes place after Vim exits Insert or Replace mode. | |
| 220 - When the 'cpoptions' option contains '$' and the change is within one line, | |
| 221 Vim continues to show the text to be deleted and puts a '$' at the last | |
| 222 deleted character. | |
| 223 | |
| 224 See |registers| for an explanation of registers. | |
| 225 | |
| 226 Replace mode is just like Insert mode, except that every character you enter | |
| 227 deletes one character. If you reach the end of a line, Vim appends any | |
| 228 further characters (just like Insert mode). In Replace mode, the backspace | |
| 229 key restores the original text (if there was any). (See section "Insert and | |
| 230 Replace mode" |mode-ins-repl|). | |
| 231 | |
| 232 *cw* *cW* | |
| 1621 | 233 Special case: When the cursor is in a word, "cw" and "cW" do not include the |
| 234 white space after a word, they only change up to the end of the word. This is | |
| 235 because Vim interprets "cw" as change-word, and a word does not include the | |
| 236 following white space. | |
| 237 {Vi: "cw" when on a blank followed by other blanks changes only the first | |
| 238 blank; this is probably a bug, because "dw" deletes all the blanks; use the | |
| 239 'w' flag in 'cpoptions' to make it work like Vi anyway} | |
| 7 | 240 |
| 241 If you prefer "cw" to include the space after a word, use this mapping: > | |
| 242 :map cw dwi | |
| 1621 | 243 Or use "caw" (see |aw|). |
| 244 | |
| 7 | 245 *:c* *:ch* *:change* |
| 168 | 246 :{range}c[hange][!] Replace lines of text with some different text. |
| 7 | 247 Type a line containing only "." to stop replacing. |
| 248 Without {range}, this command changes only the current | |
| 249 line. | |
| 168 | 250 Adding [!] toggles 'autoindent' for the time this |
| 251 command is executed. | |
| 7 | 252 |
| 253 ============================================================================== | |
| 254 3. Simple changes *simple-change* | |
| 255 | |
| 256 *r* | |
| 257 r{char} Replace the character under the cursor with {char}. | |
| 258 If {char} is a <CR> or <NL>, a line break replaces the | |
| 259 character. To replace with a real <CR>, use CTRL-V | |
| 260 <CR>. CTRL-V <NL> replaces with a <Nul>. | |
| 261 {Vi: CTRL-V <CR> still replaces with a line break, | |
| 262 cannot replace something with a <CR>} | |
|
3507
8201108e9cf0
More runtime file fixes for 'compatible' mode.
Bram Moolenaar <bram@vim.org>
parents:
3493
diff
changeset
|
263 |
|
8201108e9cf0
More runtime file fixes for 'compatible' mode.
Bram Moolenaar <bram@vim.org>
parents:
3493
diff
changeset
|
264 If {char} is CTRL-E or CTRL-Y the character from the |
|
8201108e9cf0
More runtime file fixes for 'compatible' mode.
Bram Moolenaar <bram@vim.org>
parents:
3493
diff
changeset
|
265 line below or above is used, just like with |i_CTRL-E| |
|
8201108e9cf0
More runtime file fixes for 'compatible' mode.
Bram Moolenaar <bram@vim.org>
parents:
3493
diff
changeset
|
266 and |i_CTRL-Y|. This also works with a count, thus |
|
8201108e9cf0
More runtime file fixes for 'compatible' mode.
Bram Moolenaar <bram@vim.org>
parents:
3493
diff
changeset
|
267 `10r<C-E>` copies 10 characters from the line below. |
|
8201108e9cf0
More runtime file fixes for 'compatible' mode.
Bram Moolenaar <bram@vim.org>
parents:
3493
diff
changeset
|
268 |
| 7 | 269 If you give a [count], Vim replaces [count] characters |
| 270 with [count] {char}s. When {char} is a <CR> or <NL>, | |
| 271 however, Vim inserts only one <CR>: "5r<CR>" replaces | |
| 272 five characters with a single line break. | |
| 273 When {char} is a <CR> or <NL>, Vim performs | |
| 274 autoindenting. This works just like deleting the | |
| 275 characters that are replaced and then doing | |
| 276 "i<CR><Esc>". | |
| 277 {char} can be entered as a digraph |digraph-arg|. | |
| 278 |:lmap| mappings apply to {char}. The CTRL-^ command | |
| 279 in Insert mode can be used to switch this on/off | |
| 280 |i_CTRL-^|. See |utf-8-char-arg| about using | |
| 281 composing characters when 'encoding' is Unicode. | |
| 282 | |
| 283 *gr* | |
| 284 gr{char} Replace the virtual characters under the cursor with | |
| 285 {char}. This replaces in screen space, not file | |
| 286 space. See |gR| and |Virtual-Replace-mode| for more | |
| 287 details. As with |r| a count may be given. | |
| 288 {char} can be entered like with |r|. | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
289 {not available when compiled without the |+vreplace| |
| 7 | 290 feature} |
| 291 | |
| 292 *digraph-arg* | |
| 293 The argument for Normal mode commands like |r| and |t| is a single character. | |
| 294 When 'cpo' doesn't contain the 'D' flag, this character can also be entered | |
| 295 like |digraphs|. First type CTRL-K and then the two digraph characters. | |
| 296 {not available when compiled without the |+digraphs| feature} | |
| 297 | |
| 298 *case* | |
| 299 The following commands change the case of letters. The currently active | |
| 300 |locale| is used. See |:language|. The LC_CTYPE value matters here. | |
| 301 | |
| 302 *~* | |
| 303 ~ 'notildeop' option: Switch case of the character | |
| 304 under the cursor and move the cursor to the right. | |
| 305 If a [count] is given, do that many characters. {Vi: | |
| 306 no count} | |
| 307 | |
| 308 ~{motion} 'tildeop' option: switch case of {motion} text. {Vi: | |
| 309 tilde cannot be used as an operator} | |
| 310 | |
| 311 *g~* | |
| 312 g~{motion} Switch case of {motion} text. {not in Vi} | |
| 313 | |
| 314 g~g~ *g~g~* *g~~* | |
| 315 g~~ Switch case of current line. {not in Vi}. | |
| 316 | |
| 317 *v_~* | |
| 318 {Visual}~ Switch case of highlighted text (for {Visual} see | |
| 319 |Visual-mode|). {not in Vi} | |
| 320 | |
| 321 *v_U* | |
| 322 {Visual}U Make highlighted text uppercase (for {Visual} see | |
| 323 |Visual-mode|). {not in Vi} | |
| 324 | |
| 325 *gU* *uppercase* | |
| 326 gU{motion} Make {motion} text uppercase. {not in Vi} | |
| 327 Example: > | |
| 328 :map! <C-F> <Esc>gUiw`]a | |
| 329 < This works in Insert mode: press CTRL-F to make the | |
| 330 word before the cursor uppercase. Handy to type | |
| 331 words in lowercase and then make them uppercase. | |
| 332 | |
| 333 | |
| 334 gUgU *gUgU* *gUU* | |
| 335 gUU Make current line uppercase. {not in Vi}. | |
| 336 | |
| 337 *v_u* | |
| 338 {Visual}u Make highlighted text lowercase (for {Visual} see | |
| 339 |Visual-mode|). {not in Vi} | |
| 340 | |
| 341 *gu* *lowercase* | |
| 342 gu{motion} Make {motion} text lowercase. {not in Vi} | |
| 343 | |
| 344 gugu *gugu* *guu* | |
| 345 guu Make current line lowercase. {not in Vi}. | |
| 346 | |
| 347 *g?* *rot13* | |
| 348 g?{motion} Rot13 encode {motion} text. {not in Vi} | |
| 349 | |
| 350 *v_g?* | |
| 351 {Visual}g? Rot13 encode the highlighted text (for {Visual} see | |
| 352 |Visual-mode|). {not in Vi} | |
| 353 | |
| 354 g?g? *g?g?* *g??* | |
| 355 g?? Rot13 encode current line. {not in Vi}. | |
| 356 | |
| 1621 | 357 To turn one line into title caps, make every first letter of a word |
| 358 uppercase: > | |
| 359 :s/\v<(.)(\w*)/\u\1\L\2/g | |
| 360 | |
| 7 | 361 |
| 362 Adding and subtracting ~ | |
| 363 *CTRL-A* | |
| 364 CTRL-A Add [count] to the number or alphabetic character at | |
| 365 or after the cursor. {not in Vi} | |
| 366 | |
| 367 *CTRL-X* | |
| 368 CTRL-X Subtract [count] from the number or alphabetic | |
| 369 character at or after the cursor. {not in Vi} | |
| 370 | |
| 371 The CTRL-A and CTRL-X commands work for (signed) decimal numbers, unsigned | |
| 372 octal and hexadecimal numbers and alphabetic characters. This depends on the | |
| 373 'nrformats' option. | |
| 36 | 374 - When 'nrformats' includes "octal", Vim considers numbers starting with a '0' |
| 39 | 375 to be octal, unless the number includes a '8' or '9'. Other numbers are |
| 376 decimal and may have a preceding minus sign. | |
| 36 | 377 If the cursor is on a number, the commands apply to that number; otherwise |
| 378 Vim uses the number to the right of the cursor. | |
| 7 | 379 - When 'nrformats' includes "hex", Vim assumes numbers starting with '0x' or |
| 380 '0X' are hexadecimal. The case of the rightmost letter in the number | |
| 381 determines the case of the resulting hexadecimal number. If there is no | |
| 382 letter in the current number, Vim uses the previously detected case. | |
| 36 | 383 - When 'nrformats' includes "alpha", Vim will change the alphabetic character |
| 384 under or after the cursor. This is useful to make lists with an alphabetic | |
| 385 index. | |
| 7 | 386 |
| 387 For numbers with leading zeros (including all octal and hexadecimal numbers), | |
| 388 Vim preserves the number of characters in the number when possible. CTRL-A on | |
| 36 | 389 "0077" results in "0100", CTRL-X on "0x100" results in "0x0ff". |
| 39 | 390 There is one exception: When a number that starts with a zero is found not to |
| 391 be octal (it contains a '8' or '9'), but 'nrformats' does include "octal", | |
| 392 leading zeros are removed to avoid that the result may be recognized as an | |
| 393 octal number. | |
| 36 | 394 |
| 395 Note that when 'nrformats' includes "octal", decimal numbers with leading | |
| 39 | 396 zeros cause mistakes, because they can be confused with octal numbers. |
| 7 | 397 |
| 398 The CTRL-A command is very useful in a macro. Example: Use the following | |
| 399 steps to make a numbered list. | |
| 400 | |
| 401 1. Create the first list entry, make sure it starts with a number. | |
| 99 | 402 2. qa - start recording into register 'a' |
| 7 | 403 3. Y - yank the entry |
| 404 4. p - put a copy of the entry below the first one | |
| 405 5. CTRL-A - increment the number | |
| 406 6. q - stop recording | |
| 407 7. <count>@a - repeat the yank, put and increment <count> times | |
| 408 | |
| 409 | |
| 410 SHIFTING LINES LEFT OR RIGHT *shift-left-right* | |
| 411 | |
| 412 *<* | |
| 413 <{motion} Shift {motion} lines one 'shiftwidth' leftwards. | |
| 414 | |
| 415 *<<* | |
| 416 << Shift [count] lines one 'shiftwidth' leftwards. | |
| 417 | |
| 418 *v_<* | |
| 419 {Visual}[count]< Shift the highlighted lines [count] 'shiftwidth' | |
| 420 leftwards (for {Visual} see |Visual-mode|). {not in | |
| 421 Vi} | |
| 422 | |
| 423 *>* | |
| 424 >{motion} Shift {motion} lines one 'shiftwidth' rightwards. | |
| 425 | |
| 426 *>>* | |
| 427 >> Shift [count] lines one 'shiftwidth' rightwards. | |
| 428 | |
| 429 *v_>* | |
| 430 {Visual}[count]> Shift the highlighted lines [count] 'shiftwidth' | |
| 431 rightwards (for {Visual} see |Visual-mode|). {not in | |
| 432 Vi} | |
| 433 | |
| 434 *:<* | |
| 435 :[range]< Shift [range] lines one 'shiftwidth' left. Repeat '<' | |
| 436 for shifting multiple 'shiftwidth's. | |
| 437 | |
| 438 :[range]< {count} Shift {count} lines one 'shiftwidth' left, starting | |
| 439 with [range] (default current line |cmdline-ranges|). | |
| 440 Repeat '<' for shifting multiple 'shiftwidth's. | |
| 441 | |
| 442 :[range]le[ft] [indent] left align lines in [range]. Sets the indent in the | |
| 443 lines to [indent] (default 0). {not in Vi} | |
| 444 | |
| 445 *:>* | |
| 168 | 446 :[range]> [flags] Shift {count} [range] lines one 'shiftwidth' right. |
| 7 | 447 Repeat '>' for shifting multiple 'shiftwidth's. |
| 168 | 448 See |ex-flags| for [flags]. |
| 7 | 449 |
| 168 | 450 :[range]> {count} [flags] |
| 451 Shift {count} lines one 'shiftwidth' right, starting | |
| 7 | 452 with [range] (default current line |cmdline-ranges|). |
| 453 Repeat '>' for shifting multiple 'shiftwidth's. | |
| 168 | 454 See |ex-flags| for [flags]. |
| 7 | 455 |
| 456 The ">" and "<" commands are handy for changing the indentation within | |
| 457 programs. Use the 'shiftwidth' option to set the size of the white space | |
| 458 which these commands insert or delete. Normally the 'shiftwidth' option is 8, | |
| 459 but you can set it to, say, 3 to make smaller indents. The shift leftwards | |
| 460 stops when there is no indent. The shift right does not affect empty lines. | |
| 461 | |
| 462 If the 'shiftround' option is on, the indent is rounded to a multiple of | |
| 463 'shiftwidth'. | |
| 464 | |
| 465 If the 'smartindent' option is on, or 'cindent' is on and 'cinkeys' contains | |
| 466 '#', shift right does not affect lines starting with '#' (these are supposed | |
| 467 to be C preprocessor lines that must stay in column 1). | |
| 468 | |
| 469 When the 'expandtab' option is off (this is the default) Vim uses <Tab>s as | |
| 470 much as possible to make the indent. You can use ">><<" to replace an indent | |
| 471 made out of spaces with the same indent made out of <Tab>s (and a few spaces | |
| 472 if necessary). If the 'expandtab' option is on, Vim uses only spaces. Then | |
| 473 you can use ">><<" to replace <Tab>s in the indent by spaces (or use | |
| 3492 | 474 `:retab!`). |
| 7 | 475 |
| 3492 | 476 To move a line several 'shiftwidth's, use Visual mode or the `:` commands. |
| 7 | 477 For example: > |
| 478 Vjj4> move three lines 4 indents to the right | |
| 479 :<<< move current line 3 indents to the left | |
| 480 :>> 5 move 5 lines 2 indents to the right | |
| 481 :5>> move line 5 2 indents to the right | |
| 482 | |
| 483 ============================================================================== | |
| 484 4. Complex changes *complex-change* | |
| 485 | |
| 856 | 486 4.1 Filter commands *filter* |
| 32 | 487 |
| 488 A filter is a program that accepts text at standard input, changes it in some | |
| 489 way, and sends it to standard output. You can use the commands below to send | |
| 1621 | 490 some text through a filter, so that it is replaced by the filter output. |
| 32 | 491 Examples of filters are "sort", which sorts lines alphabetically, and |
| 492 "indent", which formats C program files (you need a version of indent that | |
| 493 works like a filter; not all versions do). The 'shell' option specifies the | |
| 494 shell Vim uses to execute the filter command (See also the 'shelltype' | |
| 495 option). You can repeat filter commands with ".". Vim does not recognize a | |
| 3492 | 496 comment (starting with '"') after the `:!` command. |
| 32 | 497 |
| 498 *!* | |
| 7 | 499 !{motion}{filter} Filter {motion} text lines through the external |
| 500 program {filter}. | |
| 501 | |
| 502 *!!* | |
| 503 !!{filter} Filter [count] lines through the external program | |
| 504 {filter}. | |
| 505 | |
| 506 *v_!* | |
| 507 {Visual}!{filter} Filter the highlighted lines through the external | |
| 508 program {filter} (for {Visual} see |Visual-mode|). | |
| 509 {not in Vi} | |
| 510 | |
| 511 :{range}![!]{filter} [!][arg] *:range!* | |
| 512 Filter {range} lines through the external program | |
| 513 {filter}. Vim replaces the optional bangs with the | |
| 514 latest given command and appends the optional [arg]. | |
| 515 Vim saves the output of the filter command in a | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
516 temporary file and then reads the file into the buffer |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
517 |tempfile|. Vim uses the 'shellredir' option to |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
518 redirect the filter output to the temporary file. |
| 603 | 519 However, if the 'shelltemp' option is off then pipes |
| 520 are used when possible (on Unix). | |
| 7 | 521 When the 'R' flag is included in 'cpoptions' marks in |
| 522 the filtered lines are deleted, unless the | |
| 523 |:keepmarks| command is used. Example: > | |
| 524 :keepmarks '<,'>!sort | |
| 525 < When the number of lines after filtering is less than | |
| 526 before, marks in the missing lines are deleted anyway. | |
| 527 | |
| 528 *=* | |
| 529 ={motion} Filter {motion} lines through the external program | |
| 530 given with the 'equalprg' option. When the 'equalprg' | |
| 531 option is empty (this is the default), use the | |
| 2833 | 532 internal formatting function |C-indenting| and |
| 533 |'lisp'|. But when 'indentexpr' is not empty, it will | |
| 534 be used instead |indent-expression|. When Vim was | |
| 535 compiled without internal formatting then the "indent" | |
| 536 program is used as a last resort. | |
| 7 | 537 |
| 538 *==* | |
| 539 == Filter [count] lines like with ={motion}. | |
| 540 | |
| 541 *v_=* | |
| 542 {Visual}= Filter the highlighted lines like with ={motion}. | |
| 543 {not in Vi} | |
| 544 | |
| 545 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
546 *tempfile* *setuid* |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
547 Vim uses temporary files for filtering, generating diffs and also for |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
548 tempname(). For Unix, the file will be in a private directory (only |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
549 accessible by the current user) to avoid security problems (e.g., a symlink |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
550 attack or other people reading your file). When Vim exits the directory and |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
551 all files in it are deleted. When Vim has the setuid bit set this may cause |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
552 problems, the temp file is owned by the setuid user but the filter command |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
553 probably runs as the original user. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
554 On MS-DOS and OS/2 the first of these directories that works is used: $TMP, |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
555 $TEMP, c:\TMP, c:\TEMP. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
556 For Unix the list of directories is: $TMPDIR, /tmp, current-dir, $HOME. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
557 For MS-Windows the GetTempFileName() system function is used. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
558 For other systems the tmpnam() library function is used. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
559 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
560 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
561 |
| 32 | 562 4.2 Substitute *:substitute* |
| 563 *:s* *:su* | |
| 170 | 564 :[range]s[ubstitute]/{pattern}/{string}/[flags] [count] |
| 7 | 565 For each line in [range] replace a match of {pattern} |
| 566 with {string}. | |
| 567 For the {pattern} see |pattern|. | |
| 568 {string} can be a literal string, or something | |
| 569 special; see |sub-replace-special|. | |
| 570 When [range] and [count] are omitted, replace in the | |
| 571 current line only. | |
| 572 When [count] is given, replace in [count] lines, | |
| 573 starting with the last line in [range]. When [range] | |
| 574 is omitted start in the current line. | |
| 575 Also see |cmdline-ranges|. | |
| 170 | 576 See |:s_flags| for [flags]. |
| 7 | 577 |
| 170 | 578 :[range]s[ubstitute] [flags] [count] |
| 579 :[range]&[&][flags] [count] *:&* | |
| 7 | 580 Repeat last :substitute with same search pattern and |
| 581 substitute string, but without the same flags. You | |
| 170 | 582 may add [flags], see |:s_flags|. |
| 3492 | 583 Note that after `:substitute` the '&' flag can't be |
| 7 | 584 used, it's recognized as a pattern separator. |
| 3492 | 585 The space between `:substitute` and the 'c', 'g' and |
| 7 | 586 'r' flags isn't required, but in scripts it's a good |
| 587 idea to keep it to avoid confusion. | |
| 588 | |
| 170 | 589 :[range]~[&][flags] [count] *:~* |
| 7 | 590 Repeat last substitute with same substitute string |
| 591 but with last used search pattern. This is like | |
| 3492 | 592 `:&r`. See |:s_flags| for [flags]. |
| 7 | 593 |
| 170 | 594 *&* |
| 3492 | 595 & Synonym for `:s` (repeat last substitute). Note |
| 7 | 596 that the flags are not remembered, thus it might |
| 3492 | 597 actually work differently. You can use `:&&` to keep |
| 7 | 598 the flags. |
| 599 | |
| 170 | 600 *g&* |
| 3492 | 601 g& Synonym for `:%s//~/&` (repeat last substitute on all |
| 7 | 602 lines with the same flags). |
| 603 Mnemonic: global substitute. {not in Vi} | |
| 604 | |
| 605 *:snomagic* *:sno* | |
| 3492 | 606 :[range]sno[magic] ... Same as `:substitute`, but always use 'nomagic'. |
| 7 | 607 {not in Vi} |
| 608 | |
| 609 *:smagic* *:sm* | |
| 3492 | 610 :[range]sm[agic] ... Same as `:substitute`, but always use 'magic'. |
| 7 | 611 {not in Vi} |
| 612 | |
| 613 *:s_flags* | |
| 614 The flags that you can use for the substitute commands: | |
| 615 | |
| 616 [&] Must be the first one: Keep the flags from the previous substitute | |
| 617 command. Examples: > | |
| 618 :&& | |
| 619 :s/this/that/& | |
| 3492 | 620 < Note that `:s` and `:&` don't keep the flags. |
| 7 | 621 {not in Vi} |
| 622 | |
| 623 [c] Confirm each substitution. Vim highlights the matching string (with | |
| 624 |hl-IncSearch|). You can type: *:s_c* | |
| 625 'y' to substitute this match | |
| 626 'l' to substitute this match and then quit ("last") | |
| 627 'n' to skip this match | |
| 628 <Esc> to quit substituting | |
| 629 'a' to substitute this and all remaining matches {not in Vi} | |
| 630 'q' to quit substituting {not in Vi} | |
| 631 CTRL-E to scroll the screen up {not in Vi, not available when | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
632 compiled without the |+insert_expand| feature} |
| 7 | 633 CTRL-Y to scroll the screen down {not in Vi, not available when |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
634 compiled without the |+insert_expand| feature} |
| 7 | 635 If the 'edcompatible' option is on, Vim remembers the [c] flag and |
| 636 toggles it each time you use it, but resets it when you give a new | |
| 637 search pattern. | |
| 638 {not in Vi: highlighting of the match, other responses than 'y' or 'n'} | |
| 639 | |
| 640 [e] When the search pattern fails, do not issue an error message and, in | |
| 641 particular, continue in maps as if no error occurred. This is most | |
| 642 useful to prevent the "No match" error from breaking a mapping. Vim | |
| 643 does not suppress the following error messages, however: | |
| 644 Regular expressions can't be delimited by letters | |
| 645 \ should be followed by /, ? or & | |
| 646 No previous substitute regular expression | |
| 647 Trailing characters | |
| 648 Interrupted | |
| 649 {not in Vi} | |
| 650 | |
| 651 [g] Replace all occurrences in the line. Without this argument, | |
| 652 replacement occurs only for the first occurrence in each line. If | |
| 653 the 'edcompatible' option is on, Vim remembers this flag and toggles | |
| 654 it each time you use it, but resets it when you give a new search | |
| 655 pattern. If the 'gdefault' option is on, this flag is on by default | |
| 656 and the [g] argument switches it off. | |
| 657 | |
| 658 [i] Ignore case for the pattern. The 'ignorecase' and 'smartcase' options | |
| 659 are not used. | |
| 660 {not in Vi} | |
| 661 | |
| 662 [I] Don't ignore case for the pattern. The 'ignorecase' and 'smartcase' | |
| 663 options are not used. | |
| 664 {not in Vi} | |
| 665 | |
| 170 | 666 [n] Report the number of matches, do not actually substitute. The [c] |
| 667 flag is ignored. The matches are reported as if 'report' is zero. | |
| 668 Useful to |count-items|. | |
| 669 | |
| 7 | 670 [p] Print the line containing the last substitute. |
| 168 | 671 |
| 672 [#] Like [p] and prepend the line number. | |
| 673 | |
| 1121 | 674 [l] Like [p] but print the text like |:list|. |
| 7 | 675 |
| 3492 | 676 [r] Only useful in combination with `:&` or `:s` without arguments. `:&r` |
| 677 works the same way as `:~`: When the search pattern is empty, use the | |
| 7 | 678 previously used search pattern instead of the search pattern from the |
| 3492 | 679 last substitute or `:global`. If the last command that did a search |
| 680 was a substitute or `:global`, there is no effect. If the last | |
| 7 | 681 command was a search command such as "/", use the pattern from that |
| 682 command. | |
| 3492 | 683 For `:s` with an argument this already happens: > |
| 7 | 684 :s/blue/red/ |
| 685 /green | |
| 686 :s//red/ or :~ or :&r | |
| 687 < The last commands will replace "green" with "red". > | |
| 688 :s/blue/red/ | |
| 689 /green | |
| 690 :& | |
| 691 < The last command will replace "blue" with "red". | |
| 692 {not in Vi} | |
| 693 | |
| 694 Note that there is no flag to change the "magicness" of the pattern. A | |
| 1621 | 695 different command is used instead, or you can use |/\v| and friends. The |
| 696 reason is that the flags can only be found by skipping the pattern, and in | |
| 697 order to skip the pattern the "magicness" must be known. Catch 22! | |
| 7 | 698 |
| 699 If the {pattern} for the substitute command is empty, the command uses the | |
| 3492 | 700 pattern from the last substitute or `:global` command. If there is none, but |
| 2725 | 701 there is a previous search pattern, that one is used. With the [r] flag, the |
| 3492 | 702 command uses the pattern from the last substitute, `:global`, or search |
| 7 | 703 command. |
| 704 | |
| 1121 | 705 If the {string} is omitted the substitute is done as if it's empty. Thus the |
| 706 matched pattern is deleted. The separator after {pattern} can also be left | |
| 707 out then. Example: > | |
| 708 :%s/TESTING | |
| 709 This deletes "TESTING" from all lines, but only one per line. | |
| 710 | |
| 7 | 711 For compatibility with Vi these two exceptions are allowed: |
| 712 "\/{string}/" and "\?{string}?" do the same as "//{string}/r". | |
| 713 "\&{string}&" does the same as "//{string}/". | |
| 714 *E146* | |
| 715 Instead of the '/' which surrounds the pattern and replacement string, you | |
| 1121 | 716 can use any other single-byte character, but not an alphanumeric character, |
| 717 '\', '"' or '|'. This is useful if you want to include a '/' in the search | |
| 718 pattern or replacement string. Example: > | |
| 7 | 719 :s+/+//+ |
| 720 | |
| 1621 | 721 For the definition of a pattern, see |pattern|. In Visual block mode, use |
| 722 |/\%V| in the pattern to have the substitute work in the block only. | |
| 723 Otherwise it works on whole lines anyway. | |
| 7 | 724 |
| 725 *sub-replace-special* *:s\=* | |
| 726 When the {string} starts with "\=" it is evaluated as an expression, see | |
| 2908 | 727 |sub-replace-expression|. You can use that for complex replacement or special |
| 728 characters. | |
| 729 | |
| 452 | 730 Otherwise these characters in {string} have a special meaning: |
| 168 | 731 *:s%* |
| 843 | 732 When {string} is equal to "%" and '/' is included with the 'cpoptions' option, |
| 2908 | 733 then the {string} of the previous substitute command is used, see |cpo-/| |
| 7 | 734 |
| 735 magic nomagic action ~ | |
| 736 & \& replaced with the whole matched pattern *s/\&* | |
| 737 \& & replaced with & | |
| 738 \0 replaced with the whole matched pattern *\0* *s/\0* | |
| 739 \1 replaced with the matched pattern in the first | |
| 740 pair of () *s/\1* | |
| 26 | 741 \2 replaced with the matched pattern in the second |
| 7 | 742 pair of () *s/\2* |
| 743 .. .. *s/\3* | |
| 744 \9 replaced with the matched pattern in the ninth | |
| 745 pair of () *s/\9* | |
| 746 ~ \~ replaced with the {string} of the previous | |
| 747 substitute *s~* | |
| 748 \~ ~ replaced with ~ *s/\~* | |
| 749 \u next character made uppercase *s/\u* | |
| 750 \U following characters made uppercase, until \E *s/\U* | |
| 751 \l next character made lowercase *s/\l* | |
| 752 \L following characters made lowercase, until \E *s/\L* | |
| 753 \e end of \u, \U, \l and \L (NOTE: not <Esc>!) *s/\e* | |
| 754 \E end of \u, \U, \l and \L *s/\E* | |
| 755 <CR> split line in two at this point | |
| 756 (Type the <CR> as CTRL-V <Enter>) *s<CR>* | |
| 757 \r idem *s/\r* | |
| 758 \<CR> insert a carriage-return (CTRL-M) | |
| 759 (Type the <CR> as CTRL-V <Enter>) *s/\<CR>* | |
| 760 \n insert a <NL> (<NUL> in the file) | |
| 761 (does NOT break the line) *s/\n* | |
| 762 \b insert a <BS> *s/\b* | |
| 763 \t insert a <Tab> *s/\t* | |
| 764 \\ insert a single backslash *s/\\* | |
| 765 \x where x is any character not mentioned above: | |
| 766 Reserved for future expansion | |
| 767 | |
| 2908 | 768 The special meaning is also used inside the third argument {sub} of |
| 769 the |substitute()| function with the following exceptions: | |
| 770 - A % inserts a percent literally without regard to 'cpoptions'. | |
| 771 - magic is always set without regard to 'magic'. | |
| 772 - A ~ inserts a tilde literally. | |
| 773 - <CR> and \r inserts a carriage-return (CTRL-M). | |
| 774 - \<CR> does not have a special meaning. it's just one of \x. | |
| 775 | |
| 7 | 776 Examples: > |
| 777 :s/a\|b/xxx\0xxx/g modifies "a b" to "xxxaxxx xxxbxxx" | |
| 778 :s/\([abc]\)\([efg]\)/\2\1/g modifies "af fa bg" to "fa fa gb" | |
| 779 :s/abcde/abc^Mde/ modifies "abcde" to "abc", "de" (two lines) | |
| 780 :s/$/\^M/ modifies "abcde" to "abcde^M" | |
| 772 | 781 :s/\w\+/\u\0/g modifies "bla bla" to "Bla Bla" |
| 7 | 782 |
| 783 Note: In previous versions CTRL-V was handled in a special way. Since this is | |
| 784 not Vi compatible, this was removed. Use a backslash instead. | |
| 785 | |
| 786 command text result ~ | |
| 787 :s/aa/a^Ma/ aa a<line-break>a | |
| 788 :s/aa/a\^Ma/ aa a^Ma | |
| 789 :s/aa/a\\^Ma/ aa a\<line-break>a | |
| 790 | |
| 791 (you need to type CTRL-V <CR> to get a ^M here) | |
| 792 | |
| 793 The numbering of "\1", "\2" etc. is done based on which "\(" comes first in | |
| 794 the pattern (going left to right). When a parentheses group matches several | |
| 795 times, the last one will be used for "\1", "\2", etc. Example: > | |
| 796 :s/\(\(a[a-d] \)*\)/\2/ modifies "aa ab x" to "ab x" | |
| 797 | |
| 798 When using parentheses in combination with '|', like in \([ab]\)\|\([cd]\), | |
| 799 either the first or second pattern in parentheses did not match, so either | |
| 800 \1 or \2 is empty. Example: > | |
| 801 :s/\([ab]\)\|\([cd]\)/\1x/g modifies "a b c d" to "ax bx x x" | |
| 802 < | |
| 803 | |
| 804 Substitute with an expression *sub-replace-expression* | |
| 270 | 805 *sub-replace-\=* |
| 806 When the substitute string starts with "\=" the remainder is interpreted as an | |
| 2908 | 807 expression. This does not work recursively: a |substitute()| function inside |
| 7 | 808 the expression cannot use "\=" for the substitute string. |
| 809 | |
| 810 The special meaning for characters as mentioned at |sub-replace-special| does | |
| 2908 | 811 not apply except for "<CR>". A <NL> character is used as a line break, you |
| 812 can get one with a double-quote string: "\n". Prepend a backslash to get a | |
| 813 real <NL> character (which will be a NUL in the file). | |
| 7 | 814 |
| 2908 | 815 The "\=" notation can also be used inside the third argument {sub} of |
| 816 |substitute()| function. In this case, the special meaning for characters as | |
| 817 mentioned at |sub-replace-special| does not apply at all. Especially, <CR> and | |
| 818 <NL> are interpreted not as a line break but as a carriage-return and a | |
| 819 new-line respectively. | |
| 7 | 820 |
| 714 | 821 When the result is a |List| then the items are joined with separating line |
| 822 breaks. Thus each item becomes a line, except that they can contain line | |
| 823 breaks themselves. | |
| 824 | |
| 7 | 825 The whole matched text can be accessed with "submatch(0)". The text matched |
| 826 with the first pair of () with "submatch(1)". Likewise for further | |
| 827 sub-matches in (). | |
| 828 | |
| 829 Be careful: The separation character must not appear in the expression! | |
| 830 Consider using a character like "@" or ":". There is no problem if the result | |
| 831 of the expression contains the separation character. | |
| 832 | |
| 452 | 833 Examples: > |
| 7 | 834 :s@\n@\="\r" . expand("$HOME") . "\r"@ |
| 452 | 835 This replaces an end-of-line with a new line containing the value of $HOME. > |
| 836 | |
| 837 s/E/\="\<Char-0x20ac>"/g | |
| 1668 | 838 This replaces each 'E' character with a euro sign. Read more in |<Char->|. |
| 7 | 839 |
| 840 | |
| 32 | 841 4.3 Search and replace *search-replace* |
| 842 | |
| 843 *:pro* *:promptfind* | |
| 7 | 844 :promptf[ind] [string] |
| 845 Put up a Search dialog. When [string] is given, it is | |
| 846 used as the initial search string. | |
| 847 {only for Win32, Motif and GTK GUI} | |
| 848 | |
| 849 *:promptr* *:promptrepl* | |
| 850 :promptr[epl] [string] | |
| 851 Put up a Search/Replace dialog. When [string] is | |
| 852 given, it is used as the initial search string. | |
| 853 {only for Win32, Motif and GTK GUI} | |
| 854 | |
| 32 | 855 |
| 856 4.4 Changing tabs *change-tabs* | |
| 3492 | 857 *:ret* *:retab* *:retab!* |
| 7 | 858 :[range]ret[ab][!] [new_tabstop] |
| 859 Replace all sequences of white-space containing a | |
| 860 <Tab> with new strings of white-space using the new | |
| 861 tabstop value given. If you do not specify a new | |
| 862 tabstop size or it is zero, Vim uses the current value | |
| 863 of 'tabstop'. | |
| 864 The current value of 'tabstop' is always used to | |
| 865 compute the width of existing tabs. | |
| 866 With !, Vim also replaces strings of only normal | |
| 867 spaces with tabs where appropriate. | |
| 868 With 'expandtab' on, Vim replaces all tabs with the | |
| 869 appropriate number of spaces. | |
| 870 This command sets 'tabstop' to the new value given, | |
| 871 and if performed on the whole file, which is default, | |
| 872 should not make any visible change. | |
| 873 Careful: This command modifies any <Tab> characters | |
| 874 inside of strings in a C program. Use "\t" to avoid | |
| 875 this (that's a good habit anyway). | |
| 3492 | 876 `:retab!` may also change a sequence of spaces by |
| 7 | 877 <Tab> characters, which can mess up a printf(). |
| 878 {not in Vi} | |
| 879 Not available when |+ex_extra| feature was disabled at | |
| 880 compile time. | |
| 881 | |
| 882 *retab-example* | |
| 883 Example for using autocommands and ":retab" to edit a file which is stored | |
| 884 with tabstops at 8 but edited with tabstops set at 4. Warning: white space | |
| 885 inside of strings can change! Also see 'softtabstop' option. > | |
| 886 | |
| 887 :auto BufReadPost *.xx retab! 4 | |
| 888 :auto BufWritePre *.xx retab! 8 | |
| 889 :auto BufWritePost *.xx retab! 4 | |
| 890 :auto BufNewFile *.xx set ts=4 | |
| 891 | |
| 892 ============================================================================== | |
| 893 5. Copying and moving text *copy-move* | |
| 894 | |
| 895 *quote* | |
| 896 "{a-zA-Z0-9.%#:-"} Use register {a-zA-Z0-9.%#:-"} for next delete, yank | |
| 897 or put (use uppercase character to append with | |
| 898 delete and yank) ({.%#:} only work with put). | |
| 899 | |
| 900 *:reg* *:registers* | |
| 901 :reg[isters] Display the contents of all numbered and named | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
902 registers. If a register is written to for |:redir| |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
903 it will not be listed. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
904 {not in Vi} |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
905 |
| 7 | 906 |
| 907 :reg[isters] {arg} Display the contents of the numbered and named | |
| 908 registers that are mentioned in {arg}. For example: > | |
| 909 :dis 1a | |
| 910 < to display registers '1' and 'a'. Spaces are allowed | |
| 911 in {arg}. {not in Vi} | |
| 912 | |
| 913 *:di* *:display* | |
| 914 :di[splay] [arg] Same as :registers. {not in Vi} | |
| 915 | |
| 916 *y* *yank* | |
| 917 ["x]y{motion} Yank {motion} text [into register x]. When no | |
| 918 characters are to be yanked (e.g., "y0" in column 1), | |
| 919 this is an error when 'cpoptions' includes the 'E' | |
| 920 flag. | |
| 921 | |
| 922 *yy* | |
| 923 ["x]yy Yank [count] lines [into register x] |linewise|. | |
| 924 | |
| 925 *Y* | |
| 926 ["x]Y yank [count] lines [into register x] (synonym for | |
| 927 yy, |linewise|). If you like "Y" to work from the | |
| 928 cursor to the end of line (which is more logical, | |
| 929 but not Vi-compatible) use ":map Y y$". | |
| 930 | |
| 931 *v_y* | |
| 932 {Visual}["x]y Yank the highlighted text [into register x] (for | |
| 933 {Visual} see |Visual-mode|). {not in Vi} | |
| 934 | |
| 935 *v_Y* | |
| 936 {Visual}["x]Y Yank the highlighted lines [into register x] (for | |
| 937 {Visual} see |Visual-mode|). {not in Vi} | |
| 938 | |
| 2791 | 939 *:y* *:yank* *E850* |
| 940 :[range]y[ank] [x] Yank [range] lines [into register x]. Yanking to the | |
| 2826 | 941 "* or "+ registers is possible only when the |
| 942 |+clipboard| feature is included. | |
| 7 | 943 |
| 944 :[range]y[ank] [x] {count} | |
| 945 Yank {count} lines, starting with last line number | |
| 946 in [range] (default: current line |cmdline-ranges|), | |
| 947 [into register x]. | |
| 948 | |
| 949 *p* *put* *E353* | |
| 950 ["x]p Put the text [from register x] after the cursor | |
| 951 [count] times. {Vi: no count} | |
| 952 | |
| 953 *P* | |
| 954 ["x]P Put the text [from register x] before the cursor | |
| 955 [count] times. {Vi: no count} | |
| 956 | |
| 957 *<MiddleMouse>* | |
| 958 ["x]<MiddleMouse> Put the text from a register before the cursor [count] | |
| 959 times. Uses the "* register, unless another is | |
| 856 | 960 specified. |
| 36 | 961 Leaves the cursor at the end of the new text. |
| 962 Using the mouse only works when 'mouse' contains 'n' | |
| 963 or 'a'. | |
| 7 | 964 {not in Vi} |
| 965 If you have a scrollwheel and often accidentally paste | |
| 966 text, you can use these mappings to disable the | |
| 967 pasting with the middle mouse button: > | |
| 968 :map <MiddleMouse> <Nop> | |
| 969 :imap <MiddleMouse> <Nop> | |
| 970 < You might want to disable the multi-click versions | |
| 971 too, see |double-click|. | |
| 972 | |
| 973 *gp* | |
| 974 ["x]gp Just like "p", but leave the cursor just after the new | |
| 975 text. {not in Vi} | |
| 976 | |
| 977 *gP* | |
| 978 ["x]gP Just like "P", but leave the cursor just after the new | |
| 979 text. {not in Vi} | |
| 980 | |
| 981 *:pu* *:put* | |
| 982 :[line]pu[t] [x] Put the text [from register x] after [line] (default | |
| 983 current line). This always works |linewise|, thus | |
| 984 this command can be used to put a yanked block as new | |
| 985 lines. | |
| 3492 | 986 If no register is specified, it depends on the 'cb' |
| 987 option: If 'cb' contains "unnamedplus", paste from the | |
| 988 + register |quoteplus|. Otherwise, if 'cb' contains | |
|
3493
1be42b88900e
Updated runtime files, include fixes for line continuation.
Bram Moolenaar <bram@vim.org>
parents:
3492
diff
changeset
|
989 "unnamed", paste from the * register |quotestar|. |
| 3492 | 990 Otherwise, paste from the unnamed register |
| 991 |quote_quote|. | |
| 7 | 992 The register can also be '=' followed by an optional |
| 993 expression. The expression continues until the end of | |
| 994 the command. You need to escape the '|' and '"' | |
| 995 characters to prevent them from terminating the | |
| 996 command. Example: > | |
| 997 :put ='path' . \",/test\" | |
| 998 < If there is no expression after '=', Vim uses the | |
| 999 previous expression. You can see it with ":dis =". | |
| 1000 | |
| 1001 :[line]pu[t]! [x] Put the text [from register x] before [line] (default | |
| 1002 current line). | |
| 1003 | |
| 1004 ["x]]p or *]p* *]<MiddleMouse>* | |
| 1005 ["x]]<MiddleMouse> Like "p", but adjust the indent to the current line. | |
| 1006 Using the mouse only works when 'mouse' contains 'n' | |
| 1007 or 'a'. {not in Vi} | |
| 1008 | |
| 1009 ["x][P or *[P* | |
| 1010 ["x]]P or *]P* | |
| 1011 ["x][p or *[p* *[<MiddleMouse>* | |
| 1012 ["x][<MiddleMouse> Like "P", but adjust the indent to the current line. | |
| 1013 Using the mouse only works when 'mouse' contains 'n' | |
| 1014 or 'a'. {not in Vi} | |
| 1015 | |
| 1016 You can use these commands to copy text from one place to another. Do this | |
| 1017 by first getting the text into a register with a yank, delete or change | |
| 1018 command, then inserting the register contents with a put command. You can | |
| 1019 also use these commands to move text from one file to another, because Vim | |
| 1020 preserves all registers when changing buffers (the CTRL-^ command is a quick | |
| 1021 way to toggle between two files). | |
| 1022 | |
| 1023 *linewise-register* *characterwise-register* | |
| 1024 You can repeat the put commands with "." (except for :put) and undo them. If | |
| 1025 the command that was used to get the text into the register was |linewise|, | |
| 1026 Vim inserts the text below ("p") or above ("P") the line where the cursor is. | |
| 1027 Otherwise Vim inserts the text after ("p") or before ("P") the cursor. With | |
| 1028 the ":put" command, Vim always inserts the text in the next line. You can | |
| 1029 exchange two characters with the command sequence "xp". You can exchange two | |
| 1030 lines with the command sequence "ddp". You can exchange two words with the | |
| 1031 command sequence "deep" (start with the cursor in the blank space before the | |
| 1032 first word). You can use the "']" or "`]" command after the put command to | |
| 1033 move the cursor to the end of the inserted text, or use "'[" or "`[" to move | |
| 1034 the cursor to the start. | |
| 1035 | |
| 1036 *put-Visual-mode* *v_p* *v_P* | |
| 1037 When using a put command like |p| or |P| in Visual mode, Vim will try to | |
| 1038 replace the selected text with the contents of the register. Whether this | |
| 1039 works well depends on the type of selection and the type of the text in the | |
| 1040 register. With blockwise selection it also depends on the size of the block | |
| 236 | 1041 and whether the corners are on an existing character. (Implementation detail: |
| 7 | 1042 it actually works by first putting the register after the selection and then |
| 236 | 1043 deleting the selection.) |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1044 The previously selected text is put in the unnamed register. If you want to |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1045 put the same text into a Visual selection several times you need to use |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1046 another register. E.g., yank the text to copy, Visually select the text to |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1047 replace and use "0p . You can repeat this as many times as you like, the |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1048 unnamed register will be changed each time. |
| 7 | 1049 |
| 1050 *blockwise-register* | |
| 1051 If you use a blockwise Visual mode command to get the text into the register, | |
| 1052 the block of text will be inserted before ("P") or after ("p") the cursor | |
| 1053 column in the current and next lines. Vim makes the whole block of text start | |
| 1054 in the same column. Thus the inserted text looks the same as when it was | |
| 1055 yanked or deleted. Vim may replace some <Tab> characters with spaces to make | |
| 1056 this happen. However, if the width of the block is not a multiple of a <Tab> | |
| 1057 width and the text after the inserted block contains <Tab>s, that text may be | |
| 1058 misaligned. | |
| 1059 | |
| 1060 Note that after a characterwise yank command, Vim leaves the cursor on the | |
| 1061 first yanked character that is closest to the start of the buffer. This means | |
| 1062 that "yl" doesn't move the cursor, but "yh" moves the cursor one character | |
| 1063 left. | |
| 1064 Rationale: In Vi the "y" command followed by a backwards motion would | |
| 1065 sometimes not move the cursor to the first yanked character, | |
| 1066 because redisplaying was skipped. In Vim it always moves to | |
| 1067 the first character, as specified by Posix. | |
| 1068 With a linewise yank command the cursor is put in the first line, but the | |
| 1069 column is unmodified, thus it may not be on the first yanked character. | |
| 1070 | |
| 1071 There are nine types of registers: *registers* *E354* | |
| 1072 1. The unnamed register "" | |
| 1073 2. 10 numbered registers "0 to "9 | |
| 1074 3. The small delete register "- | |
| 1075 4. 26 named registers "a to "z or "A to "Z | |
| 1076 5. four read-only registers ":, "., "% and "# | |
| 1077 6. the expression register "= | |
| 1078 7. The selection and drop registers "*, "+ and "~ | |
| 1079 8. The black hole register "_ | |
| 1080 9. Last search pattern register "/ | |
| 1081 | |
| 1082 1. Unnamed register "" *quote_quote* *quotequote* | |
| 1083 Vim fills this register with text deleted with the "d", "c", "s", "x" commands | |
| 1084 or copied with the yank "y" command, regardless of whether or not a specific | |
| 8 | 1085 register was used (e.g. "xdd). This is like the unnamed register is pointing |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1086 to the last used register. Thus when appending using an uppercase register |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1087 name, the unnamed register contains the same text as the named register. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1088 An exception is the '_' register: "_dd does not store the deleted text in any |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1089 register. |
| 42 | 1090 Vim uses the contents of the unnamed register for any put command (p or P) |
| 1091 which does not specify a register. Additionally you can access it with the | |
| 1092 name '"'. This means you have to type two double quotes. Writing to the "" | |
| 1093 register writes to register "0. | |
| 7 | 1094 {Vi: register contents are lost when changing files, no '"'} |
| 1095 | |
| 1096 2. Numbered registers "0 to "9 *quote_number* *quote0* *quote1* | |
| 1097 *quote2* *quote3* *quote4* *quote9* | |
| 1098 Vim fills these registers with text from yank and delete commands. | |
| 1099 Numbered register 0 contains the text from the most recent yank command, | |
| 1100 unless the command specified another register with ["x]. | |
| 1101 Numbered register 1 contains the text deleted by the most recent delete or | |
| 1102 change command, unless the command specified another register or the text is | |
| 1103 less than one line (the small delete register is used then). An exception is | |
| 42 | 1104 made for the delete operator with these movement commands: |%|, |(|, |)|, |`|, |
| 1105 |/|, |?|, |n|, |N|, |{| and |}|. Register "1 is always used then (this is Vi | |
| 1106 compatible). The "- register is used as well if the delete is within a line. | |
| 7 | 1107 With each successive deletion or change, Vim shifts the previous contents |
| 1108 of register 1 into register 2, 2 into 3, and so forth, losing the previous | |
| 1109 contents of register 9. | |
| 1110 {Vi: numbered register contents are lost when changing files; register 0 does | |
| 1111 not exist} | |
| 1112 | |
| 1113 3. Small delete register "- *quote_-* *quote-* | |
| 1114 This register contains text from commands that delete less than one line, | |
| 1115 except when the command specifies a register with ["x]. | |
| 1116 {not in Vi} | |
| 1117 | |
| 1118 4. Named registers "a to "z or "A to "Z *quote_alpha* *quotea* | |
| 1119 Vim fills these registers only when you say so. Specify them as lowercase | |
| 1120 letters to replace their previous contents or as uppercase letters to append | |
| 164 | 1121 to their previous contents. When the '>' flag is present in 'cpoptions' then |
| 1122 a line break is inserted before the appended text. | |
| 7 | 1123 |
| 1124 5. Read-only registers ":, "., "% and "# | |
| 1125 These are '%', '#', ':' and '.'. You can use them only with the "p", "P", | |
| 1126 and ":put" commands and with CTRL-R. {not in Vi} | |
| 1127 *quote_.* *quote.* *E29* | |
| 1128 ". Contains the last inserted text (the same as what is inserted | |
| 1129 with the insert mode commands CTRL-A and CTRL-@). Note: this | |
| 1130 doesn't work with CTRL-R on the command-line. It works a bit | |
| 1131 differently, like inserting the text instead of putting it | |
| 1132 ('textwidth' and other options affect what is inserted). | |
| 1133 *quote_%* *quote%* | |
| 1134 "% Contains the name of the current file. | |
| 1135 *quote_#* *quote#* | |
| 1136 "# Contains the name of the alternate file. | |
| 1137 *quote_:* *quote:* *E30* | |
| 1138 ": Contains the most recent executed command-line. Example: Use | |
| 1139 "@:" to repeat the previous command-line command. | |
| 1140 The command-line is only stored in this register when at least | |
| 1141 one character of it was typed. Thus it remains unchanged if | |
| 1142 the command was completely from a mapping. | |
| 1143 {not available when compiled without the |+cmdline_hist| | |
| 1144 feature} | |
| 1145 | |
| 1121 | 1146 6. Expression register "= *quote_=* *quote=* *@=* |
| 7 | 1147 This is not really a register that stores text, but is a way to use an |
| 1148 expression in commands which use a register. The expression register is | |
| 1149 read-only; you cannot put text into it. After the '=', the cursor moves to | |
| 1150 the command-line, where you can enter any expression (see |expression|). All | |
| 1151 normal command-line editing commands are available, including a special | |
| 1152 history for expressions. When you end the command-line by typing <CR>, Vim | |
| 1153 computes the result of the expression. If you end it with <Esc>, Vim abandons | |
| 1154 the expression. If you do not enter an expression, Vim uses the previous | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1155 expression (like with the "/" command). |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1156 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1157 The expression must evaluate to a String. A Number is always automatically |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1158 converted to a String. For the "p" and ":put" command, if the result is a |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1159 Float it's converted into a String. If the result is a List each element is |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1160 turned into a String and used as a line. A Dictionary or FuncRef results in |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1161 an error message (use string() to convert). |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1162 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1163 If the "= register is used for the "p" command, the String is split up at <NL> |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1164 characters. If the String ends in a <NL>, it is regarded as a linewise |
| 332 | 1165 register. {not in Vi} |
| 7 | 1166 |
| 1167 7. Selection and drop registers "*, "+ and "~ | |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1168 Use these registers for storing and retrieving the selected text for the GUI. |
| 7 | 1169 See |quotestar| and |quoteplus|. When the clipboard is not available or not |
| 571 | 1170 working, the unnamed register is used instead. For Unix systems the clipboard |
| 1171 is only available when the |+xterm_clipboard| feature is present. {not in Vi} | |
| 7 | 1172 |
| 1173 Note that there is only a distinction between "* and "+ for X11 systems. For | |
| 1174 an explanation of the difference, see |x11-selection|. Under MS-Windows, use | |
| 1175 of "* and "+ is actually synonymous and refers to the |gui-clipboard|. | |
| 1176 | |
| 1177 *quote_~* *quote~* *<Drop>* | |
| 1178 The read-only "~ register stores the dropped text from the last drag'n'drop | |
| 1179 operation. When something has been dropped onto Vim, the "~ register is | |
| 1180 filled in and the <Drop> pseudo key is sent for notification. You can remap | |
| 1181 this key if you want; the default action (for all modes) is to insert the | |
| 1182 contents of the "~ register at the cursor position. {not in Vi} | |
| 9 | 1183 {only available when compiled with the |+dnd| feature, currently only with the |
| 7 | 1184 GTK GUI} |
| 1185 | |
| 1186 Note: The "~ register is only used when dropping plain text onto Vim. | |
| 1187 Drag'n'drop of URI lists is handled internally. | |
| 1188 | |
| 1189 8. Black hole register "_ *quote_* | |
| 1190 When writing to this register, nothing happens. This can be used to delete | |
| 1191 text without affecting the normal registers. When reading from this register, | |
| 1192 nothing is returned. {not in Vi} | |
| 1193 | |
| 1194 9. Last search pattern register "/ *quote_/* *quote/* | |
| 1195 Contains the most recent search-pattern. This is used for "n" and 'hlsearch'. | |
| 3492 | 1196 It is writable with `:let`, you can change it to have 'hlsearch' highlight |
| 7 | 1197 other matches without actually searching. You can't yank or delete into this |
| 1621 | 1198 register. The search direction is available in |v:searchforward|. |
| 1199 Note that the valued is restored when returning from a function | |
| 1200 |function-search-undo|. | |
| 1201 {not in Vi} | |
| 7 | 1202 |
| 1203 *@/* | |
| 3492 | 1204 You can write to a register with a `:let` command |:let-@|. Example: > |
| 7 | 1205 :let @/ = "the" |
| 1206 | |
| 1207 If you use a put command without specifying a register, Vim uses the register | |
| 1208 that was last filled (this is also the contents of the unnamed register). If | |
| 3492 | 1209 you are confused, use the `:dis` command to find out what Vim will put (this |
| 7 | 1210 command displays all named and numbered registers; the unnamed register is |
| 1211 labelled '"'). | |
| 1212 | |
| 1213 The next three commands always work on whole lines. | |
| 1214 | |
| 1215 :[range]co[py] {address} *:co* *:copy* | |
| 1216 Copy the lines given by [range] to below the line | |
| 1217 given by {address}. | |
| 1218 | |
| 1219 *:t* | |
| 1220 :t Synonym for copy. | |
| 1221 | |
| 1222 :[range]m[ove] {address} *:m* *:mo* *:move* *E134* | |
| 1223 Move the lines given by [range] to below the line | |
| 1224 given by {address}. | |
| 1225 | |
| 1226 ============================================================================== | |
| 1227 6. Formatting text *formatting* | |
| 1228 | |
| 1229 :[range]ce[nter] [width] *:ce* *:center* | |
| 1230 Center lines in [range] between [width] columns | |
| 1231 (default 'textwidth' or 80 when 'textwidth' is 0). | |
| 1232 {not in Vi} | |
| 1233 Not available when |+ex_extra| feature was disabled at | |
| 1234 compile time. | |
| 1235 | |
| 1236 :[range]ri[ght] [width] *:ri* *:right* | |
| 1237 Right-align lines in [range] at [width] columns | |
| 1238 (default 'textwidth' or 80 when 'textwidth' is 0). | |
| 1239 {not in Vi} | |
| 1240 Not available when |+ex_extra| feature was disabled at | |
| 1241 compile time. | |
| 1242 | |
| 1243 *:le* *:left* | |
| 1244 :[range]le[ft] [indent] | |
| 1245 Left-align lines in [range]. Sets the indent in the | |
| 1246 lines to [indent] (default 0). {not in Vi} | |
| 1247 Not available when |+ex_extra| feature was disabled at | |
| 1248 compile time. | |
| 1249 | |
| 1250 *gq* | |
| 216 | 1251 gq{motion} Format the lines that {motion} moves over. |
| 667 | 1252 Formatting is done with one of three methods: |
| 1253 1. If 'formatexpr' is not empty the expression is | |
| 1254 evaluated. This can differ for each buffer. | |
| 670 | 1255 2. If 'formatprg' is not empty an external program |
| 667 | 1256 is used. |
| 843 | 1257 3. Otherwise formatting is done internally. |
| 667 | 1258 |
| 1259 In the third case the 'textwidth' option controls the | |
| 1260 length of each formatted line (see below). | |
| 216 | 1261 If the 'textwidth' option is 0, the formatted line |
| 1262 length is the screen width (with a maximum width of | |
| 667 | 1263 79). |
| 7 | 1264 The 'formatoptions' option controls the type of |
| 1265 formatting |fo-table|. | |
| 216 | 1266 The cursor is left on the first non-blank of the last |
| 1267 formatted line. | |
| 7 | 1268 NOTE: The "Q" command formerly performed this |
| 1269 function. If you still want to use "Q" for | |
| 1270 formatting, use this mapping: > | |
| 1271 :nnoremap Q gq | |
| 1272 | |
| 1273 gqgq *gqgq* *gqq* | |
|
2434
86532ee3ea41
Updated runtime files. Add logcheck filetype plugin. (James Vega)
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
1274 gqq Format the current line. With a count format that |
|
86532ee3ea41
Updated runtime files. Add logcheck filetype plugin. (James Vega)
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
1275 many lines. {not in Vi} |
| 7 | 1276 |
| 1277 *v_gq* | |
| 1278 {Visual}gq Format the highlighted text. (for {Visual} see | |
| 1279 |Visual-mode|). {not in Vi} | |
| 1280 | |
| 1281 *gw* | |
| 1282 gw{motion} Format the lines that {motion} moves over. Similar to | |
| 1283 |gq| but puts the cursor back at the same position in | |
| 667 | 1284 the text. However, 'formatprg' and 'formatexpr' are |
| 1285 not used. {not in Vi} | |
| 7 | 1286 |
| 9 | 1287 gwgw *gwgw* *gww* |
| 1288 gww Format the current line as with "gw". {not in Vi} | |
| 1289 | |
| 1290 *v_gw* | |
| 1291 {Visual}gw Format the highlighted text as with "gw". (for | |
| 1292 {Visual} see |Visual-mode|). {not in Vi} | |
| 1293 | |
| 7 | 1294 Example: To format the current paragraph use: *gqap* > |
| 1295 gqap | |
| 1296 | |
| 1297 The "gq" command leaves the cursor in the line where the motion command takes | |
| 1298 the cursor. This allows you to repeat formatting repeated with ".". This | |
| 1299 works well with "gqj" (format current and next line) and "gq}" (format until | |
| 1300 end of paragraph). Note: When 'formatprg' is set, "gq" leaves the cursor on | |
| 1301 the first formatted line (as with using a filter command). | |
| 1302 | |
| 1303 If you want to format the current paragraph and continue where you were, use: > | |
| 1304 gwap | |
| 1305 If you always want to keep paragraphs formatted you may want to add the 'a' | |
| 1306 flag to 'formatoptions'. See |auto-format|. | |
| 1307 | |
| 1308 If the 'autoindent' option is on, Vim uses the indent of the first line for | |
| 1309 the following lines. | |
| 1310 | |
| 1311 Formatting does not change empty lines (but it does change lines with only | |
| 1312 white space!). | |
| 1313 | |
| 1314 The 'joinspaces' option is used when lines are joined together. | |
| 1315 | |
| 667 | 1316 You can set the 'formatexpr' option to an expression or the 'formatprg' option |
| 1317 to the name of an external program for Vim to use for text formatting. The | |
| 1318 'textwidth' and other options have no effect on formatting by an external | |
| 1319 program. | |
| 7 | 1320 |
| 1321 *right-justify* | |
| 1322 There is no command in Vim to right justify text. You can do it with | |
| 1323 an external command, like "par" (e.g.: "!}par" to format until the end of the | |
| 1324 paragraph) or set 'formatprg' to "par". | |
| 1325 | |
| 1326 *format-comments* | |
| 1621 | 1327 An overview of comment formatting is in section |30.6| of the user manual. |
| 1328 | |
| 1329 Vim can automatically insert and format comments in a special way. Vim | |
| 1330 recognizes a comment by a specific string at the start of the line (ignoring | |
| 1331 white space). Three types of comments can be used: | |
| 7 | 1332 |
| 1333 - A comment string that repeats at the start of each line. An example is the | |
| 1334 type of comment used in shell scripts, starting with "#". | |
| 1335 - A comment string that occurs only in the first line, not in the following | |
| 1336 lines. An example is this list with dashes. | |
| 1337 - Three-piece comments that have a start string, an end string, and optional | |
| 1338 lines in between. The strings for the start, middle and end are different. | |
| 1621 | 1339 An example is the C style comment: |
| 7 | 1340 /* |
| 1341 * this is a C comment | |
| 1342 */ | |
| 1343 | |
| 1344 The 'comments' option is a comma-separated list of parts. Each part defines a | |
| 1345 type of comment string. A part consists of: | |
| 1346 {flags}:{string} | |
| 1347 | |
| 1348 {string} is the literal text that must appear. | |
| 1349 | |
| 1350 {flags}: | |
| 1351 n Nested comment. Nesting with mixed parts is allowed. If 'comments' | |
| 1352 is "n:),n:>" a line starting with "> ) >" is a comment. | |
| 1353 | |
| 1354 b Blank (<Space>, <Tab> or <EOL>) required after {string}. | |
| 1355 | |
| 1356 f Only the first line has the comment string. Do not repeat comment on | |
| 1357 the next line, but preserve indentation (e.g., a bullet-list). | |
| 1358 | |
| 1359 s Start of three-piece comment | |
| 1360 | |
| 1361 m Middle of a three-piece comment | |
| 1362 | |
| 1363 e End of a three-piece comment | |
| 1364 | |
| 1621 | 1365 l Left align. Used together with 's' or 'e', the leftmost character of |
| 1366 start or end will line up with the leftmost character from the middle. | |
| 1367 This is the default and can be omitted. See below for more details. | |
| 7 | 1368 |
| 1621 | 1369 r Right align. Same as above but rightmost instead of leftmost. See |
| 1370 below for more details. | |
| 7 | 1371 |
| 1621 | 1372 O Don't consider this comment for the "O" command. |
| 7 | 1373 |
| 1374 x Allows three-piece comments to be ended by just typing the last | |
| 1621 | 1375 character of the end-comment string as the first action on a new |
| 1376 line when the middle-comment string has been inserted automatically. | |
| 1377 See below for more details. | |
| 7 | 1378 |
| 1379 {digits} | |
| 1621 | 1380 When together with 's' or 'e': add {digit} amount of offset to an |
| 1381 automatically inserted middle or end comment leader. The offset begins | |
| 1382 from a left alignment. See below for more details. | |
| 7 | 1383 |
| 1384 -{digits} | |
| 1385 Like {digits} but reduce the indent. This only works when there is | |
| 1386 some indent for the start or end part that can be removed. | |
| 1387 | |
| 1388 When a string has none of the 'f', 's', 'm' or 'e' flags, Vim assumes the | |
| 1389 comment string repeats at the start of each line. The flags field may be | |
| 1390 empty. | |
| 1391 | |
| 1392 Any blank space in the text before and after the {string} is part of the | |
| 1393 {string}, so do not include leading or trailing blanks unless the blanks are a | |
| 1394 required part of the comment string. | |
| 1395 | |
| 1396 When one comment leader is part of another, specify the part after the whole. | |
| 1397 For example, to include both "-" and "->", use > | |
| 1398 :set comments=f:->,f:- | |
| 1399 | |
| 1400 A three-piece comment must always be given as start,middle,end, with no other | |
| 1401 parts in between. An example of a three-piece comment is > | |
| 1402 sr:/*,mb:*,ex:*/ | |
| 1403 for C-comments. To avoid recognizing "*ptr" as a comment, the middle string | |
| 1404 includes the 'b' flag. For three-piece comments, Vim checks the text after | |
| 1405 the start and middle strings for the end string. If Vim finds the end string, | |
| 1406 the comment does not continue on the next line. Three-piece comments must | |
| 1407 have a middle string because otherwise Vim can't recognize the middle lines. | |
| 1408 | |
| 1409 Notice the use of the "x" flag in the above three-piece comment definition. | |
| 1410 When you hit Return in a C-comment, Vim will insert the middle comment leader | |
| 1621 | 1411 for the new line: " * ". To close this comment you just have to type "/" |
| 7 | 1412 before typing anything else on the new line. This will replace the |
| 1621 | 1413 middle-comment leader with the end-comment leader and apply any specified |
| 1414 alignment, leaving just " */". There is no need to hit BackSpace first. | |
| 1415 | |
| 2826 | 1416 When there is a match with a middle part, but there also is a maching end part |
| 1417 which is longer, the end part is used. This makes a C style comment work | |
| 1418 without requiring the middle part to end with a space. | |
| 1621 | 1419 |
| 1420 Here is an example of alignment flags at work to make a comment stand out | |
| 2826 | 1421 (kind of looks like a 1 too). Consider comment string: > |
| 1422 :set comments=sr:/***,m:**,ex-2:******/ | |
| 1423 < | |
| 1424 /*** ~ | |
| 1425 **<--right aligned from "r" flag ~ | |
| 1426 ** ~ | |
| 1427 offset 2 spaces for the "-2" flag--->** ~ | |
| 1428 ******/ ~ | |
| 1621 | 1429 In this case, the first comment was typed, then return was pressed 4 times, |
| 1430 then "/" was pressed to end the comment. | |
| 7 | 1431 |
| 1621 | 1432 Here are some finer points of three part comments. There are three times when |
| 1433 alignment and offset flags are taken into consideration: opening a new line | |
| 1434 after a start-comment, opening a new line before an end-comment, and | |
| 1435 automatically ending a three-piece comment. The end alignment flag has a | |
| 1436 backwards perspective; the result is that the same alignment flag used with | |
| 1437 "s" and "e" will result in the same indent for the starting and ending pieces. | |
| 1438 Only one alignment per comment part is meant to be used, but an offset number | |
| 1439 will override the "r" and "l" flag. | |
| 1440 | |
| 1441 Enabling 'cindent' will override the alignment flags in many cases. | |
| 1442 Reindenting using a different method like |gq| or |=| will not consult | |
| 1443 alignment flags either. The same behaviour can be defined in those other | |
| 1444 formatting options. One consideration is that 'cindent' has additional options | |
| 1445 for context based indenting of comments but cannot replicate many three piece | |
| 2826 | 1446 indent alignments. However, 'indentexpr' has the ability to work better with |
| 1447 three piece comments. | |
| 1621 | 1448 |
| 1449 Other examples: > | |
| 7 | 1450 "b:*" Includes lines starting with "*", but not if the "*" is |
| 1451 followed by a non-blank. This avoids a pointer dereference | |
| 1452 like "*str" to be recognized as a comment. | |
| 1453 "n:>" Includes a line starting with ">", ">>", ">>>", etc. | |
| 1454 "fb:-" Format a list that starts with "- ". | |
| 1455 | |
| 1456 By default, "b:#" is included. This means that a line that starts with | |
| 1457 "#include" is not recognized as a comment line. But a line that starts with | |
| 1458 "# define" is recognized. This is a compromise. | |
| 1459 | |
| 1460 {not available when compiled without the |+comments| feature} | |
| 1461 | |
| 1462 *fo-table* | |
| 1463 You can use the 'formatoptions' option to influence how Vim formats text. | |
| 1464 'formatoptions' is a string that can contain any of the letters below. The | |
| 1465 default setting is "tcq". You can separate the option letters with commas for | |
| 1466 readability. | |
| 1467 | |
| 1468 letter meaning when present in 'formatoptions' ~ | |
| 1469 | |
| 1121 | 1470 t Auto-wrap text using textwidth |
| 7 | 1471 c Auto-wrap comments using textwidth, inserting the current comment |
| 1472 leader automatically. | |
| 1473 r Automatically insert the current comment leader after hitting | |
| 1474 <Enter> in Insert mode. | |
| 1475 o Automatically insert the current comment leader after hitting 'o' or | |
| 1476 'O' in Normal mode. | |
| 1477 q Allow formatting of comments with "gq". | |
| 1478 Note that formatting will not change blank lines or lines containing | |
| 1479 only the comment leader. A new paragraph starts after such a line, | |
| 1480 or when the comment leader changes. | |
| 1481 w Trailing white space indicates a paragraph continues in the next line. | |
| 1482 A line that ends in a non-white character ends a paragraph. | |
| 1483 a Automatic formatting of paragraphs. Every time text is inserted or | |
| 1484 deleted the paragraph will be reformatted. See |auto-format|. | |
| 1485 When the 'c' flag is present this only happens for recognized | |
| 1486 comments. | |
| 41 | 1487 n When formatting text, recognize numbered lists. This actually uses |
| 1488 the 'formatlistpat' option, thus any kind of list can be used. The | |
| 1489 indent of the text after the number is used for the next line. The | |
| 1621 | 1490 default is to find a number, optionally followed by '.', ':', ')', |
| 41 | 1491 ']' or '}'. Note that 'autoindent' must be set too. Doesn't work |
| 1492 well together with "2". | |
| 7 | 1493 Example: > |
| 1494 1. the first item | |
| 1495 wraps | |
| 1496 2. the second item | |
| 1497 2 When formatting text, use the indent of the second line of a paragraph | |
| 1498 for the rest of the paragraph, instead of the indent of the first | |
| 1499 line. This supports paragraphs in which the first line has a | |
| 1500 different indent than the rest. Note that 'autoindent' must be set | |
| 1501 too. Example: > | |
| 1502 first line of a paragraph | |
| 1503 second line of the same paragraph | |
| 1504 third line. | |
| 1505 v Vi-compatible auto-wrapping in insert mode: Only break a line at a | |
| 1506 blank that you have entered during the current insert command. (Note: | |
| 1507 this is not 100% Vi compatible. Vi has some "unexpected features" or | |
| 1508 bugs in this area. It uses the screen column instead of the line | |
| 1509 column.) | |
| 1510 b Like 'v', but only auto-wrap if you enter a blank at or before | |
| 1511 the wrap margin. If the line was longer than 'textwidth' when you | |
| 1512 started the insert, or you do not enter a blank in the insert before | |
| 1513 reaching 'textwidth', Vim does not perform auto-wrapping. | |
| 1514 l Long lines are not broken in insert mode: When a line was longer than | |
| 1515 'textwidth' when the insert command started, Vim does not | |
| 1516 automatically format it. | |
| 1517 m Also break at a multi-byte character above 255. This is useful for | |
| 1518 Asian text where every character is a word on its own. | |
| 1519 M When joining lines, don't insert a space before or after a multi-byte | |
| 1520 character. Overrules the 'B' flag. | |
| 1521 B When joining lines, don't insert a space between two multi-byte | |
| 1522 characters. Overruled by the 'M' flag. | |
| 1523 1 Don't break a line after a one-letter word. It's broken before it | |
| 1524 instead (if possible). | |
| 1525 | |
| 1526 | |
| 1527 With 't' and 'c' you can specify when Vim performs auto-wrapping: | |
| 1528 value action ~ | |
| 1529 "" no automatic formatting (you can use "gq" for manual formatting) | |
| 1530 "t" automatic formatting of text, but not comments | |
| 1531 "c" automatic formatting for comments, but not text (good for C code) | |
| 1532 "tc" automatic formatting for text and comments | |
| 1533 | |
| 867 | 1534 Note that when 'textwidth' is 0, Vim does no automatic formatting anyway (but |
| 1535 does insert comment leaders according to the 'comments' option). An exception | |
| 1536 is when the 'a' flag is present. |auto-format| | |
| 7 | 1537 |
| 1538 Note that when 'paste' is on, Vim does no formatting at all. | |
| 1539 | |
| 1540 Note that 'textwidth' can be non-zero even if Vim never performs auto-wrapping; | |
| 1541 'textwidth' is still useful for formatting with "gq". | |
| 1542 | |
| 1543 If the 'comments' option includes "/*", "*" and/or "*/", then Vim has some | |
| 1544 built in stuff to treat these types of comments a bit more cleverly. | |
| 1545 Opening a new line before or after "/*" or "*/" (with 'r' or 'o' present in | |
| 1546 'formatoptions') gives the correct start of the line automatically. The same | |
| 236 | 1547 happens with formatting and auto-wrapping. Opening a line after a line |
| 7 | 1548 starting with "/*" or "*" and containing "*/", will cause no comment leader to |
| 1549 be inserted, and the indent of the new line is taken from the line containing | |
| 1550 the start of the comment. | |
| 1551 E.g.: | |
| 1552 /* ~ | |
| 1553 * Your typical comment. ~ | |
| 1554 */ ~ | |
| 1555 The indent on this line is the same as the start of the above | |
| 1556 comment. | |
| 1557 | |
| 1558 All of this should be really cool, especially in conjunction with the new | |
| 1559 :autocmd command to prepare different settings for different types of file. | |
| 1560 | |
| 1561 Some examples: | |
| 1562 for C code (only format comments): > | |
| 1563 :set fo=croq | |
| 1564 < for Mail/news (format all, don't start comment with "o" command): > | |
| 1565 :set fo=tcrq | |
| 1566 < | |
| 1567 | |
| 3492 | 1568 Automatic formatting *auto-format* *autoformat* |
| 7 | 1569 |
| 1570 When the 'a' flag is present in 'formatoptions' text is formatted | |
| 1571 automatically when inserting text or deleting text. This works nice for | |
| 1572 editing text paragraphs. A few hints on how to use this: | |
| 1573 | |
| 1574 - You need to properly define paragraphs. The simplest is paragraphs that are | |
| 1575 separated by a blank line. When there is no separating blank line, consider | |
| 1576 using the 'w' flag and adding a space at the end of each line in the | |
| 1577 paragraphs except the last one. | |
| 1578 | |
| 1579 - You can set the 'formatoptions' based on the type of file |filetype| or | |
| 1580 specifically for one file with a |modeline|. | |
| 1581 | |
| 1582 - Set 'formatoptions' to "aw2tq" to make text with indents like this: | |
| 1583 | |
| 1584 bla bla foobar bla | |
| 1585 bla foobar bla foobar bla | |
| 1586 bla bla foobar bla | |
| 1587 bla foobar bla bla foobar | |
| 1588 | |
| 1589 - Add the 'c' flag to only auto-format comments. Useful in source code. | |
| 1590 | |
| 867 | 1591 - Set 'textwidth' to the desired width. If it is zero then 79 is used, or the |
| 1592 width of the screen if this is smaller. | |
| 1593 | |
| 7 | 1594 And a few warnings: |
| 1595 | |
| 1596 - When part of the text is not properly separated in paragraphs, making | |
| 1597 changes in this text will cause it to be formatted anyway. Consider doing > | |
| 1598 | |
| 1599 :set fo-=a | |
| 1600 | |
| 1601 - When using the 'w' flag (trailing space means paragraph continues) and | |
| 1602 deleting the last line of a paragraph with |dd|, the paragraph will be | |
| 1603 joined with the next one. | |
| 1604 | |
| 1605 - Changed text is saved for undo. Formatting is also a change. Thus each | |
| 1606 format action saves text for undo. This may consume quite a lot of memory. | |
| 1607 | |
| 1608 - Formatting a long paragraph and/or with complicated indenting may be slow. | |
| 1609 | |
| 282 | 1610 ============================================================================== |
| 1611 7. Sorting text *sorting* | |
| 1612 | |
| 1613 Vim has a sorting function and a sorting command. The sorting function can be | |
| 1614 found here: |sort()|. | |
| 1615 | |
| 1616 *:sor* *:sort* | |
| 826 | 1617 :[range]sor[t][!] [i][u][r][n][x][o] [/{pattern}/] |
| 586 | 1618 Sort lines in [range]. When no range is given all |
| 1619 lines are sorted. | |
| 282 | 1620 |
| 1621 With [!] the order is reversed. | |
| 1622 | |
| 1623 With [i] case is ignored. | |
| 1624 | |
| 293 | 1625 With [n] sorting is done on the first decimal number |
| 826 | 1626 in the line (after or inside a {pattern} match). |
| 1698 | 1627 One leading '-' is included in the number. |
| 293 | 1628 |
| 1629 With [x] sorting is done on the first hexadecimal | |
| 826 | 1630 number in the line (after or inside a {pattern} |
| 1631 match). A leading "0x" or "0X" is ignored. | |
| 1698 | 1632 One leading '-' is included in the number. |
| 293 | 1633 |
| 1634 With [o] sorting is done on the first octal number in | |
| 826 | 1635 the line (after or inside a {pattern} match). |
| 293 | 1636 |
| 282 | 1637 With [u] only keep the first of a sequence of |
| 1638 identical lines (ignoring case when [i] is used). | |
| 826 | 1639 Without this flag, a sequence of identical lines |
| 1640 will be kept in their original order. | |
| 293 | 1641 Note that leading and trailing white space may cause |
| 1642 lines to be different. | |
| 282 | 1643 |
| 826 | 1644 When /{pattern}/ is specified and there is no [r] flag |
| 1645 the text matched with {pattern} is skipped, so that | |
| 1646 you sort on what comes after the match. | |
| 282 | 1647 Instead of the slash any non-letter can be used. |
| 1648 For example, to sort on the second comma-separated | |
| 1649 field: > | |
| 1650 :sort /[^,]*,/ | |
| 1651 < To sort on the text at virtual column 10 (thus | |
| 1652 ignoring the difference between tabs and spaces): > | |
| 1653 :sort /.*\%10v/ | |
| 824 | 1654 < To sort on the first number in the line, no matter |
| 1655 what is in front of it: > | |
| 1621 | 1656 :sort /.\{-}\ze\d/ |
| 1657 < (Explanation: ".\{-}" matches any text, "\ze" sets the | |
| 1658 end of the match and \d matches a digit.) | |
| 1659 With [r] sorting is done on the matching {pattern} | |
| 826 | 1660 instead of skipping past it as described above. |
| 1661 For example, to sort on only the first three letters | |
| 1662 of each line: > | |
| 1663 :sort /\a\a\a/ r | |
| 1664 | |
| 1665 < If a {pattern} is used, any lines which don't have a | |
| 1666 match for {pattern} are kept in their current order, | |
| 1667 but separate from the lines which do match {pattern}. | |
| 1668 If you sorted in reverse, they will be in reverse | |
| 1669 order after the sorted lines, otherwise they will be | |
| 1670 in their original order, right before the sorted | |
| 1671 lines. | |
| 1672 | |
| 1314 | 1673 If {pattern} is empty (e.g. // is specified), the |
| 1674 last search pattern is used. This allows trying out | |
| 1675 a pattern first. | |
| 1676 | |
| 3492 | 1677 Note that using `:sort` with `:global` doesn't sort the matching lines, it's |
| 293 | 1678 quite useless. |
| 7 | 1679 |
| 359 | 1680 The details about sorting depend on the library function used. There is no |
| 1681 guarantee that sorting is "stable" or obeys the current locale. You will have | |
| 1682 to try it out. | |
| 1683 | |
| 826 | 1684 The sorting can be interrupted, but if you interrupt it too late in the |
| 1685 process you may end up with duplicated lines. This also depends on the system | |
| 1686 library function used. | |
| 481 | 1687 |
| 7 | 1688 vim:tw=78:ts=8:ft=help:norl: |