Mercurial > vim
annotate runtime/doc/change.txt @ 28730:de8df542fb53
Added tag v8.2.4889 for changeset 1bd1bfc64a47064c8f511ab1f7243fc55cc9bbdf
| author | Bram Moolenaar <Bram@vim.org> |
|---|---|
| date | Fri, 06 May 2022 17:15:04 +0200 |
| parents | 5eea8a249f86 |
| children | 38698deeda58 |
| rev | line source |
|---|---|
| 28010 | 1 *change.txt* For Vim version 8.2. Last change: 2022 Mar 05 |
| 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 | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
37 (join lines). |
| 7 | 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 | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
62 {Visual} see |Visual-mode|). |
| 7 | 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 | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
72 the end of the line. |
| 7 | 73 |
| 5220 | 74 *:d* *:de* *:del* *:delete* *:dl* *:dp* |
| 7 | 75 :[range]d[elete] [x] Delete [range] lines (default: current line) [into |
| 76 register x]. | |
| 5220 | 77 Note these weird abbreviations: |
| 78 :dl delete and list | |
| 79 :dell idem | |
| 80 :delel idem | |
| 81 :deletl idem | |
| 82 :deletel idem | |
| 83 :dp delete and print | |
| 84 :dep idem | |
| 85 :delp idem | |
| 86 :delep idem | |
| 87 :deletp idem | |
| 88 :deletep idem | |
| 7 | 89 |
| 90 :[range]d[elete] [x] {count} | |
| 91 Delete {count} lines, starting with [range] | |
| 92 (default: current line |cmdline-ranges|) [into | |
| 93 register x]. | |
| 94 | |
| 3492 | 95 These commands delete text. You can repeat them with the `.` command |
| 96 (except `:d`) and undo them. Use Visual mode to delete blocks of text. See | |
| 7 | 97 |registers| for an explanation of registers. |
| 98 | |
| 99 An exception for the d{motion} command: If the motion is not linewise, the | |
| 100 start and end of the motion are not in the same line, and there are only | |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
101 blanks before the start and there are no non-blanks after the end of the |
|
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
102 motion, the delete becomes linewise. This means that the delete also removes |
|
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
103 the line of blanks that you might expect to remain. Use the |o_v| operator to |
|
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
104 force the motion to be characterwise. |
| 7 | 105 |
| 106 Trying to delete an empty region of text (e.g., "d0" in the first column) | |
| 107 is an error when 'cpoptions' includes the 'E' flag. | |
| 108 | |
| 109 *J* | |
| 110 J Join [count] lines, with a minimum of two lines. | |
| 111 Remove the indent and insert up to two spaces (see | |
|
8497
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
112 below). Fails when on the last line of the buffer. |
| 13857 | 113 If [count] is too big it is reduced to the number of |
|
8497
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
114 lines available. |
| 7 | 115 |
| 116 *v_J* | |
| 117 {Visual}J Join the highlighted lines, with a minimum of two | |
| 118 lines. Remove the indent and insert up to two spaces | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
119 (see below). |
| 7 | 120 |
| 121 *gJ* | |
| 122 gJ Join [count] lines, with a minimum of two lines. | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
123 Don't insert or remove any spaces. |
| 7 | 124 |
| 125 *v_gJ* | |
| 126 {Visual}gJ Join the highlighted lines, with a minimum of two | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
127 lines. Don't insert or remove any spaces. |
| 7 | 128 |
| 129 *:j* *:join* | |
| 168 | 130 :[range]j[oin][!] [flags] |
| 131 Join [range] lines. Same as "J", except with [!] | |
| 7 | 132 the join does not insert or delete any spaces. |
| 133 If a [range] has equal start and end values, this | |
| 134 command does nothing. The default behavior is to | |
| 135 join the current line with the line below it. | |
| 168 | 136 See |ex-flags| for [flags]. |
| 7 | 137 |
| 168 | 138 :[range]j[oin][!] {count} [flags] |
| 7 | 139 Join {count} lines, starting with [range] (default: |
| 140 current line |cmdline-ranges|). Same as "J", except | |
| 141 with [!] the join does not insert or delete any | |
| 142 spaces. | |
| 168 | 143 See |ex-flags| for [flags]. |
| 7 | 144 |
| 145 These commands delete the <EOL> between lines. This has the effect of joining | |
| 3492 | 146 multiple lines into one line. You can repeat these commands (except `:j`) and |
| 7 | 147 undo them. |
| 148 | |
| 149 These commands, except "gJ", insert one space in place of the <EOL> unless | |
| 150 there is trailing white space or the next line starts with a ')'. These | |
| 151 commands, except "gJ", delete any leading white space on the next line. If | |
| 152 the 'joinspaces' option is on, these commands insert two spaces after a '.', | |
| 153 '!' or '?' (but if 'cpoptions' includes the 'j' flag, they insert two spaces | |
| 154 only after a '.'). | |
| 155 The 'B' and 'M' flags in 'formatoptions' change the behavior for inserting | |
| 21991 | 156 spaces before and after a multibyte character |fo-table|. |
| 7 | 157 |
|
5692
80e5f9584b02
Update runtime files. Add Euphoria syntax files.
Bram Moolenaar <bram@vim.org>
parents:
5663
diff
changeset
|
158 The '[ mark is set at the end of the first line that was joined, '] at the end |
|
80e5f9584b02
Update runtime files. Add Euphoria syntax files.
Bram Moolenaar <bram@vim.org>
parents:
5663
diff
changeset
|
159 of the resulting line. |
|
80e5f9584b02
Update runtime files. Add Euphoria syntax files.
Bram Moolenaar <bram@vim.org>
parents:
5663
diff
changeset
|
160 |
| 7 | 161 |
| 162 ============================================================================== | |
| 163 2. Delete and insert *delete-insert* *replacing* | |
| 164 | |
| 165 *R* | |
| 166 R Enter Replace mode: Each character you type replaces | |
| 167 an existing character, starting with the character | |
| 168 under the cursor. Repeat the entered text [count]-1 | |
| 169 times. See |Replace-mode| for more details. | |
| 170 | |
| 171 *gR* | |
| 172 gR Enter Virtual Replace mode: Each character you type | |
| 173 replaces existing characters in screen space. So a | |
| 174 <Tab> may replace several characters at once. | |
| 175 Repeat the entered text [count]-1 times. See | |
| 176 |Virtual-Replace-mode| for more details. | |
| 177 | |
| 178 *c* | |
| 179 ["x]c{motion} Delete {motion} text [into register x] and start | |
| 180 insert. When 'cpoptions' includes the 'E' flag and | |
| 181 there is no text to delete (e.g., with "cTx" when the | |
| 182 cursor is just after an 'x'), an error occurs and | |
| 183 insert mode does not start (this is Vi compatible). | |
| 184 When 'cpoptions' does not include the 'E' flag, the | |
| 185 "c" command always starts insert mode, even if there | |
| 186 is no text to delete. | |
| 187 | |
| 188 *cc* | |
| 189 ["x]cc Delete [count] lines [into register x] and start | |
| 190 insert |linewise|. If 'autoindent' is on, preserve | |
| 191 the indent of the first line. | |
| 192 | |
| 193 *C* | |
| 194 ["x]C Delete from the cursor position to the end of the | |
| 195 line and [count]-1 more lines [into register x], and | |
| 196 start insert. Synonym for c$ (not |linewise|). | |
| 197 | |
| 198 *s* | |
| 199 ["x]s Delete [count] characters [into register x] and start | |
| 200 insert (s stands for Substitute). Synonym for "cl" | |
| 201 (not |linewise|). | |
| 202 | |
| 203 *S* | |
| 204 ["x]S Delete [count] lines [into register x] and start | |
| 205 insert. Synonym for "cc" |linewise|. | |
| 206 | |
| 207 {Visual}["x]c or *v_c* *v_s* | |
| 208 {Visual}["x]s Delete the highlighted text [into register x] and | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
209 start insert (for {Visual} see |Visual-mode|). |
| 7 | 210 |
| 211 *v_r* | |
| 20115 | 212 {Visual}r{char} Replace all selected characters by {char}. |
| 7 | 213 |
| 214 *v_C* | |
| 215 {Visual}["x]C Delete the highlighted lines [into register x] and | |
| 216 start insert. In Visual block mode it works | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
217 differently |v_b_C|. |
| 7 | 218 *v_S* |
| 219 {Visual}["x]S Delete the highlighted lines [into register x] and | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
220 start insert (for {Visual} see |Visual-mode|). |
| 7 | 221 *v_R* |
| 222 {Visual}["x]R Currently just like {Visual}["x]S. In a next version | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
223 it might work differently. |
| 7 | 224 |
| 225 Notes: | |
| 226 - You can end Insert and Replace mode with <Esc>. | |
| 227 - See the section "Insert and Replace mode" |mode-ins-repl| for the other | |
| 228 special characters in these modes. | |
| 229 - The effect of [count] takes place after Vim exits Insert or Replace mode. | |
| 230 - When the 'cpoptions' option contains '$' and the change is within one line, | |
| 231 Vim continues to show the text to be deleted and puts a '$' at the last | |
| 232 deleted character. | |
| 233 | |
| 234 See |registers| for an explanation of registers. | |
| 235 | |
| 236 Replace mode is just like Insert mode, except that every character you enter | |
| 237 deletes one character. If you reach the end of a line, Vim appends any | |
| 238 further characters (just like Insert mode). In Replace mode, the backspace | |
| 239 key restores the original text (if there was any). (See section "Insert and | |
| 240 Replace mode" |mode-ins-repl|). | |
| 241 | |
| 242 *cw* *cW* | |
| 1621 | 243 Special case: When the cursor is in a word, "cw" and "cW" do not include the |
| 244 white space after a word, they only change up to the end of the word. This is | |
| 245 because Vim interprets "cw" as change-word, and a word does not include the | |
| 246 following white space. | |
| 247 {Vi: "cw" when on a blank followed by other blanks changes only the first | |
| 248 blank; this is probably a bug, because "dw" deletes all the blanks; use the | |
| 249 'w' flag in 'cpoptions' to make it work like Vi anyway} | |
| 7 | 250 |
| 251 If you prefer "cw" to include the space after a word, use this mapping: > | |
| 252 :map cw dwi | |
| 1621 | 253 Or use "caw" (see |aw|). |
| 254 | |
| 7 | 255 *:c* *:ch* *:change* |
| 168 | 256 :{range}c[hange][!] Replace lines of text with some different text. |
| 7 | 257 Type a line containing only "." to stop replacing. |
| 258 Without {range}, this command changes only the current | |
| 259 line. | |
| 168 | 260 Adding [!] toggles 'autoindent' for the time this |
| 261 command is executed. | |
| 26779 | 262 This command is not supported in |Vim9| script, |
| 263 because it is too easily confused with a variable | |
| 264 name. | |
| 7 | 265 |
| 266 ============================================================================== | |
| 267 3. Simple changes *simple-change* | |
| 268 | |
| 269 *r* | |
| 270 r{char} Replace the character under the cursor with {char}. | |
| 271 If {char} is a <CR> or <NL>, a line break replaces the | |
| 272 character. To replace with a real <CR>, use CTRL-V | |
| 273 <CR>. CTRL-V <NL> replaces with a <Nul>. | |
|
3507
8201108e9cf0
More runtime file fixes for 'compatible' mode.
Bram Moolenaar <bram@vim.org>
parents:
3493
diff
changeset
|
274 |
|
8201108e9cf0
More runtime file fixes for 'compatible' mode.
Bram Moolenaar <bram@vim.org>
parents:
3493
diff
changeset
|
275 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
|
276 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
|
277 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
|
278 `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
|
279 |
| 7 | 280 If you give a [count], Vim replaces [count] characters |
| 281 with [count] {char}s. When {char} is a <CR> or <NL>, | |
| 282 however, Vim inserts only one <CR>: "5r<CR>" replaces | |
| 283 five characters with a single line break. | |
| 284 When {char} is a <CR> or <NL>, Vim performs | |
| 285 autoindenting. This works just like deleting the | |
| 286 characters that are replaced and then doing | |
| 287 "i<CR><Esc>". | |
| 288 {char} can be entered as a digraph |digraph-arg|. | |
| 289 |:lmap| mappings apply to {char}. The CTRL-^ command | |
| 290 in Insert mode can be used to switch this on/off | |
| 291 |i_CTRL-^|. See |utf-8-char-arg| about using | |
| 292 composing characters when 'encoding' is Unicode. | |
| 293 | |
| 294 *gr* | |
| 295 gr{char} Replace the virtual characters under the cursor with | |
| 296 {char}. This replaces in screen space, not file | |
| 297 space. See |gR| and |Virtual-Replace-mode| for more | |
| 298 details. As with |r| a count may be given. | |
| 299 {char} can be entered like with |r|. | |
| 300 | |
| 301 *digraph-arg* | |
| 302 The argument for Normal mode commands like |r| and |t| is a single character. | |
| 303 When 'cpo' doesn't contain the 'D' flag, this character can also be entered | |
| 304 like |digraphs|. First type CTRL-K and then the two digraph characters. | |
| 305 {not available when compiled without the |+digraphs| feature} | |
| 306 | |
| 307 *case* | |
| 308 The following commands change the case of letters. The currently active | |
| 309 |locale| is used. See |:language|. The LC_CTYPE value matters here. | |
| 310 | |
| 311 *~* | |
| 312 ~ 'notildeop' option: Switch case of the character | |
| 313 under the cursor and move the cursor to the right. | |
| 16610 | 314 If a [count] is given, do that many characters. |
| 7 | 315 |
| 16610 | 316 ~{motion} 'tildeop' option: switch case of {motion} text. |
| 7 | 317 |
| 318 *g~* | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
319 g~{motion} Switch case of {motion} text. |
| 7 | 320 |
| 321 g~g~ *g~g~* *g~~* | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
322 g~~ Switch case of current line. |
| 7 | 323 |
| 324 *v_~* | |
| 325 {Visual}~ Switch case of highlighted text (for {Visual} see | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
326 |Visual-mode|). |
| 7 | 327 |
| 328 *v_U* | |
| 329 {Visual}U Make highlighted text uppercase (for {Visual} see | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
330 |Visual-mode|). |
| 7 | 331 |
| 332 *gU* *uppercase* | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
333 gU{motion} Make {motion} text uppercase. |
| 7 | 334 Example: > |
| 335 :map! <C-F> <Esc>gUiw`]a | |
| 336 < This works in Insert mode: press CTRL-F to make the | |
| 337 word before the cursor uppercase. Handy to type | |
| 338 words in lowercase and then make them uppercase. | |
| 339 | |
| 340 | |
| 341 gUgU *gUgU* *gUU* | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
342 gUU Make current line uppercase. |
| 7 | 343 |
| 344 *v_u* | |
| 345 {Visual}u Make highlighted text lowercase (for {Visual} see | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
346 |Visual-mode|). |
| 7 | 347 |
| 348 *gu* *lowercase* | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
349 gu{motion} Make {motion} text lowercase. |
| 7 | 350 |
| 351 gugu *gugu* *guu* | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
352 guu Make current line lowercase. |
| 7 | 353 |
| 354 *g?* *rot13* | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
355 g?{motion} Rot13 encode {motion} text. |
| 7 | 356 |
| 357 *v_g?* | |
| 358 {Visual}g? Rot13 encode the highlighted text (for {Visual} see | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
359 |Visual-mode|). |
| 7 | 360 |
| 361 g?g? *g?g?* *g??* | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
362 g?? Rot13 encode current line. |
| 7 | 363 |
| 1621 | 364 To turn one line into title caps, make every first letter of a word |
| 365 uppercase: > | |
| 366 :s/\v<(.)(\w*)/\u\1\L\2/g | |
| 367 | |
| 7 | 368 |
| 369 Adding and subtracting ~ | |
| 370 *CTRL-A* | |
| 371 CTRL-A Add [count] to the number or alphabetic character at | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
372 or after the cursor. |
| 7 | 373 |
| 6884 | 374 *v_CTRL-A* |
| 375 {Visual}CTRL-A Add [count] to the number or alphabetic character in | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
376 the highlighted text. |
| 6884 | 377 |
| 378 *v_g_CTRL-A* | |
| 379 {Visual}g CTRL-A Add [count] to the number or alphabetic character in | |
| 380 the highlighted text. If several lines are | |
| 381 highlighted, each one will be incremented by an | |
| 382 additional [count] (so effectively creating a | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
383 [count] incrementing sequence). |
| 6884 | 384 For Example, if you have this list of numbers: |
| 385 1. ~ | |
| 386 1. ~ | |
| 387 1. ~ | |
| 388 1. ~ | |
| 389 Move to the second "1." and Visually select three | |
| 390 lines, pressing g CTRL-A results in: | |
| 391 1. ~ | |
| 392 2. ~ | |
| 393 3. ~ | |
| 394 4. ~ | |
| 395 | |
| 7 | 396 *CTRL-X* |
| 397 CTRL-X Subtract [count] from the number or alphabetic | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
398 character at or after the cursor. |
| 7 | 399 |
| 6884 | 400 *v_CTRL-X* |
| 401 {Visual}CTRL-X Subtract [count] from the number or alphabetic | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
402 character in the highlighted text. |
| 6884 | 403 |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
404 On MS-Windows, this is mapped to cut Visual text |
|
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
405 |dos-standard-mappings|. If you want to disable the |
|
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
406 mapping, use this: > |
|
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
407 silent! vunmap <C-X> |
|
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
408 < |
| 6884 | 409 *v_g_CTRL-X* |
| 410 {Visual}g CTRL-X Subtract [count] from the number or alphabetic | |
| 411 character in the highlighted text. If several lines | |
| 412 are highlighted, each value will be decremented by an | |
| 413 additional [count] (so effectively creating a [count] | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
414 decrementing sequence). |
| 6884 | 415 |
|
7447
ad432f8f68fb
commit https://github.com/vim/vim/commit/887c1fea4a114e7170091942d0446c8882701b5b
Christian Brabandt <cb@256bit.org>
parents:
7183
diff
changeset
|
416 The CTRL-A and CTRL-X commands can work for: |
|
ad432f8f68fb
commit https://github.com/vim/vim/commit/887c1fea4a114e7170091942d0446c8882701b5b
Christian Brabandt <cb@256bit.org>
parents:
7183
diff
changeset
|
417 - signed and unsigned decimal numbers |
|
ad432f8f68fb
commit https://github.com/vim/vim/commit/887c1fea4a114e7170091942d0446c8882701b5b
Christian Brabandt <cb@256bit.org>
parents:
7183
diff
changeset
|
418 - unsigned binary, octal and hexadecimal numbers |
|
ad432f8f68fb
commit https://github.com/vim/vim/commit/887c1fea4a114e7170091942d0446c8882701b5b
Christian Brabandt <cb@256bit.org>
parents:
7183
diff
changeset
|
419 - alphabetic characters |
|
ad432f8f68fb
commit https://github.com/vim/vim/commit/887c1fea4a114e7170091942d0446c8882701b5b
Christian Brabandt <cb@256bit.org>
parents:
7183
diff
changeset
|
420 |
|
ad432f8f68fb
commit https://github.com/vim/vim/commit/887c1fea4a114e7170091942d0446c8882701b5b
Christian Brabandt <cb@256bit.org>
parents:
7183
diff
changeset
|
421 This depends on the 'nrformats' option: |
|
ad432f8f68fb
commit https://github.com/vim/vim/commit/887c1fea4a114e7170091942d0446c8882701b5b
Christian Brabandt <cb@256bit.org>
parents:
7183
diff
changeset
|
422 - When 'nrformats' includes "bin", Vim assumes numbers starting with '0b' or |
|
ad432f8f68fb
commit https://github.com/vim/vim/commit/887c1fea4a114e7170091942d0446c8882701b5b
Christian Brabandt <cb@256bit.org>
parents:
7183
diff
changeset
|
423 '0B' are binary. |
| 36 | 424 - When 'nrformats' includes "octal", Vim considers numbers starting with a '0' |
| 39 | 425 to be octal, unless the number includes a '8' or '9'. Other numbers are |
| 426 decimal and may have a preceding minus sign. | |
| 36 | 427 If the cursor is on a number, the commands apply to that number; otherwise |
| 428 Vim uses the number to the right of the cursor. | |
| 7 | 429 - When 'nrformats' includes "hex", Vim assumes numbers starting with '0x' or |
| 430 '0X' are hexadecimal. The case of the rightmost letter in the number | |
| 431 determines the case of the resulting hexadecimal number. If there is no | |
| 432 letter in the current number, Vim uses the previously detected case. | |
| 36 | 433 - When 'nrformats' includes "alpha", Vim will change the alphabetic character |
| 434 under or after the cursor. This is useful to make lists with an alphabetic | |
| 435 index. | |
| 7 | 436 |
| 6884 | 437 For decimals a leading negative sign is considered for incrementing/ |
|
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7447
diff
changeset
|
438 decrementing, for binary, octal and hex values, it won't be considered. To |
| 13857 | 439 ignore the sign Visually select the number before using CTRL-A or CTRL-X. |
| 6884 | 440 |
| 7 | 441 For numbers with leading zeros (including all octal and hexadecimal numbers), |
| 442 Vim preserves the number of characters in the number when possible. CTRL-A on | |
| 36 | 443 "0077" results in "0100", CTRL-X on "0x100" results in "0x0ff". |
| 39 | 444 There is one exception: When a number that starts with a zero is found not to |
| 445 be octal (it contains a '8' or '9'), but 'nrformats' does include "octal", | |
| 446 leading zeros are removed to avoid that the result may be recognized as an | |
| 447 octal number. | |
| 36 | 448 |
| 449 Note that when 'nrformats' includes "octal", decimal numbers with leading | |
| 39 | 450 zeros cause mistakes, because they can be confused with octal numbers. |
| 7 | 451 |
|
7447
ad432f8f68fb
commit https://github.com/vim/vim/commit/887c1fea4a114e7170091942d0446c8882701b5b
Christian Brabandt <cb@256bit.org>
parents:
7183
diff
changeset
|
452 Note similarly, when 'nrformats' includes "bin", binary numbers with a leading |
|
ad432f8f68fb
commit https://github.com/vim/vim/commit/887c1fea4a114e7170091942d0446c8882701b5b
Christian Brabandt <cb@256bit.org>
parents:
7183
diff
changeset
|
453 '0x' or '0X' can be interpreted as hexadecimal rather than binary since '0b' |
|
ad432f8f68fb
commit https://github.com/vim/vim/commit/887c1fea4a114e7170091942d0446c8882701b5b
Christian Brabandt <cb@256bit.org>
parents:
7183
diff
changeset
|
454 are valid hexadecimal digits. |
|
ad432f8f68fb
commit https://github.com/vim/vim/commit/887c1fea4a114e7170091942d0446c8882701b5b
Christian Brabandt <cb@256bit.org>
parents:
7183
diff
changeset
|
455 |
| 7 | 456 The CTRL-A command is very useful in a macro. Example: Use the following |
| 457 steps to make a numbered list. | |
| 458 | |
| 459 1. Create the first list entry, make sure it starts with a number. | |
| 99 | 460 2. qa - start recording into register 'a' |
| 7 | 461 3. Y - yank the entry |
| 462 4. p - put a copy of the entry below the first one | |
| 463 5. CTRL-A - increment the number | |
| 464 6. q - stop recording | |
| 465 7. <count>@a - repeat the yank, put and increment <count> times | |
| 466 | |
| 467 | |
| 468 SHIFTING LINES LEFT OR RIGHT *shift-left-right* | |
| 469 | |
| 470 *<* | |
| 471 <{motion} Shift {motion} lines one 'shiftwidth' leftwards. | |
| 472 | |
|
15062
3a94f7918980
patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents:
14999
diff
changeset
|
473 If the 'vartabstop' feature is enabled, and the |
|
3a94f7918980
patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents:
14999
diff
changeset
|
474 'shiftwidth' option is set to zero, the amount of |
|
3a94f7918980
patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents:
14999
diff
changeset
|
475 indent is calculated at the first non-blank character |
|
3a94f7918980
patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents:
14999
diff
changeset
|
476 in the line. |
| 7 | 477 *<<* |
| 478 << Shift [count] lines one 'shiftwidth' leftwards. | |
| 479 | |
| 480 *v_<* | |
| 481 {Visual}[count]< Shift the highlighted lines [count] 'shiftwidth' | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
482 leftwards (for {Visual} see |Visual-mode|). |
| 7 | 483 |
| 484 *>* | |
| 485 >{motion} Shift {motion} lines one 'shiftwidth' rightwards. | |
| 486 | |
|
15062
3a94f7918980
patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents:
14999
diff
changeset
|
487 If the 'vartabstop' feature is enabled, and the |
|
3a94f7918980
patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents:
14999
diff
changeset
|
488 'shiftwidth' option is set to zero, the amount of |
|
3a94f7918980
patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents:
14999
diff
changeset
|
489 indent is calculated at the first non-blank character |
|
3a94f7918980
patch 8.1.0542: shiftwidth() does not take 'vartabstop' into account
Bram Moolenaar <Bram@vim.org>
parents:
14999
diff
changeset
|
490 in the line. |
| 7 | 491 *>>* |
| 492 >> Shift [count] lines one 'shiftwidth' rightwards. | |
| 493 | |
| 494 *v_>* | |
| 495 {Visual}[count]> Shift the highlighted lines [count] 'shiftwidth' | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
496 rightwards (for {Visual} see |Visual-mode|). |
| 7 | 497 |
| 498 *:<* | |
| 499 :[range]< Shift [range] lines one 'shiftwidth' left. Repeat '<' | |
| 500 for shifting multiple 'shiftwidth's. | |
| 501 | |
| 502 :[range]< {count} Shift {count} lines one 'shiftwidth' left, starting | |
| 503 with [range] (default current line |cmdline-ranges|). | |
| 504 Repeat '<' for shifting multiple 'shiftwidth's. | |
| 505 | |
| 506 :[range]le[ft] [indent] left align lines in [range]. Sets the indent in the | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
507 lines to [indent] (default 0). |
| 7 | 508 |
| 509 *:>* | |
| 168 | 510 :[range]> [flags] Shift {count} [range] lines one 'shiftwidth' right. |
| 7 | 511 Repeat '>' for shifting multiple 'shiftwidth's. |
| 168 | 512 See |ex-flags| for [flags]. |
| 7 | 513 |
| 168 | 514 :[range]> {count} [flags] |
| 515 Shift {count} lines one 'shiftwidth' right, starting | |
| 7 | 516 with [range] (default current line |cmdline-ranges|). |
| 517 Repeat '>' for shifting multiple 'shiftwidth's. | |
| 168 | 518 See |ex-flags| for [flags]. |
| 7 | 519 |
| 520 The ">" and "<" commands are handy for changing the indentation within | |
| 521 programs. Use the 'shiftwidth' option to set the size of the white space | |
| 522 which these commands insert or delete. Normally the 'shiftwidth' option is 8, | |
| 523 but you can set it to, say, 3 to make smaller indents. The shift leftwards | |
| 524 stops when there is no indent. The shift right does not affect empty lines. | |
| 525 | |
| 526 If the 'shiftround' option is on, the indent is rounded to a multiple of | |
| 527 'shiftwidth'. | |
| 528 | |
| 529 If the 'smartindent' option is on, or 'cindent' is on and 'cinkeys' contains | |
| 5466 | 530 '#' with a zero value, shift right does not affect lines starting with '#' |
| 531 (these are supposed to be C preprocessor lines that must stay in column 1). | |
| 13735 | 532 This can be changed with the 'cino' option, see |cino-#|. |
| 7 | 533 |
| 534 When the 'expandtab' option is off (this is the default) Vim uses <Tab>s as | |
| 535 much as possible to make the indent. You can use ">><<" to replace an indent | |
| 536 made out of spaces with the same indent made out of <Tab>s (and a few spaces | |
| 537 if necessary). If the 'expandtab' option is on, Vim uses only spaces. Then | |
| 538 you can use ">><<" to replace <Tab>s in the indent by spaces (or use | |
| 3492 | 539 `:retab!`). |
| 7 | 540 |
| 3492 | 541 To move a line several 'shiftwidth's, use Visual mode or the `:` commands. |
| 7 | 542 For example: > |
| 543 Vjj4> move three lines 4 indents to the right | |
| 544 :<<< move current line 3 indents to the left | |
| 545 :>> 5 move 5 lines 2 indents to the right | |
| 546 :5>> move line 5 2 indents to the right | |
| 547 | |
| 548 ============================================================================== | |
| 549 4. Complex changes *complex-change* | |
| 550 | |
| 856 | 551 4.1 Filter commands *filter* |
| 32 | 552 |
| 553 A filter is a program that accepts text at standard input, changes it in some | |
| 554 way, and sends it to standard output. You can use the commands below to send | |
| 1621 | 555 some text through a filter, so that it is replaced by the filter output. |
| 32 | 556 Examples of filters are "sort", which sorts lines alphabetically, and |
| 557 "indent", which formats C program files (you need a version of indent that | |
| 558 works like a filter; not all versions do). The 'shell' option specifies the | |
| 559 shell Vim uses to execute the filter command (See also the 'shelltype' | |
| 560 option). You can repeat filter commands with ".". Vim does not recognize a | |
| 3492 | 561 comment (starting with '"') after the `:!` command. |
| 32 | 562 |
| 563 *!* | |
| 7 | 564 !{motion}{filter} Filter {motion} text lines through the external |
| 565 program {filter}. | |
| 566 | |
| 567 *!!* | |
| 568 !!{filter} Filter [count] lines through the external program | |
| 569 {filter}. | |
| 570 | |
| 571 *v_!* | |
| 572 {Visual}!{filter} Filter the highlighted lines through the external | |
| 573 program {filter} (for {Visual} see |Visual-mode|). | |
| 574 | |
| 575 :{range}![!]{filter} [!][arg] *:range!* | |
| 576 Filter {range} lines through the external program | |
| 577 {filter}. Vim replaces the optional bangs with the | |
| 578 latest given command and appends the optional [arg]. | |
| 579 Vim saves the output of the filter command in a | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
580 temporary file and then reads the file into the buffer |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
581 |tempfile|. Vim uses the 'shellredir' option to |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
582 redirect the filter output to the temporary file. |
| 603 | 583 However, if the 'shelltemp' option is off then pipes |
| 584 are used when possible (on Unix). | |
| 7 | 585 When the 'R' flag is included in 'cpoptions' marks in |
| 586 the filtered lines are deleted, unless the | |
| 587 |:keepmarks| command is used. Example: > | |
| 588 :keepmarks '<,'>!sort | |
| 589 < When the number of lines after filtering is less than | |
| 590 before, marks in the missing lines are deleted anyway. | |
| 591 | |
| 592 *=* | |
| 593 ={motion} Filter {motion} lines through the external program | |
| 594 given with the 'equalprg' option. When the 'equalprg' | |
| 595 option is empty (this is the default), use the | |
| 2833 | 596 internal formatting function |C-indenting| and |
| 597 |'lisp'|. But when 'indentexpr' is not empty, it will | |
| 598 be used instead |indent-expression|. When Vim was | |
| 599 compiled without internal formatting then the "indent" | |
| 600 program is used as a last resort. | |
| 7 | 601 |
| 602 *==* | |
| 603 == Filter [count] lines like with ={motion}. | |
| 604 | |
| 605 *v_=* | |
| 606 {Visual}= Filter the highlighted lines like with ={motion}. | |
| 607 | |
| 608 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
609 *tempfile* *setuid* |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
610 Vim uses temporary files for filtering, generating diffs and also for |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
611 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
|
612 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
|
613 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
|
614 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
|
615 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
|
616 probably runs as the original user. |
| 28517 | 617 Directory for temporary files is created in the first of these directories |
| 618 that works: | |
| 619 Unix: $TMPDIR, /tmp, current-dir, $HOME. | |
| 620 Windows: $TMP, $TEMP, c:\TMP, c:\TEMP | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
621 For MS-Windows the GetTempFileName() system function is used. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
622 For other systems the tmpnam() library function is used. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
623 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
624 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
625 |
| 32 | 626 4.2 Substitute *:substitute* |
| 627 *:s* *:su* | |
| 170 | 628 :[range]s[ubstitute]/{pattern}/{string}/[flags] [count] |
| 7 | 629 For each line in [range] replace a match of {pattern} |
| 630 with {string}. | |
| 631 For the {pattern} see |pattern|. | |
| 632 {string} can be a literal string, or something | |
| 633 special; see |sub-replace-special|. | |
| 634 When [range] and [count] are omitted, replace in the | |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10449
diff
changeset
|
635 current line only. When [count] is given, replace in |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10449
diff
changeset
|
636 [count] lines, starting with the last line in [range]. |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10449
diff
changeset
|
637 When [range] is omitted start in the current line. |
| 15878 | 638 *E939* |
|
10895
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10449
diff
changeset
|
639 [count] must be a positive number. Also see |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10449
diff
changeset
|
640 |cmdline-ranges|. |
|
c391bfbdb452
Updated runtime files.
Christian Brabandt <cb@256bit.org>
parents:
10449
diff
changeset
|
641 |
| 170 | 642 See |:s_flags| for [flags]. |
| 19404 | 643 The delimiter doesn't need to be /, see |
| 644 |pattern-delimiter|. | |
| 7 | 645 |
| 170 | 646 :[range]s[ubstitute] [flags] [count] |
| 647 :[range]&[&][flags] [count] *:&* | |
| 7 | 648 Repeat last :substitute with same search pattern and |
| 649 substitute string, but without the same flags. You | |
| 170 | 650 may add [flags], see |:s_flags|. |
| 3492 | 651 Note that after `:substitute` the '&' flag can't be |
| 7 | 652 used, it's recognized as a pattern separator. |
| 7013 | 653 The space between `:substitute` and the 'c', 'g', |
| 654 'i', 'I' and 'r' flags isn't required, but in scripts | |
| 655 it's a good idea to keep it to avoid confusion. | |
| 24103 | 656 Also see the two and three letter commands to repeat |
| 657 :substitute below |:substitute-repeat|. | |
| 7 | 658 |
| 170 | 659 :[range]~[&][flags] [count] *:~* |
| 7 | 660 Repeat last substitute with same substitute string |
| 661 but with last used search pattern. This is like | |
| 3492 | 662 `:&r`. See |:s_flags| for [flags]. |
| 7 | 663 |
| 170 | 664 *&* |
| 3492 | 665 & Synonym for `:s` (repeat last substitute). Note |
| 7 | 666 that the flags are not remembered, thus it might |
| 3492 | 667 actually work differently. You can use `:&&` to keep |
| 7 | 668 the flags. |
| 669 | |
| 170 | 670 *g&* |
| 3920 | 671 g& Synonym for `:%s//~/&` (repeat last substitute with |
| 672 last search pattern on all lines with the same flags). | |
| 4186 | 673 For example, when you first do a substitution with |
| 3920 | 674 `:s/pattern/repl/flags` and then `/search` for |
| 675 something else, `g&` will do `:%s/search/repl/flags`. | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
676 Mnemonic: global substitute. |
| 7 | 677 |
| 678 *:snomagic* *:sno* | |
| 3492 | 679 :[range]sno[magic] ... Same as `:substitute`, but always use 'nomagic'. |
| 7 | 680 |
| 681 *:smagic* *:sm* | |
| 3492 | 682 :[range]sm[agic] ... Same as `:substitute`, but always use 'magic'. |
| 7 | 683 |
| 684 *:s_flags* | |
| 685 The flags that you can use for the substitute commands: | |
| 686 | |
|
10449
222b1432814e
commit https://github.com/vim/vim/commit/5162822914372fc916a93f85848c0c82209e7cec
Christian Brabandt <cb@256bit.org>
parents:
10245
diff
changeset
|
687 *:&&* |
| 7 | 688 [&] Must be the first one: Keep the flags from the previous substitute |
| 689 command. Examples: > | |
| 690 :&& | |
| 691 :s/this/that/& | |
| 3492 | 692 < Note that `:s` and `:&` don't keep the flags. |
| 7 | 693 |
| 694 [c] Confirm each substitution. Vim highlights the matching string (with | |
| 695 |hl-IncSearch|). You can type: *:s_c* | |
| 696 'y' to substitute this match | |
| 697 'l' to substitute this match and then quit ("last") | |
| 698 'n' to skip this match | |
| 699 <Esc> to quit substituting | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
700 'a' to substitute this and all remaining matches |
|
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
701 'q' to quit substituting |
|
17809
59f8948b7590
patch 8.1.1901: the +insert_expand feature is not always available
Bram Moolenaar <Bram@vim.org>
parents:
17372
diff
changeset
|
702 CTRL-E to scroll the screen up |
|
59f8948b7590
patch 8.1.1901: the +insert_expand feature is not always available
Bram Moolenaar <Bram@vim.org>
parents:
17372
diff
changeset
|
703 CTRL-Y to scroll the screen down |
| 7 | 704 If the 'edcompatible' option is on, Vim remembers the [c] flag and |
| 705 toggles it each time you use it, but resets it when you give a new | |
| 706 search pattern. | |
| 707 | |
| 14864 | 708 *:s_e* |
| 7 | 709 [e] When the search pattern fails, do not issue an error message and, in |
| 710 particular, continue in maps as if no error occurred. This is most | |
| 711 useful to prevent the "No match" error from breaking a mapping. Vim | |
| 712 does not suppress the following error messages, however: | |
| 713 Regular expressions can't be delimited by letters | |
| 714 \ should be followed by /, ? or & | |
| 715 No previous substitute regular expression | |
| 716 Trailing characters | |
| 717 Interrupted | |
| 718 | |
| 14864 | 719 *:s_g* |
| 7 | 720 [g] Replace all occurrences in the line. Without this argument, |
| 721 replacement occurs only for the first occurrence in each line. If | |
| 722 the 'edcompatible' option is on, Vim remembers this flag and toggles | |
| 723 it each time you use it, but resets it when you give a new search | |
| 724 pattern. If the 'gdefault' option is on, this flag is on by default | |
| 725 and the [g] argument switches it off. | |
| 726 | |
| 14864 | 727 *:s_i* |
| 7 | 728 [i] Ignore case for the pattern. The 'ignorecase' and 'smartcase' options |
| 729 are not used. | |
| 730 | |
| 14864 | 731 *:s_I* |
| 7 | 732 [I] Don't ignore case for the pattern. The 'ignorecase' and 'smartcase' |
| 733 options are not used. | |
| 734 | |
| 14864 | 735 *:s_n* |
| 170 | 736 [n] Report the number of matches, do not actually substitute. The [c] |
| 737 flag is ignored. The matches are reported as if 'report' is zero. | |
| 738 Useful to |count-items|. | |
| 3750 | 739 If \= |sub-replace-expression| is used, the expression will be |
| 740 evaluated in the |sandbox| at every match. | |
| 170 | 741 |
| 14864 | 742 [p] Print the line containing the last substitute. *:s_p* |
| 743 | |
| 744 [#] Like [p] and prepend the line number. *:s_#* | |
| 168 | 745 |
| 14864 | 746 [l] Like [p] but print the text like |:list|. *:s_l* |
| 168 | 747 |
| 14864 | 748 *:s_r* |
| 3492 | 749 [r] Only useful in combination with `:&` or `:s` without arguments. `:&r` |
| 750 works the same way as `:~`: When the search pattern is empty, use the | |
| 7 | 751 previously used search pattern instead of the search pattern from the |
| 3492 | 752 last substitute or `:global`. If the last command that did a search |
| 753 was a substitute or `:global`, there is no effect. If the last | |
| 7 | 754 command was a search command such as "/", use the pattern from that |
| 755 command. | |
| 3492 | 756 For `:s` with an argument this already happens: > |
| 7 | 757 :s/blue/red/ |
| 758 /green | |
| 759 :s//red/ or :~ or :&r | |
| 760 < The last commands will replace "green" with "red". > | |
| 761 :s/blue/red/ | |
| 762 /green | |
| 763 :& | |
| 764 < The last command will replace "blue" with "red". | |
| 765 | |
| 766 Note that there is no flag to change the "magicness" of the pattern. A | |
| 1621 | 767 different command is used instead, or you can use |/\v| and friends. The |
| 768 reason is that the flags can only be found by skipping the pattern, and in | |
| 769 order to skip the pattern the "magicness" must be known. Catch 22! | |
| 7 | 770 |
| 771 If the {pattern} for the substitute command is empty, the command uses the | |
| 3492 | 772 pattern from the last substitute or `:global` command. If there is none, but |
| 2725 | 773 there is a previous search pattern, that one is used. With the [r] flag, the |
| 3492 | 774 command uses the pattern from the last substitute, `:global`, or search |
| 7 | 775 command. |
| 776 | |
| 1121 | 777 If the {string} is omitted the substitute is done as if it's empty. Thus the |
| 778 matched pattern is deleted. The separator after {pattern} can also be left | |
| 779 out then. Example: > | |
| 780 :%s/TESTING | |
| 781 This deletes "TESTING" from all lines, but only one per line. | |
| 28010 | 782 *E1270* |
| 783 For compatibility with Vi these two exceptions are allowed in legacy script: | |
| 7 | 784 "\/{string}/" and "\?{string}?" do the same as "//{string}/r". |
| 785 "\&{string}&" does the same as "//{string}/". | |
| 27537 | 786 *pattern-delimiter* *E146* *E1241* *E1242* |
| 25056 | 787 Instead of the '/' which surrounds the pattern and replacement string, you can |
| 788 use another single-byte character. This is useful if you want to include a | |
| 789 '/' in the search pattern or replacement string. Example: > | |
| 7 | 790 :s+/+//+ |
| 791 | |
| 25056 | 792 You can use most characters, but not an alphanumeric character, '\', '"' or |
| 793 '|'. In Vim9 script you should not use '#' because it may be recognized as | |
| 794 the start of a comment. | |
| 795 | |
| 1621 | 796 For the definition of a pattern, see |pattern|. In Visual block mode, use |
| 797 |/\%V| in the pattern to have the substitute work in the block only. | |
| 798 Otherwise it works on whole lines anyway. | |
| 7 | 799 |
| 800 *sub-replace-special* *:s\=* | |
| 801 When the {string} starts with "\=" it is evaluated as an expression, see | |
| 2908 | 802 |sub-replace-expression|. You can use that for complex replacement or special |
| 803 characters. | |
| 804 | |
| 452 | 805 Otherwise these characters in {string} have a special meaning: |
| 168 | 806 *:s%* |
| 843 | 807 When {string} is equal to "%" and '/' is included with the 'cpoptions' option, |
| 2908 | 808 then the {string} of the previous substitute command is used, see |cpo-/| |
| 7 | 809 |
| 810 magic nomagic action ~ | |
| 811 & \& replaced with the whole matched pattern *s/\&* | |
| 812 \& & replaced with & | |
| 813 \0 replaced with the whole matched pattern *\0* *s/\0* | |
| 814 \1 replaced with the matched pattern in the first | |
| 815 pair of () *s/\1* | |
| 26 | 816 \2 replaced with the matched pattern in the second |
| 7 | 817 pair of () *s/\2* |
| 818 .. .. *s/\3* | |
| 819 \9 replaced with the matched pattern in the ninth | |
| 820 pair of () *s/\9* | |
| 821 ~ \~ replaced with the {string} of the previous | |
| 822 substitute *s~* | |
| 823 \~ ~ replaced with ~ *s/\~* | |
| 824 \u next character made uppercase *s/\u* | |
| 825 \U following characters made uppercase, until \E *s/\U* | |
| 826 \l next character made lowercase *s/\l* | |
| 827 \L following characters made lowercase, until \E *s/\L* | |
| 828 \e end of \u, \U, \l and \L (NOTE: not <Esc>!) *s/\e* | |
| 829 \E end of \u, \U, \l and \L *s/\E* | |
| 830 <CR> split line in two at this point | |
| 831 (Type the <CR> as CTRL-V <Enter>) *s<CR>* | |
| 832 \r idem *s/\r* | |
| 833 \<CR> insert a carriage-return (CTRL-M) | |
| 834 (Type the <CR> as CTRL-V <Enter>) *s/\<CR>* | |
| 835 \n insert a <NL> (<NUL> in the file) | |
| 836 (does NOT break the line) *s/\n* | |
| 837 \b insert a <BS> *s/\b* | |
| 838 \t insert a <Tab> *s/\t* | |
| 839 \\ insert a single backslash *s/\\* | |
| 840 \x where x is any character not mentioned above: | |
| 841 Reserved for future expansion | |
| 842 | |
| 2908 | 843 The special meaning is also used inside the third argument {sub} of |
| 844 the |substitute()| function with the following exceptions: | |
| 845 - A % inserts a percent literally without regard to 'cpoptions'. | |
| 846 - magic is always set without regard to 'magic'. | |
| 847 - A ~ inserts a tilde literally. | |
| 848 - <CR> and \r inserts a carriage-return (CTRL-M). | |
| 14999 | 849 - \<CR> does not have a special meaning. It's just one of \x. |
| 2908 | 850 |
| 7 | 851 Examples: > |
| 852 :s/a\|b/xxx\0xxx/g modifies "a b" to "xxxaxxx xxxbxxx" | |
| 853 :s/\([abc]\)\([efg]\)/\2\1/g modifies "af fa bg" to "fa fa gb" | |
| 854 :s/abcde/abc^Mde/ modifies "abcde" to "abc", "de" (two lines) | |
| 855 :s/$/\^M/ modifies "abcde" to "abcde^M" | |
| 772 | 856 :s/\w\+/\u\0/g modifies "bla bla" to "Bla Bla" |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8497
diff
changeset
|
857 :s/\w\+/\L\u\0/g modifies "BLA bla" to "Bla Bla" |
| 4264 | 858 |
| 859 Note: "\L\u" can be used to capitalize the first letter of a word. This is | |
| 860 not compatible with Vi and older versions of Vim, where the "\u" would cancel | |
| 861 out the "\L". Same for "\U\l". | |
| 7 | 862 |
| 863 Note: In previous versions CTRL-V was handled in a special way. Since this is | |
| 864 not Vi compatible, this was removed. Use a backslash instead. | |
| 865 | |
| 866 command text result ~ | |
| 867 :s/aa/a^Ma/ aa a<line-break>a | |
| 868 :s/aa/a\^Ma/ aa a^Ma | |
| 869 :s/aa/a\\^Ma/ aa a\<line-break>a | |
| 870 | |
| 871 (you need to type CTRL-V <CR> to get a ^M here) | |
| 872 | |
| 873 The numbering of "\1", "\2" etc. is done based on which "\(" comes first in | |
| 874 the pattern (going left to right). When a parentheses group matches several | |
| 875 times, the last one will be used for "\1", "\2", etc. Example: > | |
| 876 :s/\(\(a[a-d] \)*\)/\2/ modifies "aa ab x" to "ab x" | |
|
10186
a5ef9968638c
commit https://github.com/vim/vim/commit/7e1479b86c590a66b63a274c079b7f18907d45a4
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
877 The "\2" is for "\(a[a-d] \)". At first it matches "aa ", secondly "ab ". |
| 7 | 878 |
| 879 When using parentheses in combination with '|', like in \([ab]\)\|\([cd]\), | |
| 880 either the first or second pattern in parentheses did not match, so either | |
| 881 \1 or \2 is empty. Example: > | |
| 882 :s/\([ab]\)\|\([cd]\)/\1x/g modifies "a b c d" to "ax bx x x" | |
| 883 < | |
| 884 | |
|
7183
ffad29dc7eee
commit https://github.com/vim/vim/commit/a0f849ee40cbea3c889345256786b640b0becca2
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
885 *:sc* *:sce* *:scg* *:sci* *:scI* *:scl* *:scp* *:sg* *:sgc* |
|
ffad29dc7eee
commit https://github.com/vim/vim/commit/a0f849ee40cbea3c889345256786b640b0becca2
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
886 *:sge* *:sgi* *:sgI* *:sgl* *:sgn* *:sgp* *:sgr* *:sI* *:si* |
|
ffad29dc7eee
commit https://github.com/vim/vim/commit/a0f849ee40cbea3c889345256786b640b0becca2
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
887 *:sic* *:sIc* *:sie* *:sIe* *:sIg* *:sIl* *:sin* *:sIn* *:sIp* |
|
ffad29dc7eee
commit https://github.com/vim/vim/commit/a0f849ee40cbea3c889345256786b640b0becca2
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
888 *:sip* *:sIr* *:sir* *:sr* *:src* *:srg* *:sri* *:srI* *:srl* |
| 24103 | 889 *:srn* *:srp* *:substitute-repeat* |
|
7183
ffad29dc7eee
commit https://github.com/vim/vim/commit/a0f849ee40cbea3c889345256786b640b0becca2
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
890 2-letter and 3-letter :substitute commands ~ |
|
ffad29dc7eee
commit https://github.com/vim/vim/commit/a0f849ee40cbea3c889345256786b640b0becca2
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
891 |
| 24103 | 892 These commands repeat the previous `:substitute` command with the given flags. |
| 893 The first letter is always "s", followed by one or two of the possible flag | |
| 894 characters. For example `:sce` works like `:s///ce`. The table lists the | |
| 895 possible combinations, not all flags are possible, because the command is | |
| 896 short for another command. | |
| 897 | |
|
7183
ffad29dc7eee
commit https://github.com/vim/vim/commit/a0f849ee40cbea3c889345256786b640b0becca2
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
898 List of :substitute commands |
|
ffad29dc7eee
commit https://github.com/vim/vim/commit/a0f849ee40cbea3c889345256786b640b0becca2
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
899 | c e g i I n p l r |
| 24103 | 900 | c :sc :sce :scg :sci :scI :scn :scp :scl |
|
7183
ffad29dc7eee
commit https://github.com/vim/vim/commit/a0f849ee40cbea3c889345256786b640b0becca2
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
901 | e |
|
ffad29dc7eee
commit https://github.com/vim/vim/commit/a0f849ee40cbea3c889345256786b640b0becca2
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
902 | g :sgc :sge :sg :sgi :sgI :sgn :sgp :sgl :sgr |
| 24103 | 903 | i :sic :sie :si :siI :sin :sip :sir |
|
7183
ffad29dc7eee
commit https://github.com/vim/vim/commit/a0f849ee40cbea3c889345256786b640b0becca2
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
904 | I :sIc :sIe :sIg :sIi :sI :sIn :sIp :sIl :sIr |
|
ffad29dc7eee
commit https://github.com/vim/vim/commit/a0f849ee40cbea3c889345256786b640b0becca2
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
905 | n |
|
ffad29dc7eee
commit https://github.com/vim/vim/commit/a0f849ee40cbea3c889345256786b640b0becca2
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
906 | p |
|
ffad29dc7eee
commit https://github.com/vim/vim/commit/a0f849ee40cbea3c889345256786b640b0becca2
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
907 | l |
| 24103 | 908 | r :src :srg :sri :srI :srn :srp :srl :sr |
|
7183
ffad29dc7eee
commit https://github.com/vim/vim/commit/a0f849ee40cbea3c889345256786b640b0becca2
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
909 |
|
ffad29dc7eee
commit https://github.com/vim/vim/commit/a0f849ee40cbea3c889345256786b640b0becca2
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
910 Exceptions: |
|
ffad29dc7eee
commit https://github.com/vim/vim/commit/a0f849ee40cbea3c889345256786b640b0becca2
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
911 :scr is `:scriptnames` |
|
ffad29dc7eee
commit https://github.com/vim/vim/commit/a0f849ee40cbea3c889345256786b640b0becca2
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
912 :se is `:set` |
|
ffad29dc7eee
commit https://github.com/vim/vim/commit/a0f849ee40cbea3c889345256786b640b0becca2
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
913 :sig is `:sign` |
|
ffad29dc7eee
commit https://github.com/vim/vim/commit/a0f849ee40cbea3c889345256786b640b0becca2
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
914 :sil is `:silent` |
|
ffad29dc7eee
commit https://github.com/vim/vim/commit/a0f849ee40cbea3c889345256786b640b0becca2
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
915 :sn is `:snext` |
|
ffad29dc7eee
commit https://github.com/vim/vim/commit/a0f849ee40cbea3c889345256786b640b0becca2
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
916 :sp is `:split` |
|
ffad29dc7eee
commit https://github.com/vim/vim/commit/a0f849ee40cbea3c889345256786b640b0becca2
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
917 :sl is `:sleep` |
|
ffad29dc7eee
commit https://github.com/vim/vim/commit/a0f849ee40cbea3c889345256786b640b0becca2
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
918 :sre is `:srewind` |
|
ffad29dc7eee
commit https://github.com/vim/vim/commit/a0f849ee40cbea3c889345256786b640b0becca2
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
919 |
|
ffad29dc7eee
commit https://github.com/vim/vim/commit/a0f849ee40cbea3c889345256786b640b0becca2
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
920 |
| 7 | 921 Substitute with an expression *sub-replace-expression* |
|
5663
1dea14d4c738
Update runtime files. Add support for systemverilog.
Bram Moolenaar <bram@vim.org>
parents:
5618
diff
changeset
|
922 *sub-replace-\=* *s/\=* |
| 270 | 923 When the substitute string starts with "\=" the remainder is interpreted as an |
|
10245
d76ccdacb41e
commit https://github.com/vim/vim/commit/6100d02aab7c8294b581cb299250eea164b50e9d
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
924 expression. |
| 7 | 925 |
| 926 The special meaning for characters as mentioned at |sub-replace-special| does | |
| 2908 | 927 not apply except for "<CR>". A <NL> character is used as a line break, you |
| 928 can get one with a double-quote string: "\n". Prepend a backslash to get a | |
| 929 real <NL> character (which will be a NUL in the file). | |
| 7 | 930 |
| 2908 | 931 The "\=" notation can also be used inside the third argument {sub} of |
| 932 |substitute()| function. In this case, the special meaning for characters as | |
| 933 mentioned at |sub-replace-special| does not apply at all. Especially, <CR> and | |
| 934 <NL> are interpreted not as a line break but as a carriage-return and a | |
| 935 new-line respectively. | |
| 7 | 936 |
| 714 | 937 When the result is a |List| then the items are joined with separating line |
| 938 breaks. Thus each item becomes a line, except that they can contain line | |
| 939 breaks themselves. | |
| 940 | |
| 15194 | 941 The |submatch()| function can be used to obtain matched text. The whole |
| 942 matched text can be accessed with "submatch(0)". The text matched with the | |
| 943 first pair of () with "submatch(1)". Likewise for further sub-matches in (). | |
| 7 | 944 |
| 945 Be careful: The separation character must not appear in the expression! | |
| 946 Consider using a character like "@" or ":". There is no problem if the result | |
| 947 of the expression contains the separation character. | |
| 948 | |
| 452 | 949 Examples: > |
| 27903 | 950 :s@\n@\="\r" .. expand("$HOME") .. "\r"@ |
| 452 | 951 This replaces an end-of-line with a new line containing the value of $HOME. > |
| 952 | |
| 953 s/E/\="\<Char-0x20ac>"/g | |
| 1668 | 954 This replaces each 'E' character with a euro sign. Read more in |<Char->|. |
| 7 | 955 |
| 956 | |
| 32 | 957 4.3 Search and replace *search-replace* |
| 958 | |
| 959 *:pro* *:promptfind* | |
| 7 | 960 :promptf[ind] [string] |
| 961 Put up a Search dialog. When [string] is given, it is | |
| 962 used as the initial search string. | |
| 963 {only for Win32, Motif and GTK GUI} | |
| 964 | |
| 965 *:promptr* *:promptrepl* | |
| 966 :promptr[epl] [string] | |
| 967 Put up a Search/Replace dialog. When [string] is | |
| 968 given, it is used as the initial search string. | |
| 969 {only for Win32, Motif and GTK GUI} | |
| 970 | |
| 32 | 971 |
| 972 4.4 Changing tabs *change-tabs* | |
| 3492 | 973 *:ret* *:retab* *:retab!* |
| 7 | 974 :[range]ret[ab][!] [new_tabstop] |
| 975 Replace all sequences of white-space containing a | |
| 976 <Tab> with new strings of white-space using the new | |
| 977 tabstop value given. If you do not specify a new | |
| 978 tabstop size or it is zero, Vim uses the current value | |
| 979 of 'tabstop'. | |
| 980 The current value of 'tabstop' is always used to | |
| 981 compute the width of existing tabs. | |
| 982 With !, Vim also replaces strings of only normal | |
| 983 spaces with tabs where appropriate. | |
| 984 With 'expandtab' on, Vim replaces all tabs with the | |
| 985 appropriate number of spaces. | |
| 986 This command sets 'tabstop' to the new value given, | |
| 987 and if performed on the whole file, which is default, | |
| 988 should not make any visible change. | |
| 989 Careful: This command modifies any <Tab> characters | |
| 990 inside of strings in a C program. Use "\t" to avoid | |
| 991 this (that's a good habit anyway). | |
| 3492 | 992 `:retab!` may also change a sequence of spaces by |
| 7 | 993 <Tab> characters, which can mess up a printf(). |
|
14175
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
13963
diff
changeset
|
994 If the |+vartabs| feature is enabled then a list of |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
13963
diff
changeset
|
995 tab widths separated by commas may be used in place of |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
13963
diff
changeset
|
996 a single tabstop. Each value in the list represents |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
13963
diff
changeset
|
997 the width of one tabstop, except the final value which |
|
2ad722003b36
patch 8.1.0105: all tab stops are the same
Christian Brabandt <cb@256bit.org>
parents:
13963
diff
changeset
|
998 applies to all following tabstops. |
| 7 | 999 |
| 1000 *retab-example* | |
| 1001 Example for using autocommands and ":retab" to edit a file which is stored | |
| 1002 with tabstops at 8 but edited with tabstops set at 4. Warning: white space | |
| 1003 inside of strings can change! Also see 'softtabstop' option. > | |
| 1004 | |
| 1005 :auto BufReadPost *.xx retab! 4 | |
| 1006 :auto BufWritePre *.xx retab! 8 | |
| 1007 :auto BufWritePost *.xx retab! 4 | |
| 1008 :auto BufNewFile *.xx set ts=4 | |
| 1009 | |
| 1010 ============================================================================== | |
| 1011 5. Copying and moving text *copy-move* | |
| 1012 | |
| 1013 *quote* | |
| 20241 | 1014 "{register} Use {register} for next delete, yank or put. Use |
| 1015 an uppercase character to append with delete and yank. | |
| 1016 Registers ".", "%", "#" and ":" only work with put. | |
| 7 | 1017 |
| 1018 *:reg* *:registers* | |
|
18436
6ec1bfb4690b
patch 8.1.2212: cannot see the selection type in :reg output
Bram Moolenaar <Bram@vim.org>
parents:
18343
diff
changeset
|
1019 :reg[isters] Display the type and contents of all numbered and |
|
6ec1bfb4690b
patch 8.1.2212: cannot see the selection type in :reg output
Bram Moolenaar <Bram@vim.org>
parents:
18343
diff
changeset
|
1020 named registers. If a register is written to for |
|
6ec1bfb4690b
patch 8.1.2212: cannot see the selection type in :reg output
Bram Moolenaar <Bram@vim.org>
parents:
18343
diff
changeset
|
1021 |:redir| it will not be listed. |
|
6ec1bfb4690b
patch 8.1.2212: cannot see the selection type in :reg output
Bram Moolenaar <Bram@vim.org>
parents:
18343
diff
changeset
|
1022 Type can be one of: |
|
6ec1bfb4690b
patch 8.1.2212: cannot see the selection type in :reg output
Bram Moolenaar <Bram@vim.org>
parents:
18343
diff
changeset
|
1023 "c" for |characterwise| text |
|
6ec1bfb4690b
patch 8.1.2212: cannot see the selection type in :reg output
Bram Moolenaar <Bram@vim.org>
parents:
18343
diff
changeset
|
1024 "l" for |linewise| text |
|
6ec1bfb4690b
patch 8.1.2212: cannot see the selection type in :reg output
Bram Moolenaar <Bram@vim.org>
parents:
18343
diff
changeset
|
1025 "b" for |blockwise-visual| text |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1026 |
| 7 | 1027 |
| 1028 :reg[isters] {arg} Display the contents of the numbered and named | |
| 1029 registers that are mentioned in {arg}. For example: > | |
|
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7447
diff
changeset
|
1030 :reg 1a |
| 7 | 1031 < to display registers '1' and 'a'. Spaces are allowed |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
1032 in {arg}. |
| 7 | 1033 |
| 1034 *:di* *:display* | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
1035 :di[splay] [arg] Same as :registers. |
| 7 | 1036 |
| 1037 *y* *yank* | |
| 1038 ["x]y{motion} Yank {motion} text [into register x]. When no | |
| 1039 characters are to be yanked (e.g., "y0" in column 1), | |
| 1040 this is an error when 'cpoptions' includes the 'E' | |
| 1041 flag. | |
| 1042 | |
| 1043 *yy* | |
| 1044 ["x]yy Yank [count] lines [into register x] |linewise|. | |
| 1045 | |
| 1046 *Y* | |
| 1047 ["x]Y yank [count] lines [into register x] (synonym for | |
| 1048 yy, |linewise|). If you like "Y" to work from the | |
| 1049 cursor to the end of line (which is more logical, | |
| 1050 but not Vi-compatible) use ":map Y y$". | |
| 1051 | |
|
24866
f1121eb17e14
patch 8.2.2971: cannot yank a block without trailing spaces
Bram Moolenaar <Bram@vim.org>
parents:
24752
diff
changeset
|
1052 *zy* |
|
f1121eb17e14
patch 8.2.2971: cannot yank a block without trailing spaces
Bram Moolenaar <Bram@vim.org>
parents:
24752
diff
changeset
|
1053 ["x]zy{motion} Yank {motion} text [into register x]. Only differs |
|
f1121eb17e14
patch 8.2.2971: cannot yank a block without trailing spaces
Bram Moolenaar <Bram@vim.org>
parents:
24752
diff
changeset
|
1054 from `y` when selecting a block of text, see |v_zy|. |
|
f1121eb17e14
patch 8.2.2971: cannot yank a block without trailing spaces
Bram Moolenaar <Bram@vim.org>
parents:
24752
diff
changeset
|
1055 |
| 7 | 1056 *v_y* |
| 1057 {Visual}["x]y Yank the highlighted text [into register x] (for | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
1058 {Visual} see |Visual-mode|). |
| 7 | 1059 |
| 1060 *v_Y* | |
| 1061 {Visual}["x]Y Yank the highlighted lines [into register x] (for | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
1062 {Visual} see |Visual-mode|). |
| 7 | 1063 |
|
24866
f1121eb17e14
patch 8.2.2971: cannot yank a block without trailing spaces
Bram Moolenaar <Bram@vim.org>
parents:
24752
diff
changeset
|
1064 *v_zy* |
|
f1121eb17e14
patch 8.2.2971: cannot yank a block without trailing spaces
Bram Moolenaar <Bram@vim.org>
parents:
24752
diff
changeset
|
1065 {Visual}["x]zy Yank the highlighted text [into register x]. Trailing |
|
f1121eb17e14
patch 8.2.2971: cannot yank a block without trailing spaces
Bram Moolenaar <Bram@vim.org>
parents:
24752
diff
changeset
|
1066 whitespace at the end of each line of a selected block |
|
f1121eb17e14
patch 8.2.2971: cannot yank a block without trailing spaces
Bram Moolenaar <Bram@vim.org>
parents:
24752
diff
changeset
|
1067 won't be yanked. Especially useful in combination |
|
f1121eb17e14
patch 8.2.2971: cannot yank a block without trailing spaces
Bram Moolenaar <Bram@vim.org>
parents:
24752
diff
changeset
|
1068 with `zp`. (for {Visual} see |Visual-mode|) |
|
f1121eb17e14
patch 8.2.2971: cannot yank a block without trailing spaces
Bram Moolenaar <Bram@vim.org>
parents:
24752
diff
changeset
|
1069 |
| 2791 | 1070 *:y* *:yank* *E850* |
| 1071 :[range]y[ank] [x] Yank [range] lines [into register x]. Yanking to the | |
| 2826 | 1072 "* or "+ registers is possible only when the |
| 1073 |+clipboard| feature is included. | |
| 7 | 1074 |
| 1075 :[range]y[ank] [x] {count} | |
| 1076 Yank {count} lines, starting with last line number | |
| 1077 in [range] (default: current line |cmdline-ranges|), | |
| 1078 [into register x]. | |
| 1079 | |
| 27537 | 1080 *p* *put* *E353* *E1240* |
| 7 | 1081 ["x]p Put the text [from register x] after the cursor |
| 16610 | 1082 [count] times. |
| 7 | 1083 |
| 1084 *P* | |
| 1085 ["x]P Put the text [from register x] before the cursor | |
| 16610 | 1086 [count] times. |
| 7 | 1087 |
| 1088 *<MiddleMouse>* | |
| 1089 ["x]<MiddleMouse> Put the text from a register before the cursor [count] | |
| 1090 times. Uses the "* register, unless another is | |
| 856 | 1091 specified. |
| 36 | 1092 Leaves the cursor at the end of the new text. |
| 1093 Using the mouse only works when 'mouse' contains 'n' | |
| 1094 or 'a'. | |
| 7 | 1095 If you have a scrollwheel and often accidentally paste |
| 1096 text, you can use these mappings to disable the | |
| 1097 pasting with the middle mouse button: > | |
| 1098 :map <MiddleMouse> <Nop> | |
| 1099 :imap <MiddleMouse> <Nop> | |
| 1100 < You might want to disable the multi-click versions | |
| 1101 too, see |double-click|. | |
| 1102 | |
| 1103 *gp* | |
| 1104 ["x]gp Just like "p", but leave the cursor just after the new | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
1105 text. |
| 7 | 1106 |
| 1107 *gP* | |
| 1108 ["x]gP Just like "P", but leave the cursor just after the new | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
1109 text. |
| 7 | 1110 |
| 1111 *:pu* *:put* | |
| 1112 :[line]pu[t] [x] Put the text [from register x] after [line] (default | |
| 1113 current line). This always works |linewise|, thus | |
| 1114 this command can be used to put a yanked block as new | |
| 1115 lines. | |
| 3492 | 1116 If no register is specified, it depends on the 'cb' |
| 1117 option: If 'cb' contains "unnamedplus", paste from the | |
| 1118 + 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
|
1119 "unnamed", paste from the * register |quotestar|. |
| 3492 | 1120 Otherwise, paste from the unnamed register |
| 1121 |quote_quote|. | |
| 7 | 1122 The register can also be '=' followed by an optional |
| 1123 expression. The expression continues until the end of | |
| 1124 the command. You need to escape the '|' and '"' | |
| 1125 characters to prevent them from terminating the | |
| 1126 command. Example: > | |
| 27903 | 1127 :put ='path' .. \",/test\" |
| 7 | 1128 < If there is no expression after '=', Vim uses the |
| 1129 previous expression. You can see it with ":dis =". | |
| 1130 | |
| 1131 :[line]pu[t]! [x] Put the text [from register x] before [line] (default | |
| 1132 current line). | |
| 1133 | |
| 1134 ["x]]p or *]p* *]<MiddleMouse>* | |
| 1135 ["x]]<MiddleMouse> Like "p", but adjust the indent to the current line. | |
| 1136 Using the mouse only works when 'mouse' contains 'n' | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
1137 or 'a'. |
| 7 | 1138 |
| 1139 ["x][P or *[P* | |
| 1140 ["x]]P or *]P* | |
| 1141 ["x][p or *[p* *[<MiddleMouse>* | |
| 1142 ["x][<MiddleMouse> Like "P", but adjust the indent to the current line. | |
| 1143 Using the mouse only works when 'mouse' contains 'n' | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
1144 or 'a'. |
| 7 | 1145 |
|
24752
1ce39e257f1b
patch 8.2.2914: cannot paste a block without adding padding
Bram Moolenaar <Bram@vim.org>
parents:
24103
diff
changeset
|
1146 ["x]zp or *zp* *zP* |
|
1ce39e257f1b
patch 8.2.2914: cannot paste a block without adding padding
Bram Moolenaar <Bram@vim.org>
parents:
24103
diff
changeset
|
1147 ["x]zP Like "p" and "P", except without adding trailing spaces |
|
1ce39e257f1b
patch 8.2.2914: cannot paste a block without adding padding
Bram Moolenaar <Bram@vim.org>
parents:
24103
diff
changeset
|
1148 when pasting a block. Thus the inserted text will not |
|
24866
f1121eb17e14
patch 8.2.2971: cannot yank a block without trailing spaces
Bram Moolenaar <Bram@vim.org>
parents:
24752
diff
changeset
|
1149 always be a rectangle. Especially useful in |
|
f1121eb17e14
patch 8.2.2971: cannot yank a block without trailing spaces
Bram Moolenaar <Bram@vim.org>
parents:
24752
diff
changeset
|
1150 combination with |v_zy|. |
|
24752
1ce39e257f1b
patch 8.2.2914: cannot paste a block without adding padding
Bram Moolenaar <Bram@vim.org>
parents:
24103
diff
changeset
|
1151 |
| 7 | 1152 You can use these commands to copy text from one place to another. Do this |
| 1153 by first getting the text into a register with a yank, delete or change | |
| 1154 command, then inserting the register contents with a put command. You can | |
| 1155 also use these commands to move text from one file to another, because Vim | |
| 1156 preserves all registers when changing buffers (the CTRL-^ command is a quick | |
| 1157 way to toggle between two files). | |
| 1158 | |
| 1159 *linewise-register* *characterwise-register* | |
| 1160 You can repeat the put commands with "." (except for :put) and undo them. If | |
| 1161 the command that was used to get the text into the register was |linewise|, | |
| 1162 Vim inserts the text below ("p") or above ("P") the line where the cursor is. | |
| 1163 Otherwise Vim inserts the text after ("p") or before ("P") the cursor. With | |
| 1164 the ":put" command, Vim always inserts the text in the next line. You can | |
| 1165 exchange two characters with the command sequence "xp". You can exchange two | |
| 1166 lines with the command sequence "ddp". You can exchange two words with the | |
| 1167 command sequence "deep" (start with the cursor in the blank space before the | |
| 1168 first word). You can use the "']" or "`]" command after the put command to | |
| 1169 move the cursor to the end of the inserted text, or use "'[" or "`[" to move | |
| 1170 the cursor to the start. | |
| 1171 | |
| 1172 *put-Visual-mode* *v_p* *v_P* | |
| 1173 When using a put command like |p| or |P| in Visual mode, Vim will try to | |
| 1174 replace the selected text with the contents of the register. Whether this | |
| 1175 works well depends on the type of selection and the type of the text in the | |
| 1176 register. With blockwise selection it also depends on the size of the block | |
| 236 | 1177 and whether the corners are on an existing character. (Implementation detail: |
| 7 | 1178 it actually works by first putting the register after the selection and then |
| 236 | 1179 deleting the selection.) |
|
28714
5eea8a249f86
patch 8.2.4881: "P" in Visual mode still changes some registers
Bram Moolenaar <Bram@vim.org>
parents:
28517
diff
changeset
|
1180 With |p| the previously selected text is put in the unnamed register (and |
|
5eea8a249f86
patch 8.2.4881: "P" in Visual mode still changes some registers
Bram Moolenaar <Bram@vim.org>
parents:
28517
diff
changeset
|
1181 possibly the selection and/or clipboard). This is useful if you want to put |
|
5eea8a249f86
patch 8.2.4881: "P" in Visual mode still changes some registers
Bram Moolenaar <Bram@vim.org>
parents:
28517
diff
changeset
|
1182 that text somewhere else. But you cannot repeat the same change. |
|
5eea8a249f86
patch 8.2.4881: "P" in Visual mode still changes some registers
Bram Moolenaar <Bram@vim.org>
parents:
28517
diff
changeset
|
1183 With |P| the unnamed register is not changed (and neither the selection or |
|
5eea8a249f86
patch 8.2.4881: "P" in Visual mode still changes some registers
Bram Moolenaar <Bram@vim.org>
parents:
28517
diff
changeset
|
1184 clipboard), you can repeat the same change. But the deleted text cannot be |
|
5eea8a249f86
patch 8.2.4881: "P" in Visual mode still changes some registers
Bram Moolenaar <Bram@vim.org>
parents:
28517
diff
changeset
|
1185 used. If you do need it you can use |p| with another register. E.g., yank |
|
5eea8a249f86
patch 8.2.4881: "P" in Visual mode still changes some registers
Bram Moolenaar <Bram@vim.org>
parents:
28517
diff
changeset
|
1186 the text to copy, Visually select the text to replace and use "0p . You can |
|
5eea8a249f86
patch 8.2.4881: "P" in Visual mode still changes some registers
Bram Moolenaar <Bram@vim.org>
parents:
28517
diff
changeset
|
1187 repeat this as many times as you like, and the unnamed register will be |
|
5eea8a249f86
patch 8.2.4881: "P" in Visual mode still changes some registers
Bram Moolenaar <Bram@vim.org>
parents:
28517
diff
changeset
|
1188 changed each time. |
| 7 | 1189 |
| 5365 | 1190 When you use a blockwise Visual mode command and yank only a single line into |
| 1191 a register, a paste on a visual selected area will paste that single line on | |
| 1192 each of the selected lines (thus replacing the blockwise selected region by a | |
| 1193 block of the pasted line). | |
| 1194 | |
| 7 | 1195 *blockwise-register* |
| 1196 If you use a blockwise Visual mode command to get the text into the register, | |
| 1197 the block of text will be inserted before ("P") or after ("p") the cursor | |
| 1198 column in the current and next lines. Vim makes the whole block of text start | |
| 1199 in the same column. Thus the inserted text looks the same as when it was | |
| 1200 yanked or deleted. Vim may replace some <Tab> characters with spaces to make | |
| 1201 this happen. However, if the width of the block is not a multiple of a <Tab> | |
| 1202 width and the text after the inserted block contains <Tab>s, that text may be | |
| 1203 misaligned. | |
| 1204 | |
| 25973 | 1205 Use |zP|/|zp| to paste a blockwise yanked register without appending trailing |
| 1206 spaces. | |
| 1207 | |
| 7 | 1208 Note that after a characterwise yank command, Vim leaves the cursor on the |
| 1209 first yanked character that is closest to the start of the buffer. This means | |
| 1210 that "yl" doesn't move the cursor, but "yh" moves the cursor one character | |
| 1211 left. | |
| 1212 Rationale: In Vi the "y" command followed by a backwards motion would | |
| 1213 sometimes not move the cursor to the first yanked character, | |
| 1214 because redisplaying was skipped. In Vim it always moves to | |
| 1215 the first character, as specified by Posix. | |
| 1216 With a linewise yank command the cursor is put in the first line, but the | |
| 1217 column is unmodified, thus it may not be on the first yanked character. | |
| 1218 | |
| 18186 | 1219 There are ten types of registers: *registers* *{register}* *E354* |
| 7 | 1220 1. The unnamed register "" |
| 1221 2. 10 numbered registers "0 to "9 | |
| 1222 3. The small delete register "- | |
| 1223 4. 26 named registers "a to "z or "A to "Z | |
| 17372 | 1224 5. Three read-only registers ":, "., "% |
| 1225 6. Alternate buffer register "# | |
| 1226 7. The expression register "= | |
| 6557 | 1227 8. The selection and drop registers "*, "+ and "~ |
| 1228 9. The black hole register "_ | |
| 1229 10. Last search pattern register "/ | |
| 7 | 1230 |
| 1231 1. Unnamed register "" *quote_quote* *quotequote* | |
| 1232 Vim fills this register with text deleted with the "d", "c", "s", "x" commands | |
| 1233 or copied with the yank "y" command, regardless of whether or not a specific | |
| 8 | 1234 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
|
1235 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
|
1236 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
|
1237 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
|
1238 register. |
| 42 | 1239 Vim uses the contents of the unnamed register for any put command (p or P) |
| 1240 which does not specify a register. Additionally you can access it with the | |
| 1241 name '"'. This means you have to type two double quotes. Writing to the "" | |
| 1242 register writes to register "0. | |
| 7 | 1243 {Vi: register contents are lost when changing files, no '"'} |
| 1244 | |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8497
diff
changeset
|
1245 2. Numbered registers "0 to "9 *quote_number* *quote0* *quote1* |
| 7 | 1246 *quote2* *quote3* *quote4* *quote9* |
| 1247 Vim fills these registers with text from yank and delete commands. | |
| 1248 Numbered register 0 contains the text from the most recent yank command, | |
| 1249 unless the command specified another register with ["x]. | |
| 1250 Numbered register 1 contains the text deleted by the most recent delete or | |
| 1251 change command, unless the command specified another register or the text is | |
| 1252 less than one line (the small delete register is used then). An exception is | |
| 42 | 1253 made for the delete operator with these movement commands: |%|, |(|, |)|, |`|, |
| 1254 |/|, |?|, |n|, |N|, |{| and |}|. Register "1 is always used then (this is Vi | |
| 1255 compatible). The "- register is used as well if the delete is within a line. | |
|
5362
ab1508486b12
Update runtime files. Add support for J.
Bram Moolenaar <bram@vim.org>
parents:
5340
diff
changeset
|
1256 Note that these characters may be mapped. E.g. |%| is mapped by the matchit |
| 5340 | 1257 plugin. |
| 7 | 1258 With each successive deletion or change, Vim shifts the previous contents |
| 1259 of register 1 into register 2, 2 into 3, and so forth, losing the previous | |
| 1260 contents of register 9. | |
| 1261 {Vi: numbered register contents are lost when changing files; register 0 does | |
| 1262 not exist} | |
| 1263 | |
| 1264 3. Small delete register "- *quote_-* *quote-* | |
| 1265 This register contains text from commands that delete less than one line, | |
| 1266 except when the command specifies a register with ["x]. | |
| 1267 | |
| 1268 4. Named registers "a to "z or "A to "Z *quote_alpha* *quotea* | |
| 1269 Vim fills these registers only when you say so. Specify them as lowercase | |
| 1270 letters to replace their previous contents or as uppercase letters to append | |
| 164 | 1271 to their previous contents. When the '>' flag is present in 'cpoptions' then |
| 1272 a line break is inserted before the appended text. | |
| 7 | 1273 |
| 6557 | 1274 5. Read-only registers ":, ". and "% |
| 7 | 1275 These are '%', '#', ':' and '.'. You can use them only with the "p", "P", |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
1276 and ":put" commands and with CTRL-R. |
| 7 | 1277 *quote_.* *quote.* *E29* |
| 1278 ". Contains the last inserted text (the same as what is inserted | |
| 1279 with the insert mode commands CTRL-A and CTRL-@). Note: this | |
| 1280 doesn't work with CTRL-R on the command-line. It works a bit | |
| 1281 differently, like inserting the text instead of putting it | |
| 1282 ('textwidth' and other options affect what is inserted). | |
| 1283 *quote_%* *quote%* | |
| 1284 "% Contains the name of the current file. | |
| 1285 *quote_:* *quote:* *E30* | |
| 1286 ": Contains the most recent executed command-line. Example: Use | |
| 1287 "@:" to repeat the previous command-line command. | |
| 1288 The command-line is only stored in this register when at least | |
| 1289 one character of it was typed. Thus it remains unchanged if | |
| 1290 the command was completely from a mapping. | |
| 1291 {not available when compiled without the |+cmdline_hist| | |
| 1292 feature} | |
| 6557 | 1293 *quote_#* *quote#* |
| 1294 6. Alternate file register "# | |
| 1295 Contains the name of the alternate file for the current window. It will | |
| 1296 change how the |CTRL-^| command works. | |
| 1297 This register is writable, mainly to allow for restoring it after a plugin has | |
| 1298 changed it. It accepts buffer number: > | |
| 1299 let altbuf = bufnr(@#) | |
| 1300 ... | |
| 1301 let @# = altbuf | |
| 1302 It will give error |E86| if you pass buffer number and this buffer does not | |
| 1303 exist. | |
| 1304 It can also accept a match with an existing buffer name: > | |
| 1305 let @# = 'buffer_name' | |
| 1306 Error |E93| if there is more than one buffer matching the given name or |E94| | |
| 1307 if none of buffers matches the given name. | |
| 7 | 1308 |
| 6557 | 1309 7. Expression register "= *quote_=* *quote=* *@=* |
| 7 | 1310 This is not really a register that stores text, but is a way to use an |
| 1311 expression in commands which use a register. The expression register is | |
| 6647 | 1312 read-write. |
| 1313 | |
| 1314 When typing the '=' after " or CTRL-R the cursor moves to the command-line, | |
| 1315 where you can enter any expression (see |expression|). All normal | |
| 1316 command-line editing commands are available, including a special history for | |
| 1317 expressions. When you end the command-line by typing <CR>, Vim computes the | |
| 1318 result of the expression. If you end it with <Esc>, Vim abandons the | |
| 1319 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
|
1320 expression (like with the "/" command). |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1321 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1322 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
|
1323 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
|
1324 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
|
1325 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
|
1326 an error message (use string() to convert). |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1327 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1328 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
|
1329 characters. If the String ends in a <NL>, it is regarded as a linewise |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
1330 register. |
| 7 | 1331 |
| 6557 | 1332 8. Selection and drop registers "*, "+ and "~ |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1333 Use these registers for storing and retrieving the selected text for the GUI. |
| 7 | 1334 See |quotestar| and |quoteplus|. When the clipboard is not available or not |
| 571 | 1335 working, the unnamed register is used instead. For Unix systems the clipboard |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
1336 is only available when the |+xterm_clipboard| feature is present. |
| 7 | 1337 |
| 1338 Note that there is only a distinction between "* and "+ for X11 systems. For | |
| 1339 an explanation of the difference, see |x11-selection|. Under MS-Windows, use | |
| 1340 of "* and "+ is actually synonymous and refers to the |gui-clipboard|. | |
| 1341 | |
| 1342 *quote_~* *quote~* *<Drop>* | |
| 1343 The read-only "~ register stores the dropped text from the last drag'n'drop | |
| 1344 operation. When something has been dropped onto Vim, the "~ register is | |
| 1345 filled in and the <Drop> pseudo key is sent for notification. You can remap | |
| 1346 this key if you want; the default action (for all modes) is to insert the | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
1347 contents of the "~ register at the cursor position. |
| 9 | 1348 {only available when compiled with the |+dnd| feature, currently only with the |
| 7 | 1349 GTK GUI} |
| 1350 | |
| 1351 Note: The "~ register is only used when dropping plain text onto Vim. | |
| 1352 Drag'n'drop of URI lists is handled internally. | |
| 1353 | |
| 6557 | 1354 9. Black hole register "_ *quote_* |
| 7 | 1355 When writing to this register, nothing happens. This can be used to delete |
| 1356 text without affecting the normal registers. When reading from this register, | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
1357 nothing is returned. |
| 7 | 1358 |
| 18186 | 1359 10. Last search pattern register "/ *quote_/* *quote/* |
| 7 | 1360 Contains the most recent search-pattern. This is used for "n" and 'hlsearch'. |
| 3492 | 1361 It is writable with `:let`, you can change it to have 'hlsearch' highlight |
| 7 | 1362 other matches without actually searching. You can't yank or delete into this |
| 1621 | 1363 register. The search direction is available in |v:searchforward|. |
| 6647 | 1364 Note that the value is restored when returning from a function |
| 1621 | 1365 |function-search-undo|. |
| 7 | 1366 |
| 1367 *@/* | |
| 3492 | 1368 You can write to a register with a `:let` command |:let-@|. Example: > |
| 7 | 1369 :let @/ = "the" |
| 1370 | |
| 1371 If you use a put command without specifying a register, Vim uses the register | |
| 1372 that was last filled (this is also the contents of the unnamed register). If | |
| 3492 | 1373 you are confused, use the `:dis` command to find out what Vim will put (this |
| 7 | 1374 command displays all named and numbered registers; the unnamed register is |
| 1375 labelled '"'). | |
| 1376 | |
| 1377 The next three commands always work on whole lines. | |
| 1378 | |
| 1379 :[range]co[py] {address} *:co* *:copy* | |
| 1380 Copy the lines given by [range] to below the line | |
| 1381 given by {address}. | |
| 1382 | |
| 1383 *:t* | |
| 1384 :t Synonym for copy. | |
| 26779 | 1385 This command is not supported in |Vim9| script, |
| 1386 because it is too easily confused with a variable | |
| 1387 name. | |
| 7 | 1388 |
| 1389 :[range]m[ove] {address} *:m* *:mo* *:move* *E134* | |
| 1390 Move the lines given by [range] to below the line | |
| 1391 given by {address}. | |
| 1392 | |
| 1393 ============================================================================== | |
| 1394 6. Formatting text *formatting* | |
| 1395 | |
| 1396 :[range]ce[nter] [width] *:ce* *:center* | |
| 1397 Center lines in [range] between [width] columns | |
| 1398 (default 'textwidth' or 80 when 'textwidth' is 0). | |
| 1399 | |
| 1400 :[range]ri[ght] [width] *:ri* *:right* | |
| 1401 Right-align lines in [range] at [width] columns | |
| 1402 (default 'textwidth' or 80 when 'textwidth' is 0). | |
| 1403 | |
| 1404 *:le* *:left* | |
| 1405 :[range]le[ft] [indent] | |
| 1406 Left-align lines in [range]. Sets the indent in the | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
1407 lines to [indent] (default 0). |
| 7 | 1408 |
| 1409 *gq* | |
| 216 | 1410 gq{motion} Format the lines that {motion} moves over. |
| 667 | 1411 Formatting is done with one of three methods: |
| 1412 1. If 'formatexpr' is not empty the expression is | |
| 1413 evaluated. This can differ for each buffer. | |
| 670 | 1414 2. If 'formatprg' is not empty an external program |
| 667 | 1415 is used. |
| 843 | 1416 3. Otherwise formatting is done internally. |
| 667 | 1417 |
| 1418 In the third case the 'textwidth' option controls the | |
| 1419 length of each formatted line (see below). | |
| 216 | 1420 If the 'textwidth' option is 0, the formatted line |
| 1421 length is the screen width (with a maximum width of | |
| 667 | 1422 79). |
| 7 | 1423 The 'formatoptions' option controls the type of |
| 1424 formatting |fo-table|. | |
| 216 | 1425 The cursor is left on the first non-blank of the last |
| 1426 formatted line. | |
| 7 | 1427 NOTE: The "Q" command formerly performed this |
| 1428 function. If you still want to use "Q" for | |
| 1429 formatting, use this mapping: > | |
| 1430 :nnoremap Q gq | |
| 1431 | |
| 1432 gqgq *gqgq* *gqq* | |
|
2434
86532ee3ea41
Updated runtime files. Add logcheck filetype plugin. (James Vega)
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
1433 gqq Format the current line. With a count format that |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
1434 many lines. |
| 7 | 1435 |
| 1436 *v_gq* | |
| 1437 {Visual}gq Format the highlighted text. (for {Visual} see | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
1438 |Visual-mode|). |
| 7 | 1439 |
| 1440 *gw* | |
| 1441 gw{motion} Format the lines that {motion} moves over. Similar to | |
| 1442 |gq| but puts the cursor back at the same position in | |
| 667 | 1443 the text. However, 'formatprg' and 'formatexpr' are |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
1444 not used. |
| 7 | 1445 |
| 9 | 1446 gwgw *gwgw* *gww* |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
1447 gww Format the current line as with "gw". |
| 9 | 1448 |
| 1449 *v_gw* | |
| 1450 {Visual}gw Format the highlighted text as with "gw". (for | |
|
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
15878
diff
changeset
|
1451 {Visual} see |Visual-mode|). |
| 9 | 1452 |
| 7 | 1453 Example: To format the current paragraph use: *gqap* > |
| 1454 gqap | |
| 1455 | |
| 1456 The "gq" command leaves the cursor in the line where the motion command takes | |
| 1457 the cursor. This allows you to repeat formatting repeated with ".". This | |
| 1458 works well with "gqj" (format current and next line) and "gq}" (format until | |
| 1459 end of paragraph). Note: When 'formatprg' is set, "gq" leaves the cursor on | |
| 1460 the first formatted line (as with using a filter command). | |
| 1461 | |
| 1462 If you want to format the current paragraph and continue where you were, use: > | |
| 1463 gwap | |
| 1464 If you always want to keep paragraphs formatted you may want to add the 'a' | |
| 1465 flag to 'formatoptions'. See |auto-format|. | |
| 1466 | |
| 1467 If the 'autoindent' option is on, Vim uses the indent of the first line for | |
| 1468 the following lines. | |
| 1469 | |
| 1470 Formatting does not change empty lines (but it does change lines with only | |
| 1471 white space!). | |
| 1472 | |
| 1473 The 'joinspaces' option is used when lines are joined together. | |
| 1474 | |
| 667 | 1475 You can set the 'formatexpr' option to an expression or the 'formatprg' option |
| 1476 to the name of an external program for Vim to use for text formatting. The | |
| 1477 'textwidth' and other options have no effect on formatting by an external | |
| 1478 program. | |
| 7 | 1479 |
| 13912 | 1480 *format-formatexpr* |
| 14519 | 1481 The 'formatexpr' option can be set to a Vim script function that performs |
| 13912 | 1482 reformatting of the buffer. This should usually happen in an |ftplugin|, |
| 1483 since formatting is highly dependent on the type of file. It makes | |
| 1484 sense to use an |autoload| script, so the corresponding script is only loaded | |
| 1485 when actually needed and the script should be called <filetype>format.vim. | |
| 1486 | |
| 1487 For example, the XML filetype plugin distributed with Vim in the $VIMRUNTIME | |
| 1488 directory, sets the 'formatexpr' option to: > | |
| 1489 | |
| 1490 setlocal formatexpr=xmlformat#Format() | |
| 1491 | |
| 1492 That means, you will find the corresponding script, defining the | |
| 1493 xmlformat#Format() function, in the directory: | |
| 1494 `$VIMRUNTIME/autoload/xmlformat.vim` | |
| 1495 | |
| 1496 Here is an example script that removes trailing whitespace from the selected | |
| 1497 text. Put it in your autoload directory, e.g. ~/.vim/autoload/format.vim: > | |
| 1498 | |
| 1499 func! format#Format() | |
| 1500 " only reformat on explicit gq command | |
| 1501 if mode() != 'n' | |
| 19968 | 1502 " fall back to Vim's internal reformatting |
| 13912 | 1503 return 1 |
| 1504 endif | |
| 1505 let lines = getline(v:lnum, v:lnum + v:count - 1) | |
| 1506 call map(lines, {key, val -> substitute(val, '\s\+$', '', 'g')}) | |
| 1507 call setline('.', lines) | |
| 1508 | |
| 1509 " do not run internal formatter! | |
| 1510 return 0 | |
| 1511 endfunc | |
| 1512 | |
| 1513 You can then enable the formatting by executing: > | |
| 1514 setlocal formatexpr=format#Format() | |
| 14519 | 1515 |
| 13912 | 1516 Note: this function explicitly returns non-zero when called from insert mode |
| 1517 (which basically means, text is inserted beyond the 'textwidth' limit). This | |
| 1518 causes Vim to fall back to reformat the text by using the internal formatter. | |
| 1519 | |
| 1520 However, if the |gq| command is used to reformat the text, the function | |
| 1521 will receive the selected lines, trim trailing whitespace from those lines and | |
| 1522 put them back in place. If you are going to split single lines into multiple | |
| 1523 lines, be careful not to overwrite anything. | |
| 1524 | |
| 1525 If you want to allow reformatting of text from insert or replace mode, one has | |
| 1526 to be very careful, because the function might be called recursively. For | |
| 1527 debugging it helps to set the 'debug' option. | |
| 1528 | |
| 7 | 1529 *right-justify* |
| 1530 There is no command in Vim to right justify text. You can do it with | |
| 1531 an external command, like "par" (e.g.: "!}par" to format until the end of the | |
| 1532 paragraph) or set 'formatprg' to "par". | |
| 1533 | |
| 1534 *format-comments* | |
| 1621 | 1535 An overview of comment formatting is in section |30.6| of the user manual. |
| 1536 | |
| 1537 Vim can automatically insert and format comments in a special way. Vim | |
| 1538 recognizes a comment by a specific string at the start of the line (ignoring | |
| 1539 white space). Three types of comments can be used: | |
| 7 | 1540 |
| 1541 - A comment string that repeats at the start of each line. An example is the | |
| 1542 type of comment used in shell scripts, starting with "#". | |
| 1543 - A comment string that occurs only in the first line, not in the following | |
| 1544 lines. An example is this list with dashes. | |
| 1545 - Three-piece comments that have a start string, an end string, and optional | |
| 1546 lines in between. The strings for the start, middle and end are different. | |
| 1621 | 1547 An example is the C style comment: |
| 7 | 1548 /* |
| 1549 * this is a C comment | |
| 1550 */ | |
| 1551 | |
| 1552 The 'comments' option is a comma-separated list of parts. Each part defines a | |
| 1553 type of comment string. A part consists of: | |
| 1554 {flags}:{string} | |
| 1555 | |
| 1556 {string} is the literal text that must appear. | |
| 1557 | |
| 1558 {flags}: | |
| 1559 n Nested comment. Nesting with mixed parts is allowed. If 'comments' | |
| 1560 is "n:),n:>" a line starting with "> ) >" is a comment. | |
| 1561 | |
| 1562 b Blank (<Space>, <Tab> or <EOL>) required after {string}. | |
| 1563 | |
| 1564 f Only the first line has the comment string. Do not repeat comment on | |
| 1565 the next line, but preserve indentation (e.g., a bullet-list). | |
| 1566 | |
| 1567 s Start of three-piece comment | |
| 1568 | |
| 1569 m Middle of a three-piece comment | |
| 1570 | |
| 1571 e End of a three-piece comment | |
| 1572 | |
| 1621 | 1573 l Left align. Used together with 's' or 'e', the leftmost character of |
| 1574 start or end will line up with the leftmost character from the middle. | |
| 1575 This is the default and can be omitted. See below for more details. | |
| 7 | 1576 |
| 1621 | 1577 r Right align. Same as above but rightmost instead of leftmost. See |
| 1578 below for more details. | |
| 7 | 1579 |
| 1621 | 1580 O Don't consider this comment for the "O" command. |
| 7 | 1581 |
| 1582 x Allows three-piece comments to be ended by just typing the last | |
| 1621 | 1583 character of the end-comment string as the first action on a new |
| 1584 line when the middle-comment string has been inserted automatically. | |
| 1585 See below for more details. | |
| 7 | 1586 |
| 1587 {digits} | |
| 1621 | 1588 When together with 's' or 'e': add {digit} amount of offset to an |
| 1589 automatically inserted middle or end comment leader. The offset begins | |
| 1590 from a left alignment. See below for more details. | |
| 7 | 1591 |
| 1592 -{digits} | |
| 1593 Like {digits} but reduce the indent. This only works when there is | |
| 1594 some indent for the start or end part that can be removed. | |
| 1595 | |
| 1596 When a string has none of the 'f', 's', 'm' or 'e' flags, Vim assumes the | |
| 1597 comment string repeats at the start of each line. The flags field may be | |
| 1598 empty. | |
| 1599 | |
| 1600 Any blank space in the text before and after the {string} is part of the | |
| 1601 {string}, so do not include leading or trailing blanks unless the blanks are a | |
| 1602 required part of the comment string. | |
| 1603 | |
| 1604 When one comment leader is part of another, specify the part after the whole. | |
| 1605 For example, to include both "-" and "->", use > | |
| 1606 :set comments=f:->,f:- | |
| 1607 | |
| 1608 A three-piece comment must always be given as start,middle,end, with no other | |
| 1609 parts in between. An example of a three-piece comment is > | |
| 1610 sr:/*,mb:*,ex:*/ | |
| 1611 for C-comments. To avoid recognizing "*ptr" as a comment, the middle string | |
| 1612 includes the 'b' flag. For three-piece comments, Vim checks the text after | |
| 1613 the start and middle strings for the end string. If Vim finds the end string, | |
| 1614 the comment does not continue on the next line. Three-piece comments must | |
| 1615 have a middle string because otherwise Vim can't recognize the middle lines. | |
| 1616 | |
| 1617 Notice the use of the "x" flag in the above three-piece comment definition. | |
| 1618 When you hit Return in a C-comment, Vim will insert the middle comment leader | |
| 1621 | 1619 for the new line: " * ". To close this comment you just have to type "/" |
| 7 | 1620 before typing anything else on the new line. This will replace the |
| 1621 | 1621 middle-comment leader with the end-comment leader and apply any specified |
| 6647 | 1622 alignment, leaving just " */". There is no need to hit Backspace first. |
| 1621 | 1623 |
| 6647 | 1624 When there is a match with a middle part, but there also is a matching end |
| 1625 part which is longer, the end part is used. This makes a C style comment work | |
| 2826 | 1626 without requiring the middle part to end with a space. |
| 1621 | 1627 |
| 1628 Here is an example of alignment flags at work to make a comment stand out | |
| 2826 | 1629 (kind of looks like a 1 too). Consider comment string: > |
| 1630 :set comments=sr:/***,m:**,ex-2:******/ | |
| 1631 < | |
| 1632 /*** ~ | |
| 1633 **<--right aligned from "r" flag ~ | |
| 1634 ** ~ | |
| 1635 offset 2 spaces for the "-2" flag--->** ~ | |
| 1636 ******/ ~ | |
| 1621 | 1637 In this case, the first comment was typed, then return was pressed 4 times, |
| 1638 then "/" was pressed to end the comment. | |
| 7 | 1639 |
| 1621 | 1640 Here are some finer points of three part comments. There are three times when |
| 1641 alignment and offset flags are taken into consideration: opening a new line | |
| 1642 after a start-comment, opening a new line before an end-comment, and | |
| 1643 automatically ending a three-piece comment. The end alignment flag has a | |
| 1644 backwards perspective; the result is that the same alignment flag used with | |
| 1645 "s" and "e" will result in the same indent for the starting and ending pieces. | |
| 1646 Only one alignment per comment part is meant to be used, but an offset number | |
| 1647 will override the "r" and "l" flag. | |
| 1648 | |
| 1649 Enabling 'cindent' will override the alignment flags in many cases. | |
| 1650 Reindenting using a different method like |gq| or |=| will not consult | |
| 1651 alignment flags either. The same behaviour can be defined in those other | |
| 1652 formatting options. One consideration is that 'cindent' has additional options | |
| 1653 for context based indenting of comments but cannot replicate many three piece | |
| 2826 | 1654 indent alignments. However, 'indentexpr' has the ability to work better with |
| 1655 three piece comments. | |
| 1621 | 1656 |
| 1657 Other examples: > | |
| 7 | 1658 "b:*" Includes lines starting with "*", but not if the "*" is |
| 1659 followed by a non-blank. This avoids a pointer dereference | |
| 1660 like "*str" to be recognized as a comment. | |
| 1661 "n:>" Includes a line starting with ">", ">>", ">>>", etc. | |
| 1662 "fb:-" Format a list that starts with "- ". | |
| 1663 | |
| 1664 By default, "b:#" is included. This means that a line that starts with | |
| 1665 "#include" is not recognized as a comment line. But a line that starts with | |
| 1666 "# define" is recognized. This is a compromise. | |
| 1667 | |
| 1668 *fo-table* | |
| 1669 You can use the 'formatoptions' option to influence how Vim formats text. | |
| 1670 'formatoptions' is a string that can contain any of the letters below. The | |
| 1671 default setting is "tcq". You can separate the option letters with commas for | |
| 1672 readability. | |
| 1673 | |
| 1674 letter meaning when present in 'formatoptions' ~ | |
| 23737 | 1675 *fo-t* |
| 1121 | 1676 t Auto-wrap text using textwidth |
| 23737 | 1677 *fo-c* |
| 7 | 1678 c Auto-wrap comments using textwidth, inserting the current comment |
| 1679 leader automatically. | |
| 23737 | 1680 *fo-r* |
| 7 | 1681 r Automatically insert the current comment leader after hitting |
| 1682 <Enter> in Insert mode. | |
| 23737 | 1683 *fo-o* |
| 7 | 1684 o Automatically insert the current comment leader after hitting 'o' or |
| 26847 | 1685 'O' in Normal mode. In case comment is unwanted in a specific place |
| 1686 use CTRL-U to quickly delete it. |i_CTRL-U| | |
| 23737 | 1687 *fo-q* |
| 7 | 1688 q Allow formatting of comments with "gq". |
| 1689 Note that formatting will not change blank lines or lines containing | |
| 1690 only the comment leader. A new paragraph starts after such a line, | |
| 1691 or when the comment leader changes. | |
| 23737 | 1692 *fo-w* |
| 7 | 1693 w Trailing white space indicates a paragraph continues in the next line. |
| 1694 A line that ends in a non-white character ends a paragraph. | |
| 23737 | 1695 *fo-a* |
| 7 | 1696 a Automatic formatting of paragraphs. Every time text is inserted or |
| 1697 deleted the paragraph will be reformatted. See |auto-format|. | |
| 1698 When the 'c' flag is present this only happens for recognized | |
| 1699 comments. | |
| 23737 | 1700 *fo-n* |
| 41 | 1701 n When formatting text, recognize numbered lists. This actually uses |
| 1702 the 'formatlistpat' option, thus any kind of list can be used. The | |
| 1703 indent of the text after the number is used for the next line. The | |
| 1621 | 1704 default is to find a number, optionally followed by '.', ':', ')', |
| 41 | 1705 ']' or '}'. Note that 'autoindent' must be set too. Doesn't work |
| 1706 well together with "2". | |
| 7 | 1707 Example: > |
| 1708 1. the first item | |
| 1709 wraps | |
| 1710 2. the second item | |
| 23737 | 1711 < *fo-2* |
| 7 | 1712 2 When formatting text, use the indent of the second line of a paragraph |
| 1713 for the rest of the paragraph, instead of the indent of the first | |
| 1714 line. This supports paragraphs in which the first line has a | |
| 1715 different indent than the rest. Note that 'autoindent' must be set | |
| 1716 too. Example: > | |
| 1717 first line of a paragraph | |
| 1718 second line of the same paragraph | |
| 1719 third line. | |
| 3682 | 1720 < This also works inside comments, ignoring the comment leader. |
| 23737 | 1721 *fo-v* |
| 7 | 1722 v Vi-compatible auto-wrapping in insert mode: Only break a line at a |
| 1723 blank that you have entered during the current insert command. (Note: | |
| 1724 this is not 100% Vi compatible. Vi has some "unexpected features" or | |
| 1725 bugs in this area. It uses the screen column instead of the line | |
| 1726 column.) | |
| 23737 | 1727 *fo-b* |
| 7 | 1728 b Like 'v', but only auto-wrap if you enter a blank at or before |
| 1729 the wrap margin. If the line was longer than 'textwidth' when you | |
| 1730 started the insert, or you do not enter a blank in the insert before | |
| 1731 reaching 'textwidth', Vim does not perform auto-wrapping. | |
| 23737 | 1732 *fo-l* |
| 7 | 1733 l Long lines are not broken in insert mode: When a line was longer than |
| 1734 'textwidth' when the insert command started, Vim does not | |
| 1735 automatically format it. | |
| 23737 | 1736 *fo-m* |
| 21991 | 1737 m Also break at a multibyte character above 255. This is useful for |
| 7 | 1738 Asian text where every character is a word on its own. |
| 23737 | 1739 *fo-M* |
| 21991 | 1740 M When joining lines, don't insert a space before or after a multibyte |
| 7 | 1741 character. Overrules the 'B' flag. |
| 23737 | 1742 *fo-B* |
| 21991 | 1743 B When joining lines, don't insert a space between two multibyte |
| 7 | 1744 characters. Overruled by the 'M' flag. |
| 23737 | 1745 *fo-1* |
| 7 | 1746 1 Don't break a line after a one-letter word. It's broken before it |
| 1747 instead (if possible). | |
| 23737 | 1748 *fo-]* |
|
20695
cea8ae407452
patch 8.2.0901: formatting CJK text isn't optimal
Bram Moolenaar <Bram@vim.org>
parents:
20241
diff
changeset
|
1749 ] Respect textwidth rigorously. With this flag set, no line can be |
|
cea8ae407452
patch 8.2.0901: formatting CJK text isn't optimal
Bram Moolenaar <Bram@vim.org>
parents:
20241
diff
changeset
|
1750 longer than textwidth, unless line-break-prohibition rules make this |
|
cea8ae407452
patch 8.2.0901: formatting CJK text isn't optimal
Bram Moolenaar <Bram@vim.org>
parents:
20241
diff
changeset
|
1751 impossible. Mainly for CJK scripts and works only if 'encoding' is |
|
cea8ae407452
patch 8.2.0901: formatting CJK text isn't optimal
Bram Moolenaar <Bram@vim.org>
parents:
20241
diff
changeset
|
1752 "utf-8". |
| 23737 | 1753 *fo-j* |
| 3562 | 1754 j Where it makes sense, remove a comment leader when joining lines. For |
| 1755 example, joining: | |
| 1756 int i; // the index ~ | |
| 1757 // in the list ~ | |
| 1758 Becomes: | |
| 1759 int i; // the index in the list ~ | |
| 23737 | 1760 *fo-p* |
|
15440
5ecac7734184
patch 8.1.0728: cannot avoid breaking after a single space.
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1761 p Don't break lines at single spaces that follow periods. This is |
|
5ecac7734184
patch 8.1.0728: cannot avoid breaking after a single space.
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1762 intended to complement 'joinspaces' and |cpo-J|, for prose with |
|
5ecac7734184
patch 8.1.0728: cannot avoid breaking after a single space.
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1763 sentences separated by two spaces. For example, with 'textwidth' set |
|
5ecac7734184
patch 8.1.0728: cannot avoid breaking after a single space.
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1764 to 28: > |
|
5ecac7734184
patch 8.1.0728: cannot avoid breaking after a single space.
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1765 Surely you're joking, Mr. Feynman! |
|
5ecac7734184
patch 8.1.0728: cannot avoid breaking after a single space.
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1766 < Becomes: > |
|
5ecac7734184
patch 8.1.0728: cannot avoid breaking after a single space.
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1767 Surely you're joking, |
|
5ecac7734184
patch 8.1.0728: cannot avoid breaking after a single space.
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1768 Mr. Feynman! |
|
5ecac7734184
patch 8.1.0728: cannot avoid breaking after a single space.
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1769 < Instead of: > |
|
5ecac7734184
patch 8.1.0728: cannot avoid breaking after a single space.
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1770 Surely you're joking, Mr. |
|
5ecac7734184
patch 8.1.0728: cannot avoid breaking after a single space.
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1771 Feynman! |
| 7 | 1772 |
| 1773 | |
| 1774 With 't' and 'c' you can specify when Vim performs auto-wrapping: | |
| 1775 value action ~ | |
| 1776 "" no automatic formatting (you can use "gq" for manual formatting) | |
| 1777 "t" automatic formatting of text, but not comments | |
| 1778 "c" automatic formatting for comments, but not text (good for C code) | |
| 1779 "tc" automatic formatting for text and comments | |
| 1780 | |
| 867 | 1781 Note that when 'textwidth' is 0, Vim does no automatic formatting anyway (but |
| 1782 does insert comment leaders according to the 'comments' option). An exception | |
| 1783 is when the 'a' flag is present. |auto-format| | |
| 7 | 1784 |
| 1785 Note that when 'paste' is on, Vim does no formatting at all. | |
| 1786 | |
| 1787 Note that 'textwidth' can be non-zero even if Vim never performs auto-wrapping; | |
| 1788 'textwidth' is still useful for formatting with "gq". | |
| 1789 | |
| 1790 If the 'comments' option includes "/*", "*" and/or "*/", then Vim has some | |
| 1791 built in stuff to treat these types of comments a bit more cleverly. | |
| 1792 Opening a new line before or after "/*" or "*/" (with 'r' or 'o' present in | |
| 1793 'formatoptions') gives the correct start of the line automatically. The same | |
| 236 | 1794 happens with formatting and auto-wrapping. Opening a line after a line |
| 7 | 1795 starting with "/*" or "*" and containing "*/", will cause no comment leader to |
| 1796 be inserted, and the indent of the new line is taken from the line containing | |
| 1797 the start of the comment. | |
| 1798 E.g.: | |
| 1799 /* ~ | |
| 1800 * Your typical comment. ~ | |
| 1801 */ ~ | |
| 1802 The indent on this line is the same as the start of the above | |
| 1803 comment. | |
| 1804 | |
| 1805 All of this should be really cool, especially in conjunction with the new | |
| 1806 :autocmd command to prepare different settings for different types of file. | |
| 1807 | |
| 1808 Some examples: | |
| 1809 for C code (only format comments): > | |
| 1810 :set fo=croq | |
| 1811 < for Mail/news (format all, don't start comment with "o" command): > | |
| 1812 :set fo=tcrq | |
| 1813 < | |
| 1814 | |
| 3492 | 1815 Automatic formatting *auto-format* *autoformat* |
| 7 | 1816 |
| 1817 When the 'a' flag is present in 'formatoptions' text is formatted | |
| 21499 | 1818 automatically when inserting text or deleting text. This works nicely for |
| 7 | 1819 editing text paragraphs. A few hints on how to use this: |
| 1820 | |
| 1821 - You need to properly define paragraphs. The simplest is paragraphs that are | |
| 1822 separated by a blank line. When there is no separating blank line, consider | |
| 1823 using the 'w' flag and adding a space at the end of each line in the | |
| 1824 paragraphs except the last one. | |
| 1825 | |
| 1826 - You can set the 'formatoptions' based on the type of file |filetype| or | |
| 1827 specifically for one file with a |modeline|. | |
| 1828 | |
| 1829 - Set 'formatoptions' to "aw2tq" to make text with indents like this: | |
| 1830 | |
| 1831 bla bla foobar bla | |
| 1832 bla foobar bla foobar bla | |
| 1833 bla bla foobar bla | |
| 1834 bla foobar bla bla foobar | |
| 1835 | |
| 1836 - Add the 'c' flag to only auto-format comments. Useful in source code. | |
| 1837 | |
| 867 | 1838 - Set 'textwidth' to the desired width. If it is zero then 79 is used, or the |
| 1839 width of the screen if this is smaller. | |
| 1840 | |
| 7 | 1841 And a few warnings: |
| 1842 | |
| 1843 - When part of the text is not properly separated in paragraphs, making | |
| 1844 changes in this text will cause it to be formatted anyway. Consider doing > | |
| 1845 | |
| 1846 :set fo-=a | |
| 1847 | |
| 1848 - When using the 'w' flag (trailing space means paragraph continues) and | |
| 1849 deleting the last line of a paragraph with |dd|, the paragraph will be | |
| 1850 joined with the next one. | |
| 1851 | |
| 1852 - Changed text is saved for undo. Formatting is also a change. Thus each | |
| 1853 format action saves text for undo. This may consume quite a lot of memory. | |
| 1854 | |
| 1855 - Formatting a long paragraph and/or with complicated indenting may be slow. | |
| 1856 | |
| 282 | 1857 ============================================================================== |
| 1858 7. Sorting text *sorting* | |
| 1859 | |
| 1860 Vim has a sorting function and a sorting command. The sorting function can be | |
| 5747 | 1861 found here: |sort()|, |uniq()|. |
| 282 | 1862 |
| 1863 *:sor* *:sort* | |
|
22770
3e4981de5636
patch 8.2.1933: cannot sort using locale ordering
Bram Moolenaar <Bram@vim.org>
parents:
21991
diff
changeset
|
1864 :[range]sor[t][!] [b][f][i][l][n][o][r][u][x] [/{pattern}/] |
| 586 | 1865 Sort lines in [range]. When no range is given all |
| 1866 lines are sorted. | |
| 282 | 1867 |
| 1868 With [!] the order is reversed. | |
| 1869 | |
| 1870 With [i] case is ignored. | |
| 1871 | |
| 22824 | 1872 With [l] sort uses the current collation locale. |
| 1873 Implementation details: strcoll() is used to compare | |
| 1874 strings. See |:language| to check or set the collation | |
| 1875 locale. Example: > | |
| 1876 :language collate en_US.UTF-8 | |
| 1877 :%sort l | |
| 1878 < |v:collate| can also used to check the current locale. | |
| 1879 Sorting using the locale typically ignores case. | |
| 1880 This does not work properly on Mac. | |
|
22770
3e4981de5636
patch 8.2.1933: cannot sort using locale ordering
Bram Moolenaar <Bram@vim.org>
parents:
21991
diff
changeset
|
1881 |
|
7689
20dc2763a3b9
commit https://github.com/vim/vim/commit/f7edf40448a09e04eec3bd05e043f7fea93b07c9
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
1882 Options [n][f][x][o][b] are mutually exclusive. |
|
20dc2763a3b9
commit https://github.com/vim/vim/commit/f7edf40448a09e04eec3bd05e043f7fea93b07c9
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
1883 |
| 293 | 1884 With [n] sorting is done on the first decimal number |
| 826 | 1885 in the line (after or inside a {pattern} match). |
| 1698 | 1886 One leading '-' is included in the number. |
| 293 | 1887 |
|
7689
20dc2763a3b9
commit https://github.com/vim/vim/commit/f7edf40448a09e04eec3bd05e043f7fea93b07c9
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
1888 With [f] sorting is done on the Float in the line. |
|
20dc2763a3b9
commit https://github.com/vim/vim/commit/f7edf40448a09e04eec3bd05e043f7fea93b07c9
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
1889 The value of Float is determined similar to passing |
|
20dc2763a3b9
commit https://github.com/vim/vim/commit/f7edf40448a09e04eec3bd05e043f7fea93b07c9
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
1890 the text (after or inside a {pattern} match) to |
|
20dc2763a3b9
commit https://github.com/vim/vim/commit/f7edf40448a09e04eec3bd05e043f7fea93b07c9
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
1891 str2float() function. This option is available only |
|
20dc2763a3b9
commit https://github.com/vim/vim/commit/f7edf40448a09e04eec3bd05e043f7fea93b07c9
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
1892 if Vim was compiled with Floating point support. |
|
20dc2763a3b9
commit https://github.com/vim/vim/commit/f7edf40448a09e04eec3bd05e043f7fea93b07c9
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
1893 |
| 293 | 1894 With [x] sorting is done on the first hexadecimal |
| 826 | 1895 number in the line (after or inside a {pattern} |
| 1896 match). A leading "0x" or "0X" is ignored. | |
| 1698 | 1897 One leading '-' is included in the number. |
| 293 | 1898 |
| 1899 With [o] sorting is done on the first octal number in | |
| 826 | 1900 the line (after or inside a {pattern} match). |
| 293 | 1901 |
|
7447
ad432f8f68fb
commit https://github.com/vim/vim/commit/887c1fea4a114e7170091942d0446c8882701b5b
Christian Brabandt <cb@256bit.org>
parents:
7183
diff
changeset
|
1902 With [b] sorting is done on the first binary number in |
|
ad432f8f68fb
commit https://github.com/vim/vim/commit/887c1fea4a114e7170091942d0446c8882701b5b
Christian Brabandt <cb@256bit.org>
parents:
7183
diff
changeset
|
1903 the line (after or inside a {pattern} match). |
|
ad432f8f68fb
commit https://github.com/vim/vim/commit/887c1fea4a114e7170091942d0446c8882701b5b
Christian Brabandt <cb@256bit.org>
parents:
7183
diff
changeset
|
1904 |
|
7689
20dc2763a3b9
commit https://github.com/vim/vim/commit/f7edf40448a09e04eec3bd05e043f7fea93b07c9
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
1905 With [u] (u stands for unique) only keep the first of |
|
20dc2763a3b9
commit https://github.com/vim/vim/commit/f7edf40448a09e04eec3bd05e043f7fea93b07c9
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
1906 a sequence of identical lines (ignoring case when [i] |
|
20dc2763a3b9
commit https://github.com/vim/vim/commit/f7edf40448a09e04eec3bd05e043f7fea93b07c9
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
1907 is used). Without this flag, a sequence of identical |
|
20dc2763a3b9
commit https://github.com/vim/vim/commit/f7edf40448a09e04eec3bd05e043f7fea93b07c9
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
1908 lines will be kept in their original order. |
| 293 | 1909 Note that leading and trailing white space may cause |
| 1910 lines to be different. | |
| 282 | 1911 |
| 826 | 1912 When /{pattern}/ is specified and there is no [r] flag |
| 1913 the text matched with {pattern} is skipped, so that | |
| 1914 you sort on what comes after the match. | |
| 22958 | 1915 'ignorecase' applies to the pattern, but 'smartcase' |
| 1916 is not used. | |
| 282 | 1917 Instead of the slash any non-letter can be used. |
| 1918 For example, to sort on the second comma-separated | |
| 1919 field: > | |
| 1920 :sort /[^,]*,/ | |
| 1921 < To sort on the text at virtual column 10 (thus | |
| 1922 ignoring the difference between tabs and spaces): > | |
| 1923 :sort /.*\%10v/ | |
| 824 | 1924 < To sort on the first number in the line, no matter |
| 1925 what is in front of it: > | |
| 1621 | 1926 :sort /.\{-}\ze\d/ |
| 1927 < (Explanation: ".\{-}" matches any text, "\ze" sets the | |
| 1928 end of the match and \d matches a digit.) | |
| 1929 With [r] sorting is done on the matching {pattern} | |
| 826 | 1930 instead of skipping past it as described above. |
| 1931 For example, to sort on only the first three letters | |
| 1932 of each line: > | |
| 1933 :sort /\a\a\a/ r | |
| 1934 | |
| 1935 < If a {pattern} is used, any lines which don't have a | |
| 1936 match for {pattern} are kept in their current order, | |
| 1937 but separate from the lines which do match {pattern}. | |
| 1938 If you sorted in reverse, they will be in reverse | |
| 1939 order after the sorted lines, otherwise they will be | |
| 1940 in their original order, right before the sorted | |
| 1941 lines. | |
| 1942 | |
| 1314 | 1943 If {pattern} is empty (e.g. // is specified), the |
| 1944 last search pattern is used. This allows trying out | |
| 1945 a pattern first. | |
| 1946 | |
| 3492 | 1947 Note that using `:sort` with `:global` doesn't sort the matching lines, it's |
| 293 | 1948 quite useless. |
| 7 | 1949 |
|
22770
3e4981de5636
patch 8.2.1933: cannot sort using locale ordering
Bram Moolenaar <Bram@vim.org>
parents:
21991
diff
changeset
|
1950 `:sort` does not use the current locale unless the l flag is used. |
|
6032
b8f703a4e55f
Updated runtime files. Overhauled HTML indent script.
Bram Moolenaar <bram@vim.org>
parents:
5747
diff
changeset
|
1951 Vim does do a "stable" sort. |
| 359 | 1952 |
| 826 | 1953 The sorting can be interrupted, but if you interrupt it too late in the |
| 1954 process you may end up with duplicated lines. This also depends on the system | |
| 1955 library function used. | |
| 481 | 1956 |
| 14421 | 1957 vim:tw=78:ts=8:noet:ft=help:norl: |