blob: e958e038bd1b54dac33a8378df30e51610968848 [file] [log] [blame]
Hirohito Higashi26ebe212025-06-26 20:31:24 +02001*change.txt* For Vim version 9.1. Last change: 2025 Jun 26
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|
Hirohito Higashi74f0a772025-06-23 21:42:36 +0200238. Deduplicating text |deduplicating|
Bram Moolenaar071d4272004-06-13 20:20:40 +000024
25For inserting text see |insert.txt|.
26
27==============================================================================
281. Deleting text *deleting* *E470*
29
30["x]<Del> or *<Del>* *x* *dl*
31["x]x Delete [count] characters under and after the cursor
32 [into register x] (not |linewise|). Does the same as
33 "dl".
34 The <Del> key does not take a [count]. Instead, it
35 deletes the last character of the count.
36 See |:fixdel| if the <Del> key does not do what you
37 want. See |'whichwrap'| for deleting a line break
Bram Moolenaar25c9c682019-05-05 18:13:34 +020038 (join lines).
Bram Moolenaar071d4272004-06-13 20:20:40 +000039
40 *X* *dh*
41["x]X Delete [count] characters before the cursor [into
42 register x] (not |linewise|). Does the same as "dh".
43 Also see |'whichwrap'|.
44
45 *d*
46["x]d{motion} Delete text that {motion} moves over [into register
47 x]. See below for exceptions.
48
49 *dd*
50["x]dd Delete [count] lines [into register x] |linewise|.
51
52 *D*
53["x]D Delete the characters under the cursor until the end
54 of the line and [count]-1 more lines [into register
55 x]; synonym for "d$".
56 (not |linewise|)
Bram Moolenaar4399ef42005-02-12 14:29:27 +000057 When the '#' flag is in 'cpoptions' the count is
58 ignored.
Bram Moolenaar071d4272004-06-13 20:20:40 +000059
60{Visual}["x]x or *v_x* *v_d* *v_<Del>*
61{Visual}["x]d or
62{Visual}["x]<Del> Delete the highlighted text [into register x] (for
Bram Moolenaar25c9c682019-05-05 18:13:34 +020063 {Visual} see |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +000064
65{Visual}["x]CTRL-H or *v_CTRL-H* *v_<BS>*
66{Visual}["x]<BS> When in Select mode: Delete the highlighted text [into
67 register x].
68
69{Visual}["x]X or *v_X* *v_D* *v_b_D*
70{Visual}["x]D Delete the highlighted lines [into register x] (for
71 {Visual} see |Visual-mode|). In Visual block mode,
72 "D" deletes the highlighted text plus all text until
Bram Moolenaar25c9c682019-05-05 18:13:34 +020073 the end of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000074
Bram Moolenaar9ba7e172013-07-17 22:37:26 +020075 *:d* *:de* *:del* *:delete* *:dl* *:dp*
Bram Moolenaar071d4272004-06-13 20:20:40 +000076:[range]d[elete] [x] Delete [range] lines (default: current line) [into
77 register x].
Bram Moolenaar9ba7e172013-07-17 22:37:26 +020078 Note these weird abbreviations:
79 :dl delete and list
80 :dell idem
81 :delel idem
82 :deletl idem
83 :deletel idem
84 :dp delete and print
85 :dep idem
86 :delp idem
87 :delep idem
88 :deletp idem
89 :deletep idem
Bram Moolenaar071d4272004-06-13 20:20:40 +000090
91:[range]d[elete] [x] {count}
92 Delete {count} lines, starting with [range]
93 (default: current line |cmdline-ranges|) [into
94 register x].
95
Bram Moolenaard38b0552012-04-25 19:07:41 +020096These commands delete text. You can repeat them with the `.` command
97(except `:d`) and undo them. Use Visual mode to delete blocks of text. See
Bram Moolenaar071d4272004-06-13 20:20:40 +000098|registers| for an explanation of registers.
Christian Brabandt22105fd2024-07-15 20:51:11 +020099 *d-special*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000100An exception for the d{motion} command: If the motion is not linewise, the
101start and end of the motion are not in the same line, and there are only
Bram Moolenaar38a55632016-02-15 22:07:32 +0100102blanks before the start and there are no non-blanks after the end of the
103motion, the delete becomes linewise. This means that the delete also removes
104the line of blanks that you might expect to remain. Use the |o_v| operator to
Christian Brabandt22105fd2024-07-15 20:51:11 +0200105force the motion to be characterwise or remove the "z" flag from 'cpoptions'
106(see |cpo-z|) to disable this peculiarity.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000107
108Trying to delete an empty region of text (e.g., "d0" in the first column)
109is an error when 'cpoptions' includes the 'E' flag.
110
111 *J*
112J Join [count] lines, with a minimum of two lines.
113 Remove the indent and insert up to two spaces (see
Bram Moolenaar77cdfd12016-03-12 12:57:59 +0100114 below). Fails when on the last line of the buffer.
Bram Moolenaar85eee132018-05-06 17:57:30 +0200115 If [count] is too big it is reduced to the number of
Bram Moolenaar77cdfd12016-03-12 12:57:59 +0100116 lines available.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000117
118 *v_J*
119{Visual}J Join the highlighted lines, with a minimum of two
120 lines. Remove the indent and insert up to two spaces
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200121 (see below).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000122
123 *gJ*
124gJ Join [count] lines, with a minimum of two lines.
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200125 Don't insert or remove any spaces.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000126
127 *v_gJ*
128{Visual}gJ Join the highlighted lines, with a minimum of two
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200129 lines. Don't insert or remove any spaces.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000130
131 *:j* *:join*
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000132:[range]j[oin][!] [flags]
133 Join [range] lines. Same as "J", except with [!]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000134 the join does not insert or delete any spaces.
135 If a [range] has equal start and end values, this
136 command does nothing. The default behavior is to
137 join the current line with the line below it.
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000138 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000139
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000140:[range]j[oin][!] {count} [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000141 Join {count} lines, starting with [range] (default:
142 current line |cmdline-ranges|). Same as "J", except
143 with [!] the join does not insert or delete any
144 spaces.
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000145 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000146
147These commands delete the <EOL> between lines. This has the effect of joining
Bram Moolenaard38b0552012-04-25 19:07:41 +0200148multiple lines into one line. You can repeat these commands (except `:j`) and
Bram Moolenaar071d4272004-06-13 20:20:40 +0000149undo them.
150
151These commands, except "gJ", insert one space in place of the <EOL> unless
152there is trailing white space or the next line starts with a ')'. These
153commands, except "gJ", delete any leading white space on the next line. If
154the 'joinspaces' option is on, these commands insert two spaces after a '.',
155'!' or '?' (but if 'cpoptions' includes the 'j' flag, they insert two spaces
156only after a '.').
157The 'B' and 'M' flags in 'formatoptions' change the behavior for inserting
Bram Moolenaar207f0092020-08-30 17:20:20 +0200158spaces before and after a multibyte character |fo-table|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000159
Christian Brabandtdf684192025-04-03 12:33:02 +0200160The |'[| mark is set at the end of the first line that was joined, |']| at the
161end of the resulting line.
Bram Moolenaar251835e2014-02-24 02:51:51 +0100162
Bram Moolenaar071d4272004-06-13 20:20:40 +0000163
164==============================================================================
1652. Delete and insert *delete-insert* *replacing*
166
167 *R*
168R Enter Replace mode: Each character you type replaces
169 an existing character, starting with the character
170 under the cursor. Repeat the entered text [count]-1
171 times. See |Replace-mode| for more details.
172
173 *gR*
174gR Enter Virtual Replace mode: Each character you type
175 replaces existing characters in screen space. So a
176 <Tab> may replace several characters at once.
177 Repeat the entered text [count]-1 times. See
178 |Virtual-Replace-mode| for more details.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000179
180 *c*
181["x]c{motion} Delete {motion} text [into register x] and start
182 insert. When 'cpoptions' includes the 'E' flag and
183 there is no text to delete (e.g., with "cTx" when the
184 cursor is just after an 'x'), an error occurs and
185 insert mode does not start (this is Vi compatible).
186 When 'cpoptions' does not include the 'E' flag, the
187 "c" command always starts insert mode, even if there
188 is no text to delete.
189
190 *cc*
191["x]cc Delete [count] lines [into register x] and start
192 insert |linewise|. If 'autoindent' is on, preserve
193 the indent of the first line.
194
195 *C*
196["x]C Delete from the cursor position to the end of the
197 line and [count]-1 more lines [into register x], and
198 start insert. Synonym for c$ (not |linewise|).
199
200 *s*
201["x]s Delete [count] characters [into register x] and start
202 insert (s stands for Substitute). Synonym for "cl"
203 (not |linewise|).
204
205 *S*
206["x]S Delete [count] lines [into register x] and start
207 insert. Synonym for "cc" |linewise|.
208
209{Visual}["x]c or *v_c* *v_s*
210{Visual}["x]s Delete the highlighted text [into register x] and
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200211 start insert (for {Visual} see |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000212
213 *v_r*
Bram Moolenaar2c7f8c52020-04-20 19:52:53 +0200214{Visual}r{char} Replace all selected characters by {char}.
Christian Brabandt476733f2023-09-19 20:41:51 +0200215 CTRL-C will be inserted literally.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000216
217 *v_C*
218{Visual}["x]C Delete the highlighted lines [into register x] and
219 start insert. In Visual block mode it works
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200220 differently |v_b_C|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000221 *v_S*
222{Visual}["x]S Delete the highlighted lines [into register x] and
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200223 start insert (for {Visual} see |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000224 *v_R*
225{Visual}["x]R Currently just like {Visual}["x]S. In a next version
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200226 it might work differently.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000227
228Notes:
229- You can end Insert and Replace mode with <Esc>.
230- See the section "Insert and Replace mode" |mode-ins-repl| for the other
231 special characters in these modes.
232- The effect of [count] takes place after Vim exits Insert or Replace mode.
233- When the 'cpoptions' option contains '$' and the change is within one line,
234 Vim continues to show the text to be deleted and puts a '$' at the last
235 deleted character.
236
237See |registers| for an explanation of registers.
238
239Replace mode is just like Insert mode, except that every character you enter
240deletes one character. If you reach the end of a line, Vim appends any
241further characters (just like Insert mode). In Replace mode, the backspace
242key restores the original text (if there was any). (See section "Insert and
243Replace mode" |mode-ins-repl|).
244
245 *cw* *cW*
Bram Moolenaar446cb832008-06-24 21:56:24 +0000246Special case: When the cursor is in a word, "cw" and "cW" do not include the
247white space after a word, they only change up to the end of the word. This is
248because Vim interprets "cw" as change-word, and a word does not include the
249following white space.
250{Vi: "cw" when on a blank followed by other blanks changes only the first
251blank; this is probably a bug, because "dw" deletes all the blanks; use the
252'w' flag in 'cpoptions' to make it work like Vi anyway}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000253
254If you prefer "cw" to include the space after a word, use this mapping: >
255 :map cw dwi
Christian Brabandt22105fd2024-07-15 20:51:11 +0200256Alternatively use "caw" (see also |aw| and |cpo-z|).
Bram Moolenaar446cb832008-06-24 21:56:24 +0000257
Bram Moolenaar071d4272004-06-13 20:20:40 +0000258 *:c* *:ch* *:change*
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000259:{range}c[hange][!] Replace lines of text with some different text.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000260 Type a line containing only "." to stop replacing.
261 Without {range}, this command changes only the current
262 line.
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000263 Adding [!] toggles 'autoindent' for the time this
264 command is executed.
Bram Moolenaara4d131d2021-12-27 21:33:07 +0000265 This command is not supported in |Vim9| script,
266 because it is too easily confused with a variable
267 name.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268
269==============================================================================
2703. Simple changes *simple-change*
271
272 *r*
273r{char} Replace the character under the cursor with {char}.
274 If {char} is a <CR> or <NL>, a line break replaces the
275 character. To replace with a real <CR>, use CTRL-V
276 <CR>. CTRL-V <NL> replaces with a <Nul>.
Bram Moolenaar80716072012-05-01 21:14:34 +0200277
278 If {char} is CTRL-E or CTRL-Y the character from the
279 line below or above is used, just like with |i_CTRL-E|
280 and |i_CTRL-Y|. This also works with a count, thus
281 `10r<C-E>` copies 10 characters from the line below.
282
Bram Moolenaar071d4272004-06-13 20:20:40 +0000283 If you give a [count], Vim replaces [count] characters
284 with [count] {char}s. When {char} is a <CR> or <NL>,
285 however, Vim inserts only one <CR>: "5r<CR>" replaces
286 five characters with a single line break.
287 When {char} is a <CR> or <NL>, Vim performs
288 autoindenting. This works just like deleting the
289 characters that are replaced and then doing
290 "i<CR><Esc>".
291 {char} can be entered as a digraph |digraph-arg|.
292 |:lmap| mappings apply to {char}. The CTRL-^ command
293 in Insert mode can be used to switch this on/off
294 |i_CTRL-^|. See |utf-8-char-arg| about using
295 composing characters when 'encoding' is Unicode.
296
297 *gr*
298gr{char} Replace the virtual characters under the cursor with
299 {char}. This replaces in screen space, not file
300 space. See |gR| and |Virtual-Replace-mode| for more
301 details. As with |r| a count may be given.
Bram Moolenaardd60c362023-02-27 15:49:53 +0000302 {char} can be entered like with |r|, but characters
303 that have a special meaning in Insert mode, such as
304 most CTRL-keys, cannot be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000305
306 *digraph-arg*
307The argument for Normal mode commands like |r| and |t| is a single character.
308When 'cpo' doesn't contain the 'D' flag, this character can also be entered
309like |digraphs|. First type CTRL-K and then the two digraph characters.
310{not available when compiled without the |+digraphs| feature}
311
312 *case*
313The following commands change the case of letters. The currently active
314|locale| is used. See |:language|. The LC_CTYPE value matters here.
315
316 *~*
317~ 'notildeop' option: Switch case of the character
318 under the cursor and move the cursor to the right.
Bram Moolenaara6c27c42019-05-09 19:16:22 +0200319 If a [count] is given, do that many characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000320
Bram Moolenaara6c27c42019-05-09 19:16:22 +0200321~{motion} 'tildeop' option: switch case of {motion} text.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000322
323 *g~*
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200324g~{motion} Switch case of {motion} text.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000325
326g~g~ *g~g~* *g~~*
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200327g~~ Switch case of current line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000328
329 *v_~*
330{Visual}~ Switch case of highlighted text (for {Visual} see
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200331 |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000332
333 *v_U*
334{Visual}U Make highlighted text uppercase (for {Visual} see
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200335 |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000336
337 *gU* *uppercase*
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200338gU{motion} Make {motion} text uppercase.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000339 Example: >
340 :map! <C-F> <Esc>gUiw`]a
341< This works in Insert mode: press CTRL-F to make the
342 word before the cursor uppercase. Handy to type
343 words in lowercase and then make them uppercase.
344
345
346gUgU *gUgU* *gUU*
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200347gUU Make current line uppercase.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000348
349 *v_u*
350{Visual}u Make highlighted text lowercase (for {Visual} see
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200351 |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000352
353 *gu* *lowercase*
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200354gu{motion} Make {motion} text lowercase.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000355
356gugu *gugu* *guu*
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200357guu Make current line lowercase.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000358
359 *g?* *rot13*
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200360g?{motion} Rot13 encode {motion} text.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000361
362 *v_g?*
363{Visual}g? Rot13 encode the highlighted text (for {Visual} see
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200364 |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000365
366g?g? *g?g?* *g??*
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200367g?? Rot13 encode current line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000368
Bram Moolenaar446cb832008-06-24 21:56:24 +0000369To turn one line into title caps, make every first letter of a word
370uppercase: >
371 :s/\v<(.)(\w*)/\u\1\L\2/g
372
Bram Moolenaar071d4272004-06-13 20:20:40 +0000373
374Adding and subtracting ~
375 *CTRL-A*
376CTRL-A Add [count] to the number or alphabetic character at
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200377 or after the cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000378
Bram Moolenaar979243b2015-06-26 19:35:49 +0200379 *v_CTRL-A*
380{Visual}CTRL-A Add [count] to the number or alphabetic character in
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200381 the highlighted text.
Bram Moolenaar979243b2015-06-26 19:35:49 +0200382
383 *v_g_CTRL-A*
384{Visual}g CTRL-A Add [count] to the number or alphabetic character in
385 the highlighted text. If several lines are
386 highlighted, each one will be incremented by an
387 additional [count] (so effectively creating a
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200388 [count] incrementing sequence).
Bram Moolenaar979243b2015-06-26 19:35:49 +0200389 For Example, if you have this list of numbers:
390 1. ~
391 1. ~
392 1. ~
393 1. ~
394 Move to the second "1." and Visually select three
395 lines, pressing g CTRL-A results in:
396 1. ~
397 2. ~
398 3. ~
399 4. ~
400
Bram Moolenaar071d4272004-06-13 20:20:40 +0000401 *CTRL-X*
402CTRL-X Subtract [count] from the number or alphabetic
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200403 character at or after the cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000404
Bram Moolenaar979243b2015-06-26 19:35:49 +0200405 *v_CTRL-X*
406{Visual}CTRL-X Subtract [count] from the number or alphabetic
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200407 character in the highlighted text.
Bram Moolenaar979243b2015-06-26 19:35:49 +0200408
Bram Moolenaare0fa3742016-02-20 15:47:01 +0100409 On MS-Windows, this is mapped to cut Visual text
410 |dos-standard-mappings|. If you want to disable the
411 mapping, use this: >
412 silent! vunmap <C-X>
413<
Bram Moolenaar979243b2015-06-26 19:35:49 +0200414 *v_g_CTRL-X*
415{Visual}g CTRL-X Subtract [count] from the number or alphabetic
416 character in the highlighted text. If several lines
417 are highlighted, each value will be decremented by an
418 additional [count] (so effectively creating a [count]
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200419 decrementing sequence).
Bram Moolenaar979243b2015-06-26 19:35:49 +0200420
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100421The CTRL-A and CTRL-X commands can work for:
422- signed and unsigned decimal numbers
423- unsigned binary, octal and hexadecimal numbers
424- alphabetic characters
425
426This depends on the 'nrformats' option:
427- When 'nrformats' includes "bin", Vim assumes numbers starting with '0b' or
428 '0B' are binary.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000429- When 'nrformats' includes "octal", Vim considers numbers starting with a '0'
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000430 to be octal, unless the number includes a '8' or '9'. Other numbers are
431 decimal and may have a preceding minus sign.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000432 If the cursor is on a number, the commands apply to that number; otherwise
433 Vim uses the number to the right of the cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000434- When 'nrformats' includes "hex", Vim assumes numbers starting with '0x' or
435 '0X' are hexadecimal. The case of the rightmost letter in the number
436 determines the case of the resulting hexadecimal number. If there is no
437 letter in the current number, Vim uses the previously detected case.
438- When 'nrformats' includes "alpha", Vim will change the alphabetic character
439 under or after the cursor. This is useful to make lists with an alphabetic
440 index.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000441
Bram Moolenaar979243b2015-06-26 19:35:49 +0200442For decimals a leading negative sign is considered for incrementing/
Bram Moolenaarfa735342016-01-03 22:14:44 +0100443decrementing, for binary, octal and hex values, it won't be considered. To
Bram Moolenaar85eee132018-05-06 17:57:30 +0200444ignore the sign Visually select the number before using CTRL-A or CTRL-X.
Bram Moolenaar979243b2015-06-26 19:35:49 +0200445
Bram Moolenaar071d4272004-06-13 20:20:40 +0000446For numbers with leading zeros (including all octal and hexadecimal numbers),
447Vim preserves the number of characters in the number when possible. CTRL-A on
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000448"0077" results in "0100", CTRL-X on "0x100" results in "0x0ff".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000449There is one exception: When a number that starts with a zero is found not to
450be octal (it contains a '8' or '9'), but 'nrformats' does include "octal",
451leading zeros are removed to avoid that the result may be recognized as an
452octal number.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000453
454Note that when 'nrformats' includes "octal", decimal numbers with leading
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000455zeros cause mistakes, because they can be confused with octal numbers.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000456
K.Takata955652f2023-12-20 04:15:47 +0900457Note similarly, when 'nrformats' includes both "bin" and "hex", binary numbers
458with a leading '0x' or '0X' can be interpreted as hexadecimal rather than
459binary since '0b' are valid hexadecimal digits. CTRL-A on "0x0b11" results in
460"0x0b12", not "0x0b100".
461When 'nrformats' includes "bin" and doesn't include "hex", CTRL-A on "0b11" in
462"0x0b11" results in "0x0b100".
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100463
Bram Moolenaar71badf92023-04-22 22:40:14 +0100464When the number under the cursor is too big to fit into 32 or 64 bit
465(depending on how Vim was build), it will be rounded off to the nearest number
466that can be represented, and the addition/subtraction is skipped. E.g. with
46764 bit support using CTRL-X on 18446744073709551616 results in
46818446744073709551615. Same for larger numbers, such as 18446744073709551618.
469
Bram Moolenaar071d4272004-06-13 20:20:40 +0000470The CTRL-A command is very useful in a macro. Example: Use the following
471steps to make a numbered list.
472
4731. Create the first list entry, make sure it starts with a number.
Bram Moolenaard8b02732005-01-14 21:48:43 +00004742. qa - start recording into register 'a'
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753. Y - yank the entry
4764. p - put a copy of the entry below the first one
4775. CTRL-A - increment the number
4786. q - stop recording
4797. <count>@a - repeat the yank, put and increment <count> times
480
481
482SHIFTING LINES LEFT OR RIGHT *shift-left-right*
483
484 *<*
485<{motion} Shift {motion} lines one 'shiftwidth' leftwards.
486
Bram Moolenaarf9514162018-11-22 03:08:29 +0100487 If the 'vartabstop' feature is enabled, and the
488 'shiftwidth' option is set to zero, the amount of
489 indent is calculated at the first non-blank character
490 in the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000491 *<<*
492<< Shift [count] lines one 'shiftwidth' leftwards.
493
494 *v_<*
495{Visual}[count]< Shift the highlighted lines [count] 'shiftwidth'
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200496 leftwards (for {Visual} see |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000497
498 *>*
499 >{motion} Shift {motion} lines one 'shiftwidth' rightwards.
500
Bram Moolenaarf9514162018-11-22 03:08:29 +0100501 If the 'vartabstop' feature is enabled, and the
502 'shiftwidth' option is set to zero, the amount of
503 indent is calculated at the first non-blank character
504 in the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000505 *>>*
506 >> Shift [count] lines one 'shiftwidth' rightwards.
507
508 *v_>*
509{Visual}[count]> Shift the highlighted lines [count] 'shiftwidth'
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200510 rightwards (for {Visual} see |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000511
512 *:<*
513:[range]< Shift [range] lines one 'shiftwidth' left. Repeat '<'
514 for shifting multiple 'shiftwidth's.
515
516:[range]< {count} Shift {count} lines one 'shiftwidth' left, starting
517 with [range] (default current line |cmdline-ranges|).
518 Repeat '<' for shifting multiple 'shiftwidth's.
519
520:[range]le[ft] [indent] left align lines in [range]. Sets the indent in the
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200521 lines to [indent] (default 0).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000522
523 *:>*
Roy Orbitson2103a562023-12-06 01:14:33 +1030524:[range]> [flags] Shift [range] lines one 'shiftwidth' right.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000525 Repeat '>' for shifting multiple 'shiftwidth's.
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000526 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000527
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000528:[range]> {count} [flags]
529 Shift {count} lines one 'shiftwidth' right, starting
Bram Moolenaar071d4272004-06-13 20:20:40 +0000530 with [range] (default current line |cmdline-ranges|).
531 Repeat '>' for shifting multiple 'shiftwidth's.
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000532 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000533
534The ">" and "<" commands are handy for changing the indentation within
535programs. Use the 'shiftwidth' option to set the size of the white space
536which these commands insert or delete. Normally the 'shiftwidth' option is 8,
537but you can set it to, say, 3 to make smaller indents. The shift leftwards
538stops when there is no indent. The shift right does not affect empty lines.
539
540If the 'shiftround' option is on, the indent is rounded to a multiple of
541'shiftwidth'.
542
543If the 'smartindent' option is on, or 'cindent' is on and 'cinkeys' contains
Bram Moolenaar8e69b4a2013-11-09 03:41:58 +0100544'#' with a zero value, shift right does not affect lines starting with '#'
545(these are supposed to be C preprocessor lines that must stay in column 1).
Bram Moolenaar7dda86f2018-04-20 22:36:41 +0200546This can be changed with the 'cino' option, see |cino-#|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000547
548When the 'expandtab' option is off (this is the default) Vim uses <Tab>s as
549much as possible to make the indent. You can use ">><<" to replace an indent
550made out of spaces with the same indent made out of <Tab>s (and a few spaces
551if necessary). If the 'expandtab' option is on, Vim uses only spaces. Then
552you can use ">><<" to replace <Tab>s in the indent by spaces (or use
Bram Moolenaard38b0552012-04-25 19:07:41 +0200553`:retab!`).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000554
Bram Moolenaard38b0552012-04-25 19:07:41 +0200555To move a line several 'shiftwidth's, use Visual mode or the `:` commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000556For example: >
557 Vjj4> move three lines 4 indents to the right
558 :<<< move current line 3 indents to the left
559 :>> 5 move 5 lines 2 indents to the right
560 :5>> move line 5 2 indents to the right
561
562==============================================================================
5634. Complex changes *complex-change*
564
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00005654.1 Filter commands *filter*
Bram Moolenaar47136d72004-10-12 20:02:24 +0000566
567A filter is a program that accepts text at standard input, changes it in some
568way, and sends it to standard output. You can use the commands below to send
Bram Moolenaar446cb832008-06-24 21:56:24 +0000569some text through a filter, so that it is replaced by the filter output.
Bram Moolenaar47136d72004-10-12 20:02:24 +0000570Examples of filters are "sort", which sorts lines alphabetically, and
571"indent", which formats C program files (you need a version of indent that
572works like a filter; not all versions do). The 'shell' option specifies the
573shell Vim uses to execute the filter command (See also the 'shelltype'
574option). You can repeat filter commands with ".". Vim does not recognize a
Bram Moolenaard38b0552012-04-25 19:07:41 +0200575comment (starting with '"') after the `:!` command.
Bram Moolenaar47136d72004-10-12 20:02:24 +0000576
577 *!*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000578!{motion}{filter} Filter {motion} text lines through the external
579 program {filter}.
580
581 *!!*
582!!{filter} Filter [count] lines through the external program
583 {filter}.
584
585 *v_!*
586{Visual}!{filter} Filter the highlighted lines through the external
587 program {filter} (for {Visual} see |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000588
589:{range}![!]{filter} [!][arg] *:range!*
Christian Brabandtf18987c2024-11-12 21:38:22 +0100590 For executing external commands see |:!|
591
Bram Moolenaar071d4272004-06-13 20:20:40 +0000592 Filter {range} lines through the external program
593 {filter}. Vim replaces the optional bangs with the
594 latest given command and appends the optional [arg].
595 Vim saves the output of the filter command in a
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100596 temporary file and then reads the file into the buffer
597 |tempfile|. Vim uses the 'shellredir' option to
598 redirect the filter output to the temporary file.
Bram Moolenaar83c465c2005-12-16 21:53:56 +0000599 However, if the 'shelltemp' option is off then pipes
600 are used when possible (on Unix).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000601 When the 'R' flag is included in 'cpoptions' marks in
602 the filtered lines are deleted, unless the
603 |:keepmarks| command is used. Example: >
604 :keepmarks '<,'>!sort
605< When the number of lines after filtering is less than
606 before, marks in the missing lines are deleted anyway.
607
608 *=*
609={motion} Filter {motion} lines through the external program
610 given with the 'equalprg' option. When the 'equalprg'
611 option is empty (this is the default), use the
Bram Moolenaar20f90cf2011-05-19 12:22:51 +0200612 internal formatting function |C-indenting| and
613 |'lisp'|. But when 'indentexpr' is not empty, it will
614 be used instead |indent-expression|. When Vim was
615 compiled without internal formatting then the "indent"
616 program is used as a last resort.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000617
618 *==*
619== Filter [count] lines like with ={motion}.
620
621 *v_=*
622{Visual}= Filter the highlighted lines like with ={motion}.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000623
Bram Moolenaar071d4272004-06-13 20:20:40 +0000624
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100625 *tempfile* *setuid*
626Vim uses temporary files for filtering, generating diffs and also for
627tempname(). For Unix, the file will be in a private directory (only
628accessible by the current user) to avoid security problems (e.g., a symlink
629attack or other people reading your file). When Vim exits the directory and
Christian Brabandt5cf53012024-05-18 10:13:11 +0200630all files in it are deleted (only on Unix, on other systems you will have to
631clean up yourself). When Vim has the setuid bit set this may cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100632problems, the temp file is owned by the setuid user but the filter command
633probably runs as the original user.
Bram Moolenaar75ab5902022-04-18 15:36:40 +0100634Directory for temporary files is created in the first of these directories
635that works:
636 Unix: $TMPDIR, /tmp, current-dir, $HOME.
637 Windows: $TMP, $TEMP, c:\TMP, c:\TEMP
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100638For MS-Windows the GetTempFileName() system function is used.
639For other systems the tmpnam() library function is used.
640
641
642
Bram Moolenaar47136d72004-10-12 20:02:24 +00006434.2 Substitute *:substitute*
644 *:s* *:su*
Bram Moolenaar05159a02005-02-26 23:04:13 +0000645:[range]s[ubstitute]/{pattern}/{string}/[flags] [count]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000646 For each line in [range] replace a match of {pattern}
647 with {string}.
648 For the {pattern} see |pattern|.
649 {string} can be a literal string, or something
650 special; see |sub-replace-special|.
651 When [range] and [count] are omitted, replace in the
Bram Moolenaar3df01732017-02-17 22:47:16 +0100652 current line only. When [count] is given, replace in
653 [count] lines, starting with the last line in [range].
654 When [range] is omitted start in the current line.
Christian Brabandtac637872023-11-14 20:45:48 +0100655 *E939* *E1510*
656 [count] must be a positive number (max 2147483647)
657 Also see |cmdline-ranges|.
Bram Moolenaar3df01732017-02-17 22:47:16 +0100658
Bram Moolenaar05159a02005-02-26 23:04:13 +0000659 See |:s_flags| for [flags].
Bram Moolenaarebdf3c92020-02-15 21:41:42 +0100660 The delimiter doesn't need to be /, see
661 |pattern-delimiter|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000662
Bram Moolenaar05159a02005-02-26 23:04:13 +0000663:[range]s[ubstitute] [flags] [count]
664:[range]&[&][flags] [count] *:&*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000665 Repeat last :substitute with same search pattern and
666 substitute string, but without the same flags. You
Bram Moolenaar05159a02005-02-26 23:04:13 +0000667 may add [flags], see |:s_flags|.
Christian Brabandt0bc87092025-05-28 20:23:29 +0200668 Note that after `:substitute` the '&' and '#' flags
669 can't be used, they're recognized as a pattern
670 separator.
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200671 The space between `:substitute` and the 'c', 'g',
672 'i', 'I' and 'r' flags isn't required, but in scripts
673 it's a good idea to keep it to avoid confusion.
Bram Moolenaarc8cdf0f2021-03-13 13:28:13 +0100674 Also see the two and three letter commands to repeat
675 :substitute below |:substitute-repeat|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000676
Bram Moolenaar05159a02005-02-26 23:04:13 +0000677:[range]~[&][flags] [count] *:~*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000678 Repeat last substitute with same substitute string
679 but with last used search pattern. This is like
Bram Moolenaard38b0552012-04-25 19:07:41 +0200680 `:&r`. See |:s_flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000681
Bram Moolenaar05159a02005-02-26 23:04:13 +0000682 *&*
Bram Moolenaard38b0552012-04-25 19:07:41 +0200683& Synonym for `:s` (repeat last substitute). Note
Bram Moolenaar071d4272004-06-13 20:20:40 +0000684 that the flags are not remembered, thus it might
Bram Moolenaard38b0552012-04-25 19:07:41 +0200685 actually work differently. You can use `:&&` to keep
Bram Moolenaar071d4272004-06-13 20:20:40 +0000686 the flags.
687
Bram Moolenaar05159a02005-02-26 23:04:13 +0000688 *g&*
Bram Moolenaar97d62492012-11-15 21:28:22 +0100689g& Synonym for `:%s//~/&` (repeat last substitute with
690 last search pattern on all lines with the same flags).
Bram Moolenaar34700a62013-03-07 13:20:54 +0100691 For example, when you first do a substitution with
Bram Moolenaar97d62492012-11-15 21:28:22 +0100692 `:s/pattern/repl/flags` and then `/search` for
693 something else, `g&` will do `:%s/search/repl/flags`.
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200694 Mnemonic: global substitute.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695
696 *:snomagic* *:sno*
Bram Moolenaard38b0552012-04-25 19:07:41 +0200697:[range]sno[magic] ... Same as `:substitute`, but always use 'nomagic'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000698
699 *:smagic* *:sm*
Bram Moolenaard38b0552012-04-25 19:07:41 +0200700:[range]sm[agic] ... Same as `:substitute`, but always use 'magic'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000701
702 *:s_flags*
703The flags that you can use for the substitute commands:
704
Bram Moolenaar51628222016-12-01 23:03:28 +0100705 *:&&*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000706[&] Must be the first one: Keep the flags from the previous substitute
707 command. Examples: >
708 :&&
709 :s/this/that/&
Bram Moolenaard38b0552012-04-25 19:07:41 +0200710< Note that `:s` and `:&` don't keep the flags.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000711
712[c] Confirm each substitution. Vim highlights the matching string (with
713 |hl-IncSearch|). You can type: *:s_c*
714 'y' to substitute this match
715 'l' to substitute this match and then quit ("last")
716 'n' to skip this match
717 <Esc> to quit substituting
Bram Moolenaar25c9c682019-05-05 18:13:34 +0200718 'a' to substitute this and all remaining matches
719 'q' to quit substituting
Bram Moolenaare2c453d2019-08-21 14:37:09 +0200720 CTRL-E to scroll the screen up
721 CTRL-Y to scroll the screen down
Bram Moolenaar071d4272004-06-13 20:20:40 +0000722 If the 'edcompatible' option is on, Vim remembers the [c] flag and
723 toggles it each time you use it, but resets it when you give a new
724 search pattern.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000725
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200726 *:s_e*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000727[e] When the search pattern fails, do not issue an error message and, in
728 particular, continue in maps as if no error occurred. This is most
729 useful to prevent the "No match" error from breaking a mapping. Vim
730 does not suppress the following error messages, however:
731 Regular expressions can't be delimited by letters
732 \ should be followed by /, ? or &
733 No previous substitute regular expression
734 Trailing characters
735 Interrupted
Bram Moolenaar071d4272004-06-13 20:20:40 +0000736
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200737 *:s_g*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000738[g] Replace all occurrences in the line. Without this argument,
739 replacement occurs only for the first occurrence in each line. If
740 the 'edcompatible' option is on, Vim remembers this flag and toggles
741 it each time you use it, but resets it when you give a new search
742 pattern. If the 'gdefault' option is on, this flag is on by default
743 and the [g] argument switches it off.
744
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200745 *:s_i*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000746[i] Ignore case for the pattern. The 'ignorecase' and 'smartcase' options
747 are not used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000748
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200749 *:s_I*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000750[I] Don't ignore case for the pattern. The 'ignorecase' and 'smartcase'
751 options are not used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000752
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200753 *:s_n*
Bram Moolenaar05159a02005-02-26 23:04:13 +0000754[n] Report the number of matches, do not actually substitute. The [c]
755 flag is ignored. The matches are reported as if 'report' is zero.
756 Useful to |count-items|.
Bram Moolenaar9b451252012-08-15 17:43:31 +0200757 If \= |sub-replace-expression| is used, the expression will be
758 evaluated in the |sandbox| at every match.
Bram Moolenaar05159a02005-02-26 23:04:13 +0000759
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200760[p] Print the line containing the last substitute. *:s_p*
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000761
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200762[#] Like [p] and prepend the line number. *:s_#*
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000763
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200764[l] Like [p] but print the text like |:list|. *:s_l*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000765
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200766 *:s_r*
Bram Moolenaard38b0552012-04-25 19:07:41 +0200767[r] Only useful in combination with `:&` or `:s` without arguments. `:&r`
768 works the same way as `:~`: When the search pattern is empty, use the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 previously used search pattern instead of the search pattern from the
Bram Moolenaard38b0552012-04-25 19:07:41 +0200770 last substitute or `:global`. If the last command that did a search
771 was a substitute or `:global`, there is no effect. If the last
Bram Moolenaar071d4272004-06-13 20:20:40 +0000772 command was a search command such as "/", use the pattern from that
773 command.
Bram Moolenaard38b0552012-04-25 19:07:41 +0200774 For `:s` with an argument this already happens: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000775 :s/blue/red/
776 /green
777 :s//red/ or :~ or :&r
778< The last commands will replace "green" with "red". >
779 :s/blue/red/
780 /green
781 :&
782< The last command will replace "blue" with "red".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000783
784Note that there is no flag to change the "magicness" of the pattern. A
Bram Moolenaar446cb832008-06-24 21:56:24 +0000785different command is used instead, or you can use |/\v| and friends. The
786reason is that the flags can only be found by skipping the pattern, and in
787order to skip the pattern the "magicness" must be known. Catch 22!
Bram Moolenaar071d4272004-06-13 20:20:40 +0000788
789If the {pattern} for the substitute command is empty, the command uses the
Bram Moolenaard38b0552012-04-25 19:07:41 +0200790pattern from the last substitute or `:global` command. If there is none, but
Bram Moolenaar662db672011-03-22 14:05:35 +0100791there is a previous search pattern, that one is used. With the [r] flag, the
Bram Moolenaard38b0552012-04-25 19:07:41 +0200792command uses the pattern from the last substitute, `:global`, or search
Bram Moolenaar071d4272004-06-13 20:20:40 +0000793command.
794
Bram Moolenaar9964e462007-05-05 17:54:07 +0000795If the {string} is omitted the substitute is done as if it's empty. Thus the
796matched pattern is deleted. The separator after {pattern} can also be left
797out then. Example: >
798 :%s/TESTING
799This deletes "TESTING" from all lines, but only one per line.
Bram Moolenaar1588bc82022-03-08 21:35:07 +0000800 *E1270*
801For compatibility with Vi these two exceptions are allowed in legacy script:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000802"\/{string}/" and "\?{string}?" do the same as "//{string}/r".
803"\&{string}&" does the same as "//{string}/".
Bram Moolenaara2baa732022-02-04 16:09:54 +0000804 *pattern-delimiter* *E146* *E1241* *E1242*
Bram Moolenaar4d8f4762021-06-27 15:18:56 +0200805Instead of the '/' which surrounds the pattern and replacement string, you can
806use another single-byte character. This is useful if you want to include a
807'/' in the search pattern or replacement string. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000808 :s+/+//+
809
Bram Moolenaar4d8f4762021-06-27 15:18:56 +0200810You can use most characters, but not an alphanumeric character, '\', '"' or
811'|'. In Vim9 script you should not use '#' because it may be recognized as
812the start of a comment.
813
Bram Moolenaar446cb832008-06-24 21:56:24 +0000814For the definition of a pattern, see |pattern|. In Visual block mode, use
815|/\%V| in the pattern to have the substitute work in the block only.
816Otherwise it works on whole lines anyway.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000817
818 *sub-replace-special* *:s\=*
819When the {string} starts with "\=" it is evaluated as an expression, see
Bram Moolenaar251e1912011-06-19 05:09:16 +0200820|sub-replace-expression|. You can use that for complex replacement or special
821characters.
822
Bram Moolenaar2ecbe532022-07-29 21:36:21 +0100823The substitution is limited in recursion to 4 levels. *E1290*
824
Bram Moolenaar5a8684e2005-07-30 22:43:24 +0000825Otherwise these characters in {string} have a special meaning:
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000826 *:s%*
Bram Moolenaar551dbcc2006-04-25 22:13:59 +0000827When {string} is equal to "%" and '/' is included with the 'cpoptions' option,
Bram Moolenaar251e1912011-06-19 05:09:16 +0200828then the {string} of the previous substitute command is used, see |cpo-/|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000829
830magic nomagic action ~
831 & \& replaced with the whole matched pattern *s/\&*
832 \& & replaced with &
833 \0 replaced with the whole matched pattern *\0* *s/\0*
834 \1 replaced with the matched pattern in the first
835 pair of () *s/\1*
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +0000836 \2 replaced with the matched pattern in the second
Bram Moolenaar071d4272004-06-13 20:20:40 +0000837 pair of () *s/\2*
838 .. .. *s/\3*
839 \9 replaced with the matched pattern in the ninth
840 pair of () *s/\9*
841 ~ \~ replaced with the {string} of the previous
842 substitute *s~*
843 \~ ~ replaced with ~ *s/\~*
844 \u next character made uppercase *s/\u*
845 \U following characters made uppercase, until \E *s/\U*
846 \l next character made lowercase *s/\l*
847 \L following characters made lowercase, until \E *s/\L*
848 \e end of \u, \U, \l and \L (NOTE: not <Esc>!) *s/\e*
849 \E end of \u, \U, \l and \L *s/\E*
850 <CR> split line in two at this point
851 (Type the <CR> as CTRL-V <Enter>) *s<CR>*
852 \r idem *s/\r*
853 \<CR> insert a carriage-return (CTRL-M)
854 (Type the <CR> as CTRL-V <Enter>) *s/\<CR>*
855 \n insert a <NL> (<NUL> in the file)
856 (does NOT break the line) *s/\n*
857 \b insert a <BS> *s/\b*
858 \t insert a <Tab> *s/\t*
859 \\ insert a single backslash *s/\\*
860 \x where x is any character not mentioned above:
861 Reserved for future expansion
862
Bram Moolenaar251e1912011-06-19 05:09:16 +0200863The special meaning is also used inside the third argument {sub} of
864the |substitute()| function with the following exceptions:
865 - A % inserts a percent literally without regard to 'cpoptions'.
866 - magic is always set without regard to 'magic'.
867 - A ~ inserts a tilde literally.
868 - <CR> and \r inserts a carriage-return (CTRL-M).
Bram Moolenaarba3ff532018-11-04 14:45:49 +0100869 - \<CR> does not have a special meaning. It's just one of \x.
Bram Moolenaar251e1912011-06-19 05:09:16 +0200870
Bram Moolenaar071d4272004-06-13 20:20:40 +0000871Examples: >
872 :s/a\|b/xxx\0xxx/g modifies "a b" to "xxxaxxx xxxbxxx"
873 :s/\([abc]\)\([efg]\)/\2\1/g modifies "af fa bg" to "fa fa gb"
874 :s/abcde/abc^Mde/ modifies "abcde" to "abc", "de" (two lines)
875 :s/$/\^M/ modifies "abcde" to "abcde^M"
Bram Moolenaarefd2bf12006-03-16 21:41:35 +0000876 :s/\w\+/\u\0/g modifies "bla bla" to "Bla Bla"
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +0200877 :s/\w\+/\L\u\0/g modifies "BLA bla" to "Bla Bla"
Bram Moolenaarbf884932013-04-05 22:26:15 +0200878
879Note: "\L\u" can be used to capitalize the first letter of a word. This is
880not compatible with Vi and older versions of Vim, where the "\u" would cancel
881out the "\L". Same for "\U\l".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000882
883Note: In previous versions CTRL-V was handled in a special way. Since this is
884not Vi compatible, this was removed. Use a backslash instead.
885
886command text result ~
887:s/aa/a^Ma/ aa a<line-break>a
888:s/aa/a\^Ma/ aa a^Ma
889:s/aa/a\\^Ma/ aa a\<line-break>a
890
891(you need to type CTRL-V <CR> to get a ^M here)
892
893The numbering of "\1", "\2" etc. is done based on which "\(" comes first in
894the pattern (going left to right). When a parentheses group matches several
895times, the last one will be used for "\1", "\2", etc. Example: >
896 :s/\(\(a[a-d] \)*\)/\2/ modifies "aa ab x" to "ab x"
Bram Moolenaar7e1479b2016-09-11 15:07:27 +0200897The "\2" is for "\(a[a-d] \)". At first it matches "aa ", secondly "ab ".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000898
899When using parentheses in combination with '|', like in \([ab]\)\|\([cd]\),
900either the first or second pattern in parentheses did not match, so either
901\1 or \2 is empty. Example: >
902 :s/\([ab]\)\|\([cd]\)/\1x/g modifies "a b c d" to "ax bx x x"
903<
904
Bram Moolenaara0f849e2015-10-30 14:37:44 +0100905 *:sc* *:sce* *:scg* *:sci* *:scI* *:scl* *:scp* *:sg* *:sgc*
906 *:sge* *:sgi* *:sgI* *:sgl* *:sgn* *:sgp* *:sgr* *:sI* *:si*
907 *:sic* *:sIc* *:sie* *:sIe* *:sIg* *:sIl* *:sin* *:sIn* *:sIp*
908 *:sip* *:sIr* *:sir* *:sr* *:src* *:srg* *:sri* *:srI* *:srl*
Bram Moolenaarc8cdf0f2021-03-13 13:28:13 +0100909 *:srn* *:srp* *:substitute-repeat*
Bram Moolenaara0f849e2015-10-30 14:37:44 +01009102-letter and 3-letter :substitute commands ~
911
Bram Moolenaarc8cdf0f2021-03-13 13:28:13 +0100912These commands repeat the previous `:substitute` command with the given flags.
913The first letter is always "s", followed by one or two of the possible flag
914characters. For example `:sce` works like `:s///ce`. The table lists the
915possible combinations, not all flags are possible, because the command is
916short for another command.
917
Bram Moolenaara0f849e2015-10-30 14:37:44 +0100918 List of :substitute commands
919 | c e g i I n p l r
Bram Moolenaarc8cdf0f2021-03-13 13:28:13 +0100920 | c :sc :sce :scg :sci :scI :scn :scp :scl
Bram Moolenaara0f849e2015-10-30 14:37:44 +0100921 | e
922 | g :sgc :sge :sg :sgi :sgI :sgn :sgp :sgl :sgr
Bram Moolenaarc8cdf0f2021-03-13 13:28:13 +0100923 | i :sic :sie :si :siI :sin :sip :sir
Bram Moolenaara0f849e2015-10-30 14:37:44 +0100924 | I :sIc :sIe :sIg :sIi :sI :sIn :sIp :sIl :sIr
925 | n
926 | p
927 | l
Bram Moolenaarc8cdf0f2021-03-13 13:28:13 +0100928 | r :src :srg :sri :srI :srn :srp :srl :sr
Bram Moolenaara0f849e2015-10-30 14:37:44 +0100929
930Exceptions:
931 :scr is `:scriptnames`
932 :se is `:set`
933 :sig is `:sign`
934 :sil is `:silent`
935 :sn is `:snext`
936 :sp is `:split`
937 :sl is `:sleep`
938 :sre is `:srewind`
939
940
Bram Moolenaar071d4272004-06-13 20:20:40 +0000941Substitute with an expression *sub-replace-expression*
Bram Moolenaar92dff182014-02-11 19:15:50 +0100942 *sub-replace-\=* *s/\=*
Bram Moolenaara7fc0102005-05-18 22:17:12 +0000943When the substitute string starts with "\=" the remainder is interpreted as an
Bram Moolenaar6100d022016-10-02 16:51:57 +0200944expression.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000945
946The special meaning for characters as mentioned at |sub-replace-special| does
Bram Moolenaar251e1912011-06-19 05:09:16 +0200947not apply except for "<CR>". A <NL> character is used as a line break, you
948can get one with a double-quote string: "\n". Prepend a backslash to get a
949real <NL> character (which will be a NUL in the file).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000950
Bram Moolenaar251e1912011-06-19 05:09:16 +0200951The "\=" notation can also be used inside the third argument {sub} of
952|substitute()| function. In this case, the special meaning for characters as
953mentioned at |sub-replace-special| does not apply at all. Especially, <CR> and
954<NL> are interpreted not as a line break but as a carriage-return and a
955new-line respectively.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000956
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000957When the result is a |List| then the items are joined with separating line
958breaks. Thus each item becomes a line, except that they can contain line
959breaks themselves.
960
Bram Moolenaar9d87a372018-12-18 21:41:50 +0100961The |submatch()| function can be used to obtain matched text. The whole
962matched text can be accessed with "submatch(0)". The text matched with the
963first pair of () with "submatch(1)". Likewise for further sub-matches in ().
Bram Moolenaar071d4272004-06-13 20:20:40 +0000964
965Be careful: The separation character must not appear in the expression!
966Consider using a character like "@" or ":". There is no problem if the result
967of the expression contains the separation character.
968
Bram Moolenaar5a8684e2005-07-30 22:43:24 +0000969Examples: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000970 :s@\n@\="\r" .. expand("$HOME") .. "\r"@
Bram Moolenaar5a8684e2005-07-30 22:43:24 +0000971This replaces an end-of-line with a new line containing the value of $HOME. >
972
973 s/E/\="\<Char-0x20ac>"/g
Bram Moolenaarc236c162008-07-13 17:41:49 +0000974This replaces each 'E' character with a euro sign. Read more in |<Char->|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000975
976
Bram Moolenaar47136d72004-10-12 20:02:24 +00009774.3 Search and replace *search-replace*
978
979 *:pro* *:promptfind*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000980:promptf[ind] [string]
981 Put up a Search dialog. When [string] is given, it is
982 used as the initial search string.
983 {only for Win32, Motif and GTK GUI}
984
985 *:promptr* *:promptrepl*
986:promptr[epl] [string]
987 Put up a Search/Replace dialog. When [string] is
988 given, it is used as the initial search string.
989 {only for Win32, Motif and GTK GUI}
990
Bram Moolenaar47136d72004-10-12 20:02:24 +0000991
9924.4 Changing tabs *change-tabs*
Bram Moolenaard38b0552012-04-25 19:07:41 +0200993 *:ret* *:retab* *:retab!*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000994:[range]ret[ab][!] [new_tabstop]
995 Replace all sequences of white-space containing a
996 <Tab> with new strings of white-space using the new
997 tabstop value given. If you do not specify a new
998 tabstop size or it is zero, Vim uses the current value
999 of 'tabstop'.
1000 The current value of 'tabstop' is always used to
1001 compute the width of existing tabs.
1002 With !, Vim also replaces strings of only normal
1003 spaces with tabs where appropriate.
1004 With 'expandtab' on, Vim replaces all tabs with the
1005 appropriate number of spaces.
1006 This command sets 'tabstop' to the new value given,
1007 and if performed on the whole file, which is default,
1008 should not make any visible change.
1009 Careful: This command modifies any <Tab> characters
1010 inside of strings in a C program. Use "\t" to avoid
1011 this (that's a good habit anyway).
Bram Moolenaard38b0552012-04-25 19:07:41 +02001012 `:retab!` may also change a sequence of spaces by
Bram Moolenaar071d4272004-06-13 20:20:40 +00001013 <Tab> characters, which can mess up a printf().
Bram Moolenaar04958cb2018-06-23 19:23:02 +02001014 If the |+vartabs| feature is enabled then a list of
1015 tab widths separated by commas may be used in place of
1016 a single tabstop. Each value in the list represents
1017 the width of one tabstop, except the final value which
1018 applies to all following tabstops.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001019
1020 *retab-example*
1021Example for using autocommands and ":retab" to edit a file which is stored
1022with tabstops at 8 but edited with tabstops set at 4. Warning: white space
1023inside of strings can change! Also see 'softtabstop' option. >
1024
1025 :auto BufReadPost *.xx retab! 4
1026 :auto BufWritePre *.xx retab! 8
1027 :auto BufWritePost *.xx retab! 4
1028 :auto BufNewFile *.xx set ts=4
1029
1030==============================================================================
10315. Copying and moving text *copy-move*
1032
1033 *quote*
Bram Moolenaar7ceefb32020-05-01 16:07:38 +02001034"{register} Use {register} for next delete, yank or put. Use
1035 an uppercase character to append with delete and yank.
1036 Registers ".", "%", "#" and ":" only work with put.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001037
1038 *:reg* *:registers*
Bram Moolenaar3691f1e2019-10-24 20:17:00 +02001039:reg[isters] Display the type and contents of all numbered and
1040 named registers. If a register is written to for
1041 |:redir| it will not be listed.
1042 Type can be one of:
1043 "c" for |characterwise| text
1044 "l" for |linewise| text
1045 "b" for |blockwise-visual| text
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001046
Bram Moolenaar071d4272004-06-13 20:20:40 +00001047
1048:reg[isters] {arg} Display the contents of the numbered and named
1049 registers that are mentioned in {arg}. For example: >
Bram Moolenaarfa735342016-01-03 22:14:44 +01001050 :reg 1a
Bram Moolenaar071d4272004-06-13 20:20:40 +00001051< to display registers '1' and 'a'. Spaces are allowed
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001052 in {arg}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001053
Bram Moolenaardd60c362023-02-27 15:49:53 +00001054 *:di* *:dis* *:display*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001055:di[splay] [arg] Same as :registers.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001056
1057 *y* *yank*
1058["x]y{motion} Yank {motion} text [into register x]. When no
1059 characters are to be yanked (e.g., "y0" in column 1),
1060 this is an error when 'cpoptions' includes the 'E'
1061 flag.
1062
1063 *yy*
1064["x]yy Yank [count] lines [into register x] |linewise|.
1065
1066 *Y*
1067["x]Y yank [count] lines [into register x] (synonym for
1068 yy, |linewise|). If you like "Y" to work from the
1069 cursor to the end of line (which is more logical,
1070 but not Vi-compatible) use ":map Y y$".
1071
Christian Brabandt544a38e2021-06-10 19:39:11 +02001072 *zy*
1073["x]zy{motion} Yank {motion} text [into register x]. Only differs
1074 from `y` when selecting a block of text, see |v_zy|.
1075
Bram Moolenaar071d4272004-06-13 20:20:40 +00001076 *v_y*
1077{Visual}["x]y Yank the highlighted text [into register x] (for
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001078 {Visual} see |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001079
1080 *v_Y*
1081{Visual}["x]Y Yank the highlighted lines [into register x] (for
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001082 {Visual} see |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001083
Christian Brabandt544a38e2021-06-10 19:39:11 +02001084 *v_zy*
1085{Visual}["x]zy Yank the highlighted text [into register x]. Trailing
1086 whitespace at the end of each line of a selected block
1087 won't be yanked. Especially useful in combination
1088 with `zp`. (for {Visual} see |Visual-mode|)
1089
Bram Moolenaar85de2062011-05-05 14:26:41 +02001090 *:y* *:yank* *E850*
1091:[range]y[ank] [x] Yank [range] lines [into register x]. Yanking to the
Bram Moolenaar446beb42011-05-10 17:18:44 +02001092 "* or "+ registers is possible only when the
1093 |+clipboard| feature is included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001094
1095:[range]y[ank] [x] {count}
1096 Yank {count} lines, starting with last line number
1097 in [range] (default: current line |cmdline-ranges|),
1098 [into register x].
1099
Bram Moolenaara2baa732022-02-04 16:09:54 +00001100 *p* *put* *E353* *E1240*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001101["x]p Put the text [from register x] after the cursor
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001102 [count] times.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001103
1104 *P*
1105["x]P Put the text [from register x] before the cursor
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001106 [count] times.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001107
1108 *<MiddleMouse>*
1109["x]<MiddleMouse> Put the text from a register before the cursor [count]
1110 times. Uses the "* register, unless another is
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001111 specified.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001112 Leaves the cursor at the end of the new text.
1113 Using the mouse only works when 'mouse' contains 'n'
1114 or 'a'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001115 If you have a scrollwheel and often accidentally paste
1116 text, you can use these mappings to disable the
1117 pasting with the middle mouse button: >
1118 :map <MiddleMouse> <Nop>
1119 :imap <MiddleMouse> <Nop>
1120< You might want to disable the multi-click versions
1121 too, see |double-click|.
1122
1123 *gp*
1124["x]gp Just like "p", but leave the cursor just after the new
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001125 text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001126
1127 *gP*
1128["x]gP Just like "P", but leave the cursor just after the new
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001129 text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001130
1131 *:pu* *:put*
1132:[line]pu[t] [x] Put the text [from register x] after [line] (default
1133 current line). This always works |linewise|, thus
1134 this command can be used to put a yanked block as new
1135 lines.
Bram Moolenaard38b0552012-04-25 19:07:41 +02001136 If no register is specified, it depends on the 'cb'
1137 option: If 'cb' contains "unnamedplus", paste from the
1138 + register |quoteplus|. Otherwise, if 'cb' contains
Bram Moolenaarddbb5552012-04-26 20:17:03 +02001139 "unnamed", paste from the * register |quotestar|.
Bram Moolenaard38b0552012-04-25 19:07:41 +02001140 Otherwise, paste from the unnamed register
1141 |quote_quote|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001142 The register can also be '=' followed by an optional
1143 expression. The expression continues until the end of
1144 the command. You need to escape the '|' and '"'
1145 characters to prevent them from terminating the
1146 command. Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001147 :put ='path' .. \",/test\"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001148< If there is no expression after '=', Vim uses the
1149 previous expression. You can see it with ":dis =".
1150
1151:[line]pu[t]! [x] Put the text [from register x] before [line] (default
1152 current line).
1153
64-bitmane08f10a2025-03-18 22:14:34 +01001154 *:ip* *:iput*
1155:[line]ip[ut] [x] like |:put|, but adjust indent to the current line
1156
1157:[line]ip[ut]! [x] like |:put|!, but adjust indent to the current line
1158
Bram Moolenaar071d4272004-06-13 20:20:40 +00001159["x]]p or *]p* *]<MiddleMouse>*
1160["x]]<MiddleMouse> Like "p", but adjust the indent to the current line.
1161 Using the mouse only works when 'mouse' contains 'n'
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001162 or 'a'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001163
1164["x][P or *[P*
1165["x]]P or *]P*
1166["x][p or *[p* *[<MiddleMouse>*
1167["x][<MiddleMouse> Like "P", but adjust the indent to the current line.
1168 Using the mouse only works when 'mouse' contains 'n'
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001169 or 'a'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001170
Christian Brabandt2fa93842021-05-30 22:17:25 +02001171["x]zp or *zp* *zP*
1172["x]zP Like "p" and "P", except without adding trailing spaces
1173 when pasting a block. Thus the inserted text will not
Christian Brabandt544a38e2021-06-10 19:39:11 +02001174 always be a rectangle. Especially useful in
1175 combination with |v_zy|.
Christian Brabandt2fa93842021-05-30 22:17:25 +02001176
Bram Moolenaar071d4272004-06-13 20:20:40 +00001177You can use these commands to copy text from one place to another. Do this
1178by first getting the text into a register with a yank, delete or change
1179command, then inserting the register contents with a put command. You can
1180also use these commands to move text from one file to another, because Vim
1181preserves all registers when changing buffers (the CTRL-^ command is a quick
1182way to toggle between two files).
1183
1184 *linewise-register* *characterwise-register*
1185You can repeat the put commands with "." (except for :put) and undo them. If
1186the command that was used to get the text into the register was |linewise|,
1187Vim inserts the text below ("p") or above ("P") the line where the cursor is.
1188Otherwise Vim inserts the text after ("p") or before ("P") the cursor. With
1189the ":put" command, Vim always inserts the text in the next line. You can
1190exchange two characters with the command sequence "xp". You can exchange two
1191lines with the command sequence "ddp". You can exchange two words with the
1192command sequence "deep" (start with the cursor in the blank space before the
Christian Brabandtdf684192025-04-03 12:33:02 +02001193first word). You can use the |']| or |`]| command after the put command to
1194move the cursor to the end of the inserted text, or use |'[| or |`[| to move
Bram Moolenaar071d4272004-06-13 20:20:40 +00001195the cursor to the start.
1196
1197 *put-Visual-mode* *v_p* *v_P*
1198When using a put command like |p| or |P| in Visual mode, Vim will try to
1199replace the selected text with the contents of the register. Whether this
1200works well depends on the type of selection and the type of the text in the
1201register. With blockwise selection it also depends on the size of the block
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001202and whether the corners are on an existing character. (Implementation detail:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001203it actually works by first putting the register after the selection and then
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001204deleting the selection.)
Shougo Matsushita509142a2022-05-06 11:45:09 +01001205With |p| the previously selected text is put in the unnamed register (and
1206possibly the selection and/or clipboard). This is useful if you want to put
1207that text somewhere else. But you cannot repeat the same change.
1208With |P| the unnamed register is not changed (and neither the selection or
1209clipboard), you can repeat the same change. But the deleted text cannot be
1210used. If you do need it you can use |p| with another register. E.g., yank
1211the text to copy, Visually select the text to replace and use "0p . You can
1212repeat this as many times as you like, and the unnamed register will be
1213changed each time.
Bram Moolenaar9712ff12022-09-18 13:04:22 +01001214 *blockwise-put*
1215When a register contains text from one line (characterwise), using a
1216blockwise Visual selection, putting that register will paste that text
1217repeatedly in each of the selected lines, thus replacing the blockwise
1218selected region by multiple copies of the register text. For example:
1219 - yank the word "TEXT" into a register with `yw`
1220 - select a visual block, marked with "v" in this text:
1221 aaavvaaa
1222 bbbvvbbb
1223 cccvvccc
1224 - press `p`, results in:
1225 aaaTEXTaaa
1226 bbbTEXTbbb
1227 cccTEXTccc
Bram Moolenaarec11aef2013-09-22 15:23:44 +02001228
Bram Moolenaar071d4272004-06-13 20:20:40 +00001229 *blockwise-register*
1230If you use a blockwise Visual mode command to get the text into the register,
1231the block of text will be inserted before ("P") or after ("p") the cursor
1232column in the current and next lines. Vim makes the whole block of text start
1233in the same column. Thus the inserted text looks the same as when it was
1234yanked or deleted. Vim may replace some <Tab> characters with spaces to make
1235this happen. However, if the width of the block is not a multiple of a <Tab>
1236width and the text after the inserted block contains <Tab>s, that text may be
1237misaligned.
1238
Bram Moolenaar22863042021-10-16 15:23:36 +01001239Use |zP|/|zp| to paste a blockwise yanked register without appending trailing
1240spaces.
1241
Bram Moolenaar071d4272004-06-13 20:20:40 +00001242Note that after a characterwise yank command, Vim leaves the cursor on the
1243first yanked character that is closest to the start of the buffer. This means
1244that "yl" doesn't move the cursor, but "yh" moves the cursor one character
1245left.
1246Rationale: In Vi the "y" command followed by a backwards motion would
1247 sometimes not move the cursor to the first yanked character,
1248 because redisplaying was skipped. In Vim it always moves to
1249 the first character, as specified by Posix.
1250With a linewise yank command the cursor is put in the first line, but the
1251column is unmodified, thus it may not be on the first yanked character.
1252
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02001253There are ten types of registers: *registers* *{register}* *E354*
Bram Moolenaar071d4272004-06-13 20:20:40 +000012541. The unnamed register ""
12552. 10 numbered registers "0 to "9
12563. The small delete register "-
12574. 26 named registers "a to "z or "A to "Z
Bram Moolenaar396e8292019-07-13 23:04:31 +020012585. Three read-only registers ":, "., "%
12596. Alternate buffer register "#
12607. The expression register "=
Bram Moolenaar3b3a9492015-01-27 18:44:16 +010012618. The selection and drop registers "*, "+ and "~
12629. The black hole register "_
126310. Last search pattern register "/
Bram Moolenaar071d4272004-06-13 20:20:40 +00001264
12651. Unnamed register "" *quote_quote* *quotequote*
1266Vim fills this register with text deleted with the "d", "c", "s", "x" commands
1267or copied with the yank "y" command, regardless of whether or not a specific
Bram Moolenaared203462004-06-16 11:19:22 +00001268register was used (e.g. "xdd). This is like the unnamed register is pointing
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001269to the last used register. Thus when appending using an uppercase register
1270name, the unnamed register contains the same text as the named register.
1271An exception is the '_' register: "_dd does not store the deleted text in any
1272register.
Bram Moolenaar81695252004-12-29 20:58:21 +00001273Vim uses the contents of the unnamed register for any put command (p or P)
1274which does not specify a register. Additionally you can access it with the
1275name '"'. This means you have to type two double quotes. Writing to the ""
1276register writes to register "0.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001277{Vi: register contents are lost when changing files, no '"'}
1278
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +020012792. Numbered registers "0 to "9 *quote_number* *quote0* *quote1*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001280 *quote2* *quote3* *quote4* *quote9*
1281Vim fills these registers with text from yank and delete commands.
1282 Numbered register 0 contains the text from the most recent yank command,
1283unless the command specified another register with ["x].
1284 Numbered register 1 contains the text deleted by the most recent delete or
Christian Brabandtecd642a2024-06-23 20:24:52 +02001285change command (even when the command specified another register), unless the
1286text is less than one line (the small delete register is used then). An
1287exception is made for the delete operator with these movement commands: |%|,
1288|(|, |)|, |`|, |/|, |?|, |n|, |N|, |{| and |}|.
1289Register "1 is always used then (this is Vi compatible). The "- register is
1290used as well if the delete is within a line. Note that these characters may be
1291mapped. E.g. |%| is mapped by the matchit plugin.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001292 With each successive deletion or change, Vim shifts the previous contents
1293of register 1 into register 2, 2 into 3, and so forth, losing the previous
1294contents of register 9.
Frederick Key Abell III6e564842024-10-07 21:07:12 +02001295{Vi: register 0 does not exist}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001296
12973. Small delete register "- *quote_-* *quote-*
1298This register contains text from commands that delete less than one line,
1299except when the command specifies a register with ["x].
Bram Moolenaar071d4272004-06-13 20:20:40 +00001300
13014. Named registers "a to "z or "A to "Z *quote_alpha* *quotea*
1302Vim fills these registers only when you say so. Specify them as lowercase
1303letters to replace their previous contents or as uppercase letters to append
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001304to their previous contents. When the '>' flag is present in 'cpoptions' then
1305a line break is inserted before the appended text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001306
Bram Moolenaar3b3a9492015-01-27 18:44:16 +010013075. Read-only registers ":, ". and "%
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +01001308These are '%', ':' and '.'. You can use them only with the "p", "P",
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001309and ":put" commands and with CTRL-R.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001310 *quote_.* *quote.* *E29*
1311 ". Contains the last inserted text (the same as what is inserted
1312 with the insert mode commands CTRL-A and CTRL-@). Note: this
1313 doesn't work with CTRL-R on the command-line. It works a bit
1314 differently, like inserting the text instead of putting it
1315 ('textwidth' and other options affect what is inserted).
1316 *quote_%* *quote%*
1317 "% Contains the name of the current file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001318 *quote_:* *quote:* *E30*
1319 ": Contains the most recent executed command-line. Example: Use
1320 "@:" to repeat the previous command-line command.
1321 The command-line is only stored in this register when at least
1322 one character of it was typed. Thus it remains unchanged if
1323 the command was completely from a mapping.
1324 {not available when compiled without the |+cmdline_hist|
1325 feature}
Bram Moolenaar3b3a9492015-01-27 18:44:16 +01001326 *quote_#* *quote#*
13276. Alternate file register "#
1328Contains the name of the alternate file for the current window. It will
1329change how the |CTRL-^| command works.
1330This register is writable, mainly to allow for restoring it after a plugin has
1331changed it. It accepts buffer number: >
1332 let altbuf = bufnr(@#)
1333 ...
1334 let @# = altbuf
1335It will give error |E86| if you pass buffer number and this buffer does not
1336exist.
1337It can also accept a match with an existing buffer name: >
1338 let @# = 'buffer_name'
1339Error |E93| if there is more than one buffer matching the given name or |E94|
1340if none of buffers matches the given name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001341
Bram Moolenaar3b3a9492015-01-27 18:44:16 +010013427. Expression register "= *quote_=* *quote=* *@=*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001343This is not really a register that stores text, but is a way to use an
1344expression in commands which use a register. The expression register is
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001345read-write.
1346
1347When typing the '=' after " or CTRL-R the cursor moves to the command-line,
1348where you can enter any expression (see |expression|). All normal
1349command-line editing commands are available, including a special history for
1350expressions. When you end the command-line by typing <CR>, Vim computes the
1351result of the expression. If you end it with <Esc>, Vim abandons the
1352expression. If you do not enter an expression, Vim uses the previous
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001353expression (like with the "/" command).
1354
1355The expression must evaluate to a String. A Number is always automatically
1356converted to a String. For the "p" and ":put" command, if the result is a
1357Float it's converted into a String. If the result is a List each element is
Yegappan Lakshmananf01493c2024-04-14 23:21:02 +02001358turned into a String and used as a line. A Dictionary is converted into a
h-east53753f62024-05-05 18:42:31 +02001359String. A Funcref results in an error message (use string() to convert).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001360
1361If the "= register is used for the "p" command, the String is split up at <NL>
1362characters. If the String ends in a <NL>, it is regarded as a linewise
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001363register.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001364
Bram Moolenaar3b3a9492015-01-27 18:44:16 +010013658. Selection and drop registers "*, "+ and "~
Bram Moolenaar06b5d512010-05-22 15:37:44 +02001366Use these registers for storing and retrieving the selected text for the GUI.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001367See |quotestar| and |quoteplus|. When the clipboard is not available or not
Bram Moolenaarf4d11452005-12-02 00:46:37 +00001368working, the unnamed register is used instead. For Unix systems the clipboard
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001369is only available when the |+xterm_clipboard| feature is present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001370
1371Note that there is only a distinction between "* and "+ for X11 systems. For
1372an explanation of the difference, see |x11-selection|. Under MS-Windows, use
1373of "* and "+ is actually synonymous and refers to the |gui-clipboard|.
1374
1375 *quote_~* *quote~* *<Drop>*
1376The read-only "~ register stores the dropped text from the last drag'n'drop
1377operation. When something has been dropped onto Vim, the "~ register is
1378filled in and the <Drop> pseudo key is sent for notification. You can remap
1379this key if you want; the default action (for all modes) is to insert the
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001380contents of the "~ register at the cursor position.
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001381{only available when compiled with the |+dnd| feature, currently only with the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001382GTK GUI}
1383
1384Note: The "~ register is only used when dropping plain text onto Vim.
1385Drag'n'drop of URI lists is handled internally.
1386
Bram Moolenaar3b3a9492015-01-27 18:44:16 +010013879. Black hole register "_ *quote_*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001388When writing to this register, nothing happens. This can be used to delete
1389text without affecting the normal registers. When reading from this register,
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001390nothing is returned.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001391
Bram Moolenaar5be4cee2019-09-27 19:34:08 +0200139210. Last search pattern register "/ *quote_/* *quote/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001393Contains the most recent search-pattern. This is used for "n" and 'hlsearch'.
Bram Moolenaard38b0552012-04-25 19:07:41 +02001394It is writable with `:let`, you can change it to have 'hlsearch' highlight
Bram Moolenaar071d4272004-06-13 20:20:40 +00001395other matches without actually searching. You can't yank or delete into this
Bram Moolenaar446cb832008-06-24 21:56:24 +00001396register. The search direction is available in |v:searchforward|.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001397Note that the value is restored when returning from a function
Bram Moolenaar446cb832008-06-24 21:56:24 +00001398|function-search-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001399
1400 *@/*
Bram Moolenaard38b0552012-04-25 19:07:41 +02001401You can write to a register with a `:let` command |:let-@|. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001402 :let @/ = "the"
1403
1404If you use a put command without specifying a register, Vim uses the register
1405that was last filled (this is also the contents of the unnamed register). If
Bram Moolenaard38b0552012-04-25 19:07:41 +02001406you are confused, use the `:dis` command to find out what Vim will put (this
Bram Moolenaar071d4272004-06-13 20:20:40 +00001407command displays all named and numbered registers; the unnamed register is
1408labelled '"').
1409
1410The next three commands always work on whole lines.
1411
1412:[range]co[py] {address} *:co* *:copy*
1413 Copy the lines given by [range] to below the line
1414 given by {address}.
1415
1416 *:t*
1417:t Synonym for copy.
Bram Moolenaara4d131d2021-12-27 21:33:07 +00001418 This command is not supported in |Vim9| script,
1419 because it is too easily confused with a variable
1420 name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001421
1422:[range]m[ove] {address} *:m* *:mo* *:move* *E134*
1423 Move the lines given by [range] to below the line
1424 given by {address}.
h-east52e7cc22024-07-28 17:03:29 +02001425 Any text properties in [range] are cleared. See
Christian Brabandt946f61c2024-06-17 13:17:58 +02001426 |text-prop-cleared|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001427
1428==============================================================================
14296. Formatting text *formatting*
1430
1431:[range]ce[nter] [width] *:ce* *:center*
1432 Center lines in [range] between [width] columns
1433 (default 'textwidth' or 80 when 'textwidth' is 0).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001434
1435:[range]ri[ght] [width] *:ri* *:right*
1436 Right-align lines in [range] at [width] columns
1437 (default 'textwidth' or 80 when 'textwidth' is 0).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001438
1439 *:le* *:left*
1440:[range]le[ft] [indent]
1441 Left-align lines in [range]. Sets the indent in the
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001442 lines to [indent] (default 0).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001443
1444 *gq*
Bram Moolenaar4317d9b2005-03-18 20:25:31 +00001445gq{motion} Format the lines that {motion} moves over.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001446 Formatting is done with one of three methods:
1447 1. If 'formatexpr' is not empty the expression is
1448 evaluated. This can differ for each buffer.
Bram Moolenaar4c7ed462006-02-15 22:18:42 +00001449 2. If 'formatprg' is not empty an external program
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001450 is used.
Bram Moolenaar551dbcc2006-04-25 22:13:59 +00001451 3. Otherwise formatting is done internally.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001452
1453 In the third case the 'textwidth' option controls the
1454 length of each formatted line (see below).
Bram Moolenaar4317d9b2005-03-18 20:25:31 +00001455 If the 'textwidth' option is 0, the formatted line
1456 length is the screen width (with a maximum width of
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001457 79).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001458 The 'formatoptions' option controls the type of
1459 formatting |fo-table|.
Bram Moolenaar4317d9b2005-03-18 20:25:31 +00001460 The cursor is left on the first non-blank of the last
1461 formatted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001462 NOTE: The "Q" command formerly performed this
1463 function. If you still want to use "Q" for
1464 formatting, use this mapping: >
1465 :nnoremap Q gq
1466
1467gqgq *gqgq* *gqq*
Bram Moolenaar40af4e32010-07-29 22:33:18 +02001468gqq Format the current line. With a count format that
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001469 many lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001470
1471 *v_gq*
1472{Visual}gq Format the highlighted text. (for {Visual} see
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001473 |Visual-mode|).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001474
1475 *gw*
1476gw{motion} Format the lines that {motion} moves over. Similar to
1477 |gq| but puts the cursor back at the same position in
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001478 the text. However, 'formatprg' and 'formatexpr' are
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001479 not used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001480
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001481gwgw *gwgw* *gww*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001482gww Format the current line as with "gw".
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001483
1484 *v_gw*
1485{Visual}gw Format the highlighted text as with "gw". (for
Bram Moolenaar25c9c682019-05-05 18:13:34 +02001486 {Visual} see |Visual-mode|).
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001487
Bram Moolenaar071d4272004-06-13 20:20:40 +00001488Example: To format the current paragraph use: *gqap* >
1489 gqap
1490
1491The "gq" command leaves the cursor in the line where the motion command takes
1492the cursor. This allows you to repeat formatting repeated with ".". This
1493works well with "gqj" (format current and next line) and "gq}" (format until
1494end of paragraph). Note: When 'formatprg' is set, "gq" leaves the cursor on
1495the first formatted line (as with using a filter command).
1496
1497If you want to format the current paragraph and continue where you were, use: >
1498 gwap
1499If you always want to keep paragraphs formatted you may want to add the 'a'
1500flag to 'formatoptions'. See |auto-format|.
1501
1502If the 'autoindent' option is on, Vim uses the indent of the first line for
1503the following lines.
1504
1505Formatting does not change empty lines (but it does change lines with only
1506white space!).
1507
1508The 'joinspaces' option is used when lines are joined together.
1509
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001510You can set the 'formatexpr' option to an expression or the 'formatprg' option
1511to the name of an external program for Vim to use for text formatting. The
1512'textwidth' and other options have no effect on formatting by an external
1513program.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001514
Bram Moolenaar7db25fe2018-05-13 00:02:36 +02001515 *format-formatexpr*
Bram Moolenaard473c8c2018-08-11 18:00:22 +02001516The 'formatexpr' option can be set to a Vim script function that performs
Bram Moolenaar7db25fe2018-05-13 00:02:36 +02001517reformatting of the buffer. This should usually happen in an |ftplugin|,
1518since formatting is highly dependent on the type of file. It makes
1519sense to use an |autoload| script, so the corresponding script is only loaded
1520when actually needed and the script should be called <filetype>format.vim.
1521
Antonio Giovanni Colombo41d6de22024-12-15 21:17:49 +01001522For example, the XML filetype plugin distributed with Vim in the
1523$VIMRUNTIME/ftplugin directory, sets the 'formatexpr' option to: >
Bram Moolenaar7db25fe2018-05-13 00:02:36 +02001524
1525 setlocal formatexpr=xmlformat#Format()
1526
1527That means, you will find the corresponding script, defining the
Antonio Giovanni Colombo41d6de22024-12-15 21:17:49 +01001528xmlformat#Format() function, in the file `$VIMRUNTIME/autoload/xmlformat.vim`
Bram Moolenaar7db25fe2018-05-13 00:02:36 +02001529
1530Here is an example script that removes trailing whitespace from the selected
Antonio Giovanni Colombo41d6de22024-12-15 21:17:49 +01001531text. Put it in your autoload directory, e.g. ~/.vim/autoload/format.vim:
1532>vim
Bram Moolenaar7db25fe2018-05-13 00:02:36 +02001533 func! format#Format()
1534 " only reformat on explicit gq command
1535 if mode() != 'n'
Bram Moolenaard1caa942020-04-10 22:10:56 +02001536 " fall back to Vim's internal reformatting
Bram Moolenaar7db25fe2018-05-13 00:02:36 +02001537 return 1
1538 endif
1539 let lines = getline(v:lnum, v:lnum + v:count - 1)
1540 call map(lines, {key, val -> substitute(val, '\s\+$', '', 'g')})
1541 call setline('.', lines)
1542
1543 " do not run internal formatter!
1544 return 0
1545 endfunc
1546
1547You can then enable the formatting by executing: >
1548 setlocal formatexpr=format#Format()
Bram Moolenaard473c8c2018-08-11 18:00:22 +02001549
Bram Moolenaar7db25fe2018-05-13 00:02:36 +02001550Note: this function explicitly returns non-zero when called from insert mode
1551(which basically means, text is inserted beyond the 'textwidth' limit). This
1552causes Vim to fall back to reformat the text by using the internal formatter.
1553
1554However, if the |gq| command is used to reformat the text, the function
1555will receive the selected lines, trim trailing whitespace from those lines and
1556put them back in place. If you are going to split single lines into multiple
1557lines, be careful not to overwrite anything.
1558
1559If you want to allow reformatting of text from insert or replace mode, one has
1560to be very careful, because the function might be called recursively. For
1561debugging it helps to set the 'debug' option.
1562
Bram Moolenaar071d4272004-06-13 20:20:40 +00001563 *right-justify*
1564There is no command in Vim to right justify text. You can do it with
Antonio Giovanni Colombo41d6de22024-12-15 21:17:49 +01001565an external command, like "par" (e.g.: `:.,}!par` to format until the end of the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001566paragraph) or set 'formatprg' to "par".
1567
1568 *format-comments*
Bram Moolenaar446cb832008-06-24 21:56:24 +00001569An overview of comment formatting is in section |30.6| of the user manual.
1570
1571Vim can automatically insert and format comments in a special way. Vim
1572recognizes a comment by a specific string at the start of the line (ignoring
1573white space). Three types of comments can be used:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001574
1575- A comment string that repeats at the start of each line. An example is the
1576 type of comment used in shell scripts, starting with "#".
1577- A comment string that occurs only in the first line, not in the following
1578 lines. An example is this list with dashes.
1579- Three-piece comments that have a start string, an end string, and optional
1580 lines in between. The strings for the start, middle and end are different.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001581 An example is the C style comment:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001582 /*
1583 * this is a C comment
1584 */
1585
1586The 'comments' option is a comma-separated list of parts. Each part defines a
1587type of comment string. A part consists of:
1588 {flags}:{string}
1589
1590{string} is the literal text that must appear.
1591
1592{flags}:
1593 n Nested comment. Nesting with mixed parts is allowed. If 'comments'
1594 is "n:),n:>" a line starting with "> ) >" is a comment.
1595
1596 b Blank (<Space>, <Tab> or <EOL>) required after {string}.
1597
1598 f Only the first line has the comment string. Do not repeat comment on
1599 the next line, but preserve indentation (e.g., a bullet-list).
1600
1601 s Start of three-piece comment
1602
1603 m Middle of a three-piece comment
1604
1605 e End of a three-piece comment
1606
Bram Moolenaar446cb832008-06-24 21:56:24 +00001607 l Left align. Used together with 's' or 'e', the leftmost character of
1608 start or end will line up with the leftmost character from the middle.
1609 This is the default and can be omitted. See below for more details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001610
Bram Moolenaar446cb832008-06-24 21:56:24 +00001611 r Right align. Same as above but rightmost instead of leftmost. See
1612 below for more details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001613
Bram Moolenaar446cb832008-06-24 21:56:24 +00001614 O Don't consider this comment for the "O" command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001615
1616 x Allows three-piece comments to be ended by just typing the last
Bram Moolenaar446cb832008-06-24 21:56:24 +00001617 character of the end-comment string as the first action on a new
1618 line when the middle-comment string has been inserted automatically.
1619 See below for more details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001620
1621 {digits}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001622 When together with 's' or 'e': add {digit} amount of offset to an
1623 automatically inserted middle or end comment leader. The offset begins
1624 from a left alignment. See below for more details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001625
1626 -{digits}
1627 Like {digits} but reduce the indent. This only works when there is
1628 some indent for the start or end part that can be removed.
1629
1630When a string has none of the 'f', 's', 'm' or 'e' flags, Vim assumes the
Antonio Giovanni Colombo41d6de22024-12-15 21:17:49 +01001631comment string repeats at the start of each line. The {flags} field may be
Bram Moolenaar071d4272004-06-13 20:20:40 +00001632empty.
1633
1634Any blank space in the text before and after the {string} is part of the
1635{string}, so do not include leading or trailing blanks unless the blanks are a
1636required part of the comment string.
1637
1638When one comment leader is part of another, specify the part after the whole.
1639For example, to include both "-" and "->", use >
1640 :set comments=f:->,f:-
1641
1642A three-piece comment must always be given as start,middle,end, with no other
1643parts in between. An example of a three-piece comment is >
1644 sr:/*,mb:*,ex:*/
1645for C-comments. To avoid recognizing "*ptr" as a comment, the middle string
1646includes the 'b' flag. For three-piece comments, Vim checks the text after
1647the start and middle strings for the end string. If Vim finds the end string,
1648the comment does not continue on the next line. Three-piece comments must
1649have a middle string because otherwise Vim can't recognize the middle lines.
1650
1651Notice the use of the "x" flag in the above three-piece comment definition.
1652When you hit Return in a C-comment, Vim will insert the middle comment leader
Bram Moolenaar446cb832008-06-24 21:56:24 +00001653for the new line: " * ". To close this comment you just have to type "/"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001654before typing anything else on the new line. This will replace the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001655middle-comment leader with the end-comment leader and apply any specified
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001656alignment, leaving just " */". There is no need to hit Backspace first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001657
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001658When there is a match with a middle part, but there also is a matching end
1659part which is longer, the end part is used. This makes a C style comment work
Bram Moolenaar446beb42011-05-10 17:18:44 +02001660without requiring the middle part to end with a space.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001661
1662Here is an example of alignment flags at work to make a comment stand out
Bram Moolenaar446beb42011-05-10 17:18:44 +02001663(kind of looks like a 1 too). Consider comment string: >
1664 :set comments=sr:/***,m:**,ex-2:******/
1665<
1666 /*** ~
1667 **<--right aligned from "r" flag ~
1668 ** ~
1669offset 2 spaces for the "-2" flag--->** ~
1670 ******/ ~
Bram Moolenaar446cb832008-06-24 21:56:24 +00001671In this case, the first comment was typed, then return was pressed 4 times,
1672then "/" was pressed to end the comment.
1673
1674Here are some finer points of three part comments. There are three times when
1675alignment and offset flags are taken into consideration: opening a new line
1676after a start-comment, opening a new line before an end-comment, and
1677automatically ending a three-piece comment. The end alignment flag has a
1678backwards perspective; the result is that the same alignment flag used with
1679"s" and "e" will result in the same indent for the starting and ending pieces.
1680Only one alignment per comment part is meant to be used, but an offset number
1681will override the "r" and "l" flag.
1682
1683Enabling 'cindent' will override the alignment flags in many cases.
1684Reindenting using a different method like |gq| or |=| will not consult
1685alignment flags either. The same behaviour can be defined in those other
1686formatting options. One consideration is that 'cindent' has additional options
1687for context based indenting of comments but cannot replicate many three piece
Bram Moolenaar446beb42011-05-10 17:18:44 +02001688indent alignments. However, 'indentexpr' has the ability to work better with
1689three piece comments.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001690
1691Other examples: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001692 "b:*" Includes lines starting with "*", but not if the "*" is
1693 followed by a non-blank. This avoids a pointer dereference
1694 like "*str" to be recognized as a comment.
1695 "n:>" Includes a line starting with ">", ">>", ">>>", etc.
1696 "fb:-" Format a list that starts with "- ".
1697
1698By default, "b:#" is included. This means that a line that starts with
1699"#include" is not recognized as a comment line. But a line that starts with
1700"# define" is recognized. This is a compromise.
1701
Bram Moolenaar071d4272004-06-13 20:20:40 +00001702 *fo-table*
1703You can use the 'formatoptions' option to influence how Vim formats text.
1704'formatoptions' is a string that can contain any of the letters below. The
1705default setting is "tcq". You can separate the option letters with commas for
1706readability.
1707
1708letter meaning when present in 'formatoptions' ~
Bram Moolenaare0e39172021-01-25 21:14:57 +01001709 *fo-t*
Bram Moolenaar2bf875f2022-05-07 14:54:11 +01001710t Auto-wrap text using 'textwidth'
Bram Moolenaare0e39172021-01-25 21:14:57 +01001711 *fo-c*
Bram Moolenaar2bf875f2022-05-07 14:54:11 +01001712c Auto-wrap comments using 'textwidth', inserting the current comment
Bram Moolenaar071d4272004-06-13 20:20:40 +00001713 leader automatically.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001714 *fo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001715r Automatically insert the current comment leader after hitting
1716 <Enter> in Insert mode.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001717 *fo-o*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001718o Automatically insert the current comment leader after hitting 'o' or
Bram Moolenaar04fb9162021-12-30 20:24:12 +00001719 'O' in Normal mode. In case comment is unwanted in a specific place
1720 use CTRL-U to quickly delete it. |i_CTRL-U|
Bram Moolenaar2bf875f2022-05-07 14:54:11 +01001721 *fo-/*
1722/ When 'o' is included: do not insert the comment leader for a //
1723 comment after a statement, only when // is at the start of the line.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001724 *fo-q*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001725q Allow formatting of comments with "gq".
1726 Note that formatting will not change blank lines or lines containing
1727 only the comment leader. A new paragraph starts after such a line,
1728 or when the comment leader changes.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001729 *fo-w*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001730w Trailing white space indicates a paragraph continues in the next line.
1731 A line that ends in a non-white character ends a paragraph.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001732 *fo-a*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001733a Automatic formatting of paragraphs. Every time text is inserted or
1734 deleted the paragraph will be reformatted. See |auto-format|.
1735 When the 'c' flag is present this only happens for recognized
1736 comments.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001737 *fo-n*
Bram Moolenaar86b68352004-12-27 21:59:20 +00001738n When formatting text, recognize numbered lists. This actually uses
1739 the 'formatlistpat' option, thus any kind of list can be used. The
1740 indent of the text after the number is used for the next line. The
Bram Moolenaar446cb832008-06-24 21:56:24 +00001741 default is to find a number, optionally followed by '.', ':', ')',
Bram Moolenaar86b68352004-12-27 21:59:20 +00001742 ']' or '}'. Note that 'autoindent' must be set too. Doesn't work
1743 well together with "2".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744 Example: >
1745 1. the first item
1746 wraps
1747 2. the second item
Bram Moolenaare0e39172021-01-25 21:14:57 +01001748< *fo-2*
Bram Moolenaar071d4272004-06-13 20:20:40 +000017492 When formatting text, use the indent of the second line of a paragraph
1750 for the rest of the paragraph, instead of the indent of the first
1751 line. This supports paragraphs in which the first line has a
1752 different indent than the rest. Note that 'autoindent' must be set
1753 too. Example: >
1754 first line of a paragraph
1755 second line of the same paragraph
1756 third line.
Bram Moolenaar30b65812012-07-12 22:01:11 +02001757< This also works inside comments, ignoring the comment leader.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001758 *fo-v*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001759v Vi-compatible auto-wrapping in insert mode: Only break a line at a
1760 blank that you have entered during the current insert command. (Note:
1761 this is not 100% Vi compatible. Vi has some "unexpected features" or
1762 bugs in this area. It uses the screen column instead of the line
1763 column.)
Bram Moolenaare0e39172021-01-25 21:14:57 +01001764 *fo-b*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001765b Like 'v', but only auto-wrap if you enter a blank at or before
1766 the wrap margin. If the line was longer than 'textwidth' when you
1767 started the insert, or you do not enter a blank in the insert before
1768 reaching 'textwidth', Vim does not perform auto-wrapping.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001769 *fo-l*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001770l Long lines are not broken in insert mode: When a line was longer than
1771 'textwidth' when the insert command started, Vim does not
1772 automatically format it.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001773 *fo-m*
Bram Moolenaar207f0092020-08-30 17:20:20 +02001774m Also break at a multibyte character above 255. This is useful for
Bram Moolenaar071d4272004-06-13 20:20:40 +00001775 Asian text where every character is a word on its own.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001776 *fo-M*
Bram Moolenaar207f0092020-08-30 17:20:20 +02001777M When joining lines, don't insert a space before or after a multibyte
Bram Moolenaar071d4272004-06-13 20:20:40 +00001778 character. Overrules the 'B' flag.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001779 *fo-B*
Bram Moolenaar207f0092020-08-30 17:20:20 +02001780B When joining lines, don't insert a space between two multibyte
Bram Moolenaar071d4272004-06-13 20:20:40 +00001781 characters. Overruled by the 'M' flag.
Bram Moolenaare0e39172021-01-25 21:14:57 +01001782 *fo-1*
Bram Moolenaar071d4272004-06-13 20:20:40 +000017831 Don't break a line after a one-letter word. It's broken before it
1784 instead (if possible).
Bram Moolenaare0e39172021-01-25 21:14:57 +01001785 *fo-]*
Bram Moolenaar2bf875f2022-05-07 14:54:11 +01001786] Respect 'textwidth' rigorously. With this flag set, no line can be
1787 longer than 'textwidth', unless line-break-prohibition rules make this
Bram Moolenaare52702f2020-06-04 18:22:13 +02001788 impossible. Mainly for CJK scripts and works only if 'encoding' is
1789 "utf-8".
Bram Moolenaare0e39172021-01-25 21:14:57 +01001790 *fo-j*
Bram Moolenaar81340392012-06-06 16:12:59 +02001791j Where it makes sense, remove a comment leader when joining lines. For
1792 example, joining:
1793 int i; // the index ~
1794 // in the list ~
1795 Becomes:
1796 int i; // the index in the list ~
Bram Moolenaare0e39172021-01-25 21:14:57 +01001797 *fo-p*
Bram Moolenaarc3c31582019-01-11 22:15:05 +01001798p Don't break lines at single spaces that follow periods. This is
1799 intended to complement 'joinspaces' and |cpo-J|, for prose with
1800 sentences separated by two spaces. For example, with 'textwidth' set
1801 to 28: >
1802 Surely you're joking, Mr. Feynman!
1803< Becomes: >
1804 Surely you're joking,
1805 Mr. Feynman!
1806< Instead of: >
1807 Surely you're joking, Mr.
1808 Feynman!
Bram Moolenaar071d4272004-06-13 20:20:40 +00001809
1810
1811With 't' and 'c' you can specify when Vim performs auto-wrapping:
1812value action ~
1813"" no automatic formatting (you can use "gq" for manual formatting)
1814"t" automatic formatting of text, but not comments
1815"c" automatic formatting for comments, but not text (good for C code)
1816"tc" automatic formatting for text and comments
1817
Bram Moolenaar91170f82006-05-05 21:15:17 +00001818Note that when 'textwidth' is 0, Vim does no automatic formatting anyway (but
1819does insert comment leaders according to the 'comments' option). An exception
1820is when the 'a' flag is present. |auto-format|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001821
1822Note that when 'paste' is on, Vim does no formatting at all.
1823
1824Note that 'textwidth' can be non-zero even if Vim never performs auto-wrapping;
1825'textwidth' is still useful for formatting with "gq".
1826
1827If the 'comments' option includes "/*", "*" and/or "*/", then Vim has some
1828built in stuff to treat these types of comments a bit more cleverly.
1829Opening a new line before or after "/*" or "*/" (with 'r' or 'o' present in
1830'formatoptions') gives the correct start of the line automatically. The same
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001831happens with formatting and auto-wrapping. Opening a line after a line
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832starting with "/*" or "*" and containing "*/", will cause no comment leader to
1833be inserted, and the indent of the new line is taken from the line containing
1834the start of the comment.
1835E.g.:
1836 /* ~
1837 * Your typical comment. ~
1838 */ ~
1839 The indent on this line is the same as the start of the above
1840 comment.
1841
1842All of this should be really cool, especially in conjunction with the new
1843:autocmd command to prepare different settings for different types of file.
1844
1845Some examples:
1846 for C code (only format comments): >
1847 :set fo=croq
1848< for Mail/news (format all, don't start comment with "o" command): >
1849 :set fo=tcrq
1850<
1851
Bram Moolenaard38b0552012-04-25 19:07:41 +02001852Automatic formatting *auto-format* *autoformat*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001853
1854When the 'a' flag is present in 'formatoptions' text is formatted
Bram Moolenaar2547aa92020-07-26 17:00:44 +02001855automatically when inserting text or deleting text. This works nicely for
Bram Moolenaar071d4272004-06-13 20:20:40 +00001856editing text paragraphs. A few hints on how to use this:
1857
1858- You need to properly define paragraphs. The simplest is paragraphs that are
1859 separated by a blank line. When there is no separating blank line, consider
1860 using the 'w' flag and adding a space at the end of each line in the
1861 paragraphs except the last one.
1862
1863- You can set the 'formatoptions' based on the type of file |filetype| or
1864 specifically for one file with a |modeline|.
1865
1866- Set 'formatoptions' to "aw2tq" to make text with indents like this:
1867
Bram Moolenaardd60c362023-02-27 15:49:53 +00001868 bla bla foobar bla
Bram Moolenaar071d4272004-06-13 20:20:40 +00001869 bla foobar bla foobar bla
Bram Moolenaardd60c362023-02-27 15:49:53 +00001870 bla bla foobar bla
Bram Moolenaar071d4272004-06-13 20:20:40 +00001871 bla foobar bla bla foobar
1872
1873- Add the 'c' flag to only auto-format comments. Useful in source code.
1874
Bram Moolenaar91170f82006-05-05 21:15:17 +00001875- Set 'textwidth' to the desired width. If it is zero then 79 is used, or the
1876 width of the screen if this is smaller.
1877
Bram Moolenaar071d4272004-06-13 20:20:40 +00001878And a few warnings:
1879
1880- When part of the text is not properly separated in paragraphs, making
1881 changes in this text will cause it to be formatted anyway. Consider doing >
1882
1883 :set fo-=a
1884
1885- When using the 'w' flag (trailing space means paragraph continues) and
1886 deleting the last line of a paragraph with |dd|, the paragraph will be
1887 joined with the next one.
1888
1889- Changed text is saved for undo. Formatting is also a change. Thus each
1890 format action saves text for undo. This may consume quite a lot of memory.
1891
1892- Formatting a long paragraph and/or with complicated indenting may be slow.
1893
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00001894==============================================================================
18957. Sorting text *sorting*
1896
1897Vim has a sorting function and a sorting command. The sorting function can be
Bram Moolenaar327aa022014-03-25 18:24:23 +01001898found here: |sort()|, |uniq()|.
Hirohito Higashi74f0a772025-06-23 21:42:36 +02001899Also see |:uniq|.
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00001900
1901 *:sor* *:sort*
Bram Moolenaar55e29612020-11-01 13:57:44 +01001902:[range]sor[t][!] [b][f][i][l][n][o][r][u][x] [/{pattern}/]
Bram Moolenaare5180522005-12-10 20:19:46 +00001903 Sort lines in [range]. When no range is given all
1904 lines are sorted.
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00001905
1906 With [!] the order is reversed.
1907
1908 With [i] case is ignored.
Hirohito Higashi74f0a772025-06-23 21:42:36 +02001909 *:sort-l*
Bram Moolenaar3132cdd2020-11-05 20:41:49 +01001910 With [l] sort uses the current collation locale.
1911 Implementation details: strcoll() is used to compare
1912 strings. See |:language| to check or set the collation
1913 locale. Example: >
1914 :language collate en_US.UTF-8
1915 :%sort l
1916< |v:collate| can also used to check the current locale.
1917 Sorting using the locale typically ignores case.
1918 This does not work properly on Mac.
Bram Moolenaar55e29612020-11-01 13:57:44 +01001919
Bram Moolenaarf7edf402016-01-19 23:36:15 +01001920 Options [n][f][x][o][b] are mutually exclusive.
1921
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001922 With [n] sorting is done on the first decimal number
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00001923 in the line (after or inside a {pattern} match).
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001924 One leading '-' is included in the number.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001925
Bram Moolenaarf7edf402016-01-19 23:36:15 +01001926 With [f] sorting is done on the Float in the line.
1927 The value of Float is determined similar to passing
1928 the text (after or inside a {pattern} match) to
1929 str2float() function. This option is available only
1930 if Vim was compiled with Floating point support.
1931
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001932 With [x] sorting is done on the first hexadecimal
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00001933 number in the line (after or inside a {pattern}
1934 match). A leading "0x" or "0X" is ignored.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001935 One leading '-' is included in the number.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001936
1937 With [o] sorting is done on the first octal number in
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00001938 the line (after or inside a {pattern} match).
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001939
Bram Moolenaar887c1fe2016-01-02 17:56:35 +01001940 With [b] sorting is done on the first binary number in
1941 the line (after or inside a {pattern} match).
Hirohito Higashi74f0a772025-06-23 21:42:36 +02001942 *:sort-u* *:sort-uniq*
Bram Moolenaarf7edf402016-01-19 23:36:15 +01001943 With [u] (u stands for unique) only keep the first of
1944 a sequence of identical lines (ignoring case when [i]
1945 is used). Without this flag, a sequence of identical
1946 lines will be kept in their original order.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001947 Note that leading and trailing white space may cause
1948 lines to be different.
Hirohito Higashi74f0a772025-06-23 21:42:36 +02001949 When you just want to make things unique, use |:uniq|.
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00001950
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00001951 When /{pattern}/ is specified and there is no [r] flag
1952 the text matched with {pattern} is skipped, so that
1953 you sort on what comes after the match.
Bram Moolenaar4466ad62020-11-21 13:16:30 +01001954 'ignorecase' applies to the pattern, but 'smartcase'
1955 is not used.
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00001956 Instead of the slash any non-letter can be used.
1957 For example, to sort on the second comma-separated
1958 field: >
1959 :sort /[^,]*,/
1960< To sort on the text at virtual column 10 (thus
1961 ignoring the difference between tabs and spaces): >
1962 :sort /.*\%10v/
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001963< To sort on the first number in the line, no matter
1964 what is in front of it: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00001965 :sort /.\{-}\ze\d/
1966< (Explanation: ".\{-}" matches any text, "\ze" sets the
1967 end of the match and \d matches a digit.)
1968 With [r] sorting is done on the matching {pattern}
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00001969 instead of skipping past it as described above.
1970 For example, to sort on only the first three letters
1971 of each line: >
1972 :sort /\a\a\a/ r
1973
1974< If a {pattern} is used, any lines which don't have a
1975 match for {pattern} are kept in their current order,
1976 but separate from the lines which do match {pattern}.
1977 If you sorted in reverse, they will be in reverse
1978 order after the sorted lines, otherwise they will be
1979 in their original order, right before the sorted
1980 lines.
1981
Bram Moolenaar1256e722007-07-10 15:26:20 +00001982 If {pattern} is empty (e.g. // is specified), the
1983 last search pattern is used. This allows trying out
1984 a pattern first.
1985
Bram Moolenaard38b0552012-04-25 19:07:41 +02001986Note that using `:sort` with `:global` doesn't sort the matching lines, it's
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001987quite useless.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001988
Bram Moolenaar55e29612020-11-01 13:57:44 +01001989`:sort` does not use the current locale unless the l flag is used.
Bram Moolenaar8bb1c3e2014-07-04 16:43:17 +02001990Vim does do a "stable" sort.
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00001991
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00001992The sorting can be interrupted, but if you interrupt it too late in the
1993process you may end up with duplicated lines. This also depends on the system
1994library function used.
Bram Moolenaarae5bce12005-08-15 21:41:48 +00001995
Hirohito Higashi74f0a772025-06-23 21:42:36 +02001996==============================================================================
19978. Deduplicating text *deduplicating* *unique*
1998
1999Vim has a deduplicating function and a deduplicating command. The
2000deduplicating function can be found here: |uniq()|.
2001Also see |:sort-uniq|.
2002
2003 *:uni* *:uniq*
2004:[range]uni[q][!] [i][l][r][u] [/{pattern}/]
2005 Remove duplicate lines that are adjacent to each other
2006 in [range]. When no range is given, all lines are
2007 processed.
2008
2009 With [i] case is ignored when comparing lines.
2010
2011 With [l] comparison uses the current collation locale.
2012 See |:sort-l| for more details.
2013
2014 With [r] comparison is done on the text that matches
2015 /{pattern}/ instead of the full line.
2016
zeertzjq1c471ac2025-06-25 21:07:25 +02002017 With [u] only keep lines that do not repeat (i.e., are
2018 not immediately followed by the same line).
2019
2020 With [!] only keep lines that are immediately followed
2021 by a duplicate.
2022
2023 If both [!] and [u] are given, [u] is ignored and [!]
2024 takes effect.
2025
Hirohito Higashi74f0a772025-06-23 21:42:36 +02002026 When /{pattern}/ is specified and [r] is not used, the
2027 text matched with {pattern} is skipped and comparison
2028 is done on what comes after the match.
2029 'ignorecase' applies to the pattern, but 'smartcase'
2030 is not used.
Hirohito Higashi74f0a772025-06-23 21:42:36 +02002031 Instead of the slash any non-letter can be used.
2032
2033 For example, to remove adjacent duplicate lines based
2034 on the second comma-separated field: >
Hirohito Higashi26ebe212025-06-26 20:31:24 +02002035 :uniq /[^,]*,/
Hirohito Higashi74f0a772025-06-23 21:42:36 +02002036< Or to keep only unique lines ignoring the first 5
2037 characters: >
2038 :uniq u /.\{5}/
2039< If {pattern} is empty (e.g. // is used), the last
2040 search pattern is used.
2041
zeertzjq1c471ac2025-06-25 21:07:25 +02002042 Note that leading and trailing white space may cause
2043 lines to be considered different.
Hirohito Higashi74f0a772025-06-23 21:42:36 +02002044 To remove all duplicates regardless of position, use
2045 |:sort-u| or external tools.
2046
Bram Moolenaar91f84f62018-07-29 15:07:52 +02002047 vim:tw=78:ts=8:noet:ft=help:norl: