blob: a00049bef3b5e7666527523a7c5cac33cf9284a9 [file] [log] [blame]
Bram Moolenaar71badf92023-04-22 22:40:14 +01001*change.txt* For Vim version 9.0. Last change: 2023 Mar 07
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7This file describes commands that delete or change text. In this context,
8changing text means deleting the text and replacing it with other text using
9one command. You can undo all of these commands. You can repeat the non-Ex
10commands with the "." command.
11
121. Deleting text |deleting|
132. Delete and insert |delete-insert|
143. Simple changes |simple-change| *changing*
154. Complex changes |complex-change|
Bram Moolenaar47136d72004-10-12 20:02:24 +000016 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|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000205. Copying and moving text |copy-move|
216. Formatting text |formatting|
Bram Moolenaar2389c3c2005-05-22 22:07:59 +0000227. Sorting text |sorting|
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24For inserting text see |insert.txt|.
25
26==============================================================================
271. 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
Bram Moolenaar25c9c682019-05-05 18:13:34 +020037 (join lines).
Bram Moolenaar071d4272004-06-13 20:20:40 +000038
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|)
Bram Moolenaar4399ef42005-02-12 14:29:27 +000056 When the '#' flag is in 'cpoptions' the count is
57 ignored.
Bram Moolenaar071d4272004-06-13 20:20:40 +000058
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
Bram Moolenaar25c9c682019-05-05 18:13:34 +020062 {Visual} see |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +000063
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
Bram Moolenaar25c9c682019-05-05 18:13:34 +020072 the end of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000073
Bram Moolenaar9ba7e172013-07-17 22:37:26 +020074 *:d* *:de* *:del* *:delete* *:dl* *:dp*
Bram Moolenaar071d4272004-06-13 20:20:40 +000075:[range]d[elete] [x] Delete [range] lines (default: current line) [into
76 register x].
Bram Moolenaar9ba7e172013-07-17 22:37:26 +020077 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
Bram Moolenaar071d4272004-06-13 20:20:40 +000089
90:[range]d[elete] [x] {count}
91 Delete {count} lines, starting with [range]
92 (default: current line |cmdline-ranges|) [into
93 register x].
94
Bram Moolenaard38b0552012-04-25 19:07:41 +020095These 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
Bram Moolenaar071d4272004-06-13 20:20:40 +000097|registers| for an explanation of registers.
98
99An exception for the d{motion} command: If the motion is not linewise, the
100start and end of the motion are not in the same line, and there are only
Bram Moolenaar38a55632016-02-15 22:07:32 +0100101blanks before the start and there are no non-blanks after the end of the
102motion, the delete becomes linewise. This means that the delete also removes
103the line of blanks that you might expect to remain. Use the |o_v| operator to
104force the motion to be characterwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000105
106Trying to delete an empty region of text (e.g., "d0" in the first column)
107is an error when 'cpoptions' includes the 'E' flag.
108
109 *J*
110J Join [count] lines, with a minimum of two lines.
111 Remove the indent and insert up to two spaces (see
Bram Moolenaar77cdfd12016-03-12 12:57:59 +0100112 below). Fails when on the last line of the buffer.
Bram Moolenaar85eee132018-05-06 17:57:30 +0200113 If [count] is too big it is reduced to the number of
Bram Moolenaar77cdfd12016-03-12 12:57:59 +0100114 lines available.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000115
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
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200119 (see below).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000120
121 *gJ*
122gJ Join [count] lines, with a minimum of two lines.
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200123 Don't insert or remove any spaces.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000124
125 *v_gJ*
126{Visual}gJ Join the highlighted lines, with a minimum of two
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200127 lines. Don't insert or remove any spaces.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000128
129 *:j* *:join*
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000130:[range]j[oin][!] [flags]
131 Join [range] lines. Same as "J", except with [!]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000132 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.
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000136 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000137
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000138:[range]j[oin][!] {count} [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000139 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.
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000143 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144
145These commands delete the <EOL> between lines. This has the effect of joining
Bram Moolenaard38b0552012-04-25 19:07:41 +0200146multiple lines into one line. You can repeat these commands (except `:j`) and
Bram Moolenaar071d4272004-06-13 20:20:40 +0000147undo them.
148
149These commands, except "gJ", insert one space in place of the <EOL> unless
150there is trailing white space or the next line starts with a ')'. These
151commands, except "gJ", delete any leading white space on the next line. If
152the 'joinspaces' option is on, these commands insert two spaces after a '.',
153'!' or '?' (but if 'cpoptions' includes the 'j' flag, they insert two spaces
154only after a '.').
155The 'B' and 'M' flags in 'formatoptions' change the behavior for inserting
Bram Moolenaar207f0092020-08-30 17:20:20 +0200156spaces before and after a multibyte character |fo-table|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000157
Bram Moolenaar251835e2014-02-24 02:51:51 +0100158The '[ mark is set at the end of the first line that was joined, '] at the end
159of the resulting line.
160
Bram Moolenaar071d4272004-06-13 20:20:40 +0000161
162==============================================================================
1632. Delete and insert *delete-insert* *replacing*
164
165 *R*
166R 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*
172gR 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.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000177
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
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200209 start insert (for {Visual} see |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000210
211 *v_r*
Bram Moolenaar2c7f8c52020-04-20 19:52:53 +0200212{Visual}r{char} Replace all selected characters by {char}.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000213
214 *v_C*
215{Visual}["x]C Delete the highlighted lines [into register x] and
216 start insert. In Visual block mode it works
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200217 differently |v_b_C|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000218 *v_S*
219{Visual}["x]S Delete the highlighted lines [into register x] and
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200220 start insert (for {Visual} see |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000221 *v_R*
222{Visual}["x]R Currently just like {Visual}["x]S. In a next version
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200223 it might work differently.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000224
225Notes:
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
234See |registers| for an explanation of registers.
235
236Replace mode is just like Insert mode, except that every character you enter
237deletes one character. If you reach the end of a line, Vim appends any
238further characters (just like Insert mode). In Replace mode, the backspace
239key restores the original text (if there was any). (See section "Insert and
240Replace mode" |mode-ins-repl|).
241
242 *cw* *cW*
Bram Moolenaar446cb832008-06-24 21:56:24 +0000243Special case: When the cursor is in a word, "cw" and "cW" do not include the
244white space after a word, they only change up to the end of the word. This is
245because Vim interprets "cw" as change-word, and a word does not include the
246following white space.
247{Vi: "cw" when on a blank followed by other blanks changes only the first
248blank; 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}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000250
251If you prefer "cw" to include the space after a word, use this mapping: >
252 :map cw dwi
Bram Moolenaar446cb832008-06-24 21:56:24 +0000253Or use "caw" (see |aw|).
254
Bram Moolenaar071d4272004-06-13 20:20:40 +0000255 *:c* *:ch* *:change*
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000256:{range}c[hange][!] Replace lines of text with some different text.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000257 Type a line containing only "." to stop replacing.
258 Without {range}, this command changes only the current
259 line.
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000260 Adding [!] toggles 'autoindent' for the time this
261 command is executed.
Bram Moolenaara4d131d2021-12-27 21:33:07 +0000262 This command is not supported in |Vim9| script,
263 because it is too easily confused with a variable
264 name.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000265
266==============================================================================
2673. Simple changes *simple-change*
268
269 *r*
270r{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>.
Bram Moolenaar80716072012-05-01 21:14:34 +0200274
275 If {char} is CTRL-E or CTRL-Y the character from the
276 line below or above is used, just like with |i_CTRL-E|
277 and |i_CTRL-Y|. This also works with a count, thus
278 `10r<C-E>` copies 10 characters from the line below.
279
Bram Moolenaar071d4272004-06-13 20:20:40 +0000280 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*
295gr{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.
Bram Moolenaardd60c362023-02-27 15:49:53 +0000299 {char} can be entered like with |r|, but characters
300 that have a special meaning in Insert mode, such as
301 most CTRL-keys, cannot be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302
303 *digraph-arg*
304The argument for Normal mode commands like |r| and |t| is a single character.
305When 'cpo' doesn't contain the 'D' flag, this character can also be entered
306like |digraphs|. First type CTRL-K and then the two digraph characters.
307{not available when compiled without the |+digraphs| feature}
308
309 *case*
310The following commands change the case of letters. The currently active
311|locale| is used. See |:language|. The LC_CTYPE value matters here.
312
313 *~*
314~ 'notildeop' option: Switch case of the character
315 under the cursor and move the cursor to the right.
Bram Moolenaara6c27c42019-05-09 19:16:22 +0200316 If a [count] is given, do that many characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000317
Bram Moolenaara6c27c42019-05-09 19:16:22 +0200318~{motion} 'tildeop' option: switch case of {motion} text.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000319
320 *g~*
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200321g~{motion} Switch case of {motion} text.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000322
323g~g~ *g~g~* *g~~*
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200324g~~ Switch case of current line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000325
326 *v_~*
327{Visual}~ Switch case of highlighted text (for {Visual} see
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200328 |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000329
330 *v_U*
331{Visual}U Make highlighted text uppercase (for {Visual} see
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200332 |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000333
334 *gU* *uppercase*
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200335gU{motion} Make {motion} text uppercase.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000336 Example: >
337 :map! <C-F> <Esc>gUiw`]a
338< This works in Insert mode: press CTRL-F to make the
339 word before the cursor uppercase. Handy to type
340 words in lowercase and then make them uppercase.
341
342
343gUgU *gUgU* *gUU*
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200344gUU Make current line uppercase.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000345
346 *v_u*
347{Visual}u Make highlighted text lowercase (for {Visual} see
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200348 |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000349
350 *gu* *lowercase*
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200351gu{motion} Make {motion} text lowercase.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000352
353gugu *gugu* *guu*
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200354guu Make current line lowercase.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000355
356 *g?* *rot13*
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200357g?{motion} Rot13 encode {motion} text.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000358
359 *v_g?*
360{Visual}g? Rot13 encode the highlighted text (for {Visual} see
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200361 |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000362
363g?g? *g?g?* *g??*
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200364g?? Rot13 encode current line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000365
Bram Moolenaar446cb832008-06-24 21:56:24 +0000366To turn one line into title caps, make every first letter of a word
367uppercase: >
368 :s/\v<(.)(\w*)/\u\1\L\2/g
369
Bram Moolenaar071d4272004-06-13 20:20:40 +0000370
371Adding and subtracting ~
372 *CTRL-A*
373CTRL-A Add [count] to the number or alphabetic character at
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200374 or after the cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000375
Bram Moolenaar979243b2015-06-26 19:35:49 +0200376 *v_CTRL-A*
377{Visual}CTRL-A Add [count] to the number or alphabetic character in
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200378 the highlighted text.
Bram Moolenaar979243b2015-06-26 19:35:49 +0200379
380 *v_g_CTRL-A*
381{Visual}g CTRL-A Add [count] to the number or alphabetic character in
382 the highlighted text. If several lines are
383 highlighted, each one will be incremented by an
384 additional [count] (so effectively creating a
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200385 [count] incrementing sequence).
Bram Moolenaar979243b2015-06-26 19:35:49 +0200386 For Example, if you have this list of numbers:
387 1. ~
388 1. ~
389 1. ~
390 1. ~
391 Move to the second "1." and Visually select three
392 lines, pressing g CTRL-A results in:
393 1. ~
394 2. ~
395 3. ~
396 4. ~
397
Bram Moolenaar071d4272004-06-13 20:20:40 +0000398 *CTRL-X*
399CTRL-X Subtract [count] from the number or alphabetic
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200400 character at or after the cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000401
Bram Moolenaar979243b2015-06-26 19:35:49 +0200402 *v_CTRL-X*
403{Visual}CTRL-X Subtract [count] from the number or alphabetic
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200404 character in the highlighted text.
Bram Moolenaar979243b2015-06-26 19:35:49 +0200405
Bram Moolenaare0fa3742016-02-20 15:47:01 +0100406 On MS-Windows, this is mapped to cut Visual text
407 |dos-standard-mappings|. If you want to disable the
408 mapping, use this: >
409 silent! vunmap <C-X>
410<
Bram Moolenaar979243b2015-06-26 19:35:49 +0200411 *v_g_CTRL-X*
412{Visual}g CTRL-X Subtract [count] from the number or alphabetic
413 character in the highlighted text. If several lines
414 are highlighted, each value will be decremented by an
415 additional [count] (so effectively creating a [count]
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200416 decrementing sequence).
Bram Moolenaar979243b2015-06-26 19:35:49 +0200417
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100418The CTRL-A and CTRL-X commands can work for:
419- signed and unsigned decimal numbers
420- unsigned binary, octal and hexadecimal numbers
421- alphabetic characters
422
423This depends on the 'nrformats' option:
424- When 'nrformats' includes "bin", Vim assumes numbers starting with '0b' or
425 '0B' are binary.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000426- When 'nrformats' includes "octal", Vim considers numbers starting with a '0'
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000427 to be octal, unless the number includes a '8' or '9'. Other numbers are
428 decimal and may have a preceding minus sign.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000429 If the cursor is on a number, the commands apply to that number; otherwise
430 Vim uses the number to the right of the cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000431- When 'nrformats' includes "hex", Vim assumes numbers starting with '0x' or
432 '0X' are hexadecimal. The case of the rightmost letter in the number
433 determines the case of the resulting hexadecimal number. If there is no
434 letter in the current number, Vim uses the previously detected case.
435- When 'nrformats' includes "alpha", Vim will change the alphabetic character
436 under or after the cursor. This is useful to make lists with an alphabetic
437 index.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000438
Bram Moolenaar979243b2015-06-26 19:35:49 +0200439For decimals a leading negative sign is considered for incrementing/
Bram Moolenaarfa735342016-01-03 22:14:44 +0100440decrementing, for binary, octal and hex values, it won't be considered. To
Bram Moolenaar85eee132018-05-06 17:57:30 +0200441ignore the sign Visually select the number before using CTRL-A or CTRL-X.
Bram Moolenaar979243b2015-06-26 19:35:49 +0200442
Bram Moolenaar071d4272004-06-13 20:20:40 +0000443For numbers with leading zeros (including all octal and hexadecimal numbers),
444Vim preserves the number of characters in the number when possible. CTRL-A on
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000445"0077" results in "0100", CTRL-X on "0x100" results in "0x0ff".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000446There is one exception: When a number that starts with a zero is found not to
447be octal (it contains a '8' or '9'), but 'nrformats' does include "octal",
448leading zeros are removed to avoid that the result may be recognized as an
449octal number.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000450
451Note that when 'nrformats' includes "octal", decimal numbers with leading
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000452zeros cause mistakes, because they can be confused with octal numbers.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000453
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100454Note similarly, when 'nrformats' includes "bin", binary numbers with a leading
455'0x' or '0X' can be interpreted as hexadecimal rather than binary since '0b'
456are valid hexadecimal digits.
457
Bram Moolenaar71badf92023-04-22 22:40:14 +0100458When the number under the cursor is too big to fit into 32 or 64 bit
459(depending on how Vim was build), it will be rounded off to the nearest number
460that can be represented, and the addition/subtraction is skipped. E.g. with
46164 bit support using CTRL-X on 18446744073709551616 results in
46218446744073709551615. Same for larger numbers, such as 18446744073709551618.
463
Bram Moolenaar071d4272004-06-13 20:20:40 +0000464The CTRL-A command is very useful in a macro. Example: Use the following
465steps to make a numbered list.
466
4671. Create the first list entry, make sure it starts with a number.
Bram Moolenaard8b02732005-01-14 21:48:43 +00004682. qa - start recording into register 'a'
Bram Moolenaar071d4272004-06-13 20:20:40 +00004693. Y - yank the entry
4704. p - put a copy of the entry below the first one
4715. CTRL-A - increment the number
4726. q - stop recording
4737. <count>@a - repeat the yank, put and increment <count> times
474
475
476SHIFTING LINES LEFT OR RIGHT *shift-left-right*
477
478 *<*
479<{motion} Shift {motion} lines one 'shiftwidth' leftwards.
480
Bram Moolenaarf9514162018-11-22 03:08:29 +0100481 If the 'vartabstop' feature is enabled, and the
482 'shiftwidth' option is set to zero, the amount of
483 indent is calculated at the first non-blank character
484 in the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000485 *<<*
486<< Shift [count] lines one 'shiftwidth' leftwards.
487
488 *v_<*
489{Visual}[count]< Shift the highlighted lines [count] 'shiftwidth'
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200490 leftwards (for {Visual} see |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000491
492 *>*
493 >{motion} Shift {motion} lines one 'shiftwidth' rightwards.
494
Bram Moolenaarf9514162018-11-22 03:08:29 +0100495 If the 'vartabstop' feature is enabled, and the
496 'shiftwidth' option is set to zero, the amount of
497 indent is calculated at the first non-blank character
498 in the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000499 *>>*
500 >> Shift [count] lines one 'shiftwidth' rightwards.
501
502 *v_>*
503{Visual}[count]> Shift the highlighted lines [count] 'shiftwidth'
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200504 rightwards (for {Visual} see |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000505
506 *:<*
507:[range]< Shift [range] lines one 'shiftwidth' left. Repeat '<'
508 for shifting multiple 'shiftwidth's.
509
510:[range]< {count} Shift {count} lines one 'shiftwidth' left, starting
511 with [range] (default current line |cmdline-ranges|).
512 Repeat '<' for shifting multiple 'shiftwidth's.
513
514:[range]le[ft] [indent] left align lines in [range]. Sets the indent in the
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200515 lines to [indent] (default 0).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000516
517 *:>*
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000518:[range]> [flags] Shift {count} [range] lines one 'shiftwidth' right.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000519 Repeat '>' for shifting multiple 'shiftwidth's.
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000520 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000521
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000522:[range]> {count} [flags]
523 Shift {count} lines one 'shiftwidth' right, starting
Bram Moolenaar071d4272004-06-13 20:20:40 +0000524 with [range] (default current line |cmdline-ranges|).
525 Repeat '>' for shifting multiple 'shiftwidth's.
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000526 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000527
528The ">" and "<" commands are handy for changing the indentation within
529programs. Use the 'shiftwidth' option to set the size of the white space
530which these commands insert or delete. Normally the 'shiftwidth' option is 8,
531but you can set it to, say, 3 to make smaller indents. The shift leftwards
532stops when there is no indent. The shift right does not affect empty lines.
533
534If the 'shiftround' option is on, the indent is rounded to a multiple of
535'shiftwidth'.
536
537If the 'smartindent' option is on, or 'cindent' is on and 'cinkeys' contains
Bram Moolenaar8e69b4a2013-11-09 03:41:58 +0100538'#' with a zero value, shift right does not affect lines starting with '#'
539(these are supposed to be C preprocessor lines that must stay in column 1).
Bram Moolenaar7dda86f2018-04-20 22:36:41 +0200540This can be changed with the 'cino' option, see |cino-#|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000541
542When the 'expandtab' option is off (this is the default) Vim uses <Tab>s as
543much as possible to make the indent. You can use ">><<" to replace an indent
544made out of spaces with the same indent made out of <Tab>s (and a few spaces
545if necessary). If the 'expandtab' option is on, Vim uses only spaces. Then
546you can use ">><<" to replace <Tab>s in the indent by spaces (or use
Bram Moolenaard38b0552012-04-25 19:07:41 +0200547`:retab!`).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000548
Bram Moolenaard38b0552012-04-25 19:07:41 +0200549To move a line several 'shiftwidth's, use Visual mode or the `:` commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550For example: >
551 Vjj4> move three lines 4 indents to the right
552 :<<< move current line 3 indents to the left
553 :>> 5 move 5 lines 2 indents to the right
554 :5>> move line 5 2 indents to the right
555
556==============================================================================
5574. Complex changes *complex-change*
558
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00005594.1 Filter commands *filter*
Bram Moolenaar47136d72004-10-12 20:02:24 +0000560
561A filter is a program that accepts text at standard input, changes it in some
562way, and sends it to standard output. You can use the commands below to send
Bram Moolenaar446cb832008-06-24 21:56:24 +0000563some text through a filter, so that it is replaced by the filter output.
Bram Moolenaar47136d72004-10-12 20:02:24 +0000564Examples of filters are "sort", which sorts lines alphabetically, and
565"indent", which formats C program files (you need a version of indent that
566works like a filter; not all versions do). The 'shell' option specifies the
567shell Vim uses to execute the filter command (See also the 'shelltype'
568option). You can repeat filter commands with ".". Vim does not recognize a
Bram Moolenaard38b0552012-04-25 19:07:41 +0200569comment (starting with '"') after the `:!` command.
Bram Moolenaar47136d72004-10-12 20:02:24 +0000570
571 *!*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572!{motion}{filter} Filter {motion} text lines through the external
573 program {filter}.
574
575 *!!*
576!!{filter} Filter [count] lines through the external program
577 {filter}.
578
579 *v_!*
580{Visual}!{filter} Filter the highlighted lines through the external
581 program {filter} (for {Visual} see |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000582
583:{range}![!]{filter} [!][arg] *:range!*
584 Filter {range} lines through the external program
585 {filter}. Vim replaces the optional bangs with the
586 latest given command and appends the optional [arg].
587 Vim saves the output of the filter command in a
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100588 temporary file and then reads the file into the buffer
589 |tempfile|. Vim uses the 'shellredir' option to
590 redirect the filter output to the temporary file.
Bram Moolenaar83c465c2005-12-16 21:53:56 +0000591 However, if the 'shelltemp' option is off then pipes
592 are used when possible (on Unix).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000593 When the 'R' flag is included in 'cpoptions' marks in
594 the filtered lines are deleted, unless the
595 |:keepmarks| command is used. Example: >
596 :keepmarks '<,'>!sort
597< When the number of lines after filtering is less than
598 before, marks in the missing lines are deleted anyway.
599
600 *=*
601={motion} Filter {motion} lines through the external program
602 given with the 'equalprg' option. When the 'equalprg'
603 option is empty (this is the default), use the
Bram Moolenaar20f90cf2011-05-19 12:22:51 +0200604 internal formatting function |C-indenting| and
605 |'lisp'|. But when 'indentexpr' is not empty, it will
606 be used instead |indent-expression|. When Vim was
607 compiled without internal formatting then the "indent"
608 program is used as a last resort.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000609
610 *==*
611== Filter [count] lines like with ={motion}.
612
613 *v_=*
614{Visual}= Filter the highlighted lines like with ={motion}.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000615
Bram Moolenaar071d4272004-06-13 20:20:40 +0000616
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100617 *tempfile* *setuid*
618Vim uses temporary files for filtering, generating diffs and also for
619tempname(). For Unix, the file will be in a private directory (only
620accessible by the current user) to avoid security problems (e.g., a symlink
621attack or other people reading your file). When Vim exits the directory and
622all files in it are deleted. When Vim has the setuid bit set this may cause
623problems, the temp file is owned by the setuid user but the filter command
624probably runs as the original user.
Bram Moolenaar75ab5902022-04-18 15:36:40 +0100625Directory for temporary files is created in the first of these directories
626that works:
627 Unix: $TMPDIR, /tmp, current-dir, $HOME.
628 Windows: $TMP, $TEMP, c:\TMP, c:\TEMP
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100629For MS-Windows the GetTempFileName() system function is used.
630For other systems the tmpnam() library function is used.
631
632
633
Bram Moolenaar47136d72004-10-12 20:02:24 +00006344.2 Substitute *:substitute*
635 *:s* *:su*
Bram Moolenaar05159a02005-02-26 23:04:13 +0000636:[range]s[ubstitute]/{pattern}/{string}/[flags] [count]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000637 For each line in [range] replace a match of {pattern}
638 with {string}.
639 For the {pattern} see |pattern|.
640 {string} can be a literal string, or something
641 special; see |sub-replace-special|.
642 When [range] and [count] are omitted, replace in the
Bram Moolenaar3df01732017-02-17 22:47:16 +0100643 current line only. When [count] is given, replace in
644 [count] lines, starting with the last line in [range].
645 When [range] is omitted start in the current line.
Bram Moolenaar4c92e752019-02-17 21:18:32 +0100646 *E939*
Bram Moolenaar3df01732017-02-17 22:47:16 +0100647 [count] must be a positive number. Also see
648 |cmdline-ranges|.
649
Bram Moolenaar05159a02005-02-26 23:04:13 +0000650 See |:s_flags| for [flags].
Bram Moolenaarebdf3c92020-02-15 21:41:42 +0100651 The delimiter doesn't need to be /, see
652 |pattern-delimiter|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000653
Bram Moolenaar05159a02005-02-26 23:04:13 +0000654:[range]s[ubstitute] [flags] [count]
655:[range]&[&][flags] [count] *:&*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000656 Repeat last :substitute with same search pattern and
657 substitute string, but without the same flags. You
Bram Moolenaar05159a02005-02-26 23:04:13 +0000658 may add [flags], see |:s_flags|.
Bram Moolenaard38b0552012-04-25 19:07:41 +0200659 Note that after `:substitute` the '&' flag can't be
Bram Moolenaar071d4272004-06-13 20:20:40 +0000660 used, it's recognized as a pattern separator.
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200661 The space between `:substitute` and the 'c', 'g',
662 'i', 'I' and 'r' flags isn't required, but in scripts
663 it's a good idea to keep it to avoid confusion.
Bram Moolenaarc8cdf0f2021-03-13 13:28:13 +0100664 Also see the two and three letter commands to repeat
665 :substitute below |:substitute-repeat|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000666
Bram Moolenaar05159a02005-02-26 23:04:13 +0000667:[range]~[&][flags] [count] *:~*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000668 Repeat last substitute with same substitute string
669 but with last used search pattern. This is like
Bram Moolenaard38b0552012-04-25 19:07:41 +0200670 `:&r`. See |:s_flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000671
Bram Moolenaar05159a02005-02-26 23:04:13 +0000672 *&*
Bram Moolenaard38b0552012-04-25 19:07:41 +0200673& Synonym for `:s` (repeat last substitute). Note
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 that the flags are not remembered, thus it might
Bram Moolenaard38b0552012-04-25 19:07:41 +0200675 actually work differently. You can use `:&&` to keep
Bram Moolenaar071d4272004-06-13 20:20:40 +0000676 the flags.
677
Bram Moolenaar05159a02005-02-26 23:04:13 +0000678 *g&*
Bram Moolenaar97d62492012-11-15 21:28:22 +0100679g& Synonym for `:%s//~/&` (repeat last substitute with
680 last search pattern on all lines with the same flags).
Bram Moolenaar34700a62013-03-07 13:20:54 +0100681 For example, when you first do a substitution with
Bram Moolenaar97d62492012-11-15 21:28:22 +0100682 `:s/pattern/repl/flags` and then `/search` for
683 something else, `g&` will do `:%s/search/repl/flags`.
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200684 Mnemonic: global substitute.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000685
686 *:snomagic* *:sno*
Bram Moolenaard38b0552012-04-25 19:07:41 +0200687:[range]sno[magic] ... Same as `:substitute`, but always use 'nomagic'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000688
689 *:smagic* *:sm*
Bram Moolenaard38b0552012-04-25 19:07:41 +0200690:[range]sm[agic] ... Same as `:substitute`, but always use 'magic'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000691
692 *:s_flags*
693The flags that you can use for the substitute commands:
694
Bram Moolenaar51628222016-12-01 23:03:28 +0100695 *:&&*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000696[&] Must be the first one: Keep the flags from the previous substitute
697 command. Examples: >
698 :&&
699 :s/this/that/&
Bram Moolenaard38b0552012-04-25 19:07:41 +0200700< Note that `:s` and `:&` don't keep the flags.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000701
702[c] Confirm each substitution. Vim highlights the matching string (with
703 |hl-IncSearch|). You can type: *:s_c*
704 'y' to substitute this match
705 'l' to substitute this match and then quit ("last")
706 'n' to skip this match
707 <Esc> to quit substituting
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200708 'a' to substitute this and all remaining matches
709 'q' to quit substituting
Bram Moolenaare2c453d2019-08-21 14:37:09 +0200710 CTRL-E to scroll the screen up
711 CTRL-Y to scroll the screen down
Bram Moolenaar071d4272004-06-13 20:20:40 +0000712 If the 'edcompatible' option is on, Vim remembers the [c] flag and
713 toggles it each time you use it, but resets it when you give a new
714 search pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000715
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200716 *:s_e*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000717[e] When the search pattern fails, do not issue an error message and, in
718 particular, continue in maps as if no error occurred. This is most
719 useful to prevent the "No match" error from breaking a mapping. Vim
720 does not suppress the following error messages, however:
721 Regular expressions can't be delimited by letters
722 \ should be followed by /, ? or &
723 No previous substitute regular expression
724 Trailing characters
725 Interrupted
Bram Moolenaar071d4272004-06-13 20:20:40 +0000726
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200727 *:s_g*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000728[g] Replace all occurrences in the line. Without this argument,
729 replacement occurs only for the first occurrence in each line. If
730 the 'edcompatible' option is on, Vim remembers this flag and toggles
731 it each time you use it, but resets it when you give a new search
732 pattern. If the 'gdefault' option is on, this flag is on by default
733 and the [g] argument switches it off.
734
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200735 *:s_i*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000736[i] Ignore case for the pattern. The 'ignorecase' and 'smartcase' options
737 are not used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000738
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200739 *:s_I*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000740[I] Don't ignore case for the pattern. The 'ignorecase' and 'smartcase'
741 options are not used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000742
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200743 *:s_n*
Bram Moolenaar05159a02005-02-26 23:04:13 +0000744[n] Report the number of matches, do not actually substitute. The [c]
745 flag is ignored. The matches are reported as if 'report' is zero.
746 Useful to |count-items|.
Bram Moolenaar9b451252012-08-15 17:43:31 +0200747 If \= |sub-replace-expression| is used, the expression will be
748 evaluated in the |sandbox| at every match.
Bram Moolenaar05159a02005-02-26 23:04:13 +0000749
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200750[p] Print the line containing the last substitute. *:s_p*
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000751
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200752[#] Like [p] and prepend the line number. *:s_#*
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000753
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200754[l] Like [p] but print the text like |:list|. *:s_l*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000755
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200756 *:s_r*
Bram Moolenaard38b0552012-04-25 19:07:41 +0200757[r] Only useful in combination with `:&` or `:s` without arguments. `:&r`
758 works the same way as `:~`: When the search pattern is empty, use the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000759 previously used search pattern instead of the search pattern from the
Bram Moolenaard38b0552012-04-25 19:07:41 +0200760 last substitute or `:global`. If the last command that did a search
761 was a substitute or `:global`, there is no effect. If the last
Bram Moolenaar071d4272004-06-13 20:20:40 +0000762 command was a search command such as "/", use the pattern from that
763 command.
Bram Moolenaard38b0552012-04-25 19:07:41 +0200764 For `:s` with an argument this already happens: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000765 :s/blue/red/
766 /green
767 :s//red/ or :~ or :&r
768< The last commands will replace "green" with "red". >
769 :s/blue/red/
770 /green
771 :&
772< The last command will replace "blue" with "red".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000773
774Note that there is no flag to change the "magicness" of the pattern. A
Bram Moolenaar446cb832008-06-24 21:56:24 +0000775different command is used instead, or you can use |/\v| and friends. The
776reason is that the flags can only be found by skipping the pattern, and in
777order to skip the pattern the "magicness" must be known. Catch 22!
Bram Moolenaar071d4272004-06-13 20:20:40 +0000778
779If the {pattern} for the substitute command is empty, the command uses the
Bram Moolenaard38b0552012-04-25 19:07:41 +0200780pattern from the last substitute or `:global` command. If there is none, but
Bram Moolenaar662db672011-03-22 14:05:35 +0100781there is a previous search pattern, that one is used. With the [r] flag, the
Bram Moolenaard38b0552012-04-25 19:07:41 +0200782command uses the pattern from the last substitute, `:global`, or search
Bram Moolenaar071d4272004-06-13 20:20:40 +0000783command.
784
Bram Moolenaar9964e462007-05-05 17:54:07 +0000785If the {string} is omitted the substitute is done as if it's empty. Thus the
786matched pattern is deleted. The separator after {pattern} can also be left
787out then. Example: >
788 :%s/TESTING
789This deletes "TESTING" from all lines, but only one per line.
Bram Moolenaar1588bc82022-03-08 21:35:07 +0000790 *E1270*
791For compatibility with Vi these two exceptions are allowed in legacy script:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000792"\/{string}/" and "\?{string}?" do the same as "//{string}/r".
793"\&{string}&" does the same as "//{string}/".
Bram Moolenaara2baa732022-02-04 16:09:54 +0000794 *pattern-delimiter* *E146* *E1241* *E1242*
Bram Moolenaar4d8f4762021-06-27 15:18:56 +0200795Instead of the '/' which surrounds the pattern and replacement string, you can
796use another single-byte character. This is useful if you want to include a
797'/' in the search pattern or replacement string. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000798 :s+/+//+
799
Bram Moolenaar4d8f4762021-06-27 15:18:56 +0200800You can use most characters, but not an alphanumeric character, '\', '"' or
801'|'. In Vim9 script you should not use '#' because it may be recognized as
802the start of a comment.
803
Bram Moolenaar446cb832008-06-24 21:56:24 +0000804For the definition of a pattern, see |pattern|. In Visual block mode, use
805|/\%V| in the pattern to have the substitute work in the block only.
806Otherwise it works on whole lines anyway.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807
808 *sub-replace-special* *:s\=*
809When the {string} starts with "\=" it is evaluated as an expression, see
Bram Moolenaar251e1912011-06-19 05:09:16 +0200810|sub-replace-expression|. You can use that for complex replacement or special
811characters.
812
Bram Moolenaar2ecbe532022-07-29 21:36:21 +0100813The substitution is limited in recursion to 4 levels. *E1290*
814
Bram Moolenaar5a8684e2005-07-30 22:43:24 +0000815Otherwise these characters in {string} have a special meaning:
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000816 *:s%*
Bram Moolenaar551dbcc2006-04-25 22:13:59 +0000817When {string} is equal to "%" and '/' is included with the 'cpoptions' option,
Bram Moolenaar251e1912011-06-19 05:09:16 +0200818then the {string} of the previous substitute command is used, see |cpo-/|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000819
820magic nomagic action ~
821 & \& replaced with the whole matched pattern *s/\&*
822 \& & replaced with &
823 \0 replaced with the whole matched pattern *\0* *s/\0*
824 \1 replaced with the matched pattern in the first
825 pair of () *s/\1*
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +0000826 \2 replaced with the matched pattern in the second
Bram Moolenaar071d4272004-06-13 20:20:40 +0000827 pair of () *s/\2*
828 .. .. *s/\3*
829 \9 replaced with the matched pattern in the ninth
830 pair of () *s/\9*
831 ~ \~ replaced with the {string} of the previous
832 substitute *s~*
833 \~ ~ replaced with ~ *s/\~*
834 \u next character made uppercase *s/\u*
835 \U following characters made uppercase, until \E *s/\U*
836 \l next character made lowercase *s/\l*
837 \L following characters made lowercase, until \E *s/\L*
838 \e end of \u, \U, \l and \L (NOTE: not <Esc>!) *s/\e*
839 \E end of \u, \U, \l and \L *s/\E*
840 <CR> split line in two at this point
841 (Type the <CR> as CTRL-V <Enter>) *s<CR>*
842 \r idem *s/\r*
843 \<CR> insert a carriage-return (CTRL-M)
844 (Type the <CR> as CTRL-V <Enter>) *s/\<CR>*
845 \n insert a <NL> (<NUL> in the file)
846 (does NOT break the line) *s/\n*
847 \b insert a <BS> *s/\b*
848 \t insert a <Tab> *s/\t*
849 \\ insert a single backslash *s/\\*
850 \x where x is any character not mentioned above:
851 Reserved for future expansion
852
Bram Moolenaar251e1912011-06-19 05:09:16 +0200853The special meaning is also used inside the third argument {sub} of
854the |substitute()| function with the following exceptions:
855 - A % inserts a percent literally without regard to 'cpoptions'.
856 - magic is always set without regard to 'magic'.
857 - A ~ inserts a tilde literally.
858 - <CR> and \r inserts a carriage-return (CTRL-M).
Bram Moolenaarba3ff532018-11-04 14:45:49 +0100859 - \<CR> does not have a special meaning. It's just one of \x.
Bram Moolenaar251e1912011-06-19 05:09:16 +0200860
Bram Moolenaar071d4272004-06-13 20:20:40 +0000861Examples: >
862 :s/a\|b/xxx\0xxx/g modifies "a b" to "xxxaxxx xxxbxxx"
863 :s/\([abc]\)\([efg]\)/\2\1/g modifies "af fa bg" to "fa fa gb"
864 :s/abcde/abc^Mde/ modifies "abcde" to "abc", "de" (two lines)
865 :s/$/\^M/ modifies "abcde" to "abcde^M"
Bram Moolenaarefd2bf12006-03-16 21:41:35 +0000866 :s/\w\+/\u\0/g modifies "bla bla" to "Bla Bla"
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +0200867 :s/\w\+/\L\u\0/g modifies "BLA bla" to "Bla Bla"
Bram Moolenaarbf884932013-04-05 22:26:15 +0200868
869Note: "\L\u" can be used to capitalize the first letter of a word. This is
870not compatible with Vi and older versions of Vim, where the "\u" would cancel
871out the "\L". Same for "\U\l".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000872
873Note: In previous versions CTRL-V was handled in a special way. Since this is
874not Vi compatible, this was removed. Use a backslash instead.
875
876command text result ~
877:s/aa/a^Ma/ aa a<line-break>a
878:s/aa/a\^Ma/ aa a^Ma
879:s/aa/a\\^Ma/ aa a\<line-break>a
880
881(you need to type CTRL-V <CR> to get a ^M here)
882
883The numbering of "\1", "\2" etc. is done based on which "\(" comes first in
884the pattern (going left to right). When a parentheses group matches several
885times, the last one will be used for "\1", "\2", etc. Example: >
886 :s/\(\(a[a-d] \)*\)/\2/ modifies "aa ab x" to "ab x"
Bram Moolenaar7e1479b2016-09-11 15:07:27 +0200887The "\2" is for "\(a[a-d] \)". At first it matches "aa ", secondly "ab ".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000888
889When using parentheses in combination with '|', like in \([ab]\)\|\([cd]\),
890either the first or second pattern in parentheses did not match, so either
891\1 or \2 is empty. Example: >
892 :s/\([ab]\)\|\([cd]\)/\1x/g modifies "a b c d" to "ax bx x x"
893<
894
Bram Moolenaara0f849e2015-10-30 14:37:44 +0100895 *:sc* *:sce* *:scg* *:sci* *:scI* *:scl* *:scp* *:sg* *:sgc*
896 *:sge* *:sgi* *:sgI* *:sgl* *:sgn* *:sgp* *:sgr* *:sI* *:si*
897 *:sic* *:sIc* *:sie* *:sIe* *:sIg* *:sIl* *:sin* *:sIn* *:sIp*
898 *:sip* *:sIr* *:sir* *:sr* *:src* *:srg* *:sri* *:srI* *:srl*
Bram Moolenaarc8cdf0f2021-03-13 13:28:13 +0100899 *:srn* *:srp* *:substitute-repeat*
Bram Moolenaara0f849e2015-10-30 14:37:44 +01009002-letter and 3-letter :substitute commands ~
901
Bram Moolenaarc8cdf0f2021-03-13 13:28:13 +0100902These commands repeat the previous `:substitute` command with the given flags.
903The first letter is always "s", followed by one or two of the possible flag
904characters. For example `:sce` works like `:s///ce`. The table lists the
905possible combinations, not all flags are possible, because the command is
906short for another command.
907
Bram Moolenaara0f849e2015-10-30 14:37:44 +0100908 List of :substitute commands
909 | c e g i I n p l r
Bram Moolenaarc8cdf0f2021-03-13 13:28:13 +0100910 | c :sc :sce :scg :sci :scI :scn :scp :scl
Bram Moolenaara0f849e2015-10-30 14:37:44 +0100911 | e
912 | g :sgc :sge :sg :sgi :sgI :sgn :sgp :sgl :sgr
Bram Moolenaarc8cdf0f2021-03-13 13:28:13 +0100913 | i :sic :sie :si :siI :sin :sip :sir
Bram Moolenaara0f849e2015-10-30 14:37:44 +0100914 | I :sIc :sIe :sIg :sIi :sI :sIn :sIp :sIl :sIr
915 | n
916 | p
917 | l
Bram Moolenaarc8cdf0f2021-03-13 13:28:13 +0100918 | r :src :srg :sri :srI :srn :srp :srl :sr
Bram Moolenaara0f849e2015-10-30 14:37:44 +0100919
920Exceptions:
921 :scr is `:scriptnames`
922 :se is `:set`
923 :sig is `:sign`
924 :sil is `:silent`
925 :sn is `:snext`
926 :sp is `:split`
927 :sl is `:sleep`
928 :sre is `:srewind`
929
930
Bram Moolenaar071d4272004-06-13 20:20:40 +0000931Substitute with an expression *sub-replace-expression*
Bram Moolenaar92dff182014-02-11 19:15:50 +0100932 *sub-replace-\=* *s/\=*
Bram Moolenaara7fc0102005-05-18 22:17:12 +0000933When the substitute string starts with "\=" the remainder is interpreted as an
Bram Moolenaar6100d022016-10-02 16:51:57 +0200934expression.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000935
936The special meaning for characters as mentioned at |sub-replace-special| does
Bram Moolenaar251e1912011-06-19 05:09:16 +0200937not apply except for "<CR>". A <NL> character is used as a line break, you
938can get one with a double-quote string: "\n". Prepend a backslash to get a
939real <NL> character (which will be a NUL in the file).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000940
Bram Moolenaar251e1912011-06-19 05:09:16 +0200941The "\=" notation can also be used inside the third argument {sub} of
942|substitute()| function. In this case, the special meaning for characters as
943mentioned at |sub-replace-special| does not apply at all. Especially, <CR> and
944<NL> are interpreted not as a line break but as a carriage-return and a
945new-line respectively.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000946
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000947When the result is a |List| then the items are joined with separating line
948breaks. Thus each item becomes a line, except that they can contain line
949breaks themselves.
950
Bram Moolenaar9d87a372018-12-18 21:41:50 +0100951The |submatch()| function can be used to obtain matched text. The whole
952matched text can be accessed with "submatch(0)". The text matched with the
953first pair of () with "submatch(1)". Likewise for further sub-matches in ().
Bram Moolenaar071d4272004-06-13 20:20:40 +0000954
955Be careful: The separation character must not appear in the expression!
956Consider using a character like "@" or ":". There is no problem if the result
957of the expression contains the separation character.
958
Bram Moolenaar5a8684e2005-07-30 22:43:24 +0000959Examples: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000960 :s@\n@\="\r" .. expand("$HOME") .. "\r"@
Bram Moolenaar5a8684e2005-07-30 22:43:24 +0000961This replaces an end-of-line with a new line containing the value of $HOME. >
962
963 s/E/\="\<Char-0x20ac>"/g
Bram Moolenaarc236c162008-07-13 17:41:49 +0000964This replaces each 'E' character with a euro sign. Read more in |<Char->|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000965
966
Bram Moolenaar47136d72004-10-12 20:02:24 +00009674.3 Search and replace *search-replace*
968
969 *:pro* *:promptfind*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000970:promptf[ind] [string]
971 Put up a Search dialog. When [string] is given, it is
972 used as the initial search string.
973 {only for Win32, Motif and GTK GUI}
974
975 *:promptr* *:promptrepl*
976:promptr[epl] [string]
977 Put up a Search/Replace dialog. When [string] is
978 given, it is used as the initial search string.
979 {only for Win32, Motif and GTK GUI}
980
Bram Moolenaar47136d72004-10-12 20:02:24 +0000981
9824.4 Changing tabs *change-tabs*
Bram Moolenaard38b0552012-04-25 19:07:41 +0200983 *:ret* *:retab* *:retab!*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000984:[range]ret[ab][!] [new_tabstop]
985 Replace all sequences of white-space containing a
986 <Tab> with new strings of white-space using the new
987 tabstop value given. If you do not specify a new
988 tabstop size or it is zero, Vim uses the current value
989 of 'tabstop'.
990 The current value of 'tabstop' is always used to
991 compute the width of existing tabs.
992 With !, Vim also replaces strings of only normal
993 spaces with tabs where appropriate.
994 With 'expandtab' on, Vim replaces all tabs with the
995 appropriate number of spaces.
996 This command sets 'tabstop' to the new value given,
997 and if performed on the whole file, which is default,
998 should not make any visible change.
999 Careful: This command modifies any <Tab> characters
1000 inside of strings in a C program. Use "\t" to avoid
1001 this (that's a good habit anyway).
Bram Moolenaard38b0552012-04-25 19:07:41 +02001002 `:retab!` may also change a sequence of spaces by
Bram Moolenaar071d4272004-06-13 20:20:40 +00001003 <Tab> characters, which can mess up a printf().
Bram Moolenaar04958cb2018-06-23 19:23:02 +02001004 If the |+vartabs| feature is enabled then a list of
1005 tab widths separated by commas may be used in place of
1006 a single tabstop. Each value in the list represents
1007 the width of one tabstop, except the final value which
1008 applies to all following tabstops.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001009
1010 *retab-example*
1011Example for using autocommands and ":retab" to edit a file which is stored
1012with tabstops at 8 but edited with tabstops set at 4. Warning: white space
1013inside of strings can change! Also see 'softtabstop' option. >
1014
1015 :auto BufReadPost *.xx retab! 4
1016 :auto BufWritePre *.xx retab! 8
1017 :auto BufWritePost *.xx retab! 4
1018 :auto BufNewFile *.xx set ts=4
1019
1020==============================================================================
10215. Copying and moving text *copy-move*
1022
1023 *quote*
Bram Moolenaar7ceefb32020-05-01 16:07:38 +02001024"{register} Use {register} for next delete, yank or put. Use
1025 an uppercase character to append with delete and yank.
1026 Registers ".", "%", "#" and ":" only work with put.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001027
1028 *:reg* *:registers*
Bram Moolenaar3691f1e2019-10-24 20:17:00 +02001029:reg[isters] Display the type and contents of all numbered and
1030 named registers. If a register is written to for
1031 |:redir| it will not be listed.
1032 Type can be one of:
1033 "c" for |characterwise| text
1034 "l" for |linewise| text
1035 "b" for |blockwise-visual| text
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001036
Bram Moolenaar071d4272004-06-13 20:20:40 +00001037
1038:reg[isters] {arg} Display the contents of the numbered and named
1039 registers that are mentioned in {arg}. For example: >
Bram Moolenaarfa735342016-01-03 22:14:44 +01001040 :reg 1a
Bram Moolenaar071d4272004-06-13 20:20:40 +00001041< to display registers '1' and 'a'. Spaces are allowed
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001042 in {arg}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001043
Bram Moolenaardd60c362023-02-27 15:49:53 +00001044 *:di* *:dis* *:display*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001045:di[splay] [arg] Same as :registers.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001046
1047 *y* *yank*
1048["x]y{motion} Yank {motion} text [into register x]. When no
1049 characters are to be yanked (e.g., "y0" in column 1),
1050 this is an error when 'cpoptions' includes the 'E'
1051 flag.
1052
1053 *yy*
1054["x]yy Yank [count] lines [into register x] |linewise|.
1055
1056 *Y*
1057["x]Y yank [count] lines [into register x] (synonym for
1058 yy, |linewise|). If you like "Y" to work from the
1059 cursor to the end of line (which is more logical,
1060 but not Vi-compatible) use ":map Y y$".
1061
Christian Brabandt544a38e2021-06-10 19:39:11 +02001062 *zy*
1063["x]zy{motion} Yank {motion} text [into register x]. Only differs
1064 from `y` when selecting a block of text, see |v_zy|.
1065
Bram Moolenaar071d4272004-06-13 20:20:40 +00001066 *v_y*
1067{Visual}["x]y Yank the highlighted text [into register x] (for
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001068 {Visual} see |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001069
1070 *v_Y*
1071{Visual}["x]Y Yank the highlighted lines [into register x] (for
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001072 {Visual} see |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001073
Christian Brabandt544a38e2021-06-10 19:39:11 +02001074 *v_zy*
1075{Visual}["x]zy Yank the highlighted text [into register x]. Trailing
1076 whitespace at the end of each line of a selected block
1077 won't be yanked. Especially useful in combination
1078 with `zp`. (for {Visual} see |Visual-mode|)
1079
Bram Moolenaar85de2062011-05-05 14:26:41 +02001080 *:y* *:yank* *E850*
1081:[range]y[ank] [x] Yank [range] lines [into register x]. Yanking to the
Bram Moolenaar446beb42011-05-10 17:18:44 +02001082 "* or "+ registers is possible only when the
1083 |+clipboard| feature is included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001084
1085:[range]y[ank] [x] {count}
1086 Yank {count} lines, starting with last line number
1087 in [range] (default: current line |cmdline-ranges|),
1088 [into register x].
1089
Bram Moolenaara2baa732022-02-04 16:09:54 +00001090 *p* *put* *E353* *E1240*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001091["x]p Put the text [from register x] after the cursor
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001092 [count] times.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001093
1094 *P*
1095["x]P Put the text [from register x] before the cursor
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001096 [count] times.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001097
1098 *<MiddleMouse>*
1099["x]<MiddleMouse> Put the text from a register before the cursor [count]
1100 times. Uses the "* register, unless another is
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001101 specified.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001102 Leaves the cursor at the end of the new text.
1103 Using the mouse only works when 'mouse' contains 'n'
1104 or 'a'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001105 If you have a scrollwheel and often accidentally paste
1106 text, you can use these mappings to disable the
1107 pasting with the middle mouse button: >
1108 :map <MiddleMouse> <Nop>
1109 :imap <MiddleMouse> <Nop>
1110< You might want to disable the multi-click versions
1111 too, see |double-click|.
1112
1113 *gp*
1114["x]gp Just like "p", but leave the cursor just after the new
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001115 text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001116
1117 *gP*
1118["x]gP Just like "P", but leave the cursor just after the new
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001119 text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001120
1121 *:pu* *:put*
1122:[line]pu[t] [x] Put the text [from register x] after [line] (default
1123 current line). This always works |linewise|, thus
1124 this command can be used to put a yanked block as new
1125 lines.
Bram Moolenaard38b0552012-04-25 19:07:41 +02001126 If no register is specified, it depends on the 'cb'
1127 option: If 'cb' contains "unnamedplus", paste from the
1128 + register |quoteplus|. Otherwise, if 'cb' contains
Bram Moolenaarddbb5552012-04-26 20:17:03 +02001129 "unnamed", paste from the * register |quotestar|.
Bram Moolenaard38b0552012-04-25 19:07:41 +02001130 Otherwise, paste from the unnamed register
1131 |quote_quote|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001132 The register can also be '=' followed by an optional
1133 expression. The expression continues until the end of
1134 the command. You need to escape the '|' and '"'
1135 characters to prevent them from terminating the
1136 command. Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001137 :put ='path' .. \",/test\"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001138< If there is no expression after '=', Vim uses the
1139 previous expression. You can see it with ":dis =".
1140
1141:[line]pu[t]! [x] Put the text [from register x] before [line] (default
1142 current line).
1143
1144["x]]p or *]p* *]<MiddleMouse>*
1145["x]]<MiddleMouse> Like "p", but adjust the indent to the current line.
1146 Using the mouse only works when 'mouse' contains 'n'
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001147 or 'a'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001148
1149["x][P or *[P*
1150["x]]P or *]P*
1151["x][p or *[p* *[<MiddleMouse>*
1152["x][<MiddleMouse> Like "P", but adjust the indent to the current line.
1153 Using the mouse only works when 'mouse' contains 'n'
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001154 or 'a'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001155
Christian Brabandt2fa93842021-05-30 22:17:25 +02001156["x]zp or *zp* *zP*
1157["x]zP Like "p" and "P", except without adding trailing spaces
1158 when pasting a block. Thus the inserted text will not
Christian Brabandt544a38e2021-06-10 19:39:11 +02001159 always be a rectangle. Especially useful in
1160 combination with |v_zy|.
Christian Brabandt2fa93842021-05-30 22:17:25 +02001161
Bram Moolenaar071d4272004-06-13 20:20:40 +00001162You can use these commands to copy text from one place to another. Do this
1163by first getting the text into a register with a yank, delete or change
1164command, then inserting the register contents with a put command. You can
1165also use these commands to move text from one file to another, because Vim
1166preserves all registers when changing buffers (the CTRL-^ command is a quick
1167way to toggle between two files).
1168
1169 *linewise-register* *characterwise-register*
1170You can repeat the put commands with "." (except for :put) and undo them. If
1171the command that was used to get the text into the register was |linewise|,
1172Vim inserts the text below ("p") or above ("P") the line where the cursor is.
1173Otherwise Vim inserts the text after ("p") or before ("P") the cursor. With
1174the ":put" command, Vim always inserts the text in the next line. You can
1175exchange two characters with the command sequence "xp". You can exchange two
1176lines with the command sequence "ddp". You can exchange two words with the
1177command sequence "deep" (start with the cursor in the blank space before the
1178first word). You can use the "']" or "`]" command after the put command to
1179move the cursor to the end of the inserted text, or use "'[" or "`[" to move
1180the cursor to the start.
1181
1182 *put-Visual-mode* *v_p* *v_P*
1183When using a put command like |p| or |P| in Visual mode, Vim will try to
1184replace the selected text with the contents of the register. Whether this
1185works well depends on the type of selection and the type of the text in the
1186register. With blockwise selection it also depends on the size of the block
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001187and whether the corners are on an existing character. (Implementation detail:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001188it actually works by first putting the register after the selection and then
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001189deleting the selection.)
Shougo Matsushita509142a2022-05-06 11:45:09 +01001190With |p| the previously selected text is put in the unnamed register (and
1191possibly the selection and/or clipboard). This is useful if you want to put
1192that text somewhere else. But you cannot repeat the same change.
1193With |P| the unnamed register is not changed (and neither the selection or
1194clipboard), you can repeat the same change. But the deleted text cannot be
1195used. If you do need it you can use |p| with another register. E.g., yank
1196the text to copy, Visually select the text to replace and use "0p . You can
1197repeat this as many times as you like, and the unnamed register will be
1198changed each time.
Bram Moolenaar9712ff12022-09-18 13:04:22 +01001199 *blockwise-put*
1200When a register contains text from one line (characterwise), using a
1201blockwise Visual selection, putting that register will paste that text
1202repeatedly in each of the selected lines, thus replacing the blockwise
1203selected region by multiple copies of the register text. For example:
1204 - yank the word "TEXT" into a register with `yw`
1205 - select a visual block, marked with "v" in this text:
1206 aaavvaaa
1207 bbbvvbbb
1208 cccvvccc
1209 - press `p`, results in:
1210 aaaTEXTaaa
1211 bbbTEXTbbb
1212 cccTEXTccc
Bram Moolenaarec11aef2013-09-22 15:23:44 +02001213
Bram Moolenaar071d4272004-06-13 20:20:40 +00001214 *blockwise-register*
1215If you use a blockwise Visual mode command to get the text into the register,
1216the block of text will be inserted before ("P") or after ("p") the cursor
1217column in the current and next lines. Vim makes the whole block of text start
1218in the same column. Thus the inserted text looks the same as when it was
1219yanked or deleted. Vim may replace some <Tab> characters with spaces to make
1220this happen. However, if the width of the block is not a multiple of a <Tab>
1221width and the text after the inserted block contains <Tab>s, that text may be
1222misaligned.
1223
Bram Moolenaar22863042021-10-16 15:23:36 +01001224Use |zP|/|zp| to paste a blockwise yanked register without appending trailing
1225spaces.
1226
Bram Moolenaar071d4272004-06-13 20:20:40 +00001227Note that after a characterwise yank command, Vim leaves the cursor on the
1228first yanked character that is closest to the start of the buffer. This means
1229that "yl" doesn't move the cursor, but "yh" moves the cursor one character
1230left.
1231Rationale: In Vi the "y" command followed by a backwards motion would
1232 sometimes not move the cursor to the first yanked character,
1233 because redisplaying was skipped. In Vim it always moves to
1234 the first character, as specified by Posix.
1235With a linewise yank command the cursor is put in the first line, but the
1236column is unmodified, thus it may not be on the first yanked character.
1237
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02001238There are ten types of registers: *registers* *{register}* *E354*
Bram Moolenaar071d4272004-06-13 20:20:40 +000012391. The unnamed register ""
12402. 10 numbered registers "0 to "9
12413. The small delete register "-
12424. 26 named registers "a to "z or "A to "Z
Bram Moolenaar396e8292019-07-13 23:04:31 +020012435. Three read-only registers ":, "., "%
12446. Alternate buffer register "#
12457. The expression register "=
Bram Moolenaar3b3a9492015-01-27 18:44:16 +010012468. The selection and drop registers "*, "+ and "~
12479. The black hole register "_
124810. Last search pattern register "/
Bram Moolenaar071d4272004-06-13 20:20:40 +00001249
12501. Unnamed register "" *quote_quote* *quotequote*
1251Vim fills this register with text deleted with the "d", "c", "s", "x" commands
1252or copied with the yank "y" command, regardless of whether or not a specific
Bram Moolenaared203462004-06-16 11:19:22 +00001253register was used (e.g. "xdd). This is like the unnamed register is pointing
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001254to the last used register. Thus when appending using an uppercase register
1255name, the unnamed register contains the same text as the named register.
1256An exception is the '_' register: "_dd does not store the deleted text in any
1257register.
Bram Moolenaar81695252004-12-29 20:58:21 +00001258Vim uses the contents of the unnamed register for any put command (p or P)
1259which does not specify a register. Additionally you can access it with the
1260name '"'. This means you have to type two double quotes. Writing to the ""
1261register writes to register "0.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001262{Vi: register contents are lost when changing files, no '"'}
1263
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +020012642. Numbered registers "0 to "9 *quote_number* *quote0* *quote1*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001265 *quote2* *quote3* *quote4* *quote9*
1266Vim fills these registers with text from yank and delete commands.
1267 Numbered register 0 contains the text from the most recent yank command,
1268unless the command specified another register with ["x].
1269 Numbered register 1 contains the text deleted by the most recent delete or
1270change command, unless the command specified another register or the text is
1271less than one line (the small delete register is used then). An exception is
Bram Moolenaar81695252004-12-29 20:58:21 +00001272made for the delete operator with these movement commands: |%|, |(|, |)|, |`|,
1273|/|, |?|, |n|, |N|, |{| and |}|. Register "1 is always used then (this is Vi
1274compatible). The "- register is used as well if the delete is within a line.
Bram Moolenaarbaca7f72013-09-22 14:42:24 +02001275Note that these characters may be mapped. E.g. |%| is mapped by the matchit
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02001276plugin.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001277 With each successive deletion or change, Vim shifts the previous contents
1278of register 1 into register 2, 2 into 3, and so forth, losing the previous
1279contents of register 9.
1280{Vi: numbered register contents are lost when changing files; register 0 does
1281not exist}
1282
12833. Small delete register "- *quote_-* *quote-*
1284This register contains text from commands that delete less than one line,
1285except when the command specifies a register with ["x].
Bram Moolenaar071d4272004-06-13 20:20:40 +00001286
12874. Named registers "a to "z or "A to "Z *quote_alpha* *quotea*
1288Vim fills these registers only when you say so. Specify them as lowercase
1289letters to replace their previous contents or as uppercase letters to append
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001290to their previous contents. When the '>' flag is present in 'cpoptions' then
1291a line break is inserted before the appended text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001292
Bram Moolenaar3b3a9492015-01-27 18:44:16 +010012935. Read-only registers ":, ". and "%
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01001294These are '%', ':' and '.'. You can use them only with the "p", "P",
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001295and ":put" commands and with CTRL-R.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001296 *quote_.* *quote.* *E29*
1297 ". Contains the last inserted text (the same as what is inserted
1298 with the insert mode commands CTRL-A and CTRL-@). Note: this
1299 doesn't work with CTRL-R on the command-line. It works a bit
1300 differently, like inserting the text instead of putting it
1301 ('textwidth' and other options affect what is inserted).
1302 *quote_%* *quote%*
1303 "% Contains the name of the current file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001304 *quote_:* *quote:* *E30*
1305 ": Contains the most recent executed command-line. Example: Use
1306 "@:" to repeat the previous command-line command.
1307 The command-line is only stored in this register when at least
1308 one character of it was typed. Thus it remains unchanged if
1309 the command was completely from a mapping.
1310 {not available when compiled without the |+cmdline_hist|
1311 feature}
Bram Moolenaar3b3a9492015-01-27 18:44:16 +01001312 *quote_#* *quote#*
13136. Alternate file register "#
1314Contains the name of the alternate file for the current window. It will
1315change how the |CTRL-^| command works.
1316This register is writable, mainly to allow for restoring it after a plugin has
1317changed it. It accepts buffer number: >
1318 let altbuf = bufnr(@#)
1319 ...
1320 let @# = altbuf
1321It will give error |E86| if you pass buffer number and this buffer does not
1322exist.
1323It can also accept a match with an existing buffer name: >
1324 let @# = 'buffer_name'
1325Error |E93| if there is more than one buffer matching the given name or |E94|
1326if none of buffers matches the given name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001327
Bram Moolenaar3b3a9492015-01-27 18:44:16 +010013287. Expression register "= *quote_=* *quote=* *@=*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001329This is not really a register that stores text, but is a way to use an
1330expression in commands which use a register. The expression register is
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001331read-write.
1332
1333When typing the '=' after " or CTRL-R the cursor moves to the command-line,
1334where you can enter any expression (see |expression|). All normal
1335command-line editing commands are available, including a special history for
1336expressions. When you end the command-line by typing <CR>, Vim computes the
1337result of the expression. If you end it with <Esc>, Vim abandons the
1338expression. If you do not enter an expression, Vim uses the previous
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001339expression (like with the "/" command).
1340
1341The expression must evaluate to a String. A Number is always automatically
1342converted to a String. For the "p" and ":put" command, if the result is a
1343Float it's converted into a String. If the result is a List each element is
1344turned into a String and used as a line. A Dictionary or FuncRef results in
1345an error message (use string() to convert).
1346
1347If the "= register is used for the "p" command, the String is split up at <NL>
1348characters. If the String ends in a <NL>, it is regarded as a linewise
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001349register.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001350
Bram Moolenaar3b3a9492015-01-27 18:44:16 +010013518. Selection and drop registers "*, "+ and "~
Bram Moolenaar06b5d512010-05-22 15:37:44 +02001352Use these registers for storing and retrieving the selected text for the GUI.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001353See |quotestar| and |quoteplus|. When the clipboard is not available or not
Bram Moolenaarf4d11452005-12-02 00:46:37 +00001354working, the unnamed register is used instead. For Unix systems the clipboard
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001355is only available when the |+xterm_clipboard| feature is present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001356
1357Note that there is only a distinction between "* and "+ for X11 systems. For
1358an explanation of the difference, see |x11-selection|. Under MS-Windows, use
1359of "* and "+ is actually synonymous and refers to the |gui-clipboard|.
1360
1361 *quote_~* *quote~* *<Drop>*
1362The read-only "~ register stores the dropped text from the last drag'n'drop
1363operation. When something has been dropped onto Vim, the "~ register is
1364filled in and the <Drop> pseudo key is sent for notification. You can remap
1365this key if you want; the default action (for all modes) is to insert the
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001366contents of the "~ register at the cursor position.
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001367{only available when compiled with the |+dnd| feature, currently only with the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001368GTK GUI}
1369
1370Note: The "~ register is only used when dropping plain text onto Vim.
1371Drag'n'drop of URI lists is handled internally.
1372
Bram Moolenaar3b3a9492015-01-27 18:44:16 +010013739. Black hole register "_ *quote_*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001374When writing to this register, nothing happens. This can be used to delete
1375text without affecting the normal registers. When reading from this register,
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001376nothing is returned.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001377
Bram Moolenaar5be4cee2019-09-27 19:34:08 +0200137810. Last search pattern register "/ *quote_/* *quote/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001379Contains the most recent search-pattern. This is used for "n" and 'hlsearch'.
Bram Moolenaard38b0552012-04-25 19:07:41 +02001380It is writable with `:let`, you can change it to have 'hlsearch' highlight
Bram Moolenaar071d4272004-06-13 20:20:40 +00001381other matches without actually searching. You can't yank or delete into this
Bram Moolenaar446cb832008-06-24 21:56:24 +00001382register. The search direction is available in |v:searchforward|.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001383Note that the value is restored when returning from a function
Bram Moolenaar446cb832008-06-24 21:56:24 +00001384|function-search-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001385
1386 *@/*
Bram Moolenaard38b0552012-04-25 19:07:41 +02001387You can write to a register with a `:let` command |:let-@|. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001388 :let @/ = "the"
1389
1390If you use a put command without specifying a register, Vim uses the register
1391that was last filled (this is also the contents of the unnamed register). If
Bram Moolenaard38b0552012-04-25 19:07:41 +02001392you are confused, use the `:dis` command to find out what Vim will put (this
Bram Moolenaar071d4272004-06-13 20:20:40 +00001393command displays all named and numbered registers; the unnamed register is
1394labelled '"').
1395
1396The next three commands always work on whole lines.
1397
1398:[range]co[py] {address} *:co* *:copy*
1399 Copy the lines given by [range] to below the line
1400 given by {address}.
1401
1402 *:t*
1403:t Synonym for copy.
Bram Moolenaara4d131d2021-12-27 21:33:07 +00001404 This command is not supported in |Vim9| script,
1405 because it is too easily confused with a variable
1406 name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001407
1408:[range]m[ove] {address} *:m* *:mo* *:move* *E134*
1409 Move the lines given by [range] to below the line
1410 given by {address}.
1411
1412==============================================================================
14136. Formatting text *formatting*
1414
1415:[range]ce[nter] [width] *:ce* *:center*
1416 Center lines in [range] between [width] columns
1417 (default 'textwidth' or 80 when 'textwidth' is 0).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001418
1419:[range]ri[ght] [width] *:ri* *:right*
1420 Right-align lines in [range] at [width] columns
1421 (default 'textwidth' or 80 when 'textwidth' is 0).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001422
1423 *:le* *:left*
1424:[range]le[ft] [indent]
1425 Left-align lines in [range]. Sets the indent in the
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001426 lines to [indent] (default 0).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001427
1428 *gq*
Bram Moolenaar4317d9b2005-03-18 20:25:31 +00001429gq{motion} Format the lines that {motion} moves over.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001430 Formatting is done with one of three methods:
1431 1. If 'formatexpr' is not empty the expression is
1432 evaluated. This can differ for each buffer.
Bram Moolenaar4c7ed462006-02-15 22:18:42 +00001433 2. If 'formatprg' is not empty an external program
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001434 is used.
Bram Moolenaar551dbcc2006-04-25 22:13:59 +00001435 3. Otherwise formatting is done internally.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001436
1437 In the third case the 'textwidth' option controls the
1438 length of each formatted line (see below).
Bram Moolenaar4317d9b2005-03-18 20:25:31 +00001439 If the 'textwidth' option is 0, the formatted line
1440 length is the screen width (with a maximum width of
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001441 79).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001442 The 'formatoptions' option controls the type of
1443 formatting |fo-table|.
Bram Moolenaar4317d9b2005-03-18 20:25:31 +00001444 The cursor is left on the first non-blank of the last
1445 formatted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001446 NOTE: The "Q" command formerly performed this
1447 function. If you still want to use "Q" for
1448 formatting, use this mapping: >
1449 :nnoremap Q gq
1450
1451gqgq *gqgq* *gqq*
Bram Moolenaar40af4e32010-07-29 22:33:18 +02001452gqq Format the current line. With a count format that
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001453 many lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001454
1455 *v_gq*
1456{Visual}gq Format the highlighted text. (for {Visual} see
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001457 |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001458
1459 *gw*
1460gw{motion} Format the lines that {motion} moves over. Similar to
1461 |gq| but puts the cursor back at the same position in
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001462 the text. However, 'formatprg' and 'formatexpr' are
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001463 not used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001464
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001465gwgw *gwgw* *gww*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001466gww Format the current line as with "gw".
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001467
1468 *v_gw*
1469{Visual}gw Format the highlighted text as with "gw". (for
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001470 {Visual} see |Visual-mode|).
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001471
Bram Moolenaar071d4272004-06-13 20:20:40 +00001472Example: To format the current paragraph use: *gqap* >
1473 gqap
1474
1475The "gq" command leaves the cursor in the line where the motion command takes
1476the cursor. This allows you to repeat formatting repeated with ".". This
1477works well with "gqj" (format current and next line) and "gq}" (format until
1478end of paragraph). Note: When 'formatprg' is set, "gq" leaves the cursor on
1479the first formatted line (as with using a filter command).
1480
1481If you want to format the current paragraph and continue where you were, use: >
1482 gwap
1483If you always want to keep paragraphs formatted you may want to add the 'a'
1484flag to 'formatoptions'. See |auto-format|.
1485
1486If the 'autoindent' option is on, Vim uses the indent of the first line for
1487the following lines.
1488
1489Formatting does not change empty lines (but it does change lines with only
1490white space!).
1491
1492The 'joinspaces' option is used when lines are joined together.
1493
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001494You can set the 'formatexpr' option to an expression or the 'formatprg' option
1495to the name of an external program for Vim to use for text formatting. The
1496'textwidth' and other options have no effect on formatting by an external
1497program.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001498
Bram Moolenaar7db25fe2018-05-13 00:02:36 +02001499 *format-formatexpr*
Bram Moolenaard473c8c2018-08-11 18:00:22 +02001500The 'formatexpr' option can be set to a Vim script function that performs
Bram Moolenaar7db25fe2018-05-13 00:02:36 +02001501reformatting of the buffer. This should usually happen in an |ftplugin|,
1502since formatting is highly dependent on the type of file. It makes
1503sense to use an |autoload| script, so the corresponding script is only loaded
1504when actually needed and the script should be called <filetype>format.vim.
1505
1506For example, the XML filetype plugin distributed with Vim in the $VIMRUNTIME
1507directory, sets the 'formatexpr' option to: >
1508
1509 setlocal formatexpr=xmlformat#Format()
1510
1511That means, you will find the corresponding script, defining the
1512xmlformat#Format() function, in the directory:
1513`$VIMRUNTIME/autoload/xmlformat.vim`
1514
1515Here is an example script that removes trailing whitespace from the selected
1516text. Put it in your autoload directory, e.g. ~/.vim/autoload/format.vim: >
1517
1518 func! format#Format()
1519 " only reformat on explicit gq command
1520 if mode() != 'n'
Bram Moolenaard1caa942020-04-10 22:10:56 +02001521 " fall back to Vim's internal reformatting
Bram Moolenaar7db25fe2018-05-13 00:02:36 +02001522 return 1
1523 endif
1524 let lines = getline(v:lnum, v:lnum + v:count - 1)
1525 call map(lines, {key, val -> substitute(val, '\s\+$', '', 'g')})
1526 call setline('.', lines)
1527
1528 " do not run internal formatter!
1529 return 0
1530 endfunc
1531
1532You can then enable the formatting by executing: >
1533 setlocal formatexpr=format#Format()
Bram Moolenaard473c8c2018-08-11 18:00:22 +02001534
Bram Moolenaar7db25fe2018-05-13 00:02:36 +02001535Note: this function explicitly returns non-zero when called from insert mode
1536(which basically means, text is inserted beyond the 'textwidth' limit). This
1537causes Vim to fall back to reformat the text by using the internal formatter.
1538
1539However, if the |gq| command is used to reformat the text, the function
1540will receive the selected lines, trim trailing whitespace from those lines and
1541put them back in place. If you are going to split single lines into multiple
1542lines, be careful not to overwrite anything.
1543
1544If you want to allow reformatting of text from insert or replace mode, one has
1545to be very careful, because the function might be called recursively. For
1546debugging it helps to set the 'debug' option.
1547
Bram Moolenaar071d4272004-06-13 20:20:40 +00001548 *right-justify*
1549There is no command in Vim to right justify text. You can do it with
1550an external command, like "par" (e.g.: "!}par" to format until the end of the
1551paragraph) or set 'formatprg' to "par".
1552
1553 *format-comments*
Bram Moolenaar446cb832008-06-24 21:56:24 +00001554An overview of comment formatting is in section |30.6| of the user manual.
1555
1556Vim can automatically insert and format comments in a special way. Vim
1557recognizes a comment by a specific string at the start of the line (ignoring
1558white space). Three types of comments can be used:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001559
1560- A comment string that repeats at the start of each line. An example is the
1561 type of comment used in shell scripts, starting with "#".
1562- A comment string that occurs only in the first line, not in the following
1563 lines. An example is this list with dashes.
1564- Three-piece comments that have a start string, an end string, and optional
1565 lines in between. The strings for the start, middle and end are different.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001566 An example is the C style comment:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001567 /*
1568 * this is a C comment
1569 */
1570
1571The 'comments' option is a comma-separated list of parts. Each part defines a
1572type of comment string. A part consists of:
1573 {flags}:{string}
1574
1575{string} is the literal text that must appear.
1576
1577{flags}:
1578 n Nested comment. Nesting with mixed parts is allowed. If 'comments'
1579 is "n:),n:>" a line starting with "> ) >" is a comment.
1580
1581 b Blank (<Space>, <Tab> or <EOL>) required after {string}.
1582
1583 f Only the first line has the comment string. Do not repeat comment on
1584 the next line, but preserve indentation (e.g., a bullet-list).
1585
1586 s Start of three-piece comment
1587
1588 m Middle of a three-piece comment
1589
1590 e End of a three-piece comment
1591
Bram Moolenaar446cb832008-06-24 21:56:24 +00001592 l Left align. Used together with 's' or 'e', the leftmost character of
1593 start or end will line up with the leftmost character from the middle.
1594 This is the default and can be omitted. See below for more details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001595
Bram Moolenaar446cb832008-06-24 21:56:24 +00001596 r Right align. Same as above but rightmost instead of leftmost. See
1597 below for more details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001598
Bram Moolenaar446cb832008-06-24 21:56:24 +00001599 O Don't consider this comment for the "O" command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001600
1601 x Allows three-piece comments to be ended by just typing the last
Bram Moolenaar446cb832008-06-24 21:56:24 +00001602 character of the end-comment string as the first action on a new
1603 line when the middle-comment string has been inserted automatically.
1604 See below for more details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001605
1606 {digits}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001607 When together with 's' or 'e': add {digit} amount of offset to an
1608 automatically inserted middle or end comment leader. The offset begins
1609 from a left alignment. See below for more details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001610
1611 -{digits}
1612 Like {digits} but reduce the indent. This only works when there is
1613 some indent for the start or end part that can be removed.
1614
1615When a string has none of the 'f', 's', 'm' or 'e' flags, Vim assumes the
1616comment string repeats at the start of each line. The flags field may be
1617empty.
1618
1619Any blank space in the text before and after the {string} is part of the
1620{string}, so do not include leading or trailing blanks unless the blanks are a
1621required part of the comment string.
1622
1623When one comment leader is part of another, specify the part after the whole.
1624For example, to include both "-" and "->", use >
1625 :set comments=f:->,f:-
1626
1627A three-piece comment must always be given as start,middle,end, with no other
1628parts in between. An example of a three-piece comment is >
1629 sr:/*,mb:*,ex:*/
1630for C-comments. To avoid recognizing "*ptr" as a comment, the middle string
1631includes the 'b' flag. For three-piece comments, Vim checks the text after
1632the start and middle strings for the end string. If Vim finds the end string,
1633the comment does not continue on the next line. Three-piece comments must
1634have a middle string because otherwise Vim can't recognize the middle lines.
1635
1636Notice the use of the "x" flag in the above three-piece comment definition.
1637When you hit Return in a C-comment, Vim will insert the middle comment leader
Bram Moolenaar446cb832008-06-24 21:56:24 +00001638for the new line: " * ". To close this comment you just have to type "/"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001639before typing anything else on the new line. This will replace the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001640middle-comment leader with the end-comment leader and apply any specified
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001641alignment, leaving just " */". There is no need to hit Backspace first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001642
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001643When there is a match with a middle part, but there also is a matching end
1644part which is longer, the end part is used. This makes a C style comment work
Bram Moolenaar446beb42011-05-10 17:18:44 +02001645without requiring the middle part to end with a space.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001646
1647Here is an example of alignment flags at work to make a comment stand out
Bram Moolenaar446beb42011-05-10 17:18:44 +02001648(kind of looks like a 1 too). Consider comment string: >
1649 :set comments=sr:/***,m:**,ex-2:******/
1650<
1651 /*** ~
1652 **<--right aligned from "r" flag ~
1653 ** ~
1654offset 2 spaces for the "-2" flag--->** ~
1655 ******/ ~
Bram Moolenaar446cb832008-06-24 21:56:24 +00001656In this case, the first comment was typed, then return was pressed 4 times,
1657then "/" was pressed to end the comment.
1658
1659Here are some finer points of three part comments. There are three times when
1660alignment and offset flags are taken into consideration: opening a new line
1661after a start-comment, opening a new line before an end-comment, and
1662automatically ending a three-piece comment. The end alignment flag has a
1663backwards perspective; the result is that the same alignment flag used with
1664"s" and "e" will result in the same indent for the starting and ending pieces.
1665Only one alignment per comment part is meant to be used, but an offset number
1666will override the "r" and "l" flag.
1667
1668Enabling 'cindent' will override the alignment flags in many cases.
1669Reindenting using a different method like |gq| or |=| will not consult
1670alignment flags either. The same behaviour can be defined in those other
1671formatting options. One consideration is that 'cindent' has additional options
1672for context based indenting of comments but cannot replicate many three piece
Bram Moolenaar446beb42011-05-10 17:18:44 +02001673indent alignments. However, 'indentexpr' has the ability to work better with
1674three piece comments.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001675
1676Other examples: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001677 "b:*" Includes lines starting with "*", but not if the "*" is
1678 followed by a non-blank. This avoids a pointer dereference
1679 like "*str" to be recognized as a comment.
1680 "n:>" Includes a line starting with ">", ">>", ">>>", etc.
1681 "fb:-" Format a list that starts with "- ".
1682
1683By default, "b:#" is included. This means that a line that starts with
1684"#include" is not recognized as a comment line. But a line that starts with
1685"# define" is recognized. This is a compromise.
1686
Bram Moolenaar071d4272004-06-13 20:20:40 +00001687 *fo-table*
1688You can use the 'formatoptions' option to influence how Vim formats text.
1689'formatoptions' is a string that can contain any of the letters below. The
1690default setting is "tcq". You can separate the option letters with commas for
1691readability.
1692
1693letter meaning when present in 'formatoptions' ~
Bram Moolenaare0e39172021-01-25 21:14:57 +01001694 *fo-t*
Bram Moolenaar2bf875f2022-05-07 14:54:11 +01001695t Auto-wrap text using 'textwidth'
Bram Moolenaare0e39172021-01-25 21:14:57 +01001696 *fo-c*
Bram Moolenaar2bf875f2022-05-07 14:54:11 +01001697c Auto-wrap comments using 'textwidth', inserting the current comment
Bram Moolenaar071d4272004-06-13 20:20:40 +00001698 leader automatically.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001699 *fo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001700r Automatically insert the current comment leader after hitting
1701 <Enter> in Insert mode.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001702 *fo-o*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001703o Automatically insert the current comment leader after hitting 'o' or
Bram Moolenaar04fb9162021-12-30 20:24:12 +00001704 'O' in Normal mode. In case comment is unwanted in a specific place
1705 use CTRL-U to quickly delete it. |i_CTRL-U|
Bram Moolenaar2bf875f2022-05-07 14:54:11 +01001706 *fo-/*
1707/ When 'o' is included: do not insert the comment leader for a //
1708 comment after a statement, only when // is at the start of the line.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001709 *fo-q*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001710q Allow formatting of comments with "gq".
1711 Note that formatting will not change blank lines or lines containing
1712 only the comment leader. A new paragraph starts after such a line,
1713 or when the comment leader changes.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001714 *fo-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001715w Trailing white space indicates a paragraph continues in the next line.
1716 A line that ends in a non-white character ends a paragraph.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001717 *fo-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001718a Automatic formatting of paragraphs. Every time text is inserted or
1719 deleted the paragraph will be reformatted. See |auto-format|.
1720 When the 'c' flag is present this only happens for recognized
1721 comments.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001722 *fo-n*
Bram Moolenaar86b68352004-12-27 21:59:20 +00001723n When formatting text, recognize numbered lists. This actually uses
1724 the 'formatlistpat' option, thus any kind of list can be used. The
1725 indent of the text after the number is used for the next line. The
Bram Moolenaar446cb832008-06-24 21:56:24 +00001726 default is to find a number, optionally followed by '.', ':', ')',
Bram Moolenaar86b68352004-12-27 21:59:20 +00001727 ']' or '}'. Note that 'autoindent' must be set too. Doesn't work
1728 well together with "2".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001729 Example: >
1730 1. the first item
1731 wraps
1732 2. the second item
Bram Moolenaare0e39172021-01-25 21:14:57 +01001733< *fo-2*
Bram Moolenaar071d4272004-06-13 20:20:40 +000017342 When formatting text, use the indent of the second line of a paragraph
1735 for the rest of the paragraph, instead of the indent of the first
1736 line. This supports paragraphs in which the first line has a
1737 different indent than the rest. Note that 'autoindent' must be set
1738 too. Example: >
1739 first line of a paragraph
1740 second line of the same paragraph
1741 third line.
Bram Moolenaar30b65812012-07-12 22:01:11 +02001742< This also works inside comments, ignoring the comment leader.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001743 *fo-v*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744v Vi-compatible auto-wrapping in insert mode: Only break a line at a
1745 blank that you have entered during the current insert command. (Note:
1746 this is not 100% Vi compatible. Vi has some "unexpected features" or
1747 bugs in this area. It uses the screen column instead of the line
1748 column.)
Bram Moolenaare0e39172021-01-25 21:14:57 +01001749 *fo-b*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001750b Like 'v', but only auto-wrap if you enter a blank at or before
1751 the wrap margin. If the line was longer than 'textwidth' when you
1752 started the insert, or you do not enter a blank in the insert before
1753 reaching 'textwidth', Vim does not perform auto-wrapping.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001754 *fo-l*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001755l Long lines are not broken in insert mode: When a line was longer than
1756 'textwidth' when the insert command started, Vim does not
1757 automatically format it.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001758 *fo-m*
Bram Moolenaar207f0092020-08-30 17:20:20 +02001759m Also break at a multibyte character above 255. This is useful for
Bram Moolenaar071d4272004-06-13 20:20:40 +00001760 Asian text where every character is a word on its own.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001761 *fo-M*
Bram Moolenaar207f0092020-08-30 17:20:20 +02001762M When joining lines, don't insert a space before or after a multibyte
Bram Moolenaar071d4272004-06-13 20:20:40 +00001763 character. Overrules the 'B' flag.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001764 *fo-B*
Bram Moolenaar207f0092020-08-30 17:20:20 +02001765B When joining lines, don't insert a space between two multibyte
Bram Moolenaar071d4272004-06-13 20:20:40 +00001766 characters. Overruled by the 'M' flag.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001767 *fo-1*
Bram Moolenaar071d4272004-06-13 20:20:40 +000017681 Don't break a line after a one-letter word. It's broken before it
1769 instead (if possible).
Bram Moolenaare0e39172021-01-25 21:14:57 +01001770 *fo-]*
Bram Moolenaar2bf875f2022-05-07 14:54:11 +01001771] Respect 'textwidth' rigorously. With this flag set, no line can be
1772 longer than 'textwidth', unless line-break-prohibition rules make this
Bram Moolenaare52702f2020-06-04 18:22:13 +02001773 impossible. Mainly for CJK scripts and works only if 'encoding' is
1774 "utf-8".
Bram Moolenaare0e39172021-01-25 21:14:57 +01001775 *fo-j*
Bram Moolenaar81340392012-06-06 16:12:59 +02001776j Where it makes sense, remove a comment leader when joining lines. For
1777 example, joining:
1778 int i; // the index ~
1779 // in the list ~
1780 Becomes:
1781 int i; // the index in the list ~
Bram Moolenaare0e39172021-01-25 21:14:57 +01001782 *fo-p*
Bram Moolenaarc3c31582019-01-11 22:15:05 +01001783p Don't break lines at single spaces that follow periods. This is
1784 intended to complement 'joinspaces' and |cpo-J|, for prose with
1785 sentences separated by two spaces. For example, with 'textwidth' set
1786 to 28: >
1787 Surely you're joking, Mr. Feynman!
1788< Becomes: >
1789 Surely you're joking,
1790 Mr. Feynman!
1791< Instead of: >
1792 Surely you're joking, Mr.
1793 Feynman!
Bram Moolenaar071d4272004-06-13 20:20:40 +00001794
1795
1796With 't' and 'c' you can specify when Vim performs auto-wrapping:
1797value action ~
1798"" no automatic formatting (you can use "gq" for manual formatting)
1799"t" automatic formatting of text, but not comments
1800"c" automatic formatting for comments, but not text (good for C code)
1801"tc" automatic formatting for text and comments
1802
Bram Moolenaar91170f82006-05-05 21:15:17 +00001803Note that when 'textwidth' is 0, Vim does no automatic formatting anyway (but
1804does insert comment leaders according to the 'comments' option). An exception
1805is when the 'a' flag is present. |auto-format|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001806
1807Note that when 'paste' is on, Vim does no formatting at all.
1808
1809Note that 'textwidth' can be non-zero even if Vim never performs auto-wrapping;
1810'textwidth' is still useful for formatting with "gq".
1811
1812If the 'comments' option includes "/*", "*" and/or "*/", then Vim has some
1813built in stuff to treat these types of comments a bit more cleverly.
1814Opening a new line before or after "/*" or "*/" (with 'r' or 'o' present in
1815'formatoptions') gives the correct start of the line automatically. The same
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001816happens with formatting and auto-wrapping. Opening a line after a line
Bram Moolenaar071d4272004-06-13 20:20:40 +00001817starting with "/*" or "*" and containing "*/", will cause no comment leader to
1818be inserted, and the indent of the new line is taken from the line containing
1819the start of the comment.
1820E.g.:
1821 /* ~
1822 * Your typical comment. ~
1823 */ ~
1824 The indent on this line is the same as the start of the above
1825 comment.
1826
1827All of this should be really cool, especially in conjunction with the new
1828:autocmd command to prepare different settings for different types of file.
1829
1830Some examples:
1831 for C code (only format comments): >
1832 :set fo=croq
1833< for Mail/news (format all, don't start comment with "o" command): >
1834 :set fo=tcrq
1835<
1836
Bram Moolenaard38b0552012-04-25 19:07:41 +02001837Automatic formatting *auto-format* *autoformat*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838
1839When the 'a' flag is present in 'formatoptions' text is formatted
Bram Moolenaar2547aa92020-07-26 17:00:44 +02001840automatically when inserting text or deleting text. This works nicely for
Bram Moolenaar071d4272004-06-13 20:20:40 +00001841editing text paragraphs. A few hints on how to use this:
1842
1843- You need to properly define paragraphs. The simplest is paragraphs that are
1844 separated by a blank line. When there is no separating blank line, consider
1845 using the 'w' flag and adding a space at the end of each line in the
1846 paragraphs except the last one.
1847
1848- You can set the 'formatoptions' based on the type of file |filetype| or
1849 specifically for one file with a |modeline|.
1850
1851- Set 'formatoptions' to "aw2tq" to make text with indents like this:
1852
Bram Moolenaardd60c362023-02-27 15:49:53 +00001853 bla bla foobar bla
Bram Moolenaar071d4272004-06-13 20:20:40 +00001854 bla foobar bla foobar bla
Bram Moolenaardd60c362023-02-27 15:49:53 +00001855 bla bla foobar bla
Bram Moolenaar071d4272004-06-13 20:20:40 +00001856 bla foobar bla bla foobar
1857
1858- Add the 'c' flag to only auto-format comments. Useful in source code.
1859
Bram Moolenaar91170f82006-05-05 21:15:17 +00001860- Set 'textwidth' to the desired width. If it is zero then 79 is used, or the
1861 width of the screen if this is smaller.
1862
Bram Moolenaar071d4272004-06-13 20:20:40 +00001863And a few warnings:
1864
1865- When part of the text is not properly separated in paragraphs, making
1866 changes in this text will cause it to be formatted anyway. Consider doing >
1867
1868 :set fo-=a
1869
1870- When using the 'w' flag (trailing space means paragraph continues) and
1871 deleting the last line of a paragraph with |dd|, the paragraph will be
1872 joined with the next one.
1873
1874- Changed text is saved for undo. Formatting is also a change. Thus each
1875 format action saves text for undo. This may consume quite a lot of memory.
1876
1877- Formatting a long paragraph and/or with complicated indenting may be slow.
1878
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00001879==============================================================================
18807. Sorting text *sorting*
1881
1882Vim has a sorting function and a sorting command. The sorting function can be
Bram Moolenaar327aa022014-03-25 18:24:23 +01001883found here: |sort()|, |uniq()|.
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00001884
1885 *:sor* *:sort*
Bram Moolenaar55e29612020-11-01 13:57:44 +01001886:[range]sor[t][!] [b][f][i][l][n][o][r][u][x] [/{pattern}/]
Bram Moolenaare5180522005-12-10 20:19:46 +00001887 Sort lines in [range]. When no range is given all
1888 lines are sorted.
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00001889
1890 With [!] the order is reversed.
1891
1892 With [i] case is ignored.
1893
Bram Moolenaar3132cdd2020-11-05 20:41:49 +01001894 With [l] sort uses the current collation locale.
1895 Implementation details: strcoll() is used to compare
1896 strings. See |:language| to check or set the collation
1897 locale. Example: >
1898 :language collate en_US.UTF-8
1899 :%sort l
1900< |v:collate| can also used to check the current locale.
1901 Sorting using the locale typically ignores case.
1902 This does not work properly on Mac.
Bram Moolenaar55e29612020-11-01 13:57:44 +01001903
Bram Moolenaarf7edf402016-01-19 23:36:15 +01001904 Options [n][f][x][o][b] are mutually exclusive.
1905
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001906 With [n] sorting is done on the first decimal number
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00001907 in the line (after or inside a {pattern} match).
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001908 One leading '-' is included in the number.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001909
Bram Moolenaarf7edf402016-01-19 23:36:15 +01001910 With [f] sorting is done on the Float in the line.
1911 The value of Float is determined similar to passing
1912 the text (after or inside a {pattern} match) to
1913 str2float() function. This option is available only
1914 if Vim was compiled with Floating point support.
1915
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001916 With [x] sorting is done on the first hexadecimal
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00001917 number in the line (after or inside a {pattern}
1918 match). A leading "0x" or "0X" is ignored.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001919 One leading '-' is included in the number.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001920
1921 With [o] sorting is done on the first octal number in
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00001922 the line (after or inside a {pattern} match).
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001923
Bram Moolenaar887c1fe2016-01-02 17:56:35 +01001924 With [b] sorting is done on the first binary number in
1925 the line (after or inside a {pattern} match).
1926
Bram Moolenaarf7edf402016-01-19 23:36:15 +01001927 With [u] (u stands for unique) only keep the first of
1928 a sequence of identical lines (ignoring case when [i]
1929 is used). Without this flag, a sequence of identical
1930 lines will be kept in their original order.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001931 Note that leading and trailing white space may cause
1932 lines to be different.
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00001933
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00001934 When /{pattern}/ is specified and there is no [r] flag
1935 the text matched with {pattern} is skipped, so that
1936 you sort on what comes after the match.
Bram Moolenaar4466ad62020-11-21 13:16:30 +01001937 'ignorecase' applies to the pattern, but 'smartcase'
1938 is not used.
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00001939 Instead of the slash any non-letter can be used.
1940 For example, to sort on the second comma-separated
1941 field: >
1942 :sort /[^,]*,/
1943< To sort on the text at virtual column 10 (thus
1944 ignoring the difference between tabs and spaces): >
1945 :sort /.*\%10v/
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001946< To sort on the first number in the line, no matter
1947 what is in front of it: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00001948 :sort /.\{-}\ze\d/
1949< (Explanation: ".\{-}" matches any text, "\ze" sets the
1950 end of the match and \d matches a digit.)
1951 With [r] sorting is done on the matching {pattern}
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00001952 instead of skipping past it as described above.
1953 For example, to sort on only the first three letters
1954 of each line: >
1955 :sort /\a\a\a/ r
1956
1957< If a {pattern} is used, any lines which don't have a
1958 match for {pattern} are kept in their current order,
1959 but separate from the lines which do match {pattern}.
1960 If you sorted in reverse, they will be in reverse
1961 order after the sorted lines, otherwise they will be
1962 in their original order, right before the sorted
1963 lines.
1964
Bram Moolenaar1256e722007-07-10 15:26:20 +00001965 If {pattern} is empty (e.g. // is specified), the
1966 last search pattern is used. This allows trying out
1967 a pattern first.
1968
Bram Moolenaard38b0552012-04-25 19:07:41 +02001969Note that using `:sort` with `:global` doesn't sort the matching lines, it's
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001970quite useless.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001971
Bram Moolenaar55e29612020-11-01 13:57:44 +01001972`:sort` does not use the current locale unless the l flag is used.
Bram Moolenaar8bb1c3e2014-07-04 16:43:17 +02001973Vim does do a "stable" sort.
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00001974
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00001975The sorting can be interrupted, but if you interrupt it too late in the
1976process you may end up with duplicated lines. This also depends on the system
1977library function used.
Bram Moolenaarae5bce12005-08-15 21:41:48 +00001978
Bram Moolenaar91f84f62018-07-29 15:07:52 +02001979 vim:tw=78:ts=8:noet:ft=help:norl: