blob: 6dced7bfb0820718c50060490db7beec03c99e2a [file] [log] [blame]
Bram Moolenaar6100d022016-10-02 16:51:57 +02001*change.txt* For Vim version 8.0. Last change: 2016 Oct 02
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7This file describes commands that delete or change text. In this context,
8changing text means deleting the text and replacing it with other text using
9one command. You can undo all of these commands. You can repeat the non-Ex
10commands with the "." command.
11
121. Deleting text |deleting|
132. Delete and insert |delete-insert|
143. Simple changes |simple-change| *changing*
154. Complex changes |complex-change|
Bram Moolenaar47136d72004-10-12 20:02:24 +000016 4.1 Filter commands |filter|
17 4.2 Substitute |:substitute|
18 4.3 Search and replace |search-replace|
19 4.4 Changing tabs |change-tabs|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000205. Copying and moving text |copy-move|
216. Formatting text |formatting|
Bram Moolenaar2389c3c2005-05-22 22:07:59 +0000227. Sorting text |sorting|
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24For inserting text see |insert.txt|.
25
26==============================================================================
271. Deleting text *deleting* *E470*
28
29["x]<Del> or *<Del>* *x* *dl*
30["x]x Delete [count] characters under and after the cursor
31 [into register x] (not |linewise|). Does the same as
32 "dl".
33 The <Del> key does not take a [count]. Instead, it
34 deletes the last character of the count.
35 See |:fixdel| if the <Del> key does not do what you
36 want. See |'whichwrap'| for deleting a line break
37 (join lines). {Vi does not support <Del>}
38
39 *X* *dh*
40["x]X Delete [count] characters before the cursor [into
41 register x] (not |linewise|). Does the same as "dh".
42 Also see |'whichwrap'|.
43
44 *d*
45["x]d{motion} Delete text that {motion} moves over [into register
46 x]. See below for exceptions.
47
48 *dd*
49["x]dd Delete [count] lines [into register x] |linewise|.
50
51 *D*
52["x]D Delete the characters under the cursor until the end
53 of the line and [count]-1 more lines [into register
54 x]; synonym for "d$".
55 (not |linewise|)
Bram Moolenaar4399ef42005-02-12 14:29:27 +000056 When the '#' flag is in 'cpoptions' the count is
57 ignored.
Bram Moolenaar071d4272004-06-13 20:20:40 +000058
59{Visual}["x]x or *v_x* *v_d* *v_<Del>*
60{Visual}["x]d or
61{Visual}["x]<Del> Delete the highlighted text [into register x] (for
62 {Visual} see |Visual-mode|). {not in Vi}
63
64{Visual}["x]CTRL-H or *v_CTRL-H* *v_<BS>*
65{Visual}["x]<BS> When in Select mode: Delete the highlighted text [into
66 register x].
67
68{Visual}["x]X or *v_X* *v_D* *v_b_D*
69{Visual}["x]D Delete the highlighted lines [into register x] (for
70 {Visual} see |Visual-mode|). In Visual block mode,
71 "D" deletes the highlighted text plus all text until
72 the end of the line. {not in Vi}
73
Bram Moolenaar9ba7e172013-07-17 22:37:26 +020074 *:d* *:de* *:del* *:delete* *:dl* *:dp*
Bram Moolenaar071d4272004-06-13 20:20:40 +000075:[range]d[elete] [x] Delete [range] lines (default: current line) [into
76 register x].
Bram Moolenaar9ba7e172013-07-17 22:37:26 +020077 Note these weird abbreviations:
78 :dl delete and list
79 :dell idem
80 :delel idem
81 :deletl idem
82 :deletel idem
83 :dp delete and print
84 :dep idem
85 :delp idem
86 :delep idem
87 :deletp idem
88 :deletep idem
Bram Moolenaar071d4272004-06-13 20:20:40 +000089
90:[range]d[elete] [x] {count}
91 Delete {count} lines, starting with [range]
92 (default: current line |cmdline-ranges|) [into
93 register x].
94
Bram Moolenaard38b0552012-04-25 19:07:41 +020095These commands delete text. You can repeat them with the `.` command
96(except `:d`) and undo them. Use Visual mode to delete blocks of text. See
Bram Moolenaar071d4272004-06-13 20:20:40 +000097|registers| for an explanation of registers.
98
99An exception for the d{motion} command: If the motion is not linewise, the
100start and end of the motion are not in the same line, and there are only
Bram Moolenaar38a55632016-02-15 22:07:32 +0100101blanks before the start and there are no non-blanks after the end of the
102motion, the delete becomes linewise. This means that the delete also removes
103the line of blanks that you might expect to remain. Use the |o_v| operator to
104force the motion to be characterwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000105
106Trying to delete an empty region of text (e.g., "d0" in the first column)
107is an error when 'cpoptions' includes the 'E' flag.
108
109 *J*
110J Join [count] lines, with a minimum of two lines.
111 Remove the indent and insert up to two spaces (see
Bram Moolenaar77cdfd12016-03-12 12:57:59 +0100112 below). Fails when on the last line of the buffer.
113 If [count] is too big it is reduce to the number of
114 lines available.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000115
116 *v_J*
117{Visual}J Join the highlighted lines, with a minimum of two
118 lines. Remove the indent and insert up to two spaces
119 (see below). {not in Vi}
120
121 *gJ*
122gJ Join [count] lines, with a minimum of two lines.
123 Don't insert or remove any spaces. {not in Vi}
124
125 *v_gJ*
126{Visual}gJ Join the highlighted lines, with a minimum of two
127 lines. Don't insert or remove any spaces. {not in
128 Vi}
129
130 *:j* *:join*
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000131:[range]j[oin][!] [flags]
132 Join [range] lines. Same as "J", except with [!]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000133 the join does not insert or delete any spaces.
134 If a [range] has equal start and end values, this
135 command does nothing. The default behavior is to
136 join the current line with the line below it.
137 {not in Vi: !}
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.
145 {not in Vi: !}
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000146 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000147
148These commands delete the <EOL> between lines. This has the effect of joining
Bram Moolenaard38b0552012-04-25 19:07:41 +0200149multiple lines into one line. You can repeat these commands (except `:j`) and
Bram Moolenaar071d4272004-06-13 20:20:40 +0000150undo them.
151
152These commands, except "gJ", insert one space in place of the <EOL> unless
153there is trailing white space or the next line starts with a ')'. These
154commands, except "gJ", delete any leading white space on the next line. If
155the 'joinspaces' option is on, these commands insert two spaces after a '.',
156'!' or '?' (but if 'cpoptions' includes the 'j' flag, they insert two spaces
157only after a '.').
158The 'B' and 'M' flags in 'formatoptions' change the behavior for inserting
159spaces before and after a multi-byte character |fo-table|.
160
Bram Moolenaar251835e2014-02-24 02:51:51 +0100161The '[ mark is set at the end of the first line that was joined, '] at the end
162of the resulting line.
163
Bram Moolenaar071d4272004-06-13 20:20:40 +0000164
165==============================================================================
1662. Delete and insert *delete-insert* *replacing*
167
168 *R*
169R Enter Replace mode: Each character you type replaces
170 an existing character, starting with the character
171 under the cursor. Repeat the entered text [count]-1
172 times. See |Replace-mode| for more details.
173
174 *gR*
175gR Enter Virtual Replace mode: Each character you type
176 replaces existing characters in screen space. So a
177 <Tab> may replace several characters at once.
178 Repeat the entered text [count]-1 times. See
179 |Virtual-Replace-mode| for more details.
Bram Moolenaardb84e452010-08-15 13:50:43 +0200180 {not available when compiled without the |+vreplace|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000181 feature}
182
183 *c*
184["x]c{motion} Delete {motion} text [into register x] and start
185 insert. When 'cpoptions' includes the 'E' flag and
186 there is no text to delete (e.g., with "cTx" when the
187 cursor is just after an 'x'), an error occurs and
188 insert mode does not start (this is Vi compatible).
189 When 'cpoptions' does not include the 'E' flag, the
190 "c" command always starts insert mode, even if there
191 is no text to delete.
192
193 *cc*
194["x]cc Delete [count] lines [into register x] and start
195 insert |linewise|. If 'autoindent' is on, preserve
196 the indent of the first line.
197
198 *C*
199["x]C Delete from the cursor position to the end of the
200 line and [count]-1 more lines [into register x], and
201 start insert. Synonym for c$ (not |linewise|).
202
203 *s*
204["x]s Delete [count] characters [into register x] and start
205 insert (s stands for Substitute). Synonym for "cl"
206 (not |linewise|).
207
208 *S*
209["x]S Delete [count] lines [into register x] and start
210 insert. Synonym for "cc" |linewise|.
211
212{Visual}["x]c or *v_c* *v_s*
213{Visual}["x]s Delete the highlighted text [into register x] and
214 start insert (for {Visual} see |Visual-mode|). {not
215 in Vi}
216
217 *v_r*
218{Visual}["x]r{char} Replace all selected characters by {char}.
219
220 *v_C*
221{Visual}["x]C Delete the highlighted lines [into register x] and
222 start insert. In Visual block mode it works
223 differently |v_b_C|. {not in Vi}
224 *v_S*
225{Visual}["x]S Delete the highlighted lines [into register x] and
226 start insert (for {Visual} see |Visual-mode|). {not
227 in Vi}
228 *v_R*
229{Visual}["x]R Currently just like {Visual}["x]S. In a next version
230 it might work differently. {not in Vi}
231
232Notes:
233- You can end Insert and Replace mode with <Esc>.
234- See the section "Insert and Replace mode" |mode-ins-repl| for the other
235 special characters in these modes.
236- The effect of [count] takes place after Vim exits Insert or Replace mode.
237- When the 'cpoptions' option contains '$' and the change is within one line,
238 Vim continues to show the text to be deleted and puts a '$' at the last
239 deleted character.
240
241See |registers| for an explanation of registers.
242
243Replace mode is just like Insert mode, except that every character you enter
244deletes one character. If you reach the end of a line, Vim appends any
245further characters (just like Insert mode). In Replace mode, the backspace
246key restores the original text (if there was any). (See section "Insert and
247Replace mode" |mode-ins-repl|).
248
249 *cw* *cW*
Bram Moolenaar446cb832008-06-24 21:56:24 +0000250Special case: When the cursor is in a word, "cw" and "cW" do not include the
251white space after a word, they only change up to the end of the word. This is
252because Vim interprets "cw" as change-word, and a word does not include the
253following white space.
254{Vi: "cw" when on a blank followed by other blanks changes only the first
255blank; this is probably a bug, because "dw" deletes all the blanks; use the
256'w' flag in 'cpoptions' to make it work like Vi anyway}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000257
258If you prefer "cw" to include the space after a word, use this mapping: >
259 :map cw dwi
Bram Moolenaar446cb832008-06-24 21:56:24 +0000260Or use "caw" (see |aw|).
261
Bram Moolenaar071d4272004-06-13 20:20:40 +0000262 *:c* *:ch* *:change*
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000263:{range}c[hange][!] Replace lines of text with some different text.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000264 Type a line containing only "." to stop replacing.
265 Without {range}, this command changes only the current
266 line.
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000267 Adding [!] toggles 'autoindent' for the time this
268 command is executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000269
270==============================================================================
2713. Simple changes *simple-change*
272
273 *r*
274r{char} Replace the character under the cursor with {char}.
275 If {char} is a <CR> or <NL>, a line break replaces the
276 character. To replace with a real <CR>, use CTRL-V
277 <CR>. CTRL-V <NL> replaces with a <Nul>.
278 {Vi: CTRL-V <CR> still replaces with a line break,
279 cannot replace something with a <CR>}
Bram Moolenaar80716072012-05-01 21:14:34 +0200280
281 If {char} is CTRL-E or CTRL-Y the character from the
282 line below or above is used, just like with |i_CTRL-E|
283 and |i_CTRL-Y|. This also works with a count, thus
284 `10r<C-E>` copies 10 characters from the line below.
285
Bram Moolenaar071d4272004-06-13 20:20:40 +0000286 If you give a [count], Vim replaces [count] characters
287 with [count] {char}s. When {char} is a <CR> or <NL>,
288 however, Vim inserts only one <CR>: "5r<CR>" replaces
289 five characters with a single line break.
290 When {char} is a <CR> or <NL>, Vim performs
291 autoindenting. This works just like deleting the
292 characters that are replaced and then doing
293 "i<CR><Esc>".
294 {char} can be entered as a digraph |digraph-arg|.
295 |:lmap| mappings apply to {char}. The CTRL-^ command
296 in Insert mode can be used to switch this on/off
297 |i_CTRL-^|. See |utf-8-char-arg| about using
298 composing characters when 'encoding' is Unicode.
299
300 *gr*
301gr{char} Replace the virtual characters under the cursor with
302 {char}. This replaces in screen space, not file
303 space. See |gR| and |Virtual-Replace-mode| for more
304 details. As with |r| a count may be given.
305 {char} can be entered like with |r|.
Bram Moolenaardb84e452010-08-15 13:50:43 +0200306 {not available when compiled without the |+vreplace|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307 feature}
308
309 *digraph-arg*
310The argument for Normal mode commands like |r| and |t| is a single character.
311When 'cpo' doesn't contain the 'D' flag, this character can also be entered
312like |digraphs|. First type CTRL-K and then the two digraph characters.
313{not available when compiled without the |+digraphs| feature}
314
315 *case*
316The following commands change the case of letters. The currently active
317|locale| is used. See |:language|. The LC_CTYPE value matters here.
318
319 *~*
320~ 'notildeop' option: Switch case of the character
321 under the cursor and move the cursor to the right.
322 If a [count] is given, do that many characters. {Vi:
323 no count}
324
325~{motion} 'tildeop' option: switch case of {motion} text. {Vi:
326 tilde cannot be used as an operator}
327
328 *g~*
329g~{motion} Switch case of {motion} text. {not in Vi}
330
331g~g~ *g~g~* *g~~*
332g~~ Switch case of current line. {not in Vi}.
333
334 *v_~*
335{Visual}~ Switch case of highlighted text (for {Visual} see
336 |Visual-mode|). {not in Vi}
337
338 *v_U*
339{Visual}U Make highlighted text uppercase (for {Visual} see
340 |Visual-mode|). {not in Vi}
341
342 *gU* *uppercase*
343gU{motion} Make {motion} text uppercase. {not in Vi}
344 Example: >
345 :map! <C-F> <Esc>gUiw`]a
346< This works in Insert mode: press CTRL-F to make the
347 word before the cursor uppercase. Handy to type
348 words in lowercase and then make them uppercase.
349
350
351gUgU *gUgU* *gUU*
352gUU Make current line uppercase. {not in Vi}.
353
354 *v_u*
355{Visual}u Make highlighted text lowercase (for {Visual} see
356 |Visual-mode|). {not in Vi}
357
358 *gu* *lowercase*
359gu{motion} Make {motion} text lowercase. {not in Vi}
360
361gugu *gugu* *guu*
362guu Make current line lowercase. {not in Vi}.
363
364 *g?* *rot13*
365g?{motion} Rot13 encode {motion} text. {not in Vi}
366
367 *v_g?*
368{Visual}g? Rot13 encode the highlighted text (for {Visual} see
369 |Visual-mode|). {not in Vi}
370
371g?g? *g?g?* *g??*
372g?? Rot13 encode current line. {not in Vi}.
373
Bram Moolenaar446cb832008-06-24 21:56:24 +0000374To turn one line into title caps, make every first letter of a word
375uppercase: >
376 :s/\v<(.)(\w*)/\u\1\L\2/g
377
Bram Moolenaar071d4272004-06-13 20:20:40 +0000378
379Adding and subtracting ~
380 *CTRL-A*
381CTRL-A Add [count] to the number or alphabetic character at
382 or after the cursor. {not in Vi}
383
Bram Moolenaar979243b2015-06-26 19:35:49 +0200384 *v_CTRL-A*
385{Visual}CTRL-A Add [count] to the number or alphabetic character in
386 the highlighted text. {not in Vi}
387
388 *v_g_CTRL-A*
389{Visual}g CTRL-A Add [count] to the number or alphabetic character in
390 the highlighted text. If several lines are
391 highlighted, each one will be incremented by an
392 additional [count] (so effectively creating a
393 [count] incrementing sequence). {not in Vi}
394 For Example, if you have this list of numbers:
395 1. ~
396 1. ~
397 1. ~
398 1. ~
399 Move to the second "1." and Visually select three
400 lines, pressing g CTRL-A results in:
401 1. ~
402 2. ~
403 3. ~
404 4. ~
405
Bram Moolenaar071d4272004-06-13 20:20:40 +0000406 *CTRL-X*
407CTRL-X Subtract [count] from the number or alphabetic
408 character at or after the cursor. {not in Vi}
409
Bram Moolenaar979243b2015-06-26 19:35:49 +0200410 *v_CTRL-X*
411{Visual}CTRL-X Subtract [count] from the number or alphabetic
412 character in the highlighted text. {not in Vi}
413
Bram Moolenaare0fa3742016-02-20 15:47:01 +0100414 On MS-Windows, this is mapped to cut Visual text
415 |dos-standard-mappings|. If you want to disable the
416 mapping, use this: >
417 silent! vunmap <C-X>
418<
Bram Moolenaar979243b2015-06-26 19:35:49 +0200419 *v_g_CTRL-X*
420{Visual}g CTRL-X Subtract [count] from the number or alphabetic
421 character in the highlighted text. If several lines
422 are highlighted, each value will be decremented by an
423 additional [count] (so effectively creating a [count]
424 decrementing sequence). {not in Vi}
425
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100426The CTRL-A and CTRL-X commands can work for:
427- signed and unsigned decimal numbers
428- unsigned binary, octal and hexadecimal numbers
429- alphabetic characters
430
431This depends on the 'nrformats' option:
432- When 'nrformats' includes "bin", Vim assumes numbers starting with '0b' or
433 '0B' are binary.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000434- When 'nrformats' includes "octal", Vim considers numbers starting with a '0'
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000435 to be octal, unless the number includes a '8' or '9'. Other numbers are
436 decimal and may have a preceding minus sign.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000437 If the cursor is on a number, the commands apply to that number; otherwise
438 Vim uses the number to the right of the cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000439- When 'nrformats' includes "hex", Vim assumes numbers starting with '0x' or
440 '0X' are hexadecimal. The case of the rightmost letter in the number
441 determines the case of the resulting hexadecimal number. If there is no
442 letter in the current number, Vim uses the previously detected case.
443- When 'nrformats' includes "alpha", Vim will change the alphabetic character
444 under or after the cursor. This is useful to make lists with an alphabetic
445 index.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000446
Bram Moolenaar979243b2015-06-26 19:35:49 +0200447For decimals a leading negative sign is considered for incrementing/
Bram Moolenaarfa735342016-01-03 22:14:44 +0100448decrementing, for binary, octal and hex values, it won't be considered. To
449ignore the sign Visually select the number before using CTRL-A or CTRL-X.
Bram Moolenaar979243b2015-06-26 19:35:49 +0200450
Bram Moolenaar071d4272004-06-13 20:20:40 +0000451For numbers with leading zeros (including all octal and hexadecimal numbers),
452Vim preserves the number of characters in the number when possible. CTRL-A on
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000453"0077" results in "0100", CTRL-X on "0x100" results in "0x0ff".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000454There is one exception: When a number that starts with a zero is found not to
455be octal (it contains a '8' or '9'), but 'nrformats' does include "octal",
456leading zeros are removed to avoid that the result may be recognized as an
457octal number.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000458
459Note that when 'nrformats' includes "octal", decimal numbers with leading
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000460zeros cause mistakes, because they can be confused with octal numbers.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000461
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100462Note similarly, when 'nrformats' includes "bin", binary numbers with a leading
463'0x' or '0X' can be interpreted as hexadecimal rather than binary since '0b'
464are valid hexadecimal digits.
465
Bram Moolenaar071d4272004-06-13 20:20:40 +0000466The CTRL-A command is very useful in a macro. Example: Use the following
467steps to make a numbered list.
468
4691. Create the first list entry, make sure it starts with a number.
Bram Moolenaard8b02732005-01-14 21:48:43 +00004702. qa - start recording into register 'a'
Bram Moolenaar071d4272004-06-13 20:20:40 +00004713. Y - yank the entry
4724. p - put a copy of the entry below the first one
4735. CTRL-A - increment the number
4746. q - stop recording
4757. <count>@a - repeat the yank, put and increment <count> times
476
477
478SHIFTING LINES LEFT OR RIGHT *shift-left-right*
479
480 *<*
481<{motion} Shift {motion} lines one 'shiftwidth' leftwards.
482
483 *<<*
484<< Shift [count] lines one 'shiftwidth' leftwards.
485
486 *v_<*
487{Visual}[count]< Shift the highlighted lines [count] 'shiftwidth'
488 leftwards (for {Visual} see |Visual-mode|). {not in
489 Vi}
490
491 *>*
492 >{motion} Shift {motion} lines one 'shiftwidth' rightwards.
493
494 *>>*
495 >> Shift [count] lines one 'shiftwidth' rightwards.
496
497 *v_>*
498{Visual}[count]> Shift the highlighted lines [count] 'shiftwidth'
499 rightwards (for {Visual} see |Visual-mode|). {not in
500 Vi}
501
502 *:<*
503:[range]< Shift [range] lines one 'shiftwidth' left. Repeat '<'
504 for shifting multiple 'shiftwidth's.
505
506:[range]< {count} Shift {count} lines one 'shiftwidth' left, starting
507 with [range] (default current line |cmdline-ranges|).
508 Repeat '<' for shifting multiple 'shiftwidth's.
509
510:[range]le[ft] [indent] left align lines in [range]. Sets the indent in the
511 lines to [indent] (default 0). {not in Vi}
512
513 *:>*
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000514:[range]> [flags] Shift {count} [range] lines one 'shiftwidth' right.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000515 Repeat '>' for shifting multiple 'shiftwidth's.
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000516 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000517
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000518:[range]> {count} [flags]
519 Shift {count} lines one 'shiftwidth' right, starting
Bram Moolenaar071d4272004-06-13 20:20:40 +0000520 with [range] (default current line |cmdline-ranges|).
521 Repeat '>' for shifting multiple 'shiftwidth's.
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000522 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000523
524The ">" and "<" commands are handy for changing the indentation within
525programs. Use the 'shiftwidth' option to set the size of the white space
526which these commands insert or delete. Normally the 'shiftwidth' option is 8,
527but you can set it to, say, 3 to make smaller indents. The shift leftwards
528stops when there is no indent. The shift right does not affect empty lines.
529
530If the 'shiftround' option is on, the indent is rounded to a multiple of
531'shiftwidth'.
532
533If the 'smartindent' option is on, or 'cindent' is on and 'cinkeys' contains
Bram Moolenaar8e69b4a2013-11-09 03:41:58 +0100534'#' with a zero value, shift right does not affect lines starting with '#'
535(these are supposed to be C preprocessor lines that must stay in column 1).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000536
537When the 'expandtab' option is off (this is the default) Vim uses <Tab>s as
538much as possible to make the indent. You can use ">><<" to replace an indent
539made out of spaces with the same indent made out of <Tab>s (and a few spaces
540if necessary). If the 'expandtab' option is on, Vim uses only spaces. Then
541you can use ">><<" to replace <Tab>s in the indent by spaces (or use
Bram Moolenaard38b0552012-04-25 19:07:41 +0200542`:retab!`).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000543
Bram Moolenaard38b0552012-04-25 19:07:41 +0200544To move a line several 'shiftwidth's, use Visual mode or the `:` commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000545For example: >
546 Vjj4> move three lines 4 indents to the right
547 :<<< move current line 3 indents to the left
548 :>> 5 move 5 lines 2 indents to the right
549 :5>> move line 5 2 indents to the right
550
551==============================================================================
5524. Complex changes *complex-change*
553
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00005544.1 Filter commands *filter*
Bram Moolenaar47136d72004-10-12 20:02:24 +0000555
556A filter is a program that accepts text at standard input, changes it in some
557way, and sends it to standard output. You can use the commands below to send
Bram Moolenaar446cb832008-06-24 21:56:24 +0000558some text through a filter, so that it is replaced by the filter output.
Bram Moolenaar47136d72004-10-12 20:02:24 +0000559Examples of filters are "sort", which sorts lines alphabetically, and
560"indent", which formats C program files (you need a version of indent that
561works like a filter; not all versions do). The 'shell' option specifies the
562shell Vim uses to execute the filter command (See also the 'shelltype'
563option). You can repeat filter commands with ".". Vim does not recognize a
Bram Moolenaard38b0552012-04-25 19:07:41 +0200564comment (starting with '"') after the `:!` command.
Bram Moolenaar47136d72004-10-12 20:02:24 +0000565
566 *!*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000567!{motion}{filter} Filter {motion} text lines through the external
568 program {filter}.
569
570 *!!*
571!!{filter} Filter [count] lines through the external program
572 {filter}.
573
574 *v_!*
575{Visual}!{filter} Filter the highlighted lines through the external
576 program {filter} (for {Visual} see |Visual-mode|).
577 {not in Vi}
578
579:{range}![!]{filter} [!][arg] *:range!*
580 Filter {range} lines through the external program
581 {filter}. Vim replaces the optional bangs with the
582 latest given command and appends the optional [arg].
583 Vim saves the output of the filter command in a
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100584 temporary file and then reads the file into the buffer
585 |tempfile|. Vim uses the 'shellredir' option to
586 redirect the filter output to the temporary file.
Bram Moolenaar83c465c2005-12-16 21:53:56 +0000587 However, if the 'shelltemp' option is off then pipes
588 are used when possible (on Unix).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000589 When the 'R' flag is included in 'cpoptions' marks in
590 the filtered lines are deleted, unless the
591 |:keepmarks| command is used. Example: >
592 :keepmarks '<,'>!sort
593< When the number of lines after filtering is less than
594 before, marks in the missing lines are deleted anyway.
595
596 *=*
597={motion} Filter {motion} lines through the external program
598 given with the 'equalprg' option. When the 'equalprg'
599 option is empty (this is the default), use the
Bram Moolenaar20f90cf2011-05-19 12:22:51 +0200600 internal formatting function |C-indenting| and
601 |'lisp'|. But when 'indentexpr' is not empty, it will
602 be used instead |indent-expression|. When Vim was
603 compiled without internal formatting then the "indent"
604 program is used as a last resort.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000605
606 *==*
607== Filter [count] lines like with ={motion}.
608
609 *v_=*
610{Visual}= Filter the highlighted lines like with ={motion}.
611 {not in Vi}
612
Bram Moolenaar071d4272004-06-13 20:20:40 +0000613
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100614 *tempfile* *setuid*
615Vim uses temporary files for filtering, generating diffs and also for
616tempname(). For Unix, the file will be in a private directory (only
617accessible by the current user) to avoid security problems (e.g., a symlink
618attack or other people reading your file). When Vim exits the directory and
619all files in it are deleted. When Vim has the setuid bit set this may cause
620problems, the temp file is owned by the setuid user but the filter command
621probably runs as the original user.
622On MS-DOS and OS/2 the first of these directories that works is used: $TMP,
623$TEMP, c:\TMP, c:\TEMP.
624For Unix the list of directories is: $TMPDIR, /tmp, current-dir, $HOME.
625For MS-Windows the GetTempFileName() system function is used.
626For other systems the tmpnam() library function is used.
627
628
629
Bram Moolenaar47136d72004-10-12 20:02:24 +00006304.2 Substitute *:substitute*
631 *:s* *:su*
Bram Moolenaar05159a02005-02-26 23:04:13 +0000632:[range]s[ubstitute]/{pattern}/{string}/[flags] [count]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633 For each line in [range] replace a match of {pattern}
634 with {string}.
635 For the {pattern} see |pattern|.
636 {string} can be a literal string, or something
637 special; see |sub-replace-special|.
638 When [range] and [count] are omitted, replace in the
639 current line only.
640 When [count] is given, replace in [count] lines,
641 starting with the last line in [range]. When [range]
642 is omitted start in the current line.
643 Also see |cmdline-ranges|.
Bram Moolenaar05159a02005-02-26 23:04:13 +0000644 See |:s_flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000645
Bram Moolenaar05159a02005-02-26 23:04:13 +0000646:[range]s[ubstitute] [flags] [count]
647:[range]&[&][flags] [count] *:&*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000648 Repeat last :substitute with same search pattern and
649 substitute string, but without the same flags. You
Bram Moolenaar05159a02005-02-26 23:04:13 +0000650 may add [flags], see |:s_flags|.
Bram Moolenaard38b0552012-04-25 19:07:41 +0200651 Note that after `:substitute` the '&' flag can't be
Bram Moolenaar071d4272004-06-13 20:20:40 +0000652 used, it's recognized as a pattern separator.
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200653 The space between `:substitute` and the 'c', 'g',
654 'i', 'I' and 'r' flags isn't required, but in scripts
655 it's a good idea to keep it to avoid confusion.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000656
Bram Moolenaar05159a02005-02-26 23:04:13 +0000657:[range]~[&][flags] [count] *:~*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000658 Repeat last substitute with same substitute string
659 but with last used search pattern. This is like
Bram Moolenaard38b0552012-04-25 19:07:41 +0200660 `:&r`. See |:s_flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000661
Bram Moolenaar05159a02005-02-26 23:04:13 +0000662 *&*
Bram Moolenaard38b0552012-04-25 19:07:41 +0200663& Synonym for `:s` (repeat last substitute). Note
Bram Moolenaar071d4272004-06-13 20:20:40 +0000664 that the flags are not remembered, thus it might
Bram Moolenaard38b0552012-04-25 19:07:41 +0200665 actually work differently. You can use `:&&` to keep
Bram Moolenaar071d4272004-06-13 20:20:40 +0000666 the flags.
667
Bram Moolenaar05159a02005-02-26 23:04:13 +0000668 *g&*
Bram Moolenaar97d62492012-11-15 21:28:22 +0100669g& Synonym for `:%s//~/&` (repeat last substitute with
670 last search pattern on all lines with the same flags).
Bram Moolenaar34700a62013-03-07 13:20:54 +0100671 For example, when you first do a substitution with
Bram Moolenaar97d62492012-11-15 21:28:22 +0100672 `:s/pattern/repl/flags` and then `/search` for
673 something else, `g&` will do `:%s/search/repl/flags`.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 Mnemonic: global substitute. {not in Vi}
675
676 *:snomagic* *:sno*
Bram Moolenaard38b0552012-04-25 19:07:41 +0200677:[range]sno[magic] ... Same as `:substitute`, but always use 'nomagic'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000678 {not in Vi}
679
680 *:smagic* *:sm*
Bram Moolenaard38b0552012-04-25 19:07:41 +0200681:[range]sm[agic] ... Same as `:substitute`, but always use 'magic'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000682 {not in Vi}
683
684 *:s_flags*
685The flags that you can use for the substitute commands:
686
687[&] Must be the first one: Keep the flags from the previous substitute
688 command. Examples: >
689 :&&
690 :s/this/that/&
Bram Moolenaard38b0552012-04-25 19:07:41 +0200691< Note that `:s` and `:&` don't keep the flags.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000692 {not in Vi}
693
694[c] Confirm each substitution. Vim highlights the matching string (with
695 |hl-IncSearch|). You can type: *:s_c*
696 'y' to substitute this match
697 'l' to substitute this match and then quit ("last")
698 'n' to skip this match
699 <Esc> to quit substituting
700 'a' to substitute this and all remaining matches {not in Vi}
701 'q' to quit substituting {not in Vi}
702 CTRL-E to scroll the screen up {not in Vi, not available when
Bram Moolenaardb84e452010-08-15 13:50:43 +0200703 compiled without the |+insert_expand| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000704 CTRL-Y to scroll the screen down {not in Vi, not available when
Bram Moolenaardb84e452010-08-15 13:50:43 +0200705 compiled without the |+insert_expand| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000706 If the 'edcompatible' option is on, Vim remembers the [c] flag and
707 toggles it each time you use it, but resets it when you give a new
708 search pattern.
709 {not in Vi: highlighting of the match, other responses than 'y' or 'n'}
710
711[e] When the search pattern fails, do not issue an error message and, in
712 particular, continue in maps as if no error occurred. This is most
713 useful to prevent the "No match" error from breaking a mapping. Vim
714 does not suppress the following error messages, however:
715 Regular expressions can't be delimited by letters
716 \ should be followed by /, ? or &
717 No previous substitute regular expression
718 Trailing characters
719 Interrupted
720 {not in Vi}
721
722[g] Replace all occurrences in the line. Without this argument,
723 replacement occurs only for the first occurrence in each line. If
724 the 'edcompatible' option is on, Vim remembers this flag and toggles
725 it each time you use it, but resets it when you give a new search
726 pattern. If the 'gdefault' option is on, this flag is on by default
727 and the [g] argument switches it off.
728
729[i] Ignore case for the pattern. The 'ignorecase' and 'smartcase' options
730 are not used.
731 {not in Vi}
732
733[I] Don't ignore case for the pattern. The 'ignorecase' and 'smartcase'
734 options are not used.
735 {not in Vi}
736
Bram Moolenaar05159a02005-02-26 23:04:13 +0000737[n] Report the number of matches, do not actually substitute. The [c]
738 flag is ignored. The matches are reported as if 'report' is zero.
739 Useful to |count-items|.
Bram Moolenaar9b451252012-08-15 17:43:31 +0200740 If \= |sub-replace-expression| is used, the expression will be
741 evaluated in the |sandbox| at every match.
Bram Moolenaar05159a02005-02-26 23:04:13 +0000742
Bram Moolenaar071d4272004-06-13 20:20:40 +0000743[p] Print the line containing the last substitute.
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000744
745[#] Like [p] and prepend the line number.
746
Bram Moolenaar9964e462007-05-05 17:54:07 +0000747[l] Like [p] but print the text like |:list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000748
Bram Moolenaard38b0552012-04-25 19:07:41 +0200749[r] Only useful in combination with `:&` or `:s` without arguments. `:&r`
750 works the same way as `:~`: When the search pattern is empty, use the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000751 previously used search pattern instead of the search pattern from the
Bram Moolenaard38b0552012-04-25 19:07:41 +0200752 last substitute or `:global`. If the last command that did a search
753 was a substitute or `:global`, there is no effect. If the last
Bram Moolenaar071d4272004-06-13 20:20:40 +0000754 command was a search command such as "/", use the pattern from that
755 command.
Bram Moolenaard38b0552012-04-25 19:07:41 +0200756 For `:s` with an argument this already happens: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000757 :s/blue/red/
758 /green
759 :s//red/ or :~ or :&r
760< The last commands will replace "green" with "red". >
761 :s/blue/red/
762 /green
763 :&
764< The last command will replace "blue" with "red".
765 {not in Vi}
766
767Note that there is no flag to change the "magicness" of the pattern. A
Bram Moolenaar446cb832008-06-24 21:56:24 +0000768different command is used instead, or you can use |/\v| and friends. The
769reason is that the flags can only be found by skipping the pattern, and in
770order to skip the pattern the "magicness" must be known. Catch 22!
Bram Moolenaar071d4272004-06-13 20:20:40 +0000771
772If the {pattern} for the substitute command is empty, the command uses the
Bram Moolenaard38b0552012-04-25 19:07:41 +0200773pattern from the last substitute or `:global` command. If there is none, but
Bram Moolenaar662db672011-03-22 14:05:35 +0100774there is a previous search pattern, that one is used. With the [r] flag, the
Bram Moolenaard38b0552012-04-25 19:07:41 +0200775command uses the pattern from the last substitute, `:global`, or search
Bram Moolenaar071d4272004-06-13 20:20:40 +0000776command.
777
Bram Moolenaar9964e462007-05-05 17:54:07 +0000778If the {string} is omitted the substitute is done as if it's empty. Thus the
779matched pattern is deleted. The separator after {pattern} can also be left
780out then. Example: >
781 :%s/TESTING
782This deletes "TESTING" from all lines, but only one per line.
783
Bram Moolenaar071d4272004-06-13 20:20:40 +0000784For compatibility with Vi these two exceptions are allowed:
785"\/{string}/" and "\?{string}?" do the same as "//{string}/r".
786"\&{string}&" does the same as "//{string}/".
787 *E146*
788Instead of the '/' which surrounds the pattern and replacement string, you
Bram Moolenaar9964e462007-05-05 17:54:07 +0000789can use any other single-byte character, but not an alphanumeric character,
790'\', '"' or '|'. This is useful if you want to include a '/' in the search
791pattern or replacement string. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000792 :s+/+//+
793
Bram Moolenaar446cb832008-06-24 21:56:24 +0000794For the definition of a pattern, see |pattern|. In Visual block mode, use
795|/\%V| in the pattern to have the substitute work in the block only.
796Otherwise it works on whole lines anyway.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000797
798 *sub-replace-special* *:s\=*
799When the {string} starts with "\=" it is evaluated as an expression, see
Bram Moolenaar251e1912011-06-19 05:09:16 +0200800|sub-replace-expression|. You can use that for complex replacement or special
801characters.
802
Bram Moolenaar5a8684e2005-07-30 22:43:24 +0000803Otherwise these characters in {string} have a special meaning:
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000804 *:s%*
Bram Moolenaar551dbcc2006-04-25 22:13:59 +0000805When {string} is equal to "%" and '/' is included with the 'cpoptions' option,
Bram Moolenaar251e1912011-06-19 05:09:16 +0200806then the {string} of the previous substitute command is used, see |cpo-/|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807
808magic nomagic action ~
809 & \& replaced with the whole matched pattern *s/\&*
810 \& & replaced with &
811 \0 replaced with the whole matched pattern *\0* *s/\0*
812 \1 replaced with the matched pattern in the first
813 pair of () *s/\1*
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +0000814 \2 replaced with the matched pattern in the second
Bram Moolenaar071d4272004-06-13 20:20:40 +0000815 pair of () *s/\2*
816 .. .. *s/\3*
817 \9 replaced with the matched pattern in the ninth
818 pair of () *s/\9*
819 ~ \~ replaced with the {string} of the previous
820 substitute *s~*
821 \~ ~ replaced with ~ *s/\~*
822 \u next character made uppercase *s/\u*
823 \U following characters made uppercase, until \E *s/\U*
824 \l next character made lowercase *s/\l*
825 \L following characters made lowercase, until \E *s/\L*
826 \e end of \u, \U, \l and \L (NOTE: not <Esc>!) *s/\e*
827 \E end of \u, \U, \l and \L *s/\E*
828 <CR> split line in two at this point
829 (Type the <CR> as CTRL-V <Enter>) *s<CR>*
830 \r idem *s/\r*
831 \<CR> insert a carriage-return (CTRL-M)
832 (Type the <CR> as CTRL-V <Enter>) *s/\<CR>*
833 \n insert a <NL> (<NUL> in the file)
834 (does NOT break the line) *s/\n*
835 \b insert a <BS> *s/\b*
836 \t insert a <Tab> *s/\t*
837 \\ insert a single backslash *s/\\*
838 \x where x is any character not mentioned above:
839 Reserved for future expansion
840
Bram Moolenaar251e1912011-06-19 05:09:16 +0200841The special meaning is also used inside the third argument {sub} of
842the |substitute()| function with the following exceptions:
843 - A % inserts a percent literally without regard to 'cpoptions'.
844 - magic is always set without regard to 'magic'.
845 - A ~ inserts a tilde literally.
846 - <CR> and \r inserts a carriage-return (CTRL-M).
847 - \<CR> does not have a special meaning. it's just one of \x.
848
Bram Moolenaar071d4272004-06-13 20:20:40 +0000849Examples: >
850 :s/a\|b/xxx\0xxx/g modifies "a b" to "xxxaxxx xxxbxxx"
851 :s/\([abc]\)\([efg]\)/\2\1/g modifies "af fa bg" to "fa fa gb"
852 :s/abcde/abc^Mde/ modifies "abcde" to "abc", "de" (two lines)
853 :s/$/\^M/ modifies "abcde" to "abcde^M"
Bram Moolenaarefd2bf12006-03-16 21:41:35 +0000854 :s/\w\+/\u\0/g modifies "bla bla" to "Bla Bla"
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +0200855 :s/\w\+/\L\u\0/g modifies "BLA bla" to "Bla Bla"
Bram Moolenaarbf884932013-04-05 22:26:15 +0200856
857Note: "\L\u" can be used to capitalize the first letter of a word. This is
858not compatible with Vi and older versions of Vim, where the "\u" would cancel
859out the "\L". Same for "\U\l".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000860
861Note: In previous versions CTRL-V was handled in a special way. Since this is
862not Vi compatible, this was removed. Use a backslash instead.
863
864command text result ~
865:s/aa/a^Ma/ aa a<line-break>a
866:s/aa/a\^Ma/ aa a^Ma
867:s/aa/a\\^Ma/ aa a\<line-break>a
868
869(you need to type CTRL-V <CR> to get a ^M here)
870
871The numbering of "\1", "\2" etc. is done based on which "\(" comes first in
872the pattern (going left to right). When a parentheses group matches several
873times, the last one will be used for "\1", "\2", etc. Example: >
874 :s/\(\(a[a-d] \)*\)/\2/ modifies "aa ab x" to "ab x"
Bram Moolenaar7e1479b2016-09-11 15:07:27 +0200875The "\2" is for "\(a[a-d] \)". At first it matches "aa ", secondly "ab ".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000876
877When using parentheses in combination with '|', like in \([ab]\)\|\([cd]\),
878either the first or second pattern in parentheses did not match, so either
879\1 or \2 is empty. Example: >
880 :s/\([ab]\)\|\([cd]\)/\1x/g modifies "a b c d" to "ax bx x x"
881<
882
Bram Moolenaara0f849e2015-10-30 14:37:44 +0100883 *:sc* *:sce* *:scg* *:sci* *:scI* *:scl* *:scp* *:sg* *:sgc*
884 *:sge* *:sgi* *:sgI* *:sgl* *:sgn* *:sgp* *:sgr* *:sI* *:si*
885 *:sic* *:sIc* *:sie* *:sIe* *:sIg* *:sIl* *:sin* *:sIn* *:sIp*
886 *:sip* *:sIr* *:sir* *:sr* *:src* *:srg* *:sri* *:srI* *:srl*
887 *:srn* *:srp*
8882-letter and 3-letter :substitute commands ~
889
890 List of :substitute commands
891 | c e g i I n p l r
892 | c :sc :sce :scg :sci :scI :scn :scp :scl ---
893 | e
894 | g :sgc :sge :sg :sgi :sgI :sgn :sgp :sgl :sgr
895 | i :sic :sie --- :si :siI :sin :sip --- :sir
896 | I :sIc :sIe :sIg :sIi :sI :sIn :sIp :sIl :sIr
897 | n
898 | p
899 | l
900 | r :src --- :srg :sri :srI :srn :srp :srl :sr
901
902Exceptions:
903 :scr is `:scriptnames`
904 :se is `:set`
905 :sig is `:sign`
906 :sil is `:silent`
907 :sn is `:snext`
908 :sp is `:split`
909 :sl is `:sleep`
910 :sre is `:srewind`
911
912
Bram Moolenaar071d4272004-06-13 20:20:40 +0000913Substitute with an expression *sub-replace-expression*
Bram Moolenaar92dff182014-02-11 19:15:50 +0100914 *sub-replace-\=* *s/\=*
Bram Moolenaara7fc0102005-05-18 22:17:12 +0000915When the substitute string starts with "\=" the remainder is interpreted as an
Bram Moolenaar6100d022016-10-02 16:51:57 +0200916expression.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000917
918The special meaning for characters as mentioned at |sub-replace-special| does
Bram Moolenaar251e1912011-06-19 05:09:16 +0200919not apply except for "<CR>". A <NL> character is used as a line break, you
920can get one with a double-quote string: "\n". Prepend a backslash to get a
921real <NL> character (which will be a NUL in the file).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922
Bram Moolenaar251e1912011-06-19 05:09:16 +0200923The "\=" notation can also be used inside the third argument {sub} of
924|substitute()| function. In this case, the special meaning for characters as
925mentioned at |sub-replace-special| does not apply at all. Especially, <CR> and
926<NL> are interpreted not as a line break but as a carriage-return and a
927new-line respectively.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000928
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000929When the result is a |List| then the items are joined with separating line
930breaks. Thus each item becomes a line, except that they can contain line
931breaks themselves.
932
Bram Moolenaar071d4272004-06-13 20:20:40 +0000933The whole matched text can be accessed with "submatch(0)". The text matched
934with the first pair of () with "submatch(1)". Likewise for further
935sub-matches in ().
936
937Be careful: The separation character must not appear in the expression!
938Consider using a character like "@" or ":". There is no problem if the result
939of the expression contains the separation character.
940
Bram Moolenaar5a8684e2005-07-30 22:43:24 +0000941Examples: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000942 :s@\n@\="\r" . expand("$HOME") . "\r"@
Bram Moolenaar5a8684e2005-07-30 22:43:24 +0000943This replaces an end-of-line with a new line containing the value of $HOME. >
944
945 s/E/\="\<Char-0x20ac>"/g
Bram Moolenaarc236c162008-07-13 17:41:49 +0000946This replaces each 'E' character with a euro sign. Read more in |<Char->|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000947
948
Bram Moolenaar47136d72004-10-12 20:02:24 +00009494.3 Search and replace *search-replace*
950
951 *:pro* *:promptfind*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000952:promptf[ind] [string]
953 Put up a Search dialog. When [string] is given, it is
954 used as the initial search string.
955 {only for Win32, Motif and GTK GUI}
956
957 *:promptr* *:promptrepl*
958:promptr[epl] [string]
959 Put up a Search/Replace dialog. When [string] is
960 given, it is used as the initial search string.
961 {only for Win32, Motif and GTK GUI}
962
Bram Moolenaar47136d72004-10-12 20:02:24 +0000963
9644.4 Changing tabs *change-tabs*
Bram Moolenaard38b0552012-04-25 19:07:41 +0200965 *:ret* *:retab* *:retab!*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000966:[range]ret[ab][!] [new_tabstop]
967 Replace all sequences of white-space containing a
968 <Tab> with new strings of white-space using the new
969 tabstop value given. If you do not specify a new
970 tabstop size or it is zero, Vim uses the current value
971 of 'tabstop'.
972 The current value of 'tabstop' is always used to
973 compute the width of existing tabs.
974 With !, Vim also replaces strings of only normal
975 spaces with tabs where appropriate.
976 With 'expandtab' on, Vim replaces all tabs with the
977 appropriate number of spaces.
978 This command sets 'tabstop' to the new value given,
979 and if performed on the whole file, which is default,
980 should not make any visible change.
981 Careful: This command modifies any <Tab> characters
982 inside of strings in a C program. Use "\t" to avoid
983 this (that's a good habit anyway).
Bram Moolenaard38b0552012-04-25 19:07:41 +0200984 `:retab!` may also change a sequence of spaces by
Bram Moolenaar071d4272004-06-13 20:20:40 +0000985 <Tab> characters, which can mess up a printf().
986 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000987
988 *retab-example*
989Example for using autocommands and ":retab" to edit a file which is stored
990with tabstops at 8 but edited with tabstops set at 4. Warning: white space
991inside of strings can change! Also see 'softtabstop' option. >
992
993 :auto BufReadPost *.xx retab! 4
994 :auto BufWritePre *.xx retab! 8
995 :auto BufWritePost *.xx retab! 4
996 :auto BufNewFile *.xx set ts=4
997
998==============================================================================
9995. Copying and moving text *copy-move*
1000
1001 *quote*
1002"{a-zA-Z0-9.%#:-"} Use register {a-zA-Z0-9.%#:-"} for next delete, yank
1003 or put (use uppercase character to append with
1004 delete and yank) ({.%#:} only work with put).
1005
1006 *:reg* *:registers*
1007:reg[isters] Display the contents of all numbered and named
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001008 registers. If a register is written to for |:redir|
1009 it will not be listed.
1010 {not in Vi}
1011
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012
1013:reg[isters] {arg} Display the contents of the numbered and named
1014 registers that are mentioned in {arg}. For example: >
Bram Moolenaarfa735342016-01-03 22:14:44 +01001015 :reg 1a
Bram Moolenaar071d4272004-06-13 20:20:40 +00001016< to display registers '1' and 'a'. Spaces are allowed
1017 in {arg}. {not in Vi}
1018
1019 *:di* *:display*
1020:di[splay] [arg] Same as :registers. {not in Vi}
1021
1022 *y* *yank*
1023["x]y{motion} Yank {motion} text [into register x]. When no
1024 characters are to be yanked (e.g., "y0" in column 1),
1025 this is an error when 'cpoptions' includes the 'E'
1026 flag.
1027
1028 *yy*
1029["x]yy Yank [count] lines [into register x] |linewise|.
1030
1031 *Y*
1032["x]Y yank [count] lines [into register x] (synonym for
1033 yy, |linewise|). If you like "Y" to work from the
1034 cursor to the end of line (which is more logical,
1035 but not Vi-compatible) use ":map Y y$".
1036
1037 *v_y*
1038{Visual}["x]y Yank the highlighted text [into register x] (for
1039 {Visual} see |Visual-mode|). {not in Vi}
1040
1041 *v_Y*
1042{Visual}["x]Y Yank the highlighted lines [into register x] (for
1043 {Visual} see |Visual-mode|). {not in Vi}
1044
Bram Moolenaar85de2062011-05-05 14:26:41 +02001045 *:y* *:yank* *E850*
1046:[range]y[ank] [x] Yank [range] lines [into register x]. Yanking to the
Bram Moolenaar446beb42011-05-10 17:18:44 +02001047 "* or "+ registers is possible only when the
1048 |+clipboard| feature is included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001049
1050:[range]y[ank] [x] {count}
1051 Yank {count} lines, starting with last line number
1052 in [range] (default: current line |cmdline-ranges|),
1053 [into register x].
1054
1055 *p* *put* *E353*
1056["x]p Put the text [from register x] after the cursor
1057 [count] times. {Vi: no count}
1058
1059 *P*
1060["x]P Put the text [from register x] before the cursor
1061 [count] times. {Vi: no count}
1062
1063 *<MiddleMouse>*
1064["x]<MiddleMouse> Put the text from a register before the cursor [count]
1065 times. Uses the "* register, unless another is
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001066 specified.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001067 Leaves the cursor at the end of the new text.
1068 Using the mouse only works when 'mouse' contains 'n'
1069 or 'a'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001070 {not in Vi}
1071 If you have a scrollwheel and often accidentally paste
1072 text, you can use these mappings to disable the
1073 pasting with the middle mouse button: >
1074 :map <MiddleMouse> <Nop>
1075 :imap <MiddleMouse> <Nop>
1076< You might want to disable the multi-click versions
1077 too, see |double-click|.
1078
1079 *gp*
1080["x]gp Just like "p", but leave the cursor just after the new
1081 text. {not in Vi}
1082
1083 *gP*
1084["x]gP Just like "P", but leave the cursor just after the new
1085 text. {not in Vi}
1086
1087 *:pu* *:put*
1088:[line]pu[t] [x] Put the text [from register x] after [line] (default
1089 current line). This always works |linewise|, thus
1090 this command can be used to put a yanked block as new
1091 lines.
Bram Moolenaard38b0552012-04-25 19:07:41 +02001092 If no register is specified, it depends on the 'cb'
1093 option: If 'cb' contains "unnamedplus", paste from the
1094 + register |quoteplus|. Otherwise, if 'cb' contains
Bram Moolenaarddbb5552012-04-26 20:17:03 +02001095 "unnamed", paste from the * register |quotestar|.
Bram Moolenaard38b0552012-04-25 19:07:41 +02001096 Otherwise, paste from the unnamed register
1097 |quote_quote|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001098 The register can also be '=' followed by an optional
1099 expression. The expression continues until the end of
1100 the command. You need to escape the '|' and '"'
1101 characters to prevent them from terminating the
1102 command. Example: >
1103 :put ='path' . \",/test\"
1104< If there is no expression after '=', Vim uses the
1105 previous expression. You can see it with ":dis =".
1106
1107:[line]pu[t]! [x] Put the text [from register x] before [line] (default
1108 current line).
1109
1110["x]]p or *]p* *]<MiddleMouse>*
1111["x]]<MiddleMouse> Like "p", but adjust the indent to the current line.
1112 Using the mouse only works when 'mouse' contains 'n'
1113 or 'a'. {not in Vi}
1114
1115["x][P or *[P*
1116["x]]P or *]P*
1117["x][p or *[p* *[<MiddleMouse>*
1118["x][<MiddleMouse> Like "P", but adjust the indent to the current line.
1119 Using the mouse only works when 'mouse' contains 'n'
1120 or 'a'. {not in Vi}
1121
1122You can use these commands to copy text from one place to another. Do this
1123by first getting the text into a register with a yank, delete or change
1124command, then inserting the register contents with a put command. You can
1125also use these commands to move text from one file to another, because Vim
1126preserves all registers when changing buffers (the CTRL-^ command is a quick
1127way to toggle between two files).
1128
1129 *linewise-register* *characterwise-register*
1130You can repeat the put commands with "." (except for :put) and undo them. If
1131the command that was used to get the text into the register was |linewise|,
1132Vim inserts the text below ("p") or above ("P") the line where the cursor is.
1133Otherwise Vim inserts the text after ("p") or before ("P") the cursor. With
1134the ":put" command, Vim always inserts the text in the next line. You can
1135exchange two characters with the command sequence "xp". You can exchange two
1136lines with the command sequence "ddp". You can exchange two words with the
1137command sequence "deep" (start with the cursor in the blank space before the
1138first word). You can use the "']" or "`]" command after the put command to
1139move the cursor to the end of the inserted text, or use "'[" or "`[" to move
1140the cursor to the start.
1141
1142 *put-Visual-mode* *v_p* *v_P*
1143When using a put command like |p| or |P| in Visual mode, Vim will try to
1144replace the selected text with the contents of the register. Whether this
1145works well depends on the type of selection and the type of the text in the
1146register. With blockwise selection it also depends on the size of the block
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001147and whether the corners are on an existing character. (Implementation detail:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001148it actually works by first putting the register after the selection and then
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001149deleting the selection.)
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001150The previously selected text is put in the unnamed register. If you want to
1151put the same text into a Visual selection several times you need to use
1152another register. E.g., yank the text to copy, Visually select the text to
1153replace and use "0p . You can repeat this as many times as you like, the
1154unnamed register will be changed each time.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001155
Bram Moolenaarec11aef2013-09-22 15:23:44 +02001156When you use a blockwise Visual mode command and yank only a single line into
1157a register, a paste on a visual selected area will paste that single line on
1158each of the selected lines (thus replacing the blockwise selected region by a
1159block of the pasted line).
1160
Bram Moolenaar071d4272004-06-13 20:20:40 +00001161 *blockwise-register*
1162If you use a blockwise Visual mode command to get the text into the register,
1163the block of text will be inserted before ("P") or after ("p") the cursor
1164column in the current and next lines. Vim makes the whole block of text start
1165in the same column. Thus the inserted text looks the same as when it was
1166yanked or deleted. Vim may replace some <Tab> characters with spaces to make
1167this happen. However, if the width of the block is not a multiple of a <Tab>
1168width and the text after the inserted block contains <Tab>s, that text may be
1169misaligned.
1170
1171Note that after a characterwise yank command, Vim leaves the cursor on the
1172first yanked character that is closest to the start of the buffer. This means
1173that "yl" doesn't move the cursor, but "yh" moves the cursor one character
1174left.
1175Rationale: In Vi the "y" command followed by a backwards motion would
1176 sometimes not move the cursor to the first yanked character,
1177 because redisplaying was skipped. In Vim it always moves to
1178 the first character, as specified by Posix.
1179With a linewise yank command the cursor is put in the first line, but the
1180column is unmodified, thus it may not be on the first yanked character.
1181
Bram Moolenaar12969c02015-09-08 23:36:10 +02001182There are ten types of registers: *registers* *E354*
Bram Moolenaar071d4272004-06-13 20:20:40 +000011831. The unnamed register ""
11842. 10 numbered registers "0 to "9
11853. The small delete register "-
11864. 26 named registers "a to "z or "A to "Z
Bram Moolenaar3b3a9492015-01-27 18:44:16 +010011875. three read-only registers ":, "., "%
Bram Moolenaar0122c402015-02-03 19:13:34 +010011886. alternate buffer register "#
Bram Moolenaar3b3a9492015-01-27 18:44:16 +010011897. the expression register "=
11908. The selection and drop registers "*, "+ and "~
11919. The black hole register "_
119210. Last search pattern register "/
Bram Moolenaar071d4272004-06-13 20:20:40 +00001193
11941. Unnamed register "" *quote_quote* *quotequote*
1195Vim fills this register with text deleted with the "d", "c", "s", "x" commands
1196or copied with the yank "y" command, regardless of whether or not a specific
Bram Moolenaared203462004-06-16 11:19:22 +00001197register was used (e.g. "xdd). This is like the unnamed register is pointing
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001198to the last used register. Thus when appending using an uppercase register
1199name, the unnamed register contains the same text as the named register.
1200An exception is the '_' register: "_dd does not store the deleted text in any
1201register.
Bram Moolenaar81695252004-12-29 20:58:21 +00001202Vim uses the contents of the unnamed register for any put command (p or P)
1203which does not specify a register. Additionally you can access it with the
1204name '"'. This means you have to type two double quotes. Writing to the ""
1205register writes to register "0.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001206{Vi: register contents are lost when changing files, no '"'}
1207
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +020012082. Numbered registers "0 to "9 *quote_number* *quote0* *quote1*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001209 *quote2* *quote3* *quote4* *quote9*
1210Vim fills these registers with text from yank and delete commands.
1211 Numbered register 0 contains the text from the most recent yank command,
1212unless the command specified another register with ["x].
1213 Numbered register 1 contains the text deleted by the most recent delete or
1214change command, unless the command specified another register or the text is
1215less than one line (the small delete register is used then). An exception is
Bram Moolenaar81695252004-12-29 20:58:21 +00001216made for the delete operator with these movement commands: |%|, |(|, |)|, |`|,
1217|/|, |?|, |n|, |N|, |{| and |}|. Register "1 is always used then (this is Vi
1218compatible). The "- register is used as well if the delete is within a line.
Bram Moolenaarbaca7f72013-09-22 14:42:24 +02001219Note that these characters may be mapped. E.g. |%| is mapped by the matchit
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02001220plugin.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001221 With each successive deletion or change, Vim shifts the previous contents
1222of register 1 into register 2, 2 into 3, and so forth, losing the previous
1223contents of register 9.
1224{Vi: numbered register contents are lost when changing files; register 0 does
1225not exist}
1226
12273. Small delete register "- *quote_-* *quote-*
1228This register contains text from commands that delete less than one line,
1229except when the command specifies a register with ["x].
1230{not in Vi}
1231
12324. Named registers "a to "z or "A to "Z *quote_alpha* *quotea*
1233Vim fills these registers only when you say so. Specify them as lowercase
1234letters to replace their previous contents or as uppercase letters to append
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001235to their previous contents. When the '>' flag is present in 'cpoptions' then
1236a line break is inserted before the appended text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001237
Bram Moolenaar3b3a9492015-01-27 18:44:16 +010012385. Read-only registers ":, ". and "%
Bram Moolenaar071d4272004-06-13 20:20:40 +00001239These are '%', '#', ':' and '.'. You can use them only with the "p", "P",
1240and ":put" commands and with CTRL-R. {not in Vi}
1241 *quote_.* *quote.* *E29*
1242 ". Contains the last inserted text (the same as what is inserted
1243 with the insert mode commands CTRL-A and CTRL-@). Note: this
1244 doesn't work with CTRL-R on the command-line. It works a bit
1245 differently, like inserting the text instead of putting it
1246 ('textwidth' and other options affect what is inserted).
1247 *quote_%* *quote%*
1248 "% Contains the name of the current file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001249 *quote_:* *quote:* *E30*
1250 ": Contains the most recent executed command-line. Example: Use
1251 "@:" to repeat the previous command-line command.
1252 The command-line is only stored in this register when at least
1253 one character of it was typed. Thus it remains unchanged if
1254 the command was completely from a mapping.
1255 {not available when compiled without the |+cmdline_hist|
1256 feature}
Bram Moolenaar3b3a9492015-01-27 18:44:16 +01001257 *quote_#* *quote#*
12586. Alternate file register "#
1259Contains the name of the alternate file for the current window. It will
1260change how the |CTRL-^| command works.
1261This register is writable, mainly to allow for restoring it after a plugin has
1262changed it. It accepts buffer number: >
1263 let altbuf = bufnr(@#)
1264 ...
1265 let @# = altbuf
1266It will give error |E86| if you pass buffer number and this buffer does not
1267exist.
1268It can also accept a match with an existing buffer name: >
1269 let @# = 'buffer_name'
1270Error |E93| if there is more than one buffer matching the given name or |E94|
1271if none of buffers matches the given name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001272
Bram Moolenaar3b3a9492015-01-27 18:44:16 +010012737. Expression register "= *quote_=* *quote=* *@=*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001274This is not really a register that stores text, but is a way to use an
1275expression in commands which use a register. The expression register is
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001276read-write.
1277
1278When typing the '=' after " or CTRL-R the cursor moves to the command-line,
1279where you can enter any expression (see |expression|). All normal
1280command-line editing commands are available, including a special history for
1281expressions. When you end the command-line by typing <CR>, Vim computes the
1282result of the expression. If you end it with <Esc>, Vim abandons the
1283expression. If you do not enter an expression, Vim uses the previous
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001284expression (like with the "/" command).
1285
1286The expression must evaluate to a String. A Number is always automatically
1287converted to a String. For the "p" and ":put" command, if the result is a
1288Float it's converted into a String. If the result is a List each element is
1289turned into a String and used as a line. A Dictionary or FuncRef results in
1290an error message (use string() to convert).
1291
1292If the "= register is used for the "p" command, the String is split up at <NL>
1293characters. If the String ends in a <NL>, it is regarded as a linewise
Bram Moolenaar6bab4d12005-06-16 21:53:56 +00001294register. {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001295
Bram Moolenaar3b3a9492015-01-27 18:44:16 +010012968. Selection and drop registers "*, "+ and "~
Bram Moolenaar06b5d512010-05-22 15:37:44 +02001297Use these registers for storing and retrieving the selected text for the GUI.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001298See |quotestar| and |quoteplus|. When the clipboard is not available or not
Bram Moolenaarf4d11452005-12-02 00:46:37 +00001299working, the unnamed register is used instead. For Unix systems the clipboard
1300is only available when the |+xterm_clipboard| feature is present. {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001301
1302Note that there is only a distinction between "* and "+ for X11 systems. For
1303an explanation of the difference, see |x11-selection|. Under MS-Windows, use
1304of "* and "+ is actually synonymous and refers to the |gui-clipboard|.
1305
1306 *quote_~* *quote~* *<Drop>*
1307The read-only "~ register stores the dropped text from the last drag'n'drop
1308operation. When something has been dropped onto Vim, the "~ register is
1309filled in and the <Drop> pseudo key is sent for notification. You can remap
1310this key if you want; the default action (for all modes) is to insert the
1311contents of the "~ register at the cursor position. {not in Vi}
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001312{only available when compiled with the |+dnd| feature, currently only with the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001313GTK GUI}
1314
1315Note: The "~ register is only used when dropping plain text onto Vim.
1316Drag'n'drop of URI lists is handled internally.
1317
Bram Moolenaar3b3a9492015-01-27 18:44:16 +010013189. Black hole register "_ *quote_*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001319When writing to this register, nothing happens. This can be used to delete
1320text without affecting the normal registers. When reading from this register,
1321nothing is returned. {not in Vi}
1322
Bram Moolenaar3b3a9492015-01-27 18:44:16 +0100132310. Last search pattern register "/ *quote_/* *quote/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001324Contains the most recent search-pattern. This is used for "n" and 'hlsearch'.
Bram Moolenaard38b0552012-04-25 19:07:41 +02001325It is writable with `:let`, you can change it to have 'hlsearch' highlight
Bram Moolenaar071d4272004-06-13 20:20:40 +00001326other matches without actually searching. You can't yank or delete into this
Bram Moolenaar446cb832008-06-24 21:56:24 +00001327register. The search direction is available in |v:searchforward|.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001328Note that the value is restored when returning from a function
Bram Moolenaar446cb832008-06-24 21:56:24 +00001329|function-search-undo|.
1330{not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001331
1332 *@/*
Bram Moolenaard38b0552012-04-25 19:07:41 +02001333You can write to a register with a `:let` command |:let-@|. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001334 :let @/ = "the"
1335
1336If you use a put command without specifying a register, Vim uses the register
1337that was last filled (this is also the contents of the unnamed register). If
Bram Moolenaard38b0552012-04-25 19:07:41 +02001338you are confused, use the `:dis` command to find out what Vim will put (this
Bram Moolenaar071d4272004-06-13 20:20:40 +00001339command displays all named and numbered registers; the unnamed register is
1340labelled '"').
1341
1342The next three commands always work on whole lines.
1343
1344:[range]co[py] {address} *:co* *:copy*
1345 Copy the lines given by [range] to below the line
1346 given by {address}.
1347
1348 *:t*
1349:t Synonym for copy.
1350
1351:[range]m[ove] {address} *:m* *:mo* *:move* *E134*
1352 Move the lines given by [range] to below the line
1353 given by {address}.
1354
1355==============================================================================
13566. Formatting text *formatting*
1357
1358:[range]ce[nter] [width] *:ce* *:center*
1359 Center lines in [range] between [width] columns
1360 (default 'textwidth' or 80 when 'textwidth' is 0).
1361 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001362
1363:[range]ri[ght] [width] *:ri* *:right*
1364 Right-align lines in [range] at [width] columns
1365 (default 'textwidth' or 80 when 'textwidth' is 0).
1366 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001367
1368 *:le* *:left*
1369:[range]le[ft] [indent]
1370 Left-align lines in [range]. Sets the indent in the
1371 lines to [indent] (default 0). {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001372
1373 *gq*
Bram Moolenaar4317d9b2005-03-18 20:25:31 +00001374gq{motion} Format the lines that {motion} moves over.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001375 Formatting is done with one of three methods:
1376 1. If 'formatexpr' is not empty the expression is
1377 evaluated. This can differ for each buffer.
Bram Moolenaar4c7ed462006-02-15 22:18:42 +00001378 2. If 'formatprg' is not empty an external program
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001379 is used.
Bram Moolenaar551dbcc2006-04-25 22:13:59 +00001380 3. Otherwise formatting is done internally.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001381
1382 In the third case the 'textwidth' option controls the
1383 length of each formatted line (see below).
Bram Moolenaar4317d9b2005-03-18 20:25:31 +00001384 If the 'textwidth' option is 0, the formatted line
1385 length is the screen width (with a maximum width of
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001386 79).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001387 The 'formatoptions' option controls the type of
1388 formatting |fo-table|.
Bram Moolenaar4317d9b2005-03-18 20:25:31 +00001389 The cursor is left on the first non-blank of the last
1390 formatted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001391 NOTE: The "Q" command formerly performed this
1392 function. If you still want to use "Q" for
1393 formatting, use this mapping: >
1394 :nnoremap Q gq
1395
1396gqgq *gqgq* *gqq*
Bram Moolenaar40af4e32010-07-29 22:33:18 +02001397gqq Format the current line. With a count format that
1398 many lines. {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001399
1400 *v_gq*
1401{Visual}gq Format the highlighted text. (for {Visual} see
1402 |Visual-mode|). {not in Vi}
1403
1404 *gw*
1405gw{motion} Format the lines that {motion} moves over. Similar to
1406 |gq| but puts the cursor back at the same position in
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001407 the text. However, 'formatprg' and 'formatexpr' are
1408 not used. {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001409
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001410gwgw *gwgw* *gww*
1411gww Format the current line as with "gw". {not in Vi}
1412
1413 *v_gw*
1414{Visual}gw Format the highlighted text as with "gw". (for
1415 {Visual} see |Visual-mode|). {not in Vi}
1416
Bram Moolenaar071d4272004-06-13 20:20:40 +00001417Example: To format the current paragraph use: *gqap* >
1418 gqap
1419
1420The "gq" command leaves the cursor in the line where the motion command takes
1421the cursor. This allows you to repeat formatting repeated with ".". This
1422works well with "gqj" (format current and next line) and "gq}" (format until
1423end of paragraph). Note: When 'formatprg' is set, "gq" leaves the cursor on
1424the first formatted line (as with using a filter command).
1425
1426If you want to format the current paragraph and continue where you were, use: >
1427 gwap
1428If you always want to keep paragraphs formatted you may want to add the 'a'
1429flag to 'formatoptions'. See |auto-format|.
1430
1431If the 'autoindent' option is on, Vim uses the indent of the first line for
1432the following lines.
1433
1434Formatting does not change empty lines (but it does change lines with only
1435white space!).
1436
1437The 'joinspaces' option is used when lines are joined together.
1438
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001439You can set the 'formatexpr' option to an expression or the 'formatprg' option
1440to the name of an external program for Vim to use for text formatting. The
1441'textwidth' and other options have no effect on formatting by an external
1442program.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001443
1444 *right-justify*
1445There is no command in Vim to right justify text. You can do it with
1446an external command, like "par" (e.g.: "!}par" to format until the end of the
1447paragraph) or set 'formatprg' to "par".
1448
1449 *format-comments*
Bram Moolenaar446cb832008-06-24 21:56:24 +00001450An overview of comment formatting is in section |30.6| of the user manual.
1451
1452Vim can automatically insert and format comments in a special way. Vim
1453recognizes a comment by a specific string at the start of the line (ignoring
1454white space). Three types of comments can be used:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001455
1456- A comment string that repeats at the start of each line. An example is the
1457 type of comment used in shell scripts, starting with "#".
1458- A comment string that occurs only in the first line, not in the following
1459 lines. An example is this list with dashes.
1460- Three-piece comments that have a start string, an end string, and optional
1461 lines in between. The strings for the start, middle and end are different.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001462 An example is the C style comment:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001463 /*
1464 * this is a C comment
1465 */
1466
1467The 'comments' option is a comma-separated list of parts. Each part defines a
1468type of comment string. A part consists of:
1469 {flags}:{string}
1470
1471{string} is the literal text that must appear.
1472
1473{flags}:
1474 n Nested comment. Nesting with mixed parts is allowed. If 'comments'
1475 is "n:),n:>" a line starting with "> ) >" is a comment.
1476
1477 b Blank (<Space>, <Tab> or <EOL>) required after {string}.
1478
1479 f Only the first line has the comment string. Do not repeat comment on
1480 the next line, but preserve indentation (e.g., a bullet-list).
1481
1482 s Start of three-piece comment
1483
1484 m Middle of a three-piece comment
1485
1486 e End of a three-piece comment
1487
Bram Moolenaar446cb832008-06-24 21:56:24 +00001488 l Left align. Used together with 's' or 'e', the leftmost character of
1489 start or end will line up with the leftmost character from the middle.
1490 This is the default and can be omitted. See below for more details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001491
Bram Moolenaar446cb832008-06-24 21:56:24 +00001492 r Right align. Same as above but rightmost instead of leftmost. See
1493 below for more details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001494
Bram Moolenaar446cb832008-06-24 21:56:24 +00001495 O Don't consider this comment for the "O" command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001496
1497 x Allows three-piece comments to be ended by just typing the last
Bram Moolenaar446cb832008-06-24 21:56:24 +00001498 character of the end-comment string as the first action on a new
1499 line when the middle-comment string has been inserted automatically.
1500 See below for more details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001501
1502 {digits}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001503 When together with 's' or 'e': add {digit} amount of offset to an
1504 automatically inserted middle or end comment leader. The offset begins
1505 from a left alignment. See below for more details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001506
1507 -{digits}
1508 Like {digits} but reduce the indent. This only works when there is
1509 some indent for the start or end part that can be removed.
1510
1511When a string has none of the 'f', 's', 'm' or 'e' flags, Vim assumes the
1512comment string repeats at the start of each line. The flags field may be
1513empty.
1514
1515Any blank space in the text before and after the {string} is part of the
1516{string}, so do not include leading or trailing blanks unless the blanks are a
1517required part of the comment string.
1518
1519When one comment leader is part of another, specify the part after the whole.
1520For example, to include both "-" and "->", use >
1521 :set comments=f:->,f:-
1522
1523A three-piece comment must always be given as start,middle,end, with no other
1524parts in between. An example of a three-piece comment is >
1525 sr:/*,mb:*,ex:*/
1526for C-comments. To avoid recognizing "*ptr" as a comment, the middle string
1527includes the 'b' flag. For three-piece comments, Vim checks the text after
1528the start and middle strings for the end string. If Vim finds the end string,
1529the comment does not continue on the next line. Three-piece comments must
1530have a middle string because otherwise Vim can't recognize the middle lines.
1531
1532Notice the use of the "x" flag in the above three-piece comment definition.
1533When you hit Return in a C-comment, Vim will insert the middle comment leader
Bram Moolenaar446cb832008-06-24 21:56:24 +00001534for the new line: " * ". To close this comment you just have to type "/"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001535before typing anything else on the new line. This will replace the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001536middle-comment leader with the end-comment leader and apply any specified
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001537alignment, leaving just " */". There is no need to hit Backspace first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001538
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001539When there is a match with a middle part, but there also is a matching end
1540part which is longer, the end part is used. This makes a C style comment work
Bram Moolenaar446beb42011-05-10 17:18:44 +02001541without requiring the middle part to end with a space.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001542
1543Here is an example of alignment flags at work to make a comment stand out
Bram Moolenaar446beb42011-05-10 17:18:44 +02001544(kind of looks like a 1 too). Consider comment string: >
1545 :set comments=sr:/***,m:**,ex-2:******/
1546<
1547 /*** ~
1548 **<--right aligned from "r" flag ~
1549 ** ~
1550offset 2 spaces for the "-2" flag--->** ~
1551 ******/ ~
Bram Moolenaar446cb832008-06-24 21:56:24 +00001552In this case, the first comment was typed, then return was pressed 4 times,
1553then "/" was pressed to end the comment.
1554
1555Here are some finer points of three part comments. There are three times when
1556alignment and offset flags are taken into consideration: opening a new line
1557after a start-comment, opening a new line before an end-comment, and
1558automatically ending a three-piece comment. The end alignment flag has a
1559backwards perspective; the result is that the same alignment flag used with
1560"s" and "e" will result in the same indent for the starting and ending pieces.
1561Only one alignment per comment part is meant to be used, but an offset number
1562will override the "r" and "l" flag.
1563
1564Enabling 'cindent' will override the alignment flags in many cases.
1565Reindenting using a different method like |gq| or |=| will not consult
1566alignment flags either. The same behaviour can be defined in those other
1567formatting options. One consideration is that 'cindent' has additional options
1568for context based indenting of comments but cannot replicate many three piece
Bram Moolenaar446beb42011-05-10 17:18:44 +02001569indent alignments. However, 'indentexpr' has the ability to work better with
1570three piece comments.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001571
1572Other examples: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001573 "b:*" Includes lines starting with "*", but not if the "*" is
1574 followed by a non-blank. This avoids a pointer dereference
1575 like "*str" to be recognized as a comment.
1576 "n:>" Includes a line starting with ">", ">>", ">>>", etc.
1577 "fb:-" Format a list that starts with "- ".
1578
1579By default, "b:#" is included. This means that a line that starts with
1580"#include" is not recognized as a comment line. But a line that starts with
1581"# define" is recognized. This is a compromise.
1582
Bram Moolenaar071d4272004-06-13 20:20:40 +00001583{not available when compiled without the |+comments| feature}
1584
1585 *fo-table*
1586You can use the 'formatoptions' option to influence how Vim formats text.
1587'formatoptions' is a string that can contain any of the letters below. The
1588default setting is "tcq". You can separate the option letters with commas for
1589readability.
1590
1591letter meaning when present in 'formatoptions' ~
1592
Bram Moolenaar9964e462007-05-05 17:54:07 +00001593t Auto-wrap text using textwidth
Bram Moolenaar071d4272004-06-13 20:20:40 +00001594c Auto-wrap comments using textwidth, inserting the current comment
1595 leader automatically.
1596r Automatically insert the current comment leader after hitting
1597 <Enter> in Insert mode.
1598o Automatically insert the current comment leader after hitting 'o' or
1599 'O' in Normal mode.
1600q Allow formatting of comments with "gq".
1601 Note that formatting will not change blank lines or lines containing
1602 only the comment leader. A new paragraph starts after such a line,
1603 or when the comment leader changes.
1604w Trailing white space indicates a paragraph continues in the next line.
1605 A line that ends in a non-white character ends a paragraph.
1606a Automatic formatting of paragraphs. Every time text is inserted or
1607 deleted the paragraph will be reformatted. See |auto-format|.
1608 When the 'c' flag is present this only happens for recognized
1609 comments.
Bram Moolenaar86b68352004-12-27 21:59:20 +00001610n When formatting text, recognize numbered lists. This actually uses
1611 the 'formatlistpat' option, thus any kind of list can be used. The
1612 indent of the text after the number is used for the next line. The
Bram Moolenaar446cb832008-06-24 21:56:24 +00001613 default is to find a number, optionally followed by '.', ':', ')',
Bram Moolenaar86b68352004-12-27 21:59:20 +00001614 ']' or '}'. Note that 'autoindent' must be set too. Doesn't work
1615 well together with "2".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001616 Example: >
1617 1. the first item
1618 wraps
1619 2. the second item
16202 When formatting text, use the indent of the second line of a paragraph
1621 for the rest of the paragraph, instead of the indent of the first
1622 line. This supports paragraphs in which the first line has a
1623 different indent than the rest. Note that 'autoindent' must be set
1624 too. Example: >
1625 first line of a paragraph
1626 second line of the same paragraph
1627 third line.
Bram Moolenaar30b65812012-07-12 22:01:11 +02001628< This also works inside comments, ignoring the comment leader.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001629v Vi-compatible auto-wrapping in insert mode: Only break a line at a
1630 blank that you have entered during the current insert command. (Note:
1631 this is not 100% Vi compatible. Vi has some "unexpected features" or
1632 bugs in this area. It uses the screen column instead of the line
1633 column.)
1634b Like 'v', but only auto-wrap if you enter a blank at or before
1635 the wrap margin. If the line was longer than 'textwidth' when you
1636 started the insert, or you do not enter a blank in the insert before
1637 reaching 'textwidth', Vim does not perform auto-wrapping.
1638l Long lines are not broken in insert mode: When a line was longer than
1639 'textwidth' when the insert command started, Vim does not
1640 automatically format it.
1641m Also break at a multi-byte character above 255. This is useful for
1642 Asian text where every character is a word on its own.
1643M When joining lines, don't insert a space before or after a multi-byte
1644 character. Overrules the 'B' flag.
1645B When joining lines, don't insert a space between two multi-byte
1646 characters. Overruled by the 'M' flag.
16471 Don't break a line after a one-letter word. It's broken before it
1648 instead (if possible).
Bram Moolenaar81340392012-06-06 16:12:59 +02001649j Where it makes sense, remove a comment leader when joining lines. For
1650 example, joining:
1651 int i; // the index ~
1652 // in the list ~
1653 Becomes:
1654 int i; // the index in the list ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00001655
1656
1657With 't' and 'c' you can specify when Vim performs auto-wrapping:
1658value action ~
1659"" no automatic formatting (you can use "gq" for manual formatting)
1660"t" automatic formatting of text, but not comments
1661"c" automatic formatting for comments, but not text (good for C code)
1662"tc" automatic formatting for text and comments
1663
Bram Moolenaar91170f82006-05-05 21:15:17 +00001664Note that when 'textwidth' is 0, Vim does no automatic formatting anyway (but
1665does insert comment leaders according to the 'comments' option). An exception
1666is when the 'a' flag is present. |auto-format|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001667
1668Note that when 'paste' is on, Vim does no formatting at all.
1669
1670Note that 'textwidth' can be non-zero even if Vim never performs auto-wrapping;
1671'textwidth' is still useful for formatting with "gq".
1672
1673If the 'comments' option includes "/*", "*" and/or "*/", then Vim has some
1674built in stuff to treat these types of comments a bit more cleverly.
1675Opening a new line before or after "/*" or "*/" (with 'r' or 'o' present in
1676'formatoptions') gives the correct start of the line automatically. The same
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001677happens with formatting and auto-wrapping. Opening a line after a line
Bram Moolenaar071d4272004-06-13 20:20:40 +00001678starting with "/*" or "*" and containing "*/", will cause no comment leader to
1679be inserted, and the indent of the new line is taken from the line containing
1680the start of the comment.
1681E.g.:
1682 /* ~
1683 * Your typical comment. ~
1684 */ ~
1685 The indent on this line is the same as the start of the above
1686 comment.
1687
1688All of this should be really cool, especially in conjunction with the new
1689:autocmd command to prepare different settings for different types of file.
1690
1691Some examples:
1692 for C code (only format comments): >
1693 :set fo=croq
1694< for Mail/news (format all, don't start comment with "o" command): >
1695 :set fo=tcrq
1696<
1697
Bram Moolenaard38b0552012-04-25 19:07:41 +02001698Automatic formatting *auto-format* *autoformat*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001699
1700When the 'a' flag is present in 'formatoptions' text is formatted
1701automatically when inserting text or deleting text. This works nice for
1702editing text paragraphs. A few hints on how to use this:
1703
1704- You need to properly define paragraphs. The simplest is paragraphs that are
1705 separated by a blank line. When there is no separating blank line, consider
1706 using the 'w' flag and adding a space at the end of each line in the
1707 paragraphs except the last one.
1708
1709- You can set the 'formatoptions' based on the type of file |filetype| or
1710 specifically for one file with a |modeline|.
1711
1712- Set 'formatoptions' to "aw2tq" to make text with indents like this:
1713
1714 bla bla foobar bla
1715 bla foobar bla foobar bla
1716 bla bla foobar bla
1717 bla foobar bla bla foobar
1718
1719- Add the 'c' flag to only auto-format comments. Useful in source code.
1720
Bram Moolenaar91170f82006-05-05 21:15:17 +00001721- Set 'textwidth' to the desired width. If it is zero then 79 is used, or the
1722 width of the screen if this is smaller.
1723
Bram Moolenaar071d4272004-06-13 20:20:40 +00001724And a few warnings:
1725
1726- When part of the text is not properly separated in paragraphs, making
1727 changes in this text will cause it to be formatted anyway. Consider doing >
1728
1729 :set fo-=a
1730
1731- When using the 'w' flag (trailing space means paragraph continues) and
1732 deleting the last line of a paragraph with |dd|, the paragraph will be
1733 joined with the next one.
1734
1735- Changed text is saved for undo. Formatting is also a change. Thus each
1736 format action saves text for undo. This may consume quite a lot of memory.
1737
1738- Formatting a long paragraph and/or with complicated indenting may be slow.
1739
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00001740==============================================================================
17417. Sorting text *sorting*
1742
1743Vim has a sorting function and a sorting command. The sorting function can be
Bram Moolenaar327aa022014-03-25 18:24:23 +01001744found here: |sort()|, |uniq()|.
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00001745
1746 *:sor* *:sort*
Bram Moolenaarf7edf402016-01-19 23:36:15 +01001747:[range]sor[t][!] [b][f][i][n][o][r][u][x] [/{pattern}/]
Bram Moolenaare5180522005-12-10 20:19:46 +00001748 Sort lines in [range]. When no range is given all
1749 lines are sorted.
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00001750
1751 With [!] the order is reversed.
1752
1753 With [i] case is ignored.
1754
Bram Moolenaarf7edf402016-01-19 23:36:15 +01001755 Options [n][f][x][o][b] are mutually exclusive.
1756
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001757 With [n] sorting is done on the first decimal number
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00001758 in the line (after or inside a {pattern} match).
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001759 One leading '-' is included in the number.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001760
Bram Moolenaarf7edf402016-01-19 23:36:15 +01001761 With [f] sorting is done on the Float in the line.
1762 The value of Float is determined similar to passing
1763 the text (after or inside a {pattern} match) to
1764 str2float() function. This option is available only
1765 if Vim was compiled with Floating point support.
1766
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001767 With [x] sorting is done on the first hexadecimal
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00001768 number in the line (after or inside a {pattern}
1769 match). A leading "0x" or "0X" is ignored.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001770 One leading '-' is included in the number.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001771
1772 With [o] sorting is done on the first octal number in
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00001773 the line (after or inside a {pattern} match).
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001774
Bram Moolenaar887c1fe2016-01-02 17:56:35 +01001775 With [b] sorting is done on the first binary number in
1776 the line (after or inside a {pattern} match).
1777
Bram Moolenaarf7edf402016-01-19 23:36:15 +01001778 With [u] (u stands for unique) only keep the first of
1779 a sequence of identical lines (ignoring case when [i]
1780 is used). Without this flag, a sequence of identical
1781 lines will be kept in their original order.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001782 Note that leading and trailing white space may cause
1783 lines to be different.
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00001784
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00001785 When /{pattern}/ is specified and there is no [r] flag
1786 the text matched with {pattern} is skipped, so that
1787 you sort on what comes after the match.
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00001788 Instead of the slash any non-letter can be used.
1789 For example, to sort on the second comma-separated
1790 field: >
1791 :sort /[^,]*,/
1792< To sort on the text at virtual column 10 (thus
1793 ignoring the difference between tabs and spaces): >
1794 :sort /.*\%10v/
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001795< To sort on the first number in the line, no matter
1796 what is in front of it: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00001797 :sort /.\{-}\ze\d/
1798< (Explanation: ".\{-}" matches any text, "\ze" sets the
1799 end of the match and \d matches a digit.)
1800 With [r] sorting is done on the matching {pattern}
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00001801 instead of skipping past it as described above.
1802 For example, to sort on only the first three letters
1803 of each line: >
1804 :sort /\a\a\a/ r
1805
1806< If a {pattern} is used, any lines which don't have a
1807 match for {pattern} are kept in their current order,
1808 but separate from the lines which do match {pattern}.
1809 If you sorted in reverse, they will be in reverse
1810 order after the sorted lines, otherwise they will be
1811 in their original order, right before the sorted
1812 lines.
1813
Bram Moolenaar1256e722007-07-10 15:26:20 +00001814 If {pattern} is empty (e.g. // is specified), the
1815 last search pattern is used. This allows trying out
1816 a pattern first.
1817
Bram Moolenaard38b0552012-04-25 19:07:41 +02001818Note that using `:sort` with `:global` doesn't sort the matching lines, it's
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001819quite useless.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001820
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00001821The details about sorting depend on the library function used. There is no
Bram Moolenaar8bb1c3e2014-07-04 16:43:17 +02001822guarantee that sorting obeys the current locale. You will have to try it out.
1823Vim does do a "stable" sort.
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00001824
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00001825The sorting can be interrupted, but if you interrupt it too late in the
1826process you may end up with duplicated lines. This also depends on the system
1827library function used.
Bram Moolenaarae5bce12005-08-15 21:41:48 +00001828
Bram Moolenaar071d4272004-06-13 20:20:40 +00001829 vim:tw=78:ts=8:ft=help:norl: