blob: 4fc20cae4f1f06408e20257f2496f8060f4f5d84 [file] [log] [blame]
Bram Moolenaardd60c362023-02-27 15:49:53 +00001*change.txt* For Vim version 9.0. Last change: 2023 Feb 27
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 Moolenaar071d4272004-06-13 20:20:40 +0000458The CTRL-A command is very useful in a macro. Example: Use the following
459steps to make a numbered list.
460
4611. Create the first list entry, make sure it starts with a number.
Bram Moolenaard8b02732005-01-14 21:48:43 +00004622. qa - start recording into register 'a'
Bram Moolenaar071d4272004-06-13 20:20:40 +00004633. Y - yank the entry
4644. p - put a copy of the entry below the first one
4655. CTRL-A - increment the number
4666. q - stop recording
4677. <count>@a - repeat the yank, put and increment <count> times
468
469
470SHIFTING LINES LEFT OR RIGHT *shift-left-right*
471
472 *<*
473<{motion} Shift {motion} lines one 'shiftwidth' leftwards.
474
Bram Moolenaarf9514162018-11-22 03:08:29 +0100475 If the 'vartabstop' feature is enabled, and the
476 'shiftwidth' option is set to zero, the amount of
477 indent is calculated at the first non-blank character
478 in the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000479 *<<*
480<< Shift [count] lines one 'shiftwidth' leftwards.
481
482 *v_<*
483{Visual}[count]< Shift the highlighted lines [count] 'shiftwidth'
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200484 leftwards (for {Visual} see |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000485
486 *>*
487 >{motion} Shift {motion} lines one 'shiftwidth' rightwards.
488
Bram Moolenaarf9514162018-11-22 03:08:29 +0100489 If the 'vartabstop' feature is enabled, and the
490 'shiftwidth' option is set to zero, the amount of
491 indent is calculated at the first non-blank character
492 in the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000493 *>>*
494 >> Shift [count] lines one 'shiftwidth' rightwards.
495
496 *v_>*
497{Visual}[count]> Shift the highlighted lines [count] 'shiftwidth'
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200498 rightwards (for {Visual} see |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000499
500 *:<*
501:[range]< Shift [range] lines one 'shiftwidth' left. Repeat '<'
502 for shifting multiple 'shiftwidth's.
503
504:[range]< {count} Shift {count} lines one 'shiftwidth' left, starting
505 with [range] (default current line |cmdline-ranges|).
506 Repeat '<' for shifting multiple 'shiftwidth's.
507
508:[range]le[ft] [indent] left align lines in [range]. Sets the indent in the
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200509 lines to [indent] (default 0).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000510
511 *:>*
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000512:[range]> [flags] Shift {count} [range] lines one 'shiftwidth' right.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000513 Repeat '>' for shifting multiple 'shiftwidth's.
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000514 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000515
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000516:[range]> {count} [flags]
517 Shift {count} lines one 'shiftwidth' right, starting
Bram Moolenaar071d4272004-06-13 20:20:40 +0000518 with [range] (default current line |cmdline-ranges|).
519 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
522The ">" and "<" commands are handy for changing the indentation within
523programs. Use the 'shiftwidth' option to set the size of the white space
524which these commands insert or delete. Normally the 'shiftwidth' option is 8,
525but you can set it to, say, 3 to make smaller indents. The shift leftwards
526stops when there is no indent. The shift right does not affect empty lines.
527
528If the 'shiftround' option is on, the indent is rounded to a multiple of
529'shiftwidth'.
530
531If the 'smartindent' option is on, or 'cindent' is on and 'cinkeys' contains
Bram Moolenaar8e69b4a2013-11-09 03:41:58 +0100532'#' with a zero value, shift right does not affect lines starting with '#'
533(these are supposed to be C preprocessor lines that must stay in column 1).
Bram Moolenaar7dda86f2018-04-20 22:36:41 +0200534This can be changed with the 'cino' option, see |cino-#|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000535
536When the 'expandtab' option is off (this is the default) Vim uses <Tab>s as
537much as possible to make the indent. You can use ">><<" to replace an indent
538made out of spaces with the same indent made out of <Tab>s (and a few spaces
539if necessary). If the 'expandtab' option is on, Vim uses only spaces. Then
540you can use ">><<" to replace <Tab>s in the indent by spaces (or use
Bram Moolenaard38b0552012-04-25 19:07:41 +0200541`:retab!`).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000542
Bram Moolenaard38b0552012-04-25 19:07:41 +0200543To move a line several 'shiftwidth's, use Visual mode or the `:` commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000544For example: >
545 Vjj4> move three lines 4 indents to the right
546 :<<< move current line 3 indents to the left
547 :>> 5 move 5 lines 2 indents to the right
548 :5>> move line 5 2 indents to the right
549
550==============================================================================
5514. Complex changes *complex-change*
552
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00005534.1 Filter commands *filter*
Bram Moolenaar47136d72004-10-12 20:02:24 +0000554
555A filter is a program that accepts text at standard input, changes it in some
556way, and sends it to standard output. You can use the commands below to send
Bram Moolenaar446cb832008-06-24 21:56:24 +0000557some text through a filter, so that it is replaced by the filter output.
Bram Moolenaar47136d72004-10-12 20:02:24 +0000558Examples of filters are "sort", which sorts lines alphabetically, and
559"indent", which formats C program files (you need a version of indent that
560works like a filter; not all versions do). The 'shell' option specifies the
561shell Vim uses to execute the filter command (See also the 'shelltype'
562option). You can repeat filter commands with ".". Vim does not recognize a
Bram Moolenaard38b0552012-04-25 19:07:41 +0200563comment (starting with '"') after the `:!` command.
Bram Moolenaar47136d72004-10-12 20:02:24 +0000564
565 *!*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000566!{motion}{filter} Filter {motion} text lines through the external
567 program {filter}.
568
569 *!!*
570!!{filter} Filter [count] lines through the external program
571 {filter}.
572
573 *v_!*
574{Visual}!{filter} Filter the highlighted lines through the external
575 program {filter} (for {Visual} see |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000576
577:{range}![!]{filter} [!][arg] *:range!*
578 Filter {range} lines through the external program
579 {filter}. Vim replaces the optional bangs with the
580 latest given command and appends the optional [arg].
581 Vim saves the output of the filter command in a
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100582 temporary file and then reads the file into the buffer
583 |tempfile|. Vim uses the 'shellredir' option to
584 redirect the filter output to the temporary file.
Bram Moolenaar83c465c2005-12-16 21:53:56 +0000585 However, if the 'shelltemp' option is off then pipes
586 are used when possible (on Unix).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000587 When the 'R' flag is included in 'cpoptions' marks in
588 the filtered lines are deleted, unless the
589 |:keepmarks| command is used. Example: >
590 :keepmarks '<,'>!sort
591< When the number of lines after filtering is less than
592 before, marks in the missing lines are deleted anyway.
593
594 *=*
595={motion} Filter {motion} lines through the external program
596 given with the 'equalprg' option. When the 'equalprg'
597 option is empty (this is the default), use the
Bram Moolenaar20f90cf2011-05-19 12:22:51 +0200598 internal formatting function |C-indenting| and
599 |'lisp'|. But when 'indentexpr' is not empty, it will
600 be used instead |indent-expression|. When Vim was
601 compiled without internal formatting then the "indent"
602 program is used as a last resort.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000603
604 *==*
605== Filter [count] lines like with ={motion}.
606
607 *v_=*
608{Visual}= Filter the highlighted lines like with ={motion}.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000609
Bram Moolenaar071d4272004-06-13 20:20:40 +0000610
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100611 *tempfile* *setuid*
612Vim uses temporary files for filtering, generating diffs and also for
613tempname(). For Unix, the file will be in a private directory (only
614accessible by the current user) to avoid security problems (e.g., a symlink
615attack or other people reading your file). When Vim exits the directory and
616all files in it are deleted. When Vim has the setuid bit set this may cause
617problems, the temp file is owned by the setuid user but the filter command
618probably runs as the original user.
Bram Moolenaar75ab5902022-04-18 15:36:40 +0100619Directory for temporary files is created in the first of these directories
620that works:
621 Unix: $TMPDIR, /tmp, current-dir, $HOME.
622 Windows: $TMP, $TEMP, c:\TMP, c:\TEMP
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100623For MS-Windows the GetTempFileName() system function is used.
624For other systems the tmpnam() library function is used.
625
626
627
Bram Moolenaar47136d72004-10-12 20:02:24 +00006284.2 Substitute *:substitute*
629 *:s* *:su*
Bram Moolenaar05159a02005-02-26 23:04:13 +0000630:[range]s[ubstitute]/{pattern}/{string}/[flags] [count]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000631 For each line in [range] replace a match of {pattern}
632 with {string}.
633 For the {pattern} see |pattern|.
634 {string} can be a literal string, or something
635 special; see |sub-replace-special|.
636 When [range] and [count] are omitted, replace in the
Bram Moolenaar3df01732017-02-17 22:47:16 +0100637 current line only. When [count] is given, replace in
638 [count] lines, starting with the last line in [range].
639 When [range] is omitted start in the current line.
Bram Moolenaar4c92e752019-02-17 21:18:32 +0100640 *E939*
Bram Moolenaar3df01732017-02-17 22:47:16 +0100641 [count] must be a positive number. Also see
642 |cmdline-ranges|.
643
Bram Moolenaar05159a02005-02-26 23:04:13 +0000644 See |:s_flags| for [flags].
Bram Moolenaarebdf3c92020-02-15 21:41:42 +0100645 The delimiter doesn't need to be /, see
646 |pattern-delimiter|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000647
Bram Moolenaar05159a02005-02-26 23:04:13 +0000648:[range]s[ubstitute] [flags] [count]
649:[range]&[&][flags] [count] *:&*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000650 Repeat last :substitute with same search pattern and
651 substitute string, but without the same flags. You
Bram Moolenaar05159a02005-02-26 23:04:13 +0000652 may add [flags], see |:s_flags|.
Bram Moolenaard38b0552012-04-25 19:07:41 +0200653 Note that after `:substitute` the '&' flag can't be
Bram Moolenaar071d4272004-06-13 20:20:40 +0000654 used, it's recognized as a pattern separator.
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200655 The space between `:substitute` and the 'c', 'g',
656 'i', 'I' and 'r' flags isn't required, but in scripts
657 it's a good idea to keep it to avoid confusion.
Bram Moolenaarc8cdf0f2021-03-13 13:28:13 +0100658 Also see the two and three letter commands to repeat
659 :substitute below |:substitute-repeat|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000660
Bram Moolenaar05159a02005-02-26 23:04:13 +0000661:[range]~[&][flags] [count] *:~*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000662 Repeat last substitute with same substitute string
663 but with last used search pattern. This is like
Bram Moolenaard38b0552012-04-25 19:07:41 +0200664 `:&r`. See |:s_flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000665
Bram Moolenaar05159a02005-02-26 23:04:13 +0000666 *&*
Bram Moolenaard38b0552012-04-25 19:07:41 +0200667& Synonym for `:s` (repeat last substitute). Note
Bram Moolenaar071d4272004-06-13 20:20:40 +0000668 that the flags are not remembered, thus it might
Bram Moolenaard38b0552012-04-25 19:07:41 +0200669 actually work differently. You can use `:&&` to keep
Bram Moolenaar071d4272004-06-13 20:20:40 +0000670 the flags.
671
Bram Moolenaar05159a02005-02-26 23:04:13 +0000672 *g&*
Bram Moolenaar97d62492012-11-15 21:28:22 +0100673g& Synonym for `:%s//~/&` (repeat last substitute with
674 last search pattern on all lines with the same flags).
Bram Moolenaar34700a62013-03-07 13:20:54 +0100675 For example, when you first do a substitution with
Bram Moolenaar97d62492012-11-15 21:28:22 +0100676 `:s/pattern/repl/flags` and then `/search` for
677 something else, `g&` will do `:%s/search/repl/flags`.
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200678 Mnemonic: global substitute.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000679
680 *:snomagic* *:sno*
Bram Moolenaard38b0552012-04-25 19:07:41 +0200681:[range]sno[magic] ... Same as `:substitute`, but always use 'nomagic'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000682
683 *:smagic* *:sm*
Bram Moolenaard38b0552012-04-25 19:07:41 +0200684:[range]sm[agic] ... Same as `:substitute`, but always use 'magic'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000685
686 *:s_flags*
687The flags that you can use for the substitute commands:
688
Bram Moolenaar51628222016-12-01 23:03:28 +0100689 *:&&*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000690[&] Must be the first one: Keep the flags from the previous substitute
691 command. Examples: >
692 :&&
693 :s/this/that/&
Bram Moolenaard38b0552012-04-25 19:07:41 +0200694< Note that `:s` and `:&` don't keep the flags.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695
696[c] Confirm each substitution. Vim highlights the matching string (with
697 |hl-IncSearch|). You can type: *:s_c*
698 'y' to substitute this match
699 'l' to substitute this match and then quit ("last")
700 'n' to skip this match
701 <Esc> to quit substituting
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200702 'a' to substitute this and all remaining matches
703 'q' to quit substituting
Bram Moolenaare2c453d2019-08-21 14:37:09 +0200704 CTRL-E to scroll the screen up
705 CTRL-Y to scroll the screen down
Bram Moolenaar071d4272004-06-13 20:20:40 +0000706 If the 'edcompatible' option is on, Vim remembers the [c] flag and
707 toggles it each time you use it, but resets it when you give a new
708 search pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000709
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200710 *:s_e*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000711[e] When the search pattern fails, do not issue an error message and, in
712 particular, continue in maps as if no error occurred. This is most
713 useful to prevent the "No match" error from breaking a mapping. Vim
714 does not suppress the following error messages, however:
715 Regular expressions can't be delimited by letters
716 \ should be followed by /, ? or &
717 No previous substitute regular expression
718 Trailing characters
719 Interrupted
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200721 *:s_g*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000722[g] Replace all occurrences in the line. Without this argument,
723 replacement occurs only for the first occurrence in each line. If
724 the 'edcompatible' option is on, Vim remembers this flag and toggles
725 it each time you use it, but resets it when you give a new search
726 pattern. If the 'gdefault' option is on, this flag is on by default
727 and the [g] argument switches it off.
728
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200729 *:s_i*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000730[i] Ignore case for the pattern. The 'ignorecase' and 'smartcase' options
731 are not used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000732
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200733 *:s_I*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000734[I] Don't ignore case for the pattern. The 'ignorecase' and 'smartcase'
735 options are not used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000736
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200737 *:s_n*
Bram Moolenaar05159a02005-02-26 23:04:13 +0000738[n] Report the number of matches, do not actually substitute. The [c]
739 flag is ignored. The matches are reported as if 'report' is zero.
740 Useful to |count-items|.
Bram Moolenaar9b451252012-08-15 17:43:31 +0200741 If \= |sub-replace-expression| is used, the expression will be
742 evaluated in the |sandbox| at every match.
Bram Moolenaar05159a02005-02-26 23:04:13 +0000743
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200744[p] Print the line containing the last substitute. *:s_p*
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000745
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200746[#] Like [p] and prepend the line number. *:s_#*
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000747
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200748[l] Like [p] but print the text like |:list|. *:s_l*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000749
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200750 *:s_r*
Bram Moolenaard38b0552012-04-25 19:07:41 +0200751[r] Only useful in combination with `:&` or `:s` without arguments. `:&r`
752 works the same way as `:~`: When the search pattern is empty, use the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000753 previously used search pattern instead of the search pattern from the
Bram Moolenaard38b0552012-04-25 19:07:41 +0200754 last substitute or `:global`. If the last command that did a search
755 was a substitute or `:global`, there is no effect. If the last
Bram Moolenaar071d4272004-06-13 20:20:40 +0000756 command was a search command such as "/", use the pattern from that
757 command.
Bram Moolenaard38b0552012-04-25 19:07:41 +0200758 For `:s` with an argument this already happens: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000759 :s/blue/red/
760 /green
761 :s//red/ or :~ or :&r
762< The last commands will replace "green" with "red". >
763 :s/blue/red/
764 /green
765 :&
766< The last command will replace "blue" with "red".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000767
768Note that there is no flag to change the "magicness" of the pattern. A
Bram Moolenaar446cb832008-06-24 21:56:24 +0000769different command is used instead, or you can use |/\v| and friends. The
770reason is that the flags can only be found by skipping the pattern, and in
771order to skip the pattern the "magicness" must be known. Catch 22!
Bram Moolenaar071d4272004-06-13 20:20:40 +0000772
773If the {pattern} for the substitute command is empty, the command uses the
Bram Moolenaard38b0552012-04-25 19:07:41 +0200774pattern from the last substitute or `:global` command. If there is none, but
Bram Moolenaar662db672011-03-22 14:05:35 +0100775there is a previous search pattern, that one is used. With the [r] flag, the
Bram Moolenaard38b0552012-04-25 19:07:41 +0200776command uses the pattern from the last substitute, `:global`, or search
Bram Moolenaar071d4272004-06-13 20:20:40 +0000777command.
778
Bram Moolenaar9964e462007-05-05 17:54:07 +0000779If the {string} is omitted the substitute is done as if it's empty. Thus the
780matched pattern is deleted. The separator after {pattern} can also be left
781out then. Example: >
782 :%s/TESTING
783This deletes "TESTING" from all lines, but only one per line.
Bram Moolenaar1588bc82022-03-08 21:35:07 +0000784 *E1270*
785For compatibility with Vi these two exceptions are allowed in legacy script:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000786"\/{string}/" and "\?{string}?" do the same as "//{string}/r".
787"\&{string}&" does the same as "//{string}/".
Bram Moolenaara2baa732022-02-04 16:09:54 +0000788 *pattern-delimiter* *E146* *E1241* *E1242*
Bram Moolenaar4d8f4762021-06-27 15:18:56 +0200789Instead of the '/' which surrounds the pattern and replacement string, you can
790use another single-byte character. This is useful if you want to include a
791'/' in the search pattern or replacement string. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000792 :s+/+//+
793
Bram Moolenaar4d8f4762021-06-27 15:18:56 +0200794You can use most characters, but not an alphanumeric character, '\', '"' or
795'|'. In Vim9 script you should not use '#' because it may be recognized as
796the start of a comment.
797
Bram Moolenaar446cb832008-06-24 21:56:24 +0000798For the definition of a pattern, see |pattern|. In Visual block mode, use
799|/\%V| in the pattern to have the substitute work in the block only.
800Otherwise it works on whole lines anyway.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801
802 *sub-replace-special* *:s\=*
803When the {string} starts with "\=" it is evaluated as an expression, see
Bram Moolenaar251e1912011-06-19 05:09:16 +0200804|sub-replace-expression|. You can use that for complex replacement or special
805characters.
806
Bram Moolenaar2ecbe532022-07-29 21:36:21 +0100807The substitution is limited in recursion to 4 levels. *E1290*
808
Bram Moolenaar5a8684e2005-07-30 22:43:24 +0000809Otherwise these characters in {string} have a special meaning:
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000810 *:s%*
Bram Moolenaar551dbcc2006-04-25 22:13:59 +0000811When {string} is equal to "%" and '/' is included with the 'cpoptions' option,
Bram Moolenaar251e1912011-06-19 05:09:16 +0200812then the {string} of the previous substitute command is used, see |cpo-/|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000813
814magic nomagic action ~
815 & \& replaced with the whole matched pattern *s/\&*
816 \& & replaced with &
817 \0 replaced with the whole matched pattern *\0* *s/\0*
818 \1 replaced with the matched pattern in the first
819 pair of () *s/\1*
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +0000820 \2 replaced with the matched pattern in the second
Bram Moolenaar071d4272004-06-13 20:20:40 +0000821 pair of () *s/\2*
822 .. .. *s/\3*
823 \9 replaced with the matched pattern in the ninth
824 pair of () *s/\9*
825 ~ \~ replaced with the {string} of the previous
826 substitute *s~*
827 \~ ~ replaced with ~ *s/\~*
828 \u next character made uppercase *s/\u*
829 \U following characters made uppercase, until \E *s/\U*
830 \l next character made lowercase *s/\l*
831 \L following characters made lowercase, until \E *s/\L*
832 \e end of \u, \U, \l and \L (NOTE: not <Esc>!) *s/\e*
833 \E end of \u, \U, \l and \L *s/\E*
834 <CR> split line in two at this point
835 (Type the <CR> as CTRL-V <Enter>) *s<CR>*
836 \r idem *s/\r*
837 \<CR> insert a carriage-return (CTRL-M)
838 (Type the <CR> as CTRL-V <Enter>) *s/\<CR>*
839 \n insert a <NL> (<NUL> in the file)
840 (does NOT break the line) *s/\n*
841 \b insert a <BS> *s/\b*
842 \t insert a <Tab> *s/\t*
843 \\ insert a single backslash *s/\\*
844 \x where x is any character not mentioned above:
845 Reserved for future expansion
846
Bram Moolenaar251e1912011-06-19 05:09:16 +0200847The special meaning is also used inside the third argument {sub} of
848the |substitute()| function with the following exceptions:
849 - A % inserts a percent literally without regard to 'cpoptions'.
850 - magic is always set without regard to 'magic'.
851 - A ~ inserts a tilde literally.
852 - <CR> and \r inserts a carriage-return (CTRL-M).
Bram Moolenaarba3ff532018-11-04 14:45:49 +0100853 - \<CR> does not have a special meaning. It's just one of \x.
Bram Moolenaar251e1912011-06-19 05:09:16 +0200854
Bram Moolenaar071d4272004-06-13 20:20:40 +0000855Examples: >
856 :s/a\|b/xxx\0xxx/g modifies "a b" to "xxxaxxx xxxbxxx"
857 :s/\([abc]\)\([efg]\)/\2\1/g modifies "af fa bg" to "fa fa gb"
858 :s/abcde/abc^Mde/ modifies "abcde" to "abc", "de" (two lines)
859 :s/$/\^M/ modifies "abcde" to "abcde^M"
Bram Moolenaarefd2bf12006-03-16 21:41:35 +0000860 :s/\w\+/\u\0/g modifies "bla bla" to "Bla Bla"
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +0200861 :s/\w\+/\L\u\0/g modifies "BLA bla" to "Bla Bla"
Bram Moolenaarbf884932013-04-05 22:26:15 +0200862
863Note: "\L\u" can be used to capitalize the first letter of a word. This is
864not compatible with Vi and older versions of Vim, where the "\u" would cancel
865out the "\L". Same for "\U\l".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000866
867Note: In previous versions CTRL-V was handled in a special way. Since this is
868not Vi compatible, this was removed. Use a backslash instead.
869
870command text result ~
871:s/aa/a^Ma/ aa a<line-break>a
872:s/aa/a\^Ma/ aa a^Ma
873:s/aa/a\\^Ma/ aa a\<line-break>a
874
875(you need to type CTRL-V <CR> to get a ^M here)
876
877The numbering of "\1", "\2" etc. is done based on which "\(" comes first in
878the pattern (going left to right). When a parentheses group matches several
879times, the last one will be used for "\1", "\2", etc. Example: >
880 :s/\(\(a[a-d] \)*\)/\2/ modifies "aa ab x" to "ab x"
Bram Moolenaar7e1479b2016-09-11 15:07:27 +0200881The "\2" is for "\(a[a-d] \)". At first it matches "aa ", secondly "ab ".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000882
883When using parentheses in combination with '|', like in \([ab]\)\|\([cd]\),
884either the first or second pattern in parentheses did not match, so either
885\1 or \2 is empty. Example: >
886 :s/\([ab]\)\|\([cd]\)/\1x/g modifies "a b c d" to "ax bx x x"
887<
888
Bram Moolenaara0f849e2015-10-30 14:37:44 +0100889 *:sc* *:sce* *:scg* *:sci* *:scI* *:scl* *:scp* *:sg* *:sgc*
890 *:sge* *:sgi* *:sgI* *:sgl* *:sgn* *:sgp* *:sgr* *:sI* *:si*
891 *:sic* *:sIc* *:sie* *:sIe* *:sIg* *:sIl* *:sin* *:sIn* *:sIp*
892 *:sip* *:sIr* *:sir* *:sr* *:src* *:srg* *:sri* *:srI* *:srl*
Bram Moolenaarc8cdf0f2021-03-13 13:28:13 +0100893 *:srn* *:srp* *:substitute-repeat*
Bram Moolenaara0f849e2015-10-30 14:37:44 +01008942-letter and 3-letter :substitute commands ~
895
Bram Moolenaarc8cdf0f2021-03-13 13:28:13 +0100896These commands repeat the previous `:substitute` command with the given flags.
897The first letter is always "s", followed by one or two of the possible flag
898characters. For example `:sce` works like `:s///ce`. The table lists the
899possible combinations, not all flags are possible, because the command is
900short for another command.
901
Bram Moolenaara0f849e2015-10-30 14:37:44 +0100902 List of :substitute commands
903 | c e g i I n p l r
Bram Moolenaarc8cdf0f2021-03-13 13:28:13 +0100904 | c :sc :sce :scg :sci :scI :scn :scp :scl
Bram Moolenaara0f849e2015-10-30 14:37:44 +0100905 | e
906 | g :sgc :sge :sg :sgi :sgI :sgn :sgp :sgl :sgr
Bram Moolenaarc8cdf0f2021-03-13 13:28:13 +0100907 | i :sic :sie :si :siI :sin :sip :sir
Bram Moolenaara0f849e2015-10-30 14:37:44 +0100908 | I :sIc :sIe :sIg :sIi :sI :sIn :sIp :sIl :sIr
909 | n
910 | p
911 | l
Bram Moolenaarc8cdf0f2021-03-13 13:28:13 +0100912 | r :src :srg :sri :srI :srn :srp :srl :sr
Bram Moolenaara0f849e2015-10-30 14:37:44 +0100913
914Exceptions:
915 :scr is `:scriptnames`
916 :se is `:set`
917 :sig is `:sign`
918 :sil is `:silent`
919 :sn is `:snext`
920 :sp is `:split`
921 :sl is `:sleep`
922 :sre is `:srewind`
923
924
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925Substitute with an expression *sub-replace-expression*
Bram Moolenaar92dff182014-02-11 19:15:50 +0100926 *sub-replace-\=* *s/\=*
Bram Moolenaara7fc0102005-05-18 22:17:12 +0000927When the substitute string starts with "\=" the remainder is interpreted as an
Bram Moolenaar6100d022016-10-02 16:51:57 +0200928expression.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000929
930The special meaning for characters as mentioned at |sub-replace-special| does
Bram Moolenaar251e1912011-06-19 05:09:16 +0200931not apply except for "<CR>". A <NL> character is used as a line break, you
932can get one with a double-quote string: "\n". Prepend a backslash to get a
933real <NL> character (which will be a NUL in the file).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000934
Bram Moolenaar251e1912011-06-19 05:09:16 +0200935The "\=" notation can also be used inside the third argument {sub} of
936|substitute()| function. In this case, the special meaning for characters as
937mentioned at |sub-replace-special| does not apply at all. Especially, <CR> and
938<NL> are interpreted not as a line break but as a carriage-return and a
939new-line respectively.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000940
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000941When the result is a |List| then the items are joined with separating line
942breaks. Thus each item becomes a line, except that they can contain line
943breaks themselves.
944
Bram Moolenaar9d87a372018-12-18 21:41:50 +0100945The |submatch()| function can be used to obtain matched text. The whole
946matched text can be accessed with "submatch(0)". The text matched with the
947first pair of () with "submatch(1)". Likewise for further sub-matches in ().
Bram Moolenaar071d4272004-06-13 20:20:40 +0000948
949Be careful: The separation character must not appear in the expression!
950Consider using a character like "@" or ":". There is no problem if the result
951of the expression contains the separation character.
952
Bram Moolenaar5a8684e2005-07-30 22:43:24 +0000953Examples: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000954 :s@\n@\="\r" .. expand("$HOME") .. "\r"@
Bram Moolenaar5a8684e2005-07-30 22:43:24 +0000955This replaces an end-of-line with a new line containing the value of $HOME. >
956
957 s/E/\="\<Char-0x20ac>"/g
Bram Moolenaarc236c162008-07-13 17:41:49 +0000958This replaces each 'E' character with a euro sign. Read more in |<Char->|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000959
960
Bram Moolenaar47136d72004-10-12 20:02:24 +00009614.3 Search and replace *search-replace*
962
963 *:pro* *:promptfind*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000964:promptf[ind] [string]
965 Put up a Search dialog. When [string] is given, it is
966 used as the initial search string.
967 {only for Win32, Motif and GTK GUI}
968
969 *:promptr* *:promptrepl*
970:promptr[epl] [string]
971 Put up a Search/Replace dialog. When [string] is
972 given, it is used as the initial search string.
973 {only for Win32, Motif and GTK GUI}
974
Bram Moolenaar47136d72004-10-12 20:02:24 +0000975
9764.4 Changing tabs *change-tabs*
Bram Moolenaard38b0552012-04-25 19:07:41 +0200977 *:ret* *:retab* *:retab!*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000978:[range]ret[ab][!] [new_tabstop]
979 Replace all sequences of white-space containing a
980 <Tab> with new strings of white-space using the new
981 tabstop value given. If you do not specify a new
982 tabstop size or it is zero, Vim uses the current value
983 of 'tabstop'.
984 The current value of 'tabstop' is always used to
985 compute the width of existing tabs.
986 With !, Vim also replaces strings of only normal
987 spaces with tabs where appropriate.
988 With 'expandtab' on, Vim replaces all tabs with the
989 appropriate number of spaces.
990 This command sets 'tabstop' to the new value given,
991 and if performed on the whole file, which is default,
992 should not make any visible change.
993 Careful: This command modifies any <Tab> characters
994 inside of strings in a C program. Use "\t" to avoid
995 this (that's a good habit anyway).
Bram Moolenaard38b0552012-04-25 19:07:41 +0200996 `:retab!` may also change a sequence of spaces by
Bram Moolenaar071d4272004-06-13 20:20:40 +0000997 <Tab> characters, which can mess up a printf().
Bram Moolenaar04958cb2018-06-23 19:23:02 +0200998 If the |+vartabs| feature is enabled then a list of
999 tab widths separated by commas may be used in place of
1000 a single tabstop. Each value in the list represents
1001 the width of one tabstop, except the final value which
1002 applies to all following tabstops.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001003
1004 *retab-example*
1005Example for using autocommands and ":retab" to edit a file which is stored
1006with tabstops at 8 but edited with tabstops set at 4. Warning: white space
1007inside of strings can change! Also see 'softtabstop' option. >
1008
1009 :auto BufReadPost *.xx retab! 4
1010 :auto BufWritePre *.xx retab! 8
1011 :auto BufWritePost *.xx retab! 4
1012 :auto BufNewFile *.xx set ts=4
1013
1014==============================================================================
10155. Copying and moving text *copy-move*
1016
1017 *quote*
Bram Moolenaar7ceefb32020-05-01 16:07:38 +02001018"{register} Use {register} for next delete, yank or put. Use
1019 an uppercase character to append with delete and yank.
1020 Registers ".", "%", "#" and ":" only work with put.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001021
1022 *:reg* *:registers*
Bram Moolenaar3691f1e2019-10-24 20:17:00 +02001023:reg[isters] Display the type and contents of all numbered and
1024 named registers. If a register is written to for
1025 |:redir| it will not be listed.
1026 Type can be one of:
1027 "c" for |characterwise| text
1028 "l" for |linewise| text
1029 "b" for |blockwise-visual| text
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001030
Bram Moolenaar071d4272004-06-13 20:20:40 +00001031
1032:reg[isters] {arg} Display the contents of the numbered and named
1033 registers that are mentioned in {arg}. For example: >
Bram Moolenaarfa735342016-01-03 22:14:44 +01001034 :reg 1a
Bram Moolenaar071d4272004-06-13 20:20:40 +00001035< to display registers '1' and 'a'. Spaces are allowed
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001036 in {arg}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001037
Bram Moolenaardd60c362023-02-27 15:49:53 +00001038 *:di* *:dis* *:display*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001039:di[splay] [arg] Same as :registers.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001040
1041 *y* *yank*
1042["x]y{motion} Yank {motion} text [into register x]. When no
1043 characters are to be yanked (e.g., "y0" in column 1),
1044 this is an error when 'cpoptions' includes the 'E'
1045 flag.
1046
1047 *yy*
1048["x]yy Yank [count] lines [into register x] |linewise|.
1049
1050 *Y*
1051["x]Y yank [count] lines [into register x] (synonym for
1052 yy, |linewise|). If you like "Y" to work from the
1053 cursor to the end of line (which is more logical,
1054 but not Vi-compatible) use ":map Y y$".
1055
Christian Brabandt544a38e2021-06-10 19:39:11 +02001056 *zy*
1057["x]zy{motion} Yank {motion} text [into register x]. Only differs
1058 from `y` when selecting a block of text, see |v_zy|.
1059
Bram Moolenaar071d4272004-06-13 20:20:40 +00001060 *v_y*
1061{Visual}["x]y Yank the highlighted text [into register x] (for
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001062 {Visual} see |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001063
1064 *v_Y*
1065{Visual}["x]Y Yank the highlighted lines [into register x] (for
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001066 {Visual} see |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001067
Christian Brabandt544a38e2021-06-10 19:39:11 +02001068 *v_zy*
1069{Visual}["x]zy Yank the highlighted text [into register x]. Trailing
1070 whitespace at the end of each line of a selected block
1071 won't be yanked. Especially useful in combination
1072 with `zp`. (for {Visual} see |Visual-mode|)
1073
Bram Moolenaar85de2062011-05-05 14:26:41 +02001074 *:y* *:yank* *E850*
1075:[range]y[ank] [x] Yank [range] lines [into register x]. Yanking to the
Bram Moolenaar446beb42011-05-10 17:18:44 +02001076 "* or "+ registers is possible only when the
1077 |+clipboard| feature is included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001078
1079:[range]y[ank] [x] {count}
1080 Yank {count} lines, starting with last line number
1081 in [range] (default: current line |cmdline-ranges|),
1082 [into register x].
1083
Bram Moolenaara2baa732022-02-04 16:09:54 +00001084 *p* *put* *E353* *E1240*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001085["x]p Put the text [from register x] after the cursor
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001086 [count] times.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001087
1088 *P*
1089["x]P Put the text [from register x] before the cursor
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001090 [count] times.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001091
1092 *<MiddleMouse>*
1093["x]<MiddleMouse> Put the text from a register before the cursor [count]
1094 times. Uses the "* register, unless another is
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001095 specified.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001096 Leaves the cursor at the end of the new text.
1097 Using the mouse only works when 'mouse' contains 'n'
1098 or 'a'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001099 If you have a scrollwheel and often accidentally paste
1100 text, you can use these mappings to disable the
1101 pasting with the middle mouse button: >
1102 :map <MiddleMouse> <Nop>
1103 :imap <MiddleMouse> <Nop>
1104< You might want to disable the multi-click versions
1105 too, see |double-click|.
1106
1107 *gp*
1108["x]gp Just like "p", but leave the cursor just after the new
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001109 text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001110
1111 *gP*
1112["x]gP Just like "P", but leave the cursor just after the new
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001113 text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001114
1115 *:pu* *:put*
1116:[line]pu[t] [x] Put the text [from register x] after [line] (default
1117 current line). This always works |linewise|, thus
1118 this command can be used to put a yanked block as new
1119 lines.
Bram Moolenaard38b0552012-04-25 19:07:41 +02001120 If no register is specified, it depends on the 'cb'
1121 option: If 'cb' contains "unnamedplus", paste from the
1122 + register |quoteplus|. Otherwise, if 'cb' contains
Bram Moolenaarddbb5552012-04-26 20:17:03 +02001123 "unnamed", paste from the * register |quotestar|.
Bram Moolenaard38b0552012-04-25 19:07:41 +02001124 Otherwise, paste from the unnamed register
1125 |quote_quote|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001126 The register can also be '=' followed by an optional
1127 expression. The expression continues until the end of
1128 the command. You need to escape the '|' and '"'
1129 characters to prevent them from terminating the
1130 command. Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001131 :put ='path' .. \",/test\"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001132< If there is no expression after '=', Vim uses the
1133 previous expression. You can see it with ":dis =".
1134
1135:[line]pu[t]! [x] Put the text [from register x] before [line] (default
1136 current line).
1137
1138["x]]p or *]p* *]<MiddleMouse>*
1139["x]]<MiddleMouse> Like "p", but adjust the indent to the current line.
1140 Using the mouse only works when 'mouse' contains 'n'
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001141 or 'a'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001142
1143["x][P or *[P*
1144["x]]P or *]P*
1145["x][p or *[p* *[<MiddleMouse>*
1146["x][<MiddleMouse> Like "P", but adjust the indent to the current line.
1147 Using the mouse only works when 'mouse' contains 'n'
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001148 or 'a'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001149
Christian Brabandt2fa93842021-05-30 22:17:25 +02001150["x]zp or *zp* *zP*
1151["x]zP Like "p" and "P", except without adding trailing spaces
1152 when pasting a block. Thus the inserted text will not
Christian Brabandt544a38e2021-06-10 19:39:11 +02001153 always be a rectangle. Especially useful in
1154 combination with |v_zy|.
Christian Brabandt2fa93842021-05-30 22:17:25 +02001155
Bram Moolenaar071d4272004-06-13 20:20:40 +00001156You can use these commands to copy text from one place to another. Do this
1157by first getting the text into a register with a yank, delete or change
1158command, then inserting the register contents with a put command. You can
1159also use these commands to move text from one file to another, because Vim
1160preserves all registers when changing buffers (the CTRL-^ command is a quick
1161way to toggle between two files).
1162
1163 *linewise-register* *characterwise-register*
1164You can repeat the put commands with "." (except for :put) and undo them. If
1165the command that was used to get the text into the register was |linewise|,
1166Vim inserts the text below ("p") or above ("P") the line where the cursor is.
1167Otherwise Vim inserts the text after ("p") or before ("P") the cursor. With
1168the ":put" command, Vim always inserts the text in the next line. You can
1169exchange two characters with the command sequence "xp". You can exchange two
1170lines with the command sequence "ddp". You can exchange two words with the
1171command sequence "deep" (start with the cursor in the blank space before the
1172first word). You can use the "']" or "`]" command after the put command to
1173move the cursor to the end of the inserted text, or use "'[" or "`[" to move
1174the cursor to the start.
1175
1176 *put-Visual-mode* *v_p* *v_P*
1177When using a put command like |p| or |P| in Visual mode, Vim will try to
1178replace the selected text with the contents of the register. Whether this
1179works well depends on the type of selection and the type of the text in the
1180register. With blockwise selection it also depends on the size of the block
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001181and whether the corners are on an existing character. (Implementation detail:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001182it actually works by first putting the register after the selection and then
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001183deleting the selection.)
Shougo Matsushita509142a2022-05-06 11:45:09 +01001184With |p| the previously selected text is put in the unnamed register (and
1185possibly the selection and/or clipboard). This is useful if you want to put
1186that text somewhere else. But you cannot repeat the same change.
1187With |P| the unnamed register is not changed (and neither the selection or
1188clipboard), you can repeat the same change. But the deleted text cannot be
1189used. If you do need it you can use |p| with another register. E.g., yank
1190the text to copy, Visually select the text to replace and use "0p . You can
1191repeat this as many times as you like, and the unnamed register will be
1192changed each time.
Bram Moolenaar9712ff12022-09-18 13:04:22 +01001193 *blockwise-put*
1194When a register contains text from one line (characterwise), using a
1195blockwise Visual selection, putting that register will paste that text
1196repeatedly in each of the selected lines, thus replacing the blockwise
1197selected region by multiple copies of the register text. For example:
1198 - yank the word "TEXT" into a register with `yw`
1199 - select a visual block, marked with "v" in this text:
1200 aaavvaaa
1201 bbbvvbbb
1202 cccvvccc
1203 - press `p`, results in:
1204 aaaTEXTaaa
1205 bbbTEXTbbb
1206 cccTEXTccc
Bram Moolenaarec11aef2013-09-22 15:23:44 +02001207
Bram Moolenaar071d4272004-06-13 20:20:40 +00001208 *blockwise-register*
1209If you use a blockwise Visual mode command to get the text into the register,
1210the block of text will be inserted before ("P") or after ("p") the cursor
1211column in the current and next lines. Vim makes the whole block of text start
1212in the same column. Thus the inserted text looks the same as when it was
1213yanked or deleted. Vim may replace some <Tab> characters with spaces to make
1214this happen. However, if the width of the block is not a multiple of a <Tab>
1215width and the text after the inserted block contains <Tab>s, that text may be
1216misaligned.
1217
Bram Moolenaar22863042021-10-16 15:23:36 +01001218Use |zP|/|zp| to paste a blockwise yanked register without appending trailing
1219spaces.
1220
Bram Moolenaar071d4272004-06-13 20:20:40 +00001221Note that after a characterwise yank command, Vim leaves the cursor on the
1222first yanked character that is closest to the start of the buffer. This means
1223that "yl" doesn't move the cursor, but "yh" moves the cursor one character
1224left.
1225Rationale: In Vi the "y" command followed by a backwards motion would
1226 sometimes not move the cursor to the first yanked character,
1227 because redisplaying was skipped. In Vim it always moves to
1228 the first character, as specified by Posix.
1229With a linewise yank command the cursor is put in the first line, but the
1230column is unmodified, thus it may not be on the first yanked character.
1231
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02001232There are ten types of registers: *registers* *{register}* *E354*
Bram Moolenaar071d4272004-06-13 20:20:40 +000012331. The unnamed register ""
12342. 10 numbered registers "0 to "9
12353. The small delete register "-
12364. 26 named registers "a to "z or "A to "Z
Bram Moolenaar396e8292019-07-13 23:04:31 +020012375. Three read-only registers ":, "., "%
12386. Alternate buffer register "#
12397. The expression register "=
Bram Moolenaar3b3a9492015-01-27 18:44:16 +010012408. The selection and drop registers "*, "+ and "~
12419. The black hole register "_
124210. Last search pattern register "/
Bram Moolenaar071d4272004-06-13 20:20:40 +00001243
12441. Unnamed register "" *quote_quote* *quotequote*
1245Vim fills this register with text deleted with the "d", "c", "s", "x" commands
1246or copied with the yank "y" command, regardless of whether or not a specific
Bram Moolenaared203462004-06-16 11:19:22 +00001247register was used (e.g. "xdd). This is like the unnamed register is pointing
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001248to the last used register. Thus when appending using an uppercase register
1249name, the unnamed register contains the same text as the named register.
1250An exception is the '_' register: "_dd does not store the deleted text in any
1251register.
Bram Moolenaar81695252004-12-29 20:58:21 +00001252Vim uses the contents of the unnamed register for any put command (p or P)
1253which does not specify a register. Additionally you can access it with the
1254name '"'. This means you have to type two double quotes. Writing to the ""
1255register writes to register "0.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001256{Vi: register contents are lost when changing files, no '"'}
1257
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +020012582. Numbered registers "0 to "9 *quote_number* *quote0* *quote1*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001259 *quote2* *quote3* *quote4* *quote9*
1260Vim fills these registers with text from yank and delete commands.
1261 Numbered register 0 contains the text from the most recent yank command,
1262unless the command specified another register with ["x].
1263 Numbered register 1 contains the text deleted by the most recent delete or
1264change command, unless the command specified another register or the text is
1265less than one line (the small delete register is used then). An exception is
Bram Moolenaar81695252004-12-29 20:58:21 +00001266made for the delete operator with these movement commands: |%|, |(|, |)|, |`|,
1267|/|, |?|, |n|, |N|, |{| and |}|. Register "1 is always used then (this is Vi
1268compatible). The "- register is used as well if the delete is within a line.
Bram Moolenaarbaca7f72013-09-22 14:42:24 +02001269Note that these characters may be mapped. E.g. |%| is mapped by the matchit
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02001270plugin.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001271 With each successive deletion or change, Vim shifts the previous contents
1272of register 1 into register 2, 2 into 3, and so forth, losing the previous
1273contents of register 9.
1274{Vi: numbered register contents are lost when changing files; register 0 does
1275not exist}
1276
12773. Small delete register "- *quote_-* *quote-*
1278This register contains text from commands that delete less than one line,
1279except when the command specifies a register with ["x].
Bram Moolenaar071d4272004-06-13 20:20:40 +00001280
12814. Named registers "a to "z or "A to "Z *quote_alpha* *quotea*
1282Vim fills these registers only when you say so. Specify them as lowercase
1283letters to replace their previous contents or as uppercase letters to append
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001284to their previous contents. When the '>' flag is present in 'cpoptions' then
1285a line break is inserted before the appended text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001286
Bram Moolenaar3b3a9492015-01-27 18:44:16 +010012875. Read-only registers ":, ". and "%
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01001288These are '%', ':' and '.'. You can use them only with the "p", "P",
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001289and ":put" commands and with CTRL-R.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001290 *quote_.* *quote.* *E29*
1291 ". Contains the last inserted text (the same as what is inserted
1292 with the insert mode commands CTRL-A and CTRL-@). Note: this
1293 doesn't work with CTRL-R on the command-line. It works a bit
1294 differently, like inserting the text instead of putting it
1295 ('textwidth' and other options affect what is inserted).
1296 *quote_%* *quote%*
1297 "% Contains the name of the current file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001298 *quote_:* *quote:* *E30*
1299 ": Contains the most recent executed command-line. Example: Use
1300 "@:" to repeat the previous command-line command.
1301 The command-line is only stored in this register when at least
1302 one character of it was typed. Thus it remains unchanged if
1303 the command was completely from a mapping.
1304 {not available when compiled without the |+cmdline_hist|
1305 feature}
Bram Moolenaar3b3a9492015-01-27 18:44:16 +01001306 *quote_#* *quote#*
13076. Alternate file register "#
1308Contains the name of the alternate file for the current window. It will
1309change how the |CTRL-^| command works.
1310This register is writable, mainly to allow for restoring it after a plugin has
1311changed it. It accepts buffer number: >
1312 let altbuf = bufnr(@#)
1313 ...
1314 let @# = altbuf
1315It will give error |E86| if you pass buffer number and this buffer does not
1316exist.
1317It can also accept a match with an existing buffer name: >
1318 let @# = 'buffer_name'
1319Error |E93| if there is more than one buffer matching the given name or |E94|
1320if none of buffers matches the given name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001321
Bram Moolenaar3b3a9492015-01-27 18:44:16 +010013227. Expression register "= *quote_=* *quote=* *@=*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001323This is not really a register that stores text, but is a way to use an
1324expression in commands which use a register. The expression register is
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001325read-write.
1326
1327When typing the '=' after " or CTRL-R the cursor moves to the command-line,
1328where you can enter any expression (see |expression|). All normal
1329command-line editing commands are available, including a special history for
1330expressions. When you end the command-line by typing <CR>, Vim computes the
1331result of the expression. If you end it with <Esc>, Vim abandons the
1332expression. If you do not enter an expression, Vim uses the previous
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001333expression (like with the "/" command).
1334
1335The expression must evaluate to a String. A Number is always automatically
1336converted to a String. For the "p" and ":put" command, if the result is a
1337Float it's converted into a String. If the result is a List each element is
1338turned into a String and used as a line. A Dictionary or FuncRef results in
1339an error message (use string() to convert).
1340
1341If the "= register is used for the "p" command, the String is split up at <NL>
1342characters. If the String ends in a <NL>, it is regarded as a linewise
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001343register.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001344
Bram Moolenaar3b3a9492015-01-27 18:44:16 +010013458. Selection and drop registers "*, "+ and "~
Bram Moolenaar06b5d512010-05-22 15:37:44 +02001346Use these registers for storing and retrieving the selected text for the GUI.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001347See |quotestar| and |quoteplus|. When the clipboard is not available or not
Bram Moolenaarf4d11452005-12-02 00:46:37 +00001348working, the unnamed register is used instead. For Unix systems the clipboard
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001349is only available when the |+xterm_clipboard| feature is present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001350
1351Note that there is only a distinction between "* and "+ for X11 systems. For
1352an explanation of the difference, see |x11-selection|. Under MS-Windows, use
1353of "* and "+ is actually synonymous and refers to the |gui-clipboard|.
1354
1355 *quote_~* *quote~* *<Drop>*
1356The read-only "~ register stores the dropped text from the last drag'n'drop
1357operation. When something has been dropped onto Vim, the "~ register is
1358filled in and the <Drop> pseudo key is sent for notification. You can remap
1359this key if you want; the default action (for all modes) is to insert the
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001360contents of the "~ register at the cursor position.
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001361{only available when compiled with the |+dnd| feature, currently only with the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001362GTK GUI}
1363
1364Note: The "~ register is only used when dropping plain text onto Vim.
1365Drag'n'drop of URI lists is handled internally.
1366
Bram Moolenaar3b3a9492015-01-27 18:44:16 +010013679. Black hole register "_ *quote_*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001368When writing to this register, nothing happens. This can be used to delete
1369text without affecting the normal registers. When reading from this register,
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001370nothing is returned.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001371
Bram Moolenaar5be4cee2019-09-27 19:34:08 +0200137210. Last search pattern register "/ *quote_/* *quote/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001373Contains the most recent search-pattern. This is used for "n" and 'hlsearch'.
Bram Moolenaard38b0552012-04-25 19:07:41 +02001374It is writable with `:let`, you can change it to have 'hlsearch' highlight
Bram Moolenaar071d4272004-06-13 20:20:40 +00001375other matches without actually searching. You can't yank or delete into this
Bram Moolenaar446cb832008-06-24 21:56:24 +00001376register. The search direction is available in |v:searchforward|.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001377Note that the value is restored when returning from a function
Bram Moolenaar446cb832008-06-24 21:56:24 +00001378|function-search-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001379
1380 *@/*
Bram Moolenaard38b0552012-04-25 19:07:41 +02001381You can write to a register with a `:let` command |:let-@|. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001382 :let @/ = "the"
1383
1384If you use a put command without specifying a register, Vim uses the register
1385that was last filled (this is also the contents of the unnamed register). If
Bram Moolenaard38b0552012-04-25 19:07:41 +02001386you are confused, use the `:dis` command to find out what Vim will put (this
Bram Moolenaar071d4272004-06-13 20:20:40 +00001387command displays all named and numbered registers; the unnamed register is
1388labelled '"').
1389
1390The next three commands always work on whole lines.
1391
1392:[range]co[py] {address} *:co* *:copy*
1393 Copy the lines given by [range] to below the line
1394 given by {address}.
1395
1396 *:t*
1397:t Synonym for copy.
Bram Moolenaara4d131d2021-12-27 21:33:07 +00001398 This command is not supported in |Vim9| script,
1399 because it is too easily confused with a variable
1400 name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001401
1402:[range]m[ove] {address} *:m* *:mo* *:move* *E134*
1403 Move the lines given by [range] to below the line
1404 given by {address}.
1405
1406==============================================================================
14076. Formatting text *formatting*
1408
1409:[range]ce[nter] [width] *:ce* *:center*
1410 Center lines in [range] between [width] columns
1411 (default 'textwidth' or 80 when 'textwidth' is 0).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001412
1413:[range]ri[ght] [width] *:ri* *:right*
1414 Right-align lines in [range] at [width] columns
1415 (default 'textwidth' or 80 when 'textwidth' is 0).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001416
1417 *:le* *:left*
1418:[range]le[ft] [indent]
1419 Left-align lines in [range]. Sets the indent in the
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001420 lines to [indent] (default 0).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001421
1422 *gq*
Bram Moolenaar4317d9b2005-03-18 20:25:31 +00001423gq{motion} Format the lines that {motion} moves over.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001424 Formatting is done with one of three methods:
1425 1. If 'formatexpr' is not empty the expression is
1426 evaluated. This can differ for each buffer.
Bram Moolenaar4c7ed462006-02-15 22:18:42 +00001427 2. If 'formatprg' is not empty an external program
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001428 is used.
Bram Moolenaar551dbcc2006-04-25 22:13:59 +00001429 3. Otherwise formatting is done internally.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001430
1431 In the third case the 'textwidth' option controls the
1432 length of each formatted line (see below).
Bram Moolenaar4317d9b2005-03-18 20:25:31 +00001433 If the 'textwidth' option is 0, the formatted line
1434 length is the screen width (with a maximum width of
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001435 79).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001436 The 'formatoptions' option controls the type of
1437 formatting |fo-table|.
Bram Moolenaar4317d9b2005-03-18 20:25:31 +00001438 The cursor is left on the first non-blank of the last
1439 formatted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001440 NOTE: The "Q" command formerly performed this
1441 function. If you still want to use "Q" for
1442 formatting, use this mapping: >
1443 :nnoremap Q gq
1444
1445gqgq *gqgq* *gqq*
Bram Moolenaar40af4e32010-07-29 22:33:18 +02001446gqq Format the current line. With a count format that
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001447 many lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001448
1449 *v_gq*
1450{Visual}gq Format the highlighted text. (for {Visual} see
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001451 |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001452
1453 *gw*
1454gw{motion} Format the lines that {motion} moves over. Similar to
1455 |gq| but puts the cursor back at the same position in
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001456 the text. However, 'formatprg' and 'formatexpr' are
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001457 not used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001458
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001459gwgw *gwgw* *gww*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001460gww Format the current line as with "gw".
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001461
1462 *v_gw*
1463{Visual}gw Format the highlighted text as with "gw". (for
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001464 {Visual} see |Visual-mode|).
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001465
Bram Moolenaar071d4272004-06-13 20:20:40 +00001466Example: To format the current paragraph use: *gqap* >
1467 gqap
1468
1469The "gq" command leaves the cursor in the line where the motion command takes
1470the cursor. This allows you to repeat formatting repeated with ".". This
1471works well with "gqj" (format current and next line) and "gq}" (format until
1472end of paragraph). Note: When 'formatprg' is set, "gq" leaves the cursor on
1473the first formatted line (as with using a filter command).
1474
1475If you want to format the current paragraph and continue where you were, use: >
1476 gwap
1477If you always want to keep paragraphs formatted you may want to add the 'a'
1478flag to 'formatoptions'. See |auto-format|.
1479
1480If the 'autoindent' option is on, Vim uses the indent of the first line for
1481the following lines.
1482
1483Formatting does not change empty lines (but it does change lines with only
1484white space!).
1485
1486The 'joinspaces' option is used when lines are joined together.
1487
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001488You can set the 'formatexpr' option to an expression or the 'formatprg' option
1489to the name of an external program for Vim to use for text formatting. The
1490'textwidth' and other options have no effect on formatting by an external
1491program.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001492
Bram Moolenaar7db25fe2018-05-13 00:02:36 +02001493 *format-formatexpr*
Bram Moolenaard473c8c2018-08-11 18:00:22 +02001494The 'formatexpr' option can be set to a Vim script function that performs
Bram Moolenaar7db25fe2018-05-13 00:02:36 +02001495reformatting of the buffer. This should usually happen in an |ftplugin|,
1496since formatting is highly dependent on the type of file. It makes
1497sense to use an |autoload| script, so the corresponding script is only loaded
1498when actually needed and the script should be called <filetype>format.vim.
1499
1500For example, the XML filetype plugin distributed with Vim in the $VIMRUNTIME
1501directory, sets the 'formatexpr' option to: >
1502
1503 setlocal formatexpr=xmlformat#Format()
1504
1505That means, you will find the corresponding script, defining the
1506xmlformat#Format() function, in the directory:
1507`$VIMRUNTIME/autoload/xmlformat.vim`
1508
1509Here is an example script that removes trailing whitespace from the selected
1510text. Put it in your autoload directory, e.g. ~/.vim/autoload/format.vim: >
1511
1512 func! format#Format()
1513 " only reformat on explicit gq command
1514 if mode() != 'n'
Bram Moolenaard1caa942020-04-10 22:10:56 +02001515 " fall back to Vim's internal reformatting
Bram Moolenaar7db25fe2018-05-13 00:02:36 +02001516 return 1
1517 endif
1518 let lines = getline(v:lnum, v:lnum + v:count - 1)
1519 call map(lines, {key, val -> substitute(val, '\s\+$', '', 'g')})
1520 call setline('.', lines)
1521
1522 " do not run internal formatter!
1523 return 0
1524 endfunc
1525
1526You can then enable the formatting by executing: >
1527 setlocal formatexpr=format#Format()
Bram Moolenaard473c8c2018-08-11 18:00:22 +02001528
Bram Moolenaar7db25fe2018-05-13 00:02:36 +02001529Note: this function explicitly returns non-zero when called from insert mode
1530(which basically means, text is inserted beyond the 'textwidth' limit). This
1531causes Vim to fall back to reformat the text by using the internal formatter.
1532
1533However, if the |gq| command is used to reformat the text, the function
1534will receive the selected lines, trim trailing whitespace from those lines and
1535put them back in place. If you are going to split single lines into multiple
1536lines, be careful not to overwrite anything.
1537
1538If you want to allow reformatting of text from insert or replace mode, one has
1539to be very careful, because the function might be called recursively. For
1540debugging it helps to set the 'debug' option.
1541
Bram Moolenaar071d4272004-06-13 20:20:40 +00001542 *right-justify*
1543There is no command in Vim to right justify text. You can do it with
1544an external command, like "par" (e.g.: "!}par" to format until the end of the
1545paragraph) or set 'formatprg' to "par".
1546
1547 *format-comments*
Bram Moolenaar446cb832008-06-24 21:56:24 +00001548An overview of comment formatting is in section |30.6| of the user manual.
1549
1550Vim can automatically insert and format comments in a special way. Vim
1551recognizes a comment by a specific string at the start of the line (ignoring
1552white space). Three types of comments can be used:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001553
1554- A comment string that repeats at the start of each line. An example is the
1555 type of comment used in shell scripts, starting with "#".
1556- A comment string that occurs only in the first line, not in the following
1557 lines. An example is this list with dashes.
1558- Three-piece comments that have a start string, an end string, and optional
1559 lines in between. The strings for the start, middle and end are different.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001560 An example is the C style comment:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001561 /*
1562 * this is a C comment
1563 */
1564
1565The 'comments' option is a comma-separated list of parts. Each part defines a
1566type of comment string. A part consists of:
1567 {flags}:{string}
1568
1569{string} is the literal text that must appear.
1570
1571{flags}:
1572 n Nested comment. Nesting with mixed parts is allowed. If 'comments'
1573 is "n:),n:>" a line starting with "> ) >" is a comment.
1574
1575 b Blank (<Space>, <Tab> or <EOL>) required after {string}.
1576
1577 f Only the first line has the comment string. Do not repeat comment on
1578 the next line, but preserve indentation (e.g., a bullet-list).
1579
1580 s Start of three-piece comment
1581
1582 m Middle of a three-piece comment
1583
1584 e End of a three-piece comment
1585
Bram Moolenaar446cb832008-06-24 21:56:24 +00001586 l Left align. Used together with 's' or 'e', the leftmost character of
1587 start or end will line up with the leftmost character from the middle.
1588 This is the default and can be omitted. See below for more details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001589
Bram Moolenaar446cb832008-06-24 21:56:24 +00001590 r Right align. Same as above but rightmost instead of leftmost. See
1591 below for more details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001592
Bram Moolenaar446cb832008-06-24 21:56:24 +00001593 O Don't consider this comment for the "O" command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001594
1595 x Allows three-piece comments to be ended by just typing the last
Bram Moolenaar446cb832008-06-24 21:56:24 +00001596 character of the end-comment string as the first action on a new
1597 line when the middle-comment string has been inserted automatically.
1598 See below for more details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599
1600 {digits}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001601 When together with 's' or 'e': add {digit} amount of offset to an
1602 automatically inserted middle or end comment leader. The offset begins
1603 from a left alignment. See below for more details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001604
1605 -{digits}
1606 Like {digits} but reduce the indent. This only works when there is
1607 some indent for the start or end part that can be removed.
1608
1609When a string has none of the 'f', 's', 'm' or 'e' flags, Vim assumes the
1610comment string repeats at the start of each line. The flags field may be
1611empty.
1612
1613Any blank space in the text before and after the {string} is part of the
1614{string}, so do not include leading or trailing blanks unless the blanks are a
1615required part of the comment string.
1616
1617When one comment leader is part of another, specify the part after the whole.
1618For example, to include both "-" and "->", use >
1619 :set comments=f:->,f:-
1620
1621A three-piece comment must always be given as start,middle,end, with no other
1622parts in between. An example of a three-piece comment is >
1623 sr:/*,mb:*,ex:*/
1624for C-comments. To avoid recognizing "*ptr" as a comment, the middle string
1625includes the 'b' flag. For three-piece comments, Vim checks the text after
1626the start and middle strings for the end string. If Vim finds the end string,
1627the comment does not continue on the next line. Three-piece comments must
1628have a middle string because otherwise Vim can't recognize the middle lines.
1629
1630Notice the use of the "x" flag in the above three-piece comment definition.
1631When you hit Return in a C-comment, Vim will insert the middle comment leader
Bram Moolenaar446cb832008-06-24 21:56:24 +00001632for the new line: " * ". To close this comment you just have to type "/"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001633before typing anything else on the new line. This will replace the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001634middle-comment leader with the end-comment leader and apply any specified
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001635alignment, leaving just " */". There is no need to hit Backspace first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001636
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001637When there is a match with a middle part, but there also is a matching end
1638part which is longer, the end part is used. This makes a C style comment work
Bram Moolenaar446beb42011-05-10 17:18:44 +02001639without requiring the middle part to end with a space.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001640
1641Here is an example of alignment flags at work to make a comment stand out
Bram Moolenaar446beb42011-05-10 17:18:44 +02001642(kind of looks like a 1 too). Consider comment string: >
1643 :set comments=sr:/***,m:**,ex-2:******/
1644<
1645 /*** ~
1646 **<--right aligned from "r" flag ~
1647 ** ~
1648offset 2 spaces for the "-2" flag--->** ~
1649 ******/ ~
Bram Moolenaar446cb832008-06-24 21:56:24 +00001650In this case, the first comment was typed, then return was pressed 4 times,
1651then "/" was pressed to end the comment.
1652
1653Here are some finer points of three part comments. There are three times when
1654alignment and offset flags are taken into consideration: opening a new line
1655after a start-comment, opening a new line before an end-comment, and
1656automatically ending a three-piece comment. The end alignment flag has a
1657backwards perspective; the result is that the same alignment flag used with
1658"s" and "e" will result in the same indent for the starting and ending pieces.
1659Only one alignment per comment part is meant to be used, but an offset number
1660will override the "r" and "l" flag.
1661
1662Enabling 'cindent' will override the alignment flags in many cases.
1663Reindenting using a different method like |gq| or |=| will not consult
1664alignment flags either. The same behaviour can be defined in those other
1665formatting options. One consideration is that 'cindent' has additional options
1666for context based indenting of comments but cannot replicate many three piece
Bram Moolenaar446beb42011-05-10 17:18:44 +02001667indent alignments. However, 'indentexpr' has the ability to work better with
1668three piece comments.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001669
1670Other examples: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001671 "b:*" Includes lines starting with "*", but not if the "*" is
1672 followed by a non-blank. This avoids a pointer dereference
1673 like "*str" to be recognized as a comment.
1674 "n:>" Includes a line starting with ">", ">>", ">>>", etc.
1675 "fb:-" Format a list that starts with "- ".
1676
1677By default, "b:#" is included. This means that a line that starts with
1678"#include" is not recognized as a comment line. But a line that starts with
1679"# define" is recognized. This is a compromise.
1680
Bram Moolenaar071d4272004-06-13 20:20:40 +00001681 *fo-table*
1682You can use the 'formatoptions' option to influence how Vim formats text.
1683'formatoptions' is a string that can contain any of the letters below. The
1684default setting is "tcq". You can separate the option letters with commas for
1685readability.
1686
1687letter meaning when present in 'formatoptions' ~
Bram Moolenaare0e39172021-01-25 21:14:57 +01001688 *fo-t*
Bram Moolenaar2bf875f2022-05-07 14:54:11 +01001689t Auto-wrap text using 'textwidth'
Bram Moolenaare0e39172021-01-25 21:14:57 +01001690 *fo-c*
Bram Moolenaar2bf875f2022-05-07 14:54:11 +01001691c Auto-wrap comments using 'textwidth', inserting the current comment
Bram Moolenaar071d4272004-06-13 20:20:40 +00001692 leader automatically.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001693 *fo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001694r Automatically insert the current comment leader after hitting
1695 <Enter> in Insert mode.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001696 *fo-o*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001697o Automatically insert the current comment leader after hitting 'o' or
Bram Moolenaar04fb9162021-12-30 20:24:12 +00001698 'O' in Normal mode. In case comment is unwanted in a specific place
1699 use CTRL-U to quickly delete it. |i_CTRL-U|
Bram Moolenaar2bf875f2022-05-07 14:54:11 +01001700 *fo-/*
1701/ When 'o' is included: do not insert the comment leader for a //
1702 comment after a statement, only when // is at the start of the line.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001703 *fo-q*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001704q Allow formatting of comments with "gq".
1705 Note that formatting will not change blank lines or lines containing
1706 only the comment leader. A new paragraph starts after such a line,
1707 or when the comment leader changes.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001708 *fo-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001709w Trailing white space indicates a paragraph continues in the next line.
1710 A line that ends in a non-white character ends a paragraph.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001711 *fo-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001712a Automatic formatting of paragraphs. Every time text is inserted or
1713 deleted the paragraph will be reformatted. See |auto-format|.
1714 When the 'c' flag is present this only happens for recognized
1715 comments.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001716 *fo-n*
Bram Moolenaar86b68352004-12-27 21:59:20 +00001717n When formatting text, recognize numbered lists. This actually uses
1718 the 'formatlistpat' option, thus any kind of list can be used. The
1719 indent of the text after the number is used for the next line. The
Bram Moolenaar446cb832008-06-24 21:56:24 +00001720 default is to find a number, optionally followed by '.', ':', ')',
Bram Moolenaar86b68352004-12-27 21:59:20 +00001721 ']' or '}'. Note that 'autoindent' must be set too. Doesn't work
1722 well together with "2".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001723 Example: >
1724 1. the first item
1725 wraps
1726 2. the second item
Bram Moolenaare0e39172021-01-25 21:14:57 +01001727< *fo-2*
Bram Moolenaar071d4272004-06-13 20:20:40 +000017282 When formatting text, use the indent of the second line of a paragraph
1729 for the rest of the paragraph, instead of the indent of the first
1730 line. This supports paragraphs in which the first line has a
1731 different indent than the rest. Note that 'autoindent' must be set
1732 too. Example: >
1733 first line of a paragraph
1734 second line of the same paragraph
1735 third line.
Bram Moolenaar30b65812012-07-12 22:01:11 +02001736< This also works inside comments, ignoring the comment leader.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001737 *fo-v*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001738v Vi-compatible auto-wrapping in insert mode: Only break a line at a
1739 blank that you have entered during the current insert command. (Note:
1740 this is not 100% Vi compatible. Vi has some "unexpected features" or
1741 bugs in this area. It uses the screen column instead of the line
1742 column.)
Bram Moolenaare0e39172021-01-25 21:14:57 +01001743 *fo-b*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744b Like 'v', but only auto-wrap if you enter a blank at or before
1745 the wrap margin. If the line was longer than 'textwidth' when you
1746 started the insert, or you do not enter a blank in the insert before
1747 reaching 'textwidth', Vim does not perform auto-wrapping.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001748 *fo-l*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001749l Long lines are not broken in insert mode: When a line was longer than
1750 'textwidth' when the insert command started, Vim does not
1751 automatically format it.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001752 *fo-m*
Bram Moolenaar207f0092020-08-30 17:20:20 +02001753m Also break at a multibyte character above 255. This is useful for
Bram Moolenaar071d4272004-06-13 20:20:40 +00001754 Asian text where every character is a word on its own.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001755 *fo-M*
Bram Moolenaar207f0092020-08-30 17:20:20 +02001756M When joining lines, don't insert a space before or after a multibyte
Bram Moolenaar071d4272004-06-13 20:20:40 +00001757 character. Overrules the 'B' flag.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001758 *fo-B*
Bram Moolenaar207f0092020-08-30 17:20:20 +02001759B When joining lines, don't insert a space between two multibyte
Bram Moolenaar071d4272004-06-13 20:20:40 +00001760 characters. Overruled by the 'M' flag.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001761 *fo-1*
Bram Moolenaar071d4272004-06-13 20:20:40 +000017621 Don't break a line after a one-letter word. It's broken before it
1763 instead (if possible).
Bram Moolenaare0e39172021-01-25 21:14:57 +01001764 *fo-]*
Bram Moolenaar2bf875f2022-05-07 14:54:11 +01001765] Respect 'textwidth' rigorously. With this flag set, no line can be
1766 longer than 'textwidth', unless line-break-prohibition rules make this
Bram Moolenaare52702f2020-06-04 18:22:13 +02001767 impossible. Mainly for CJK scripts and works only if 'encoding' is
1768 "utf-8".
Bram Moolenaare0e39172021-01-25 21:14:57 +01001769 *fo-j*
Bram Moolenaar81340392012-06-06 16:12:59 +02001770j Where it makes sense, remove a comment leader when joining lines. For
1771 example, joining:
1772 int i; // the index ~
1773 // in the list ~
1774 Becomes:
1775 int i; // the index in the list ~
Bram Moolenaare0e39172021-01-25 21:14:57 +01001776 *fo-p*
Bram Moolenaarc3c31582019-01-11 22:15:05 +01001777p Don't break lines at single spaces that follow periods. This is
1778 intended to complement 'joinspaces' and |cpo-J|, for prose with
1779 sentences separated by two spaces. For example, with 'textwidth' set
1780 to 28: >
1781 Surely you're joking, Mr. Feynman!
1782< Becomes: >
1783 Surely you're joking,
1784 Mr. Feynman!
1785< Instead of: >
1786 Surely you're joking, Mr.
1787 Feynman!
Bram Moolenaar071d4272004-06-13 20:20:40 +00001788
1789
1790With 't' and 'c' you can specify when Vim performs auto-wrapping:
1791value action ~
1792"" no automatic formatting (you can use "gq" for manual formatting)
1793"t" automatic formatting of text, but not comments
1794"c" automatic formatting for comments, but not text (good for C code)
1795"tc" automatic formatting for text and comments
1796
Bram Moolenaar91170f82006-05-05 21:15:17 +00001797Note that when 'textwidth' is 0, Vim does no automatic formatting anyway (but
1798does insert comment leaders according to the 'comments' option). An exception
1799is when the 'a' flag is present. |auto-format|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001800
1801Note that when 'paste' is on, Vim does no formatting at all.
1802
1803Note that 'textwidth' can be non-zero even if Vim never performs auto-wrapping;
1804'textwidth' is still useful for formatting with "gq".
1805
1806If the 'comments' option includes "/*", "*" and/or "*/", then Vim has some
1807built in stuff to treat these types of comments a bit more cleverly.
1808Opening a new line before or after "/*" or "*/" (with 'r' or 'o' present in
1809'formatoptions') gives the correct start of the line automatically. The same
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001810happens with formatting and auto-wrapping. Opening a line after a line
Bram Moolenaar071d4272004-06-13 20:20:40 +00001811starting with "/*" or "*" and containing "*/", will cause no comment leader to
1812be inserted, and the indent of the new line is taken from the line containing
1813the start of the comment.
1814E.g.:
1815 /* ~
1816 * Your typical comment. ~
1817 */ ~
1818 The indent on this line is the same as the start of the above
1819 comment.
1820
1821All of this should be really cool, especially in conjunction with the new
1822:autocmd command to prepare different settings for different types of file.
1823
1824Some examples:
1825 for C code (only format comments): >
1826 :set fo=croq
1827< for Mail/news (format all, don't start comment with "o" command): >
1828 :set fo=tcrq
1829<
1830
Bram Moolenaard38b0552012-04-25 19:07:41 +02001831Automatic formatting *auto-format* *autoformat*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832
1833When the 'a' flag is present in 'formatoptions' text is formatted
Bram Moolenaar2547aa92020-07-26 17:00:44 +02001834automatically when inserting text or deleting text. This works nicely for
Bram Moolenaar071d4272004-06-13 20:20:40 +00001835editing text paragraphs. A few hints on how to use this:
1836
1837- You need to properly define paragraphs. The simplest is paragraphs that are
1838 separated by a blank line. When there is no separating blank line, consider
1839 using the 'w' flag and adding a space at the end of each line in the
1840 paragraphs except the last one.
1841
1842- You can set the 'formatoptions' based on the type of file |filetype| or
1843 specifically for one file with a |modeline|.
1844
1845- Set 'formatoptions' to "aw2tq" to make text with indents like this:
1846
Bram Moolenaardd60c362023-02-27 15:49:53 +00001847 bla bla foobar bla
Bram Moolenaar071d4272004-06-13 20:20:40 +00001848 bla foobar bla foobar bla
Bram Moolenaardd60c362023-02-27 15:49:53 +00001849 bla bla foobar bla
Bram Moolenaar071d4272004-06-13 20:20:40 +00001850 bla foobar bla bla foobar
1851
1852- Add the 'c' flag to only auto-format comments. Useful in source code.
1853
Bram Moolenaar91170f82006-05-05 21:15:17 +00001854- Set 'textwidth' to the desired width. If it is zero then 79 is used, or the
1855 width of the screen if this is smaller.
1856
Bram Moolenaar071d4272004-06-13 20:20:40 +00001857And a few warnings:
1858
1859- When part of the text is not properly separated in paragraphs, making
1860 changes in this text will cause it to be formatted anyway. Consider doing >
1861
1862 :set fo-=a
1863
1864- When using the 'w' flag (trailing space means paragraph continues) and
1865 deleting the last line of a paragraph with |dd|, the paragraph will be
1866 joined with the next one.
1867
1868- Changed text is saved for undo. Formatting is also a change. Thus each
1869 format action saves text for undo. This may consume quite a lot of memory.
1870
1871- Formatting a long paragraph and/or with complicated indenting may be slow.
1872
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00001873==============================================================================
18747. Sorting text *sorting*
1875
1876Vim has a sorting function and a sorting command. The sorting function can be
Bram Moolenaar327aa022014-03-25 18:24:23 +01001877found here: |sort()|, |uniq()|.
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00001878
1879 *:sor* *:sort*
Bram Moolenaar55e29612020-11-01 13:57:44 +01001880:[range]sor[t][!] [b][f][i][l][n][o][r][u][x] [/{pattern}/]
Bram Moolenaare5180522005-12-10 20:19:46 +00001881 Sort lines in [range]. When no range is given all
1882 lines are sorted.
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00001883
1884 With [!] the order is reversed.
1885
1886 With [i] case is ignored.
1887
Bram Moolenaar3132cdd2020-11-05 20:41:49 +01001888 With [l] sort uses the current collation locale.
1889 Implementation details: strcoll() is used to compare
1890 strings. See |:language| to check or set the collation
1891 locale. Example: >
1892 :language collate en_US.UTF-8
1893 :%sort l
1894< |v:collate| can also used to check the current locale.
1895 Sorting using the locale typically ignores case.
1896 This does not work properly on Mac.
Bram Moolenaar55e29612020-11-01 13:57:44 +01001897
Bram Moolenaarf7edf402016-01-19 23:36:15 +01001898 Options [n][f][x][o][b] are mutually exclusive.
1899
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001900 With [n] sorting is done on the first decimal number
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00001901 in the line (after or inside a {pattern} match).
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001902 One leading '-' is included in the number.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001903
Bram Moolenaarf7edf402016-01-19 23:36:15 +01001904 With [f] sorting is done on the Float in the line.
1905 The value of Float is determined similar to passing
1906 the text (after or inside a {pattern} match) to
1907 str2float() function. This option is available only
1908 if Vim was compiled with Floating point support.
1909
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001910 With [x] sorting is done on the first hexadecimal
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00001911 number in the line (after or inside a {pattern}
1912 match). A leading "0x" or "0X" is ignored.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001913 One leading '-' is included in the number.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001914
1915 With [o] sorting is done on the first octal number in
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00001916 the line (after or inside a {pattern} match).
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001917
Bram Moolenaar887c1fe2016-01-02 17:56:35 +01001918 With [b] sorting is done on the first binary number in
1919 the line (after or inside a {pattern} match).
1920
Bram Moolenaarf7edf402016-01-19 23:36:15 +01001921 With [u] (u stands for unique) only keep the first of
1922 a sequence of identical lines (ignoring case when [i]
1923 is used). Without this flag, a sequence of identical
1924 lines will be kept in their original order.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001925 Note that leading and trailing white space may cause
1926 lines to be different.
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00001927
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00001928 When /{pattern}/ is specified and there is no [r] flag
1929 the text matched with {pattern} is skipped, so that
1930 you sort on what comes after the match.
Bram Moolenaar4466ad62020-11-21 13:16:30 +01001931 'ignorecase' applies to the pattern, but 'smartcase'
1932 is not used.
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00001933 Instead of the slash any non-letter can be used.
1934 For example, to sort on the second comma-separated
1935 field: >
1936 :sort /[^,]*,/
1937< To sort on the text at virtual column 10 (thus
1938 ignoring the difference between tabs and spaces): >
1939 :sort /.*\%10v/
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001940< To sort on the first number in the line, no matter
1941 what is in front of it: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00001942 :sort /.\{-}\ze\d/
1943< (Explanation: ".\{-}" matches any text, "\ze" sets the
1944 end of the match and \d matches a digit.)
1945 With [r] sorting is done on the matching {pattern}
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00001946 instead of skipping past it as described above.
1947 For example, to sort on only the first three letters
1948 of each line: >
1949 :sort /\a\a\a/ r
1950
1951< If a {pattern} is used, any lines which don't have a
1952 match for {pattern} are kept in their current order,
1953 but separate from the lines which do match {pattern}.
1954 If you sorted in reverse, they will be in reverse
1955 order after the sorted lines, otherwise they will be
1956 in their original order, right before the sorted
1957 lines.
1958
Bram Moolenaar1256e722007-07-10 15:26:20 +00001959 If {pattern} is empty (e.g. // is specified), the
1960 last search pattern is used. This allows trying out
1961 a pattern first.
1962
Bram Moolenaard38b0552012-04-25 19:07:41 +02001963Note that using `:sort` with `:global` doesn't sort the matching lines, it's
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001964quite useless.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001965
Bram Moolenaar55e29612020-11-01 13:57:44 +01001966`:sort` does not use the current locale unless the l flag is used.
Bram Moolenaar8bb1c3e2014-07-04 16:43:17 +02001967Vim does do a "stable" sort.
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00001968
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00001969The sorting can be interrupted, but if you interrupt it too late in the
1970process you may end up with duplicated lines. This also depends on the system
1971library function used.
Bram Moolenaarae5bce12005-08-15 21:41:48 +00001972
Bram Moolenaar91f84f62018-07-29 15:07:52 +02001973 vim:tw=78:ts=8:noet:ft=help:norl: