blob: 3f2f490df2c17546b8d60b2f8135b923941ab033 [file] [log] [blame]
Bram Moolenaar38a55632016-02-15 22:07:32 +01001*change.txt* For Vim version 7.4. Last change: 2016 Feb 10
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
112 below).
113
114 *v_J*
115{Visual}J Join the highlighted lines, with a minimum of two
116 lines. Remove the indent and insert up to two spaces
117 (see below). {not in Vi}
118
119 *gJ*
120gJ Join [count] lines, with a minimum of two lines.
121 Don't insert or remove any spaces. {not in Vi}
122
123 *v_gJ*
124{Visual}gJ Join the highlighted lines, with a minimum of two
125 lines. Don't insert or remove any spaces. {not in
126 Vi}
127
128 *:j* *:join*
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000129:[range]j[oin][!] [flags]
130 Join [range] lines. Same as "J", except with [!]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000131 the join does not insert or delete any spaces.
132 If a [range] has equal start and end values, this
133 command does nothing. The default behavior is to
134 join the current line with the line below it.
135 {not in Vi: !}
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000136 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000137
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000138:[range]j[oin][!] {count} [flags]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000139 Join {count} lines, starting with [range] (default:
140 current line |cmdline-ranges|). Same as "J", except
141 with [!] the join does not insert or delete any
142 spaces.
143 {not in Vi: !}
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000144 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000145
146These commands delete the <EOL> between lines. This has the effect of joining
Bram Moolenaard38b0552012-04-25 19:07:41 +0200147multiple lines into one line. You can repeat these commands (except `:j`) and
Bram Moolenaar071d4272004-06-13 20:20:40 +0000148undo them.
149
150These commands, except "gJ", insert one space in place of the <EOL> unless
151there is trailing white space or the next line starts with a ')'. These
152commands, except "gJ", delete any leading white space on the next line. If
153the 'joinspaces' option is on, these commands insert two spaces after a '.',
154'!' or '?' (but if 'cpoptions' includes the 'j' flag, they insert two spaces
155only after a '.').
156The 'B' and 'M' flags in 'formatoptions' change the behavior for inserting
157spaces before and after a multi-byte character |fo-table|.
158
Bram Moolenaar251835e2014-02-24 02:51:51 +0100159The '[ mark is set at the end of the first line that was joined, '] at the end
160of the resulting line.
161
Bram Moolenaar071d4272004-06-13 20:20:40 +0000162
163==============================================================================
1642. Delete and insert *delete-insert* *replacing*
165
166 *R*
167R Enter Replace mode: Each character you type replaces
168 an existing character, starting with the character
169 under the cursor. Repeat the entered text [count]-1
170 times. See |Replace-mode| for more details.
171
172 *gR*
173gR Enter Virtual Replace mode: Each character you type
174 replaces existing characters in screen space. So a
175 <Tab> may replace several characters at once.
176 Repeat the entered text [count]-1 times. See
177 |Virtual-Replace-mode| for more details.
Bram Moolenaardb84e452010-08-15 13:50:43 +0200178 {not available when compiled without the |+vreplace|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000179 feature}
180
181 *c*
182["x]c{motion} Delete {motion} text [into register x] and start
183 insert. When 'cpoptions' includes the 'E' flag and
184 there is no text to delete (e.g., with "cTx" when the
185 cursor is just after an 'x'), an error occurs and
186 insert mode does not start (this is Vi compatible).
187 When 'cpoptions' does not include the 'E' flag, the
188 "c" command always starts insert mode, even if there
189 is no text to delete.
190
191 *cc*
192["x]cc Delete [count] lines [into register x] and start
193 insert |linewise|. If 'autoindent' is on, preserve
194 the indent of the first line.
195
196 *C*
197["x]C Delete from the cursor position to the end of the
198 line and [count]-1 more lines [into register x], and
199 start insert. Synonym for c$ (not |linewise|).
200
201 *s*
202["x]s Delete [count] characters [into register x] and start
203 insert (s stands for Substitute). Synonym for "cl"
204 (not |linewise|).
205
206 *S*
207["x]S Delete [count] lines [into register x] and start
208 insert. Synonym for "cc" |linewise|.
209
210{Visual}["x]c or *v_c* *v_s*
211{Visual}["x]s Delete the highlighted text [into register x] and
212 start insert (for {Visual} see |Visual-mode|). {not
213 in Vi}
214
215 *v_r*
216{Visual}["x]r{char} Replace all selected characters by {char}.
217
218 *v_C*
219{Visual}["x]C Delete the highlighted lines [into register x] and
220 start insert. In Visual block mode it works
221 differently |v_b_C|. {not in Vi}
222 *v_S*
223{Visual}["x]S Delete the highlighted lines [into register x] and
224 start insert (for {Visual} see |Visual-mode|). {not
225 in Vi}
226 *v_R*
227{Visual}["x]R Currently just like {Visual}["x]S. In a next version
228 it might work differently. {not in Vi}
229
230Notes:
231- You can end Insert and Replace mode with <Esc>.
232- See the section "Insert and Replace mode" |mode-ins-repl| for the other
233 special characters in these modes.
234- The effect of [count] takes place after Vim exits Insert or Replace mode.
235- When the 'cpoptions' option contains '$' and the change is within one line,
236 Vim continues to show the text to be deleted and puts a '$' at the last
237 deleted character.
238
239See |registers| for an explanation of registers.
240
241Replace mode is just like Insert mode, except that every character you enter
242deletes one character. If you reach the end of a line, Vim appends any
243further characters (just like Insert mode). In Replace mode, the backspace
244key restores the original text (if there was any). (See section "Insert and
245Replace mode" |mode-ins-repl|).
246
247 *cw* *cW*
Bram Moolenaar446cb832008-06-24 21:56:24 +0000248Special case: When the cursor is in a word, "cw" and "cW" do not include the
249white space after a word, they only change up to the end of the word. This is
250because Vim interprets "cw" as change-word, and a word does not include the
251following white space.
252{Vi: "cw" when on a blank followed by other blanks changes only the first
253blank; this is probably a bug, because "dw" deletes all the blanks; use the
254'w' flag in 'cpoptions' to make it work like Vi anyway}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000255
256If you prefer "cw" to include the space after a word, use this mapping: >
257 :map cw dwi
Bram Moolenaar446cb832008-06-24 21:56:24 +0000258Or use "caw" (see |aw|).
259
Bram Moolenaar071d4272004-06-13 20:20:40 +0000260 *:c* *:ch* *:change*
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000261:{range}c[hange][!] Replace lines of text with some different text.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000262 Type a line containing only "." to stop replacing.
263 Without {range}, this command changes only the current
264 line.
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000265 Adding [!] toggles 'autoindent' for the time this
266 command is executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000267
268==============================================================================
2693. Simple changes *simple-change*
270
271 *r*
272r{char} Replace the character under the cursor with {char}.
273 If {char} is a <CR> or <NL>, a line break replaces the
274 character. To replace with a real <CR>, use CTRL-V
275 <CR>. CTRL-V <NL> replaces with a <Nul>.
276 {Vi: CTRL-V <CR> still replaces with a line break,
277 cannot replace something with a <CR>}
Bram Moolenaar80716072012-05-01 21:14:34 +0200278
279 If {char} is CTRL-E or CTRL-Y the character from the
280 line below or above is used, just like with |i_CTRL-E|
281 and |i_CTRL-Y|. This also works with a count, thus
282 `10r<C-E>` copies 10 characters from the line below.
283
Bram Moolenaar071d4272004-06-13 20:20:40 +0000284 If you give a [count], Vim replaces [count] characters
285 with [count] {char}s. When {char} is a <CR> or <NL>,
286 however, Vim inserts only one <CR>: "5r<CR>" replaces
287 five characters with a single line break.
288 When {char} is a <CR> or <NL>, Vim performs
289 autoindenting. This works just like deleting the
290 characters that are replaced and then doing
291 "i<CR><Esc>".
292 {char} can be entered as a digraph |digraph-arg|.
293 |:lmap| mappings apply to {char}. The CTRL-^ command
294 in Insert mode can be used to switch this on/off
295 |i_CTRL-^|. See |utf-8-char-arg| about using
296 composing characters when 'encoding' is Unicode.
297
298 *gr*
299gr{char} Replace the virtual characters under the cursor with
300 {char}. This replaces in screen space, not file
301 space. See |gR| and |Virtual-Replace-mode| for more
302 details. As with |r| a count may be given.
303 {char} can be entered like with |r|.
Bram Moolenaardb84e452010-08-15 13:50:43 +0200304 {not available when compiled without the |+vreplace|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000305 feature}
306
307 *digraph-arg*
308The argument for Normal mode commands like |r| and |t| is a single character.
309When 'cpo' doesn't contain the 'D' flag, this character can also be entered
310like |digraphs|. First type CTRL-K and then the two digraph characters.
311{not available when compiled without the |+digraphs| feature}
312
313 *case*
314The following commands change the case of letters. The currently active
315|locale| is used. See |:language|. The LC_CTYPE value matters here.
316
317 *~*
318~ 'notildeop' option: Switch case of the character
319 under the cursor and move the cursor to the right.
320 If a [count] is given, do that many characters. {Vi:
321 no count}
322
323~{motion} 'tildeop' option: switch case of {motion} text. {Vi:
324 tilde cannot be used as an operator}
325
326 *g~*
327g~{motion} Switch case of {motion} text. {not in Vi}
328
329g~g~ *g~g~* *g~~*
330g~~ Switch case of current line. {not in Vi}.
331
332 *v_~*
333{Visual}~ Switch case of highlighted text (for {Visual} see
334 |Visual-mode|). {not in Vi}
335
336 *v_U*
337{Visual}U Make highlighted text uppercase (for {Visual} see
338 |Visual-mode|). {not in Vi}
339
340 *gU* *uppercase*
341gU{motion} Make {motion} text uppercase. {not in Vi}
342 Example: >
343 :map! <C-F> <Esc>gUiw`]a
344< This works in Insert mode: press CTRL-F to make the
345 word before the cursor uppercase. Handy to type
346 words in lowercase and then make them uppercase.
347
348
349gUgU *gUgU* *gUU*
350gUU Make current line uppercase. {not in Vi}.
351
352 *v_u*
353{Visual}u Make highlighted text lowercase (for {Visual} see
354 |Visual-mode|). {not in Vi}
355
356 *gu* *lowercase*
357gu{motion} Make {motion} text lowercase. {not in Vi}
358
359gugu *gugu* *guu*
360guu Make current line lowercase. {not in Vi}.
361
362 *g?* *rot13*
363g?{motion} Rot13 encode {motion} text. {not in Vi}
364
365 *v_g?*
366{Visual}g? Rot13 encode the highlighted text (for {Visual} see
367 |Visual-mode|). {not in Vi}
368
369g?g? *g?g?* *g??*
370g?? Rot13 encode current line. {not in Vi}.
371
Bram Moolenaar446cb832008-06-24 21:56:24 +0000372To turn one line into title caps, make every first letter of a word
373uppercase: >
374 :s/\v<(.)(\w*)/\u\1\L\2/g
375
Bram Moolenaar071d4272004-06-13 20:20:40 +0000376
377Adding and subtracting ~
378 *CTRL-A*
379CTRL-A Add [count] to the number or alphabetic character at
380 or after the cursor. {not in Vi}
381
Bram Moolenaar979243b2015-06-26 19:35:49 +0200382 *v_CTRL-A*
383{Visual}CTRL-A Add [count] to the number or alphabetic character in
384 the highlighted text. {not in Vi}
385
386 *v_g_CTRL-A*
387{Visual}g CTRL-A Add [count] to the number or alphabetic character in
388 the highlighted text. If several lines are
389 highlighted, each one will be incremented by an
390 additional [count] (so effectively creating a
391 [count] incrementing sequence). {not in Vi}
392 For Example, if you have this list of numbers:
393 1. ~
394 1. ~
395 1. ~
396 1. ~
397 Move to the second "1." and Visually select three
398 lines, pressing g CTRL-A results in:
399 1. ~
400 2. ~
401 3. ~
402 4. ~
403
Bram Moolenaar071d4272004-06-13 20:20:40 +0000404 *CTRL-X*
405CTRL-X Subtract [count] from the number or alphabetic
406 character at or after the cursor. {not in Vi}
407
Bram Moolenaar979243b2015-06-26 19:35:49 +0200408 *v_CTRL-X*
409{Visual}CTRL-X Subtract [count] from the number or alphabetic
410 character in the highlighted text. {not in Vi}
411
Bram Moolenaare0fa3742016-02-20 15:47:01 +0100412 On MS-Windows, this is mapped to cut Visual text
413 |dos-standard-mappings|. If you want to disable the
414 mapping, use this: >
415 silent! vunmap <C-X>
416<
Bram Moolenaar979243b2015-06-26 19:35:49 +0200417 *v_g_CTRL-X*
418{Visual}g CTRL-X Subtract [count] from the number or alphabetic
419 character in the highlighted text. If several lines
420 are highlighted, each value will be decremented by an
421 additional [count] (so effectively creating a [count]
422 decrementing sequence). {not in Vi}
423
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100424The CTRL-A and CTRL-X commands can work for:
425- signed and unsigned decimal numbers
426- unsigned binary, octal and hexadecimal numbers
427- alphabetic characters
428
429This depends on the 'nrformats' option:
430- When 'nrformats' includes "bin", Vim assumes numbers starting with '0b' or
431 '0B' are binary.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000432- When 'nrformats' includes "octal", Vim considers numbers starting with a '0'
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000433 to be octal, unless the number includes a '8' or '9'. Other numbers are
434 decimal and may have a preceding minus sign.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000435 If the cursor is on a number, the commands apply to that number; otherwise
436 Vim uses the number to the right of the cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000437- When 'nrformats' includes "hex", Vim assumes numbers starting with '0x' or
438 '0X' are hexadecimal. The case of the rightmost letter in the number
439 determines the case of the resulting hexadecimal number. If there is no
440 letter in the current number, Vim uses the previously detected case.
441- When 'nrformats' includes "alpha", Vim will change the alphabetic character
442 under or after the cursor. This is useful to make lists with an alphabetic
443 index.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000444
Bram Moolenaar979243b2015-06-26 19:35:49 +0200445For decimals a leading negative sign is considered for incrementing/
Bram Moolenaarfa735342016-01-03 22:14:44 +0100446decrementing, for binary, octal and hex values, it won't be considered. To
447ignore the sign Visually select the number before using CTRL-A or CTRL-X.
Bram Moolenaar979243b2015-06-26 19:35:49 +0200448
Bram Moolenaar071d4272004-06-13 20:20:40 +0000449For numbers with leading zeros (including all octal and hexadecimal numbers),
450Vim preserves the number of characters in the number when possible. CTRL-A on
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000451"0077" results in "0100", CTRL-X on "0x100" results in "0x0ff".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000452There is one exception: When a number that starts with a zero is found not to
453be octal (it contains a '8' or '9'), but 'nrformats' does include "octal",
454leading zeros are removed to avoid that the result may be recognized as an
455octal number.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000456
457Note that when 'nrformats' includes "octal", decimal numbers with leading
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000458zeros cause mistakes, because they can be confused with octal numbers.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000459
Bram Moolenaar887c1fe2016-01-02 17:56:35 +0100460Note similarly, when 'nrformats' includes "bin", binary numbers with a leading
461'0x' or '0X' can be interpreted as hexadecimal rather than binary since '0b'
462are valid hexadecimal digits.
463
Bram Moolenaar071d4272004-06-13 20:20:40 +0000464The CTRL-A command is very useful in a macro. Example: Use the following
465steps to make a numbered list.
466
4671. Create the first list entry, make sure it starts with a number.
Bram Moolenaard8b02732005-01-14 21:48:43 +00004682. qa - start recording into register 'a'
Bram Moolenaar071d4272004-06-13 20:20:40 +00004693. Y - yank the entry
4704. p - put a copy of the entry below the first one
4715. CTRL-A - increment the number
4726. q - stop recording
4737. <count>@a - repeat the yank, put and increment <count> times
474
475
476SHIFTING LINES LEFT OR RIGHT *shift-left-right*
477
478 *<*
479<{motion} Shift {motion} lines one 'shiftwidth' leftwards.
480
481 *<<*
482<< Shift [count] lines one 'shiftwidth' leftwards.
483
484 *v_<*
485{Visual}[count]< Shift the highlighted lines [count] 'shiftwidth'
486 leftwards (for {Visual} see |Visual-mode|). {not in
487 Vi}
488
489 *>*
490 >{motion} Shift {motion} lines one 'shiftwidth' rightwards.
491
492 *>>*
493 >> Shift [count] lines one 'shiftwidth' rightwards.
494
495 *v_>*
496{Visual}[count]> Shift the highlighted lines [count] 'shiftwidth'
497 rightwards (for {Visual} see |Visual-mode|). {not in
498 Vi}
499
500 *:<*
501:[range]< Shift [range] lines one 'shiftwidth' left. Repeat '<'
502 for shifting multiple 'shiftwidth's.
503
504:[range]< {count} Shift {count} lines one 'shiftwidth' left, starting
505 with [range] (default current line |cmdline-ranges|).
506 Repeat '<' for shifting multiple 'shiftwidth's.
507
508:[range]le[ft] [indent] left align lines in [range]. Sets the indent in the
509 lines to [indent] (default 0). {not in Vi}
510
511 *:>*
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000512:[range]> [flags] Shift {count} [range] lines one 'shiftwidth' right.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000513 Repeat '>' for shifting multiple 'shiftwidth's.
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000514 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000515
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000516:[range]> {count} [flags]
517 Shift {count} lines one 'shiftwidth' right, starting
Bram Moolenaar071d4272004-06-13 20:20:40 +0000518 with [range] (default current line |cmdline-ranges|).
519 Repeat '>' for shifting multiple 'shiftwidth's.
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000520 See |ex-flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000521
522The ">" and "<" commands are handy for changing the indentation within
523programs. Use the 'shiftwidth' option to set the size of the white space
524which these commands insert or delete. Normally the 'shiftwidth' option is 8,
525but you can set it to, say, 3 to make smaller indents. The shift leftwards
526stops when there is no indent. The shift right does not affect empty lines.
527
528If the 'shiftround' option is on, the indent is rounded to a multiple of
529'shiftwidth'.
530
531If the 'smartindent' option is on, or 'cindent' is on and 'cinkeys' contains
Bram Moolenaar8e69b4a2013-11-09 03:41:58 +0100532'#' with a zero value, shift right does not affect lines starting with '#'
533(these are supposed to be C preprocessor lines that must stay in column 1).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000534
535When the 'expandtab' option is off (this is the default) Vim uses <Tab>s as
536much as possible to make the indent. You can use ">><<" to replace an indent
537made out of spaces with the same indent made out of <Tab>s (and a few spaces
538if necessary). If the 'expandtab' option is on, Vim uses only spaces. Then
539you can use ">><<" to replace <Tab>s in the indent by spaces (or use
Bram Moolenaard38b0552012-04-25 19:07:41 +0200540`:retab!`).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000541
Bram Moolenaard38b0552012-04-25 19:07:41 +0200542To move a line several 'shiftwidth's, use Visual mode or the `:` commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000543For example: >
544 Vjj4> move three lines 4 indents to the right
545 :<<< move current line 3 indents to the left
546 :>> 5 move 5 lines 2 indents to the right
547 :5>> move line 5 2 indents to the right
548
549==============================================================================
5504. Complex changes *complex-change*
551
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00005524.1 Filter commands *filter*
Bram Moolenaar47136d72004-10-12 20:02:24 +0000553
554A filter is a program that accepts text at standard input, changes it in some
555way, and sends it to standard output. You can use the commands below to send
Bram Moolenaar446cb832008-06-24 21:56:24 +0000556some text through a filter, so that it is replaced by the filter output.
Bram Moolenaar47136d72004-10-12 20:02:24 +0000557Examples of filters are "sort", which sorts lines alphabetically, and
558"indent", which formats C program files (you need a version of indent that
559works like a filter; not all versions do). The 'shell' option specifies the
560shell Vim uses to execute the filter command (See also the 'shelltype'
561option). You can repeat filter commands with ".". Vim does not recognize a
Bram Moolenaard38b0552012-04-25 19:07:41 +0200562comment (starting with '"') after the `:!` command.
Bram Moolenaar47136d72004-10-12 20:02:24 +0000563
564 *!*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000565!{motion}{filter} Filter {motion} text lines through the external
566 program {filter}.
567
568 *!!*
569!!{filter} Filter [count] lines through the external program
570 {filter}.
571
572 *v_!*
573{Visual}!{filter} Filter the highlighted lines through the external
574 program {filter} (for {Visual} see |Visual-mode|).
575 {not in Vi}
576
577:{range}![!]{filter} [!][arg] *:range!*
578 Filter {range} lines through the external program
579 {filter}. Vim replaces the optional bangs with the
580 latest given command and appends the optional [arg].
581 Vim saves the output of the filter command in a
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100582 temporary file and then reads the file into the buffer
583 |tempfile|. Vim uses the 'shellredir' option to
584 redirect the filter output to the temporary file.
Bram Moolenaar83c465c2005-12-16 21:53:56 +0000585 However, if the 'shelltemp' option is off then pipes
586 are used when possible (on Unix).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000587 When the 'R' flag is included in 'cpoptions' marks in
588 the filtered lines are deleted, unless the
589 |:keepmarks| command is used. Example: >
590 :keepmarks '<,'>!sort
591< When the number of lines after filtering is less than
592 before, marks in the missing lines are deleted anyway.
593
594 *=*
595={motion} Filter {motion} lines through the external program
596 given with the 'equalprg' option. When the 'equalprg'
597 option is empty (this is the default), use the
Bram Moolenaar20f90cf2011-05-19 12:22:51 +0200598 internal formatting function |C-indenting| and
599 |'lisp'|. But when 'indentexpr' is not empty, it will
600 be used instead |indent-expression|. When Vim was
601 compiled without internal formatting then the "indent"
602 program is used as a last resort.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000603
604 *==*
605== Filter [count] lines like with ={motion}.
606
607 *v_=*
608{Visual}= Filter the highlighted lines like with ={motion}.
609 {not in Vi}
610
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100612 *tempfile* *setuid*
613Vim uses temporary files for filtering, generating diffs and also for
614tempname(). For Unix, the file will be in a private directory (only
615accessible by the current user) to avoid security problems (e.g., a symlink
616attack or other people reading your file). When Vim exits the directory and
617all files in it are deleted. When Vim has the setuid bit set this may cause
618problems, the temp file is owned by the setuid user but the filter command
619probably runs as the original user.
620On MS-DOS and OS/2 the first of these directories that works is used: $TMP,
621$TEMP, c:\TMP, c:\TEMP.
622For Unix the list of directories is: $TMPDIR, /tmp, current-dir, $HOME.
623For MS-Windows the GetTempFileName() system function is used.
624For other systems the tmpnam() library function is used.
625
626
627
Bram Moolenaar47136d72004-10-12 20:02:24 +00006284.2 Substitute *:substitute*
629 *:s* *:su*
Bram Moolenaar05159a02005-02-26 23:04:13 +0000630:[range]s[ubstitute]/{pattern}/{string}/[flags] [count]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000631 For each line in [range] replace a match of {pattern}
632 with {string}.
633 For the {pattern} see |pattern|.
634 {string} can be a literal string, or something
635 special; see |sub-replace-special|.
636 When [range] and [count] are omitted, replace in the
637 current line only.
638 When [count] is given, replace in [count] lines,
639 starting with the last line in [range]. When [range]
640 is omitted start in the current line.
641 Also see |cmdline-ranges|.
Bram Moolenaar05159a02005-02-26 23:04:13 +0000642 See |:s_flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000643
Bram Moolenaar05159a02005-02-26 23:04:13 +0000644:[range]s[ubstitute] [flags] [count]
645:[range]&[&][flags] [count] *:&*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000646 Repeat last :substitute with same search pattern and
647 substitute string, but without the same flags. You
Bram Moolenaar05159a02005-02-26 23:04:13 +0000648 may add [flags], see |:s_flags|.
Bram Moolenaard38b0552012-04-25 19:07:41 +0200649 Note that after `:substitute` the '&' flag can't be
Bram Moolenaar071d4272004-06-13 20:20:40 +0000650 used, it's recognized as a pattern separator.
Bram Moolenaarfc39ecf2015-08-11 20:34:49 +0200651 The space between `:substitute` and the 'c', 'g',
652 'i', 'I' and 'r' flags isn't required, but in scripts
653 it's a good idea to keep it to avoid confusion.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000654
Bram Moolenaar05159a02005-02-26 23:04:13 +0000655:[range]~[&][flags] [count] *:~*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000656 Repeat last substitute with same substitute string
657 but with last used search pattern. This is like
Bram Moolenaard38b0552012-04-25 19:07:41 +0200658 `:&r`. See |:s_flags| for [flags].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000659
Bram Moolenaar05159a02005-02-26 23:04:13 +0000660 *&*
Bram Moolenaard38b0552012-04-25 19:07:41 +0200661& Synonym for `:s` (repeat last substitute). Note
Bram Moolenaar071d4272004-06-13 20:20:40 +0000662 that the flags are not remembered, thus it might
Bram Moolenaard38b0552012-04-25 19:07:41 +0200663 actually work differently. You can use `:&&` to keep
Bram Moolenaar071d4272004-06-13 20:20:40 +0000664 the flags.
665
Bram Moolenaar05159a02005-02-26 23:04:13 +0000666 *g&*
Bram Moolenaar97d62492012-11-15 21:28:22 +0100667g& Synonym for `:%s//~/&` (repeat last substitute with
668 last search pattern on all lines with the same flags).
Bram Moolenaar34700a62013-03-07 13:20:54 +0100669 For example, when you first do a substitution with
Bram Moolenaar97d62492012-11-15 21:28:22 +0100670 `:s/pattern/repl/flags` and then `/search` for
671 something else, `g&` will do `:%s/search/repl/flags`.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000672 Mnemonic: global substitute. {not in Vi}
673
674 *:snomagic* *:sno*
Bram Moolenaard38b0552012-04-25 19:07:41 +0200675:[range]sno[magic] ... Same as `:substitute`, but always use 'nomagic'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000676 {not in Vi}
677
678 *:smagic* *:sm*
Bram Moolenaard38b0552012-04-25 19:07:41 +0200679:[range]sm[agic] ... Same as `:substitute`, but always use 'magic'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000680 {not in Vi}
681
682 *:s_flags*
683The flags that you can use for the substitute commands:
684
685[&] Must be the first one: Keep the flags from the previous substitute
686 command. Examples: >
687 :&&
688 :s/this/that/&
Bram Moolenaard38b0552012-04-25 19:07:41 +0200689< Note that `:s` and `:&` don't keep the flags.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000690 {not in Vi}
691
692[c] Confirm each substitution. Vim highlights the matching string (with
693 |hl-IncSearch|). You can type: *:s_c*
694 'y' to substitute this match
695 'l' to substitute this match and then quit ("last")
696 'n' to skip this match
697 <Esc> to quit substituting
698 'a' to substitute this and all remaining matches {not in Vi}
699 'q' to quit substituting {not in Vi}
700 CTRL-E to scroll the screen up {not in Vi, not available when
Bram Moolenaardb84e452010-08-15 13:50:43 +0200701 compiled without the |+insert_expand| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000702 CTRL-Y to scroll the screen down {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 If the 'edcompatible' option is on, Vim remembers the [c] flag and
705 toggles it each time you use it, but resets it when you give a new
706 search pattern.
707 {not in Vi: highlighting of the match, other responses than 'y' or 'n'}
708
709[e] When the search pattern fails, do not issue an error message and, in
710 particular, continue in maps as if no error occurred. This is most
711 useful to prevent the "No match" error from breaking a mapping. Vim
712 does not suppress the following error messages, however:
713 Regular expressions can't be delimited by letters
714 \ should be followed by /, ? or &
715 No previous substitute regular expression
716 Trailing characters
717 Interrupted
718 {not in Vi}
719
720[g] Replace all occurrences in the line. Without this argument,
721 replacement occurs only for the first occurrence in each line. If
722 the 'edcompatible' option is on, Vim remembers this flag and toggles
723 it each time you use it, but resets it when you give a new search
724 pattern. If the 'gdefault' option is on, this flag is on by default
725 and the [g] argument switches it off.
726
727[i] Ignore case for the pattern. The 'ignorecase' and 'smartcase' options
728 are not used.
729 {not in Vi}
730
731[I] Don't ignore case for the pattern. The 'ignorecase' and 'smartcase'
732 options are not used.
733 {not in Vi}
734
Bram Moolenaar05159a02005-02-26 23:04:13 +0000735[n] Report the number of matches, do not actually substitute. The [c]
736 flag is ignored. The matches are reported as if 'report' is zero.
737 Useful to |count-items|.
Bram Moolenaar9b451252012-08-15 17:43:31 +0200738 If \= |sub-replace-expression| is used, the expression will be
739 evaluated in the |sandbox| at every match.
Bram Moolenaar05159a02005-02-26 23:04:13 +0000740
Bram Moolenaar071d4272004-06-13 20:20:40 +0000741[p] Print the line containing the last substitute.
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000742
743[#] Like [p] and prepend the line number.
744
Bram Moolenaar9964e462007-05-05 17:54:07 +0000745[l] Like [p] but print the text like |:list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000746
Bram Moolenaard38b0552012-04-25 19:07:41 +0200747[r] Only useful in combination with `:&` or `:s` without arguments. `:&r`
748 works the same way as `:~`: When the search pattern is empty, use the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000749 previously used search pattern instead of the search pattern from the
Bram Moolenaard38b0552012-04-25 19:07:41 +0200750 last substitute or `:global`. If the last command that did a search
751 was a substitute or `:global`, there is no effect. If the last
Bram Moolenaar071d4272004-06-13 20:20:40 +0000752 command was a search command such as "/", use the pattern from that
753 command.
Bram Moolenaard38b0552012-04-25 19:07:41 +0200754 For `:s` with an argument this already happens: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000755 :s/blue/red/
756 /green
757 :s//red/ or :~ or :&r
758< The last commands will replace "green" with "red". >
759 :s/blue/red/
760 /green
761 :&
762< The last command will replace "blue" with "red".
763 {not in Vi}
764
765Note that there is no flag to change the "magicness" of the pattern. A
Bram Moolenaar446cb832008-06-24 21:56:24 +0000766different command is used instead, or you can use |/\v| and friends. The
767reason is that the flags can only be found by skipping the pattern, and in
768order to skip the pattern the "magicness" must be known. Catch 22!
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769
770If the {pattern} for the substitute command is empty, the command uses the
Bram Moolenaard38b0552012-04-25 19:07:41 +0200771pattern from the last substitute or `:global` command. If there is none, but
Bram Moolenaar662db672011-03-22 14:05:35 +0100772there is a previous search pattern, that one is used. With the [r] flag, the
Bram Moolenaard38b0552012-04-25 19:07:41 +0200773command uses the pattern from the last substitute, `:global`, or search
Bram Moolenaar071d4272004-06-13 20:20:40 +0000774command.
775
Bram Moolenaar9964e462007-05-05 17:54:07 +0000776If the {string} is omitted the substitute is done as if it's empty. Thus the
777matched pattern is deleted. The separator after {pattern} can also be left
778out then. Example: >
779 :%s/TESTING
780This deletes "TESTING" from all lines, but only one per line.
781
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782For compatibility with Vi these two exceptions are allowed:
783"\/{string}/" and "\?{string}?" do the same as "//{string}/r".
784"\&{string}&" does the same as "//{string}/".
785 *E146*
786Instead of the '/' which surrounds the pattern and replacement string, you
Bram Moolenaar9964e462007-05-05 17:54:07 +0000787can use any other single-byte character, but not an alphanumeric character,
788'\', '"' or '|'. This is useful if you want to include a '/' in the search
789pattern or replacement string. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000790 :s+/+//+
791
Bram Moolenaar446cb832008-06-24 21:56:24 +0000792For the definition of a pattern, see |pattern|. In Visual block mode, use
793|/\%V| in the pattern to have the substitute work in the block only.
794Otherwise it works on whole lines anyway.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000795
796 *sub-replace-special* *:s\=*
797When the {string} starts with "\=" it is evaluated as an expression, see
Bram Moolenaar251e1912011-06-19 05:09:16 +0200798|sub-replace-expression|. You can use that for complex replacement or special
799characters.
800
Bram Moolenaar5a8684e2005-07-30 22:43:24 +0000801Otherwise these characters in {string} have a special meaning:
Bram Moolenaar26a60b42005-02-22 08:49:11 +0000802 *:s%*
Bram Moolenaar551dbcc2006-04-25 22:13:59 +0000803When {string} is equal to "%" and '/' is included with the 'cpoptions' option,
Bram Moolenaar251e1912011-06-19 05:09:16 +0200804then the {string} of the previous substitute command is used, see |cpo-/|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805
806magic nomagic action ~
807 & \& replaced with the whole matched pattern *s/\&*
808 \& & replaced with &
809 \0 replaced with the whole matched pattern *\0* *s/\0*
810 \1 replaced with the matched pattern in the first
811 pair of () *s/\1*
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +0000812 \2 replaced with the matched pattern in the second
Bram Moolenaar071d4272004-06-13 20:20:40 +0000813 pair of () *s/\2*
814 .. .. *s/\3*
815 \9 replaced with the matched pattern in the ninth
816 pair of () *s/\9*
817 ~ \~ replaced with the {string} of the previous
818 substitute *s~*
819 \~ ~ replaced with ~ *s/\~*
820 \u next character made uppercase *s/\u*
821 \U following characters made uppercase, until \E *s/\U*
822 \l next character made lowercase *s/\l*
823 \L following characters made lowercase, until \E *s/\L*
824 \e end of \u, \U, \l and \L (NOTE: not <Esc>!) *s/\e*
825 \E end of \u, \U, \l and \L *s/\E*
826 <CR> split line in two at this point
827 (Type the <CR> as CTRL-V <Enter>) *s<CR>*
828 \r idem *s/\r*
829 \<CR> insert a carriage-return (CTRL-M)
830 (Type the <CR> as CTRL-V <Enter>) *s/\<CR>*
831 \n insert a <NL> (<NUL> in the file)
832 (does NOT break the line) *s/\n*
833 \b insert a <BS> *s/\b*
834 \t insert a <Tab> *s/\t*
835 \\ insert a single backslash *s/\\*
836 \x where x is any character not mentioned above:
837 Reserved for future expansion
838
Bram Moolenaar251e1912011-06-19 05:09:16 +0200839The special meaning is also used inside the third argument {sub} of
840the |substitute()| function with the following exceptions:
841 - A % inserts a percent literally without regard to 'cpoptions'.
842 - magic is always set without regard to 'magic'.
843 - A ~ inserts a tilde literally.
844 - <CR> and \r inserts a carriage-return (CTRL-M).
845 - \<CR> does not have a special meaning. it's just one of \x.
846
Bram Moolenaar071d4272004-06-13 20:20:40 +0000847Examples: >
848 :s/a\|b/xxx\0xxx/g modifies "a b" to "xxxaxxx xxxbxxx"
849 :s/\([abc]\)\([efg]\)/\2\1/g modifies "af fa bg" to "fa fa gb"
850 :s/abcde/abc^Mde/ modifies "abcde" to "abc", "de" (two lines)
851 :s/$/\^M/ modifies "abcde" to "abcde^M"
Bram Moolenaarefd2bf12006-03-16 21:41:35 +0000852 :s/\w\+/\u\0/g modifies "bla bla" to "Bla Bla"
Bram Moolenaarbf884932013-04-05 22:26:15 +0200853 :s/\w\+/\L\u/g modifies "BLA bla" to "Bla Bla"
854
855Note: "\L\u" can be used to capitalize the first letter of a word. This is
856not compatible with Vi and older versions of Vim, where the "\u" would cancel
857out the "\L". Same for "\U\l".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000858
859Note: In previous versions CTRL-V was handled in a special way. Since this is
860not Vi compatible, this was removed. Use a backslash instead.
861
862command text result ~
863:s/aa/a^Ma/ aa a<line-break>a
864:s/aa/a\^Ma/ aa a^Ma
865:s/aa/a\\^Ma/ aa a\<line-break>a
866
867(you need to type CTRL-V <CR> to get a ^M here)
868
869The numbering of "\1", "\2" etc. is done based on which "\(" comes first in
870the pattern (going left to right). When a parentheses group matches several
871times, the last one will be used for "\1", "\2", etc. Example: >
872 :s/\(\(a[a-d] \)*\)/\2/ modifies "aa ab x" to "ab x"
873
874When using parentheses in combination with '|', like in \([ab]\)\|\([cd]\),
875either the first or second pattern in parentheses did not match, so either
876\1 or \2 is empty. Example: >
877 :s/\([ab]\)\|\([cd]\)/\1x/g modifies "a b c d" to "ax bx x x"
878<
879
Bram Moolenaara0f849e2015-10-30 14:37:44 +0100880 *:sc* *:sce* *:scg* *:sci* *:scI* *:scl* *:scp* *:sg* *:sgc*
881 *:sge* *:sgi* *:sgI* *:sgl* *:sgn* *:sgp* *:sgr* *:sI* *:si*
882 *:sic* *:sIc* *:sie* *:sIe* *:sIg* *:sIl* *:sin* *:sIn* *:sIp*
883 *:sip* *:sIr* *:sir* *:sr* *:src* *:srg* *:sri* *:srI* *:srl*
884 *:srn* *:srp*
8852-letter and 3-letter :substitute commands ~
886
887 List of :substitute commands
888 | c e g i I n p l r
889 | c :sc :sce :scg :sci :scI :scn :scp :scl ---
890 | e
891 | g :sgc :sge :sg :sgi :sgI :sgn :sgp :sgl :sgr
892 | i :sic :sie --- :si :siI :sin :sip --- :sir
893 | I :sIc :sIe :sIg :sIi :sI :sIn :sIp :sIl :sIr
894 | n
895 | p
896 | l
897 | r :src --- :srg :sri :srI :srn :srp :srl :sr
898
899Exceptions:
900 :scr is `:scriptnames`
901 :se is `:set`
902 :sig is `:sign`
903 :sil is `:silent`
904 :sn is `:snext`
905 :sp is `:split`
906 :sl is `:sleep`
907 :sre is `:srewind`
908
909
Bram Moolenaar071d4272004-06-13 20:20:40 +0000910Substitute with an expression *sub-replace-expression*
Bram Moolenaar92dff182014-02-11 19:15:50 +0100911 *sub-replace-\=* *s/\=*
Bram Moolenaara7fc0102005-05-18 22:17:12 +0000912When the substitute string starts with "\=" the remainder is interpreted as an
Bram Moolenaar251e1912011-06-19 05:09:16 +0200913expression. This does not work recursively: a |substitute()| function inside
Bram Moolenaar071d4272004-06-13 20:20:40 +0000914the expression cannot use "\=" for the substitute string.
915
916The special meaning for characters as mentioned at |sub-replace-special| does
Bram Moolenaar251e1912011-06-19 05:09:16 +0200917not apply except for "<CR>". A <NL> character is used as a line break, you
918can get one with a double-quote string: "\n". Prepend a backslash to get a
919real <NL> character (which will be a NUL in the file).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000920
Bram Moolenaar251e1912011-06-19 05:09:16 +0200921The "\=" notation can also be used inside the third argument {sub} of
922|substitute()| function. In this case, the special meaning for characters as
923mentioned at |sub-replace-special| does not apply at all. Especially, <CR> and
924<NL> are interpreted not as a line break but as a carriage-return and a
925new-line respectively.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000926
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000927When the result is a |List| then the items are joined with separating line
928breaks. Thus each item becomes a line, except that they can contain line
929breaks themselves.
930
Bram Moolenaar071d4272004-06-13 20:20:40 +0000931The whole matched text can be accessed with "submatch(0)". The text matched
932with the first pair of () with "submatch(1)". Likewise for further
933sub-matches in ().
934
935Be careful: The separation character must not appear in the expression!
936Consider using a character like "@" or ":". There is no problem if the result
937of the expression contains the separation character.
938
Bram Moolenaar5a8684e2005-07-30 22:43:24 +0000939Examples: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000940 :s@\n@\="\r" . expand("$HOME") . "\r"@
Bram Moolenaar5a8684e2005-07-30 22:43:24 +0000941This replaces an end-of-line with a new line containing the value of $HOME. >
942
943 s/E/\="\<Char-0x20ac>"/g
Bram Moolenaarc236c162008-07-13 17:41:49 +0000944This replaces each 'E' character with a euro sign. Read more in |<Char->|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000945
946
Bram Moolenaar47136d72004-10-12 20:02:24 +00009474.3 Search and replace *search-replace*
948
949 *:pro* *:promptfind*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000950:promptf[ind] [string]
951 Put up a Search dialog. When [string] is given, it is
952 used as the initial search string.
953 {only for Win32, Motif and GTK GUI}
954
955 *:promptr* *:promptrepl*
956:promptr[epl] [string]
957 Put up a Search/Replace dialog. When [string] is
958 given, it is used as the initial search string.
959 {only for Win32, Motif and GTK GUI}
960
Bram Moolenaar47136d72004-10-12 20:02:24 +0000961
9624.4 Changing tabs *change-tabs*
Bram Moolenaard38b0552012-04-25 19:07:41 +0200963 *:ret* *:retab* *:retab!*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000964:[range]ret[ab][!] [new_tabstop]
965 Replace all sequences of white-space containing a
966 <Tab> with new strings of white-space using the new
967 tabstop value given. If you do not specify a new
968 tabstop size or it is zero, Vim uses the current value
969 of 'tabstop'.
970 The current value of 'tabstop' is always used to
971 compute the width of existing tabs.
972 With !, Vim also replaces strings of only normal
973 spaces with tabs where appropriate.
974 With 'expandtab' on, Vim replaces all tabs with the
975 appropriate number of spaces.
976 This command sets 'tabstop' to the new value given,
977 and if performed on the whole file, which is default,
978 should not make any visible change.
979 Careful: This command modifies any <Tab> characters
980 inside of strings in a C program. Use "\t" to avoid
981 this (that's a good habit anyway).
Bram Moolenaard38b0552012-04-25 19:07:41 +0200982 `:retab!` may also change a sequence of spaces by
Bram Moolenaar071d4272004-06-13 20:20:40 +0000983 <Tab> characters, which can mess up a printf().
984 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000985
986 *retab-example*
987Example for using autocommands and ":retab" to edit a file which is stored
988with tabstops at 8 but edited with tabstops set at 4. Warning: white space
989inside of strings can change! Also see 'softtabstop' option. >
990
991 :auto BufReadPost *.xx retab! 4
992 :auto BufWritePre *.xx retab! 8
993 :auto BufWritePost *.xx retab! 4
994 :auto BufNewFile *.xx set ts=4
995
996==============================================================================
9975. Copying and moving text *copy-move*
998
999 *quote*
1000"{a-zA-Z0-9.%#:-"} Use register {a-zA-Z0-9.%#:-"} for next delete, yank
1001 or put (use uppercase character to append with
1002 delete and yank) ({.%#:} only work with put).
1003
1004 *:reg* *:registers*
1005:reg[isters] Display the contents of all numbered and named
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001006 registers. If a register is written to for |:redir|
1007 it will not be listed.
1008 {not in Vi}
1009
Bram Moolenaar071d4272004-06-13 20:20:40 +00001010
1011:reg[isters] {arg} Display the contents of the numbered and named
1012 registers that are mentioned in {arg}. For example: >
Bram Moolenaarfa735342016-01-03 22:14:44 +01001013 :reg 1a
Bram Moolenaar071d4272004-06-13 20:20:40 +00001014< to display registers '1' and 'a'. Spaces are allowed
1015 in {arg}. {not in Vi}
1016
1017 *:di* *:display*
1018:di[splay] [arg] Same as :registers. {not in Vi}
1019
1020 *y* *yank*
1021["x]y{motion} Yank {motion} text [into register x]. When no
1022 characters are to be yanked (e.g., "y0" in column 1),
1023 this is an error when 'cpoptions' includes the 'E'
1024 flag.
1025
1026 *yy*
1027["x]yy Yank [count] lines [into register x] |linewise|.
1028
1029 *Y*
1030["x]Y yank [count] lines [into register x] (synonym for
1031 yy, |linewise|). If you like "Y" to work from the
1032 cursor to the end of line (which is more logical,
1033 but not Vi-compatible) use ":map Y y$".
1034
1035 *v_y*
1036{Visual}["x]y Yank the highlighted text [into register x] (for
1037 {Visual} see |Visual-mode|). {not in Vi}
1038
1039 *v_Y*
1040{Visual}["x]Y Yank the highlighted lines [into register x] (for
1041 {Visual} see |Visual-mode|). {not in Vi}
1042
Bram Moolenaar85de2062011-05-05 14:26:41 +02001043 *:y* *:yank* *E850*
1044:[range]y[ank] [x] Yank [range] lines [into register x]. Yanking to the
Bram Moolenaar446beb42011-05-10 17:18:44 +02001045 "* or "+ registers is possible only when the
1046 |+clipboard| feature is included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001047
1048:[range]y[ank] [x] {count}
1049 Yank {count} lines, starting with last line number
1050 in [range] (default: current line |cmdline-ranges|),
1051 [into register x].
1052
1053 *p* *put* *E353*
1054["x]p Put the text [from register x] after the cursor
1055 [count] times. {Vi: no count}
1056
1057 *P*
1058["x]P Put the text [from register x] before the cursor
1059 [count] times. {Vi: no count}
1060
1061 *<MiddleMouse>*
1062["x]<MiddleMouse> Put the text from a register before the cursor [count]
1063 times. Uses the "* register, unless another is
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001064 specified.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001065 Leaves the cursor at the end of the new text.
1066 Using the mouse only works when 'mouse' contains 'n'
1067 or 'a'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001068 {not in Vi}
1069 If you have a scrollwheel and often accidentally paste
1070 text, you can use these mappings to disable the
1071 pasting with the middle mouse button: >
1072 :map <MiddleMouse> <Nop>
1073 :imap <MiddleMouse> <Nop>
1074< You might want to disable the multi-click versions
1075 too, see |double-click|.
1076
1077 *gp*
1078["x]gp Just like "p", but leave the cursor just after the new
1079 text. {not in Vi}
1080
1081 *gP*
1082["x]gP Just like "P", but leave the cursor just after the new
1083 text. {not in Vi}
1084
1085 *:pu* *:put*
1086:[line]pu[t] [x] Put the text [from register x] after [line] (default
1087 current line). This always works |linewise|, thus
1088 this command can be used to put a yanked block as new
1089 lines.
Bram Moolenaard38b0552012-04-25 19:07:41 +02001090 If no register is specified, it depends on the 'cb'
1091 option: If 'cb' contains "unnamedplus", paste from the
1092 + register |quoteplus|. Otherwise, if 'cb' contains
Bram Moolenaarddbb5552012-04-26 20:17:03 +02001093 "unnamed", paste from the * register |quotestar|.
Bram Moolenaard38b0552012-04-25 19:07:41 +02001094 Otherwise, paste from the unnamed register
1095 |quote_quote|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001096 The register can also be '=' followed by an optional
1097 expression. The expression continues until the end of
1098 the command. You need to escape the '|' and '"'
1099 characters to prevent them from terminating the
1100 command. Example: >
1101 :put ='path' . \",/test\"
1102< If there is no expression after '=', Vim uses the
1103 previous expression. You can see it with ":dis =".
1104
1105:[line]pu[t]! [x] Put the text [from register x] before [line] (default
1106 current line).
1107
1108["x]]p or *]p* *]<MiddleMouse>*
1109["x]]<MiddleMouse> Like "p", but adjust the indent to the current line.
1110 Using the mouse only works when 'mouse' contains 'n'
1111 or 'a'. {not in Vi}
1112
1113["x][P or *[P*
1114["x]]P or *]P*
1115["x][p or *[p* *[<MiddleMouse>*
1116["x][<MiddleMouse> Like "P", but adjust the indent to the current line.
1117 Using the mouse only works when 'mouse' contains 'n'
1118 or 'a'. {not in Vi}
1119
1120You can use these commands to copy text from one place to another. Do this
1121by first getting the text into a register with a yank, delete or change
1122command, then inserting the register contents with a put command. You can
1123also use these commands to move text from one file to another, because Vim
1124preserves all registers when changing buffers (the CTRL-^ command is a quick
1125way to toggle between two files).
1126
1127 *linewise-register* *characterwise-register*
1128You can repeat the put commands with "." (except for :put) and undo them. If
1129the command that was used to get the text into the register was |linewise|,
1130Vim inserts the text below ("p") or above ("P") the line where the cursor is.
1131Otherwise Vim inserts the text after ("p") or before ("P") the cursor. With
1132the ":put" command, Vim always inserts the text in the next line. You can
1133exchange two characters with the command sequence "xp". You can exchange two
1134lines with the command sequence "ddp". You can exchange two words with the
1135command sequence "deep" (start with the cursor in the blank space before the
1136first word). You can use the "']" or "`]" command after the put command to
1137move the cursor to the end of the inserted text, or use "'[" or "`[" to move
1138the cursor to the start.
1139
1140 *put-Visual-mode* *v_p* *v_P*
1141When using a put command like |p| or |P| in Visual mode, Vim will try to
1142replace the selected text with the contents of the register. Whether this
1143works well depends on the type of selection and the type of the text in the
1144register. With blockwise selection it also depends on the size of the block
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001145and whether the corners are on an existing character. (Implementation detail:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001146it actually works by first putting the register after the selection and then
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001147deleting the selection.)
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001148The previously selected text is put in the unnamed register. If you want to
1149put the same text into a Visual selection several times you need to use
1150another register. E.g., yank the text to copy, Visually select the text to
1151replace and use "0p . You can repeat this as many times as you like, the
1152unnamed register will be changed each time.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001153
Bram Moolenaarec11aef2013-09-22 15:23:44 +02001154When you use a blockwise Visual mode command and yank only a single line into
1155a register, a paste on a visual selected area will paste that single line on
1156each of the selected lines (thus replacing the blockwise selected region by a
1157block of the pasted line).
1158
Bram Moolenaar071d4272004-06-13 20:20:40 +00001159 *blockwise-register*
1160If you use a blockwise Visual mode command to get the text into the register,
1161the block of text will be inserted before ("P") or after ("p") the cursor
1162column in the current and next lines. Vim makes the whole block of text start
1163in the same column. Thus the inserted text looks the same as when it was
1164yanked or deleted. Vim may replace some <Tab> characters with spaces to make
1165this happen. However, if the width of the block is not a multiple of a <Tab>
1166width and the text after the inserted block contains <Tab>s, that text may be
1167misaligned.
1168
1169Note that after a characterwise yank command, Vim leaves the cursor on the
1170first yanked character that is closest to the start of the buffer. This means
1171that "yl" doesn't move the cursor, but "yh" moves the cursor one character
1172left.
1173Rationale: In Vi the "y" command followed by a backwards motion would
1174 sometimes not move the cursor to the first yanked character,
1175 because redisplaying was skipped. In Vim it always moves to
1176 the first character, as specified by Posix.
1177With a linewise yank command the cursor is put in the first line, but the
1178column is unmodified, thus it may not be on the first yanked character.
1179
Bram Moolenaar12969c02015-09-08 23:36:10 +02001180There are ten types of registers: *registers* *E354*
Bram Moolenaar071d4272004-06-13 20:20:40 +000011811. The unnamed register ""
11822. 10 numbered registers "0 to "9
11833. The small delete register "-
11844. 26 named registers "a to "z or "A to "Z
Bram Moolenaar3b3a9492015-01-27 18:44:16 +010011855. three read-only registers ":, "., "%
Bram Moolenaar0122c402015-02-03 19:13:34 +010011866. alternate buffer register "#
Bram Moolenaar3b3a9492015-01-27 18:44:16 +010011877. the expression register "=
11888. The selection and drop registers "*, "+ and "~
11899. The black hole register "_
119010. Last search pattern register "/
Bram Moolenaar071d4272004-06-13 20:20:40 +00001191
11921. Unnamed register "" *quote_quote* *quotequote*
1193Vim fills this register with text deleted with the "d", "c", "s", "x" commands
1194or copied with the yank "y" command, regardless of whether or not a specific
Bram Moolenaared203462004-06-16 11:19:22 +00001195register was used (e.g. "xdd). This is like the unnamed register is pointing
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001196to the last used register. Thus when appending using an uppercase register
1197name, the unnamed register contains the same text as the named register.
1198An exception is the '_' register: "_dd does not store the deleted text in any
1199register.
Bram Moolenaar81695252004-12-29 20:58:21 +00001200Vim uses the contents of the unnamed register for any put command (p or P)
1201which does not specify a register. Additionally you can access it with the
1202name '"'. This means you have to type two double quotes. Writing to the ""
1203register writes to register "0.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001204{Vi: register contents are lost when changing files, no '"'}
1205
12062. Numbered registers "0 to "9 *quote_number* *quote0* *quote1*
1207 *quote2* *quote3* *quote4* *quote9*
1208Vim fills these registers with text from yank and delete commands.
1209 Numbered register 0 contains the text from the most recent yank command,
1210unless the command specified another register with ["x].
1211 Numbered register 1 contains the text deleted by the most recent delete or
1212change command, unless the command specified another register or the text is
1213less than one line (the small delete register is used then). An exception is
Bram Moolenaar81695252004-12-29 20:58:21 +00001214made for the delete operator with these movement commands: |%|, |(|, |)|, |`|,
1215|/|, |?|, |n|, |N|, |{| and |}|. Register "1 is always used then (this is Vi
1216compatible). The "- register is used as well if the delete is within a line.
Bram Moolenaarbaca7f72013-09-22 14:42:24 +02001217Note that these characters may be mapped. E.g. |%| is mapped by the matchit
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02001218plugin.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001219 With each successive deletion or change, Vim shifts the previous contents
1220of register 1 into register 2, 2 into 3, and so forth, losing the previous
1221contents of register 9.
1222{Vi: numbered register contents are lost when changing files; register 0 does
1223not exist}
1224
12253. Small delete register "- *quote_-* *quote-*
1226This register contains text from commands that delete less than one line,
1227except when the command specifies a register with ["x].
1228{not in Vi}
1229
12304. Named registers "a to "z or "A to "Z *quote_alpha* *quotea*
1231Vim fills these registers only when you say so. Specify them as lowercase
1232letters to replace their previous contents or as uppercase letters to append
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001233to their previous contents. When the '>' flag is present in 'cpoptions' then
1234a line break is inserted before the appended text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001235
Bram Moolenaar3b3a9492015-01-27 18:44:16 +010012365. Read-only registers ":, ". and "%
Bram Moolenaar071d4272004-06-13 20:20:40 +00001237These are '%', '#', ':' and '.'. You can use them only with the "p", "P",
1238and ":put" commands and with CTRL-R. {not in Vi}
1239 *quote_.* *quote.* *E29*
1240 ". Contains the last inserted text (the same as what is inserted
1241 with the insert mode commands CTRL-A and CTRL-@). Note: this
1242 doesn't work with CTRL-R on the command-line. It works a bit
1243 differently, like inserting the text instead of putting it
1244 ('textwidth' and other options affect what is inserted).
1245 *quote_%* *quote%*
1246 "% Contains the name of the current file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001247 *quote_:* *quote:* *E30*
1248 ": Contains the most recent executed command-line. Example: Use
1249 "@:" to repeat the previous command-line command.
1250 The command-line is only stored in this register when at least
1251 one character of it was typed. Thus it remains unchanged if
1252 the command was completely from a mapping.
1253 {not available when compiled without the |+cmdline_hist|
1254 feature}
Bram Moolenaar3b3a9492015-01-27 18:44:16 +01001255 *quote_#* *quote#*
12566. Alternate file register "#
1257Contains the name of the alternate file for the current window. It will
1258change how the |CTRL-^| command works.
1259This register is writable, mainly to allow for restoring it after a plugin has
1260changed it. It accepts buffer number: >
1261 let altbuf = bufnr(@#)
1262 ...
1263 let @# = altbuf
1264It will give error |E86| if you pass buffer number and this buffer does not
1265exist.
1266It can also accept a match with an existing buffer name: >
1267 let @# = 'buffer_name'
1268Error |E93| if there is more than one buffer matching the given name or |E94|
1269if none of buffers matches the given name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001270
Bram Moolenaar3b3a9492015-01-27 18:44:16 +010012717. Expression register "= *quote_=* *quote=* *@=*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001272This is not really a register that stores text, but is a way to use an
1273expression in commands which use a register. The expression register is
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001274read-write.
1275
1276When typing the '=' after " or CTRL-R the cursor moves to the command-line,
1277where you can enter any expression (see |expression|). All normal
1278command-line editing commands are available, including a special history for
1279expressions. When you end the command-line by typing <CR>, Vim computes the
1280result of the expression. If you end it with <Esc>, Vim abandons the
1281expression. If you do not enter an expression, Vim uses the previous
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001282expression (like with the "/" command).
1283
1284The expression must evaluate to a String. A Number is always automatically
1285converted to a String. For the "p" and ":put" command, if the result is a
1286Float it's converted into a String. If the result is a List each element is
1287turned into a String and used as a line. A Dictionary or FuncRef results in
1288an error message (use string() to convert).
1289
1290If the "= register is used for the "p" command, the String is split up at <NL>
1291characters. If the String ends in a <NL>, it is regarded as a linewise
Bram Moolenaar6bab4d12005-06-16 21:53:56 +00001292register. {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001293
Bram Moolenaar3b3a9492015-01-27 18:44:16 +010012948. Selection and drop registers "*, "+ and "~
Bram Moolenaar06b5d512010-05-22 15:37:44 +02001295Use these registers for storing and retrieving the selected text for the GUI.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001296See |quotestar| and |quoteplus|. When the clipboard is not available or not
Bram Moolenaarf4d11452005-12-02 00:46:37 +00001297working, the unnamed register is used instead. For Unix systems the clipboard
1298is only available when the |+xterm_clipboard| feature is present. {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001299
1300Note that there is only a distinction between "* and "+ for X11 systems. For
1301an explanation of the difference, see |x11-selection|. Under MS-Windows, use
1302of "* and "+ is actually synonymous and refers to the |gui-clipboard|.
1303
1304 *quote_~* *quote~* *<Drop>*
1305The read-only "~ register stores the dropped text from the last drag'n'drop
1306operation. When something has been dropped onto Vim, the "~ register is
1307filled in and the <Drop> pseudo key is sent for notification. You can remap
1308this key if you want; the default action (for all modes) is to insert the
1309contents of the "~ register at the cursor position. {not in Vi}
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001310{only available when compiled with the |+dnd| feature, currently only with the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001311GTK GUI}
1312
1313Note: The "~ register is only used when dropping plain text onto Vim.
1314Drag'n'drop of URI lists is handled internally.
1315
Bram Moolenaar3b3a9492015-01-27 18:44:16 +010013169. Black hole register "_ *quote_*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001317When writing to this register, nothing happens. This can be used to delete
1318text without affecting the normal registers. When reading from this register,
1319nothing is returned. {not in Vi}
1320
Bram Moolenaar3b3a9492015-01-27 18:44:16 +0100132110. Last search pattern register "/ *quote_/* *quote/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001322Contains the most recent search-pattern. This is used for "n" and 'hlsearch'.
Bram Moolenaard38b0552012-04-25 19:07:41 +02001323It is writable with `:let`, you can change it to have 'hlsearch' highlight
Bram Moolenaar071d4272004-06-13 20:20:40 +00001324other matches without actually searching. You can't yank or delete into this
Bram Moolenaar446cb832008-06-24 21:56:24 +00001325register. The search direction is available in |v:searchforward|.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001326Note that the value is restored when returning from a function
Bram Moolenaar446cb832008-06-24 21:56:24 +00001327|function-search-undo|.
1328{not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001329
1330 *@/*
Bram Moolenaard38b0552012-04-25 19:07:41 +02001331You can write to a register with a `:let` command |:let-@|. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001332 :let @/ = "the"
1333
1334If you use a put command without specifying a register, Vim uses the register
1335that was last filled (this is also the contents of the unnamed register). If
Bram Moolenaard38b0552012-04-25 19:07:41 +02001336you are confused, use the `:dis` command to find out what Vim will put (this
Bram Moolenaar071d4272004-06-13 20:20:40 +00001337command displays all named and numbered registers; the unnamed register is
1338labelled '"').
1339
1340The next three commands always work on whole lines.
1341
1342:[range]co[py] {address} *:co* *:copy*
1343 Copy the lines given by [range] to below the line
1344 given by {address}.
1345
1346 *:t*
1347:t Synonym for copy.
1348
1349:[range]m[ove] {address} *:m* *:mo* *:move* *E134*
1350 Move the lines given by [range] to below the line
1351 given by {address}.
1352
1353==============================================================================
13546. Formatting text *formatting*
1355
1356:[range]ce[nter] [width] *:ce* *:center*
1357 Center lines in [range] between [width] columns
1358 (default 'textwidth' or 80 when 'textwidth' is 0).
1359 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001360
1361:[range]ri[ght] [width] *:ri* *:right*
1362 Right-align lines in [range] at [width] columns
1363 (default 'textwidth' or 80 when 'textwidth' is 0).
1364 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001365
1366 *:le* *:left*
1367:[range]le[ft] [indent]
1368 Left-align lines in [range]. Sets the indent in the
1369 lines to [indent] (default 0). {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001370
1371 *gq*
Bram Moolenaar4317d9b2005-03-18 20:25:31 +00001372gq{motion} Format the lines that {motion} moves over.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001373 Formatting is done with one of three methods:
1374 1. If 'formatexpr' is not empty the expression is
1375 evaluated. This can differ for each buffer.
Bram Moolenaar4c7ed462006-02-15 22:18:42 +00001376 2. If 'formatprg' is not empty an external program
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001377 is used.
Bram Moolenaar551dbcc2006-04-25 22:13:59 +00001378 3. Otherwise formatting is done internally.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001379
1380 In the third case the 'textwidth' option controls the
1381 length of each formatted line (see below).
Bram Moolenaar4317d9b2005-03-18 20:25:31 +00001382 If the 'textwidth' option is 0, the formatted line
1383 length is the screen width (with a maximum width of
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001384 79).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001385 The 'formatoptions' option controls the type of
1386 formatting |fo-table|.
Bram Moolenaar4317d9b2005-03-18 20:25:31 +00001387 The cursor is left on the first non-blank of the last
1388 formatted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001389 NOTE: The "Q" command formerly performed this
1390 function. If you still want to use "Q" for
1391 formatting, use this mapping: >
1392 :nnoremap Q gq
1393
1394gqgq *gqgq* *gqq*
Bram Moolenaar40af4e32010-07-29 22:33:18 +02001395gqq Format the current line. With a count format that
1396 many lines. {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001397
1398 *v_gq*
1399{Visual}gq Format the highlighted text. (for {Visual} see
1400 |Visual-mode|). {not in Vi}
1401
1402 *gw*
1403gw{motion} Format the lines that {motion} moves over. Similar to
1404 |gq| but puts the cursor back at the same position in
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001405 the text. However, 'formatprg' and 'formatexpr' are
1406 not used. {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001407
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001408gwgw *gwgw* *gww*
1409gww Format the current line as with "gw". {not in Vi}
1410
1411 *v_gw*
1412{Visual}gw Format the highlighted text as with "gw". (for
1413 {Visual} see |Visual-mode|). {not in Vi}
1414
Bram Moolenaar071d4272004-06-13 20:20:40 +00001415Example: To format the current paragraph use: *gqap* >
1416 gqap
1417
1418The "gq" command leaves the cursor in the line where the motion command takes
1419the cursor. This allows you to repeat formatting repeated with ".". This
1420works well with "gqj" (format current and next line) and "gq}" (format until
1421end of paragraph). Note: When 'formatprg' is set, "gq" leaves the cursor on
1422the first formatted line (as with using a filter command).
1423
1424If you want to format the current paragraph and continue where you were, use: >
1425 gwap
1426If you always want to keep paragraphs formatted you may want to add the 'a'
1427flag to 'formatoptions'. See |auto-format|.
1428
1429If the 'autoindent' option is on, Vim uses the indent of the first line for
1430the following lines.
1431
1432Formatting does not change empty lines (but it does change lines with only
1433white space!).
1434
1435The 'joinspaces' option is used when lines are joined together.
1436
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001437You can set the 'formatexpr' option to an expression or the 'formatprg' option
1438to the name of an external program for Vim to use for text formatting. The
1439'textwidth' and other options have no effect on formatting by an external
1440program.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001441
1442 *right-justify*
1443There is no command in Vim to right justify text. You can do it with
1444an external command, like "par" (e.g.: "!}par" to format until the end of the
1445paragraph) or set 'formatprg' to "par".
1446
1447 *format-comments*
Bram Moolenaar446cb832008-06-24 21:56:24 +00001448An overview of comment formatting is in section |30.6| of the user manual.
1449
1450Vim can automatically insert and format comments in a special way. Vim
1451recognizes a comment by a specific string at the start of the line (ignoring
1452white space). Three types of comments can be used:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001453
1454- A comment string that repeats at the start of each line. An example is the
1455 type of comment used in shell scripts, starting with "#".
1456- A comment string that occurs only in the first line, not in the following
1457 lines. An example is this list with dashes.
1458- Three-piece comments that have a start string, an end string, and optional
1459 lines in between. The strings for the start, middle and end are different.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001460 An example is the C style comment:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001461 /*
1462 * this is a C comment
1463 */
1464
1465The 'comments' option is a comma-separated list of parts. Each part defines a
1466type of comment string. A part consists of:
1467 {flags}:{string}
1468
1469{string} is the literal text that must appear.
1470
1471{flags}:
1472 n Nested comment. Nesting with mixed parts is allowed. If 'comments'
1473 is "n:),n:>" a line starting with "> ) >" is a comment.
1474
1475 b Blank (<Space>, <Tab> or <EOL>) required after {string}.
1476
1477 f Only the first line has the comment string. Do not repeat comment on
1478 the next line, but preserve indentation (e.g., a bullet-list).
1479
1480 s Start of three-piece comment
1481
1482 m Middle of a three-piece comment
1483
1484 e End of a three-piece comment
1485
Bram Moolenaar446cb832008-06-24 21:56:24 +00001486 l Left align. Used together with 's' or 'e', the leftmost character of
1487 start or end will line up with the leftmost character from the middle.
1488 This is the default and can be omitted. See below for more details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001489
Bram Moolenaar446cb832008-06-24 21:56:24 +00001490 r Right align. Same as above but rightmost instead of leftmost. See
1491 below for more details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001492
Bram Moolenaar446cb832008-06-24 21:56:24 +00001493 O Don't consider this comment for the "O" command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001494
1495 x Allows three-piece comments to be ended by just typing the last
Bram Moolenaar446cb832008-06-24 21:56:24 +00001496 character of the end-comment string as the first action on a new
1497 line when the middle-comment string has been inserted automatically.
1498 See below for more details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001499
1500 {digits}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001501 When together with 's' or 'e': add {digit} amount of offset to an
1502 automatically inserted middle or end comment leader. The offset begins
1503 from a left alignment. See below for more details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001504
1505 -{digits}
1506 Like {digits} but reduce the indent. This only works when there is
1507 some indent for the start or end part that can be removed.
1508
1509When a string has none of the 'f', 's', 'm' or 'e' flags, Vim assumes the
1510comment string repeats at the start of each line. The flags field may be
1511empty.
1512
1513Any blank space in the text before and after the {string} is part of the
1514{string}, so do not include leading or trailing blanks unless the blanks are a
1515required part of the comment string.
1516
1517When one comment leader is part of another, specify the part after the whole.
1518For example, to include both "-" and "->", use >
1519 :set comments=f:->,f:-
1520
1521A three-piece comment must always be given as start,middle,end, with no other
1522parts in between. An example of a three-piece comment is >
1523 sr:/*,mb:*,ex:*/
1524for C-comments. To avoid recognizing "*ptr" as a comment, the middle string
1525includes the 'b' flag. For three-piece comments, Vim checks the text after
1526the start and middle strings for the end string. If Vim finds the end string,
1527the comment does not continue on the next line. Three-piece comments must
1528have a middle string because otherwise Vim can't recognize the middle lines.
1529
1530Notice the use of the "x" flag in the above three-piece comment definition.
1531When you hit Return in a C-comment, Vim will insert the middle comment leader
Bram Moolenaar446cb832008-06-24 21:56:24 +00001532for the new line: " * ". To close this comment you just have to type "/"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001533before typing anything else on the new line. This will replace the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001534middle-comment leader with the end-comment leader and apply any specified
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001535alignment, leaving just " */". There is no need to hit Backspace first.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001536
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001537When there is a match with a middle part, but there also is a matching end
1538part which is longer, the end part is used. This makes a C style comment work
Bram Moolenaar446beb42011-05-10 17:18:44 +02001539without requiring the middle part to end with a space.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001540
1541Here is an example of alignment flags at work to make a comment stand out
Bram Moolenaar446beb42011-05-10 17:18:44 +02001542(kind of looks like a 1 too). Consider comment string: >
1543 :set comments=sr:/***,m:**,ex-2:******/
1544<
1545 /*** ~
1546 **<--right aligned from "r" flag ~
1547 ** ~
1548offset 2 spaces for the "-2" flag--->** ~
1549 ******/ ~
Bram Moolenaar446cb832008-06-24 21:56:24 +00001550In this case, the first comment was typed, then return was pressed 4 times,
1551then "/" was pressed to end the comment.
1552
1553Here are some finer points of three part comments. There are three times when
1554alignment and offset flags are taken into consideration: opening a new line
1555after a start-comment, opening a new line before an end-comment, and
1556automatically ending a three-piece comment. The end alignment flag has a
1557backwards perspective; the result is that the same alignment flag used with
1558"s" and "e" will result in the same indent for the starting and ending pieces.
1559Only one alignment per comment part is meant to be used, but an offset number
1560will override the "r" and "l" flag.
1561
1562Enabling 'cindent' will override the alignment flags in many cases.
1563Reindenting using a different method like |gq| or |=| will not consult
1564alignment flags either. The same behaviour can be defined in those other
1565formatting options. One consideration is that 'cindent' has additional options
1566for context based indenting of comments but cannot replicate many three piece
Bram Moolenaar446beb42011-05-10 17:18:44 +02001567indent alignments. However, 'indentexpr' has the ability to work better with
1568three piece comments.
Bram Moolenaar446cb832008-06-24 21:56:24 +00001569
1570Other examples: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001571 "b:*" Includes lines starting with "*", but not if the "*" is
1572 followed by a non-blank. This avoids a pointer dereference
1573 like "*str" to be recognized as a comment.
1574 "n:>" Includes a line starting with ">", ">>", ">>>", etc.
1575 "fb:-" Format a list that starts with "- ".
1576
1577By default, "b:#" is included. This means that a line that starts with
1578"#include" is not recognized as a comment line. But a line that starts with
1579"# define" is recognized. This is a compromise.
1580
Bram Moolenaar071d4272004-06-13 20:20:40 +00001581{not available when compiled without the |+comments| feature}
1582
1583 *fo-table*
1584You can use the 'formatoptions' option to influence how Vim formats text.
1585'formatoptions' is a string that can contain any of the letters below. The
1586default setting is "tcq". You can separate the option letters with commas for
1587readability.
1588
1589letter meaning when present in 'formatoptions' ~
1590
Bram Moolenaar9964e462007-05-05 17:54:07 +00001591t Auto-wrap text using textwidth
Bram Moolenaar071d4272004-06-13 20:20:40 +00001592c Auto-wrap comments using textwidth, inserting the current comment
1593 leader automatically.
1594r Automatically insert the current comment leader after hitting
1595 <Enter> in Insert mode.
1596o Automatically insert the current comment leader after hitting 'o' or
1597 'O' in Normal mode.
1598q Allow formatting of comments with "gq".
1599 Note that formatting will not change blank lines or lines containing
1600 only the comment leader. A new paragraph starts after such a line,
1601 or when the comment leader changes.
1602w Trailing white space indicates a paragraph continues in the next line.
1603 A line that ends in a non-white character ends a paragraph.
1604a Automatic formatting of paragraphs. Every time text is inserted or
1605 deleted the paragraph will be reformatted. See |auto-format|.
1606 When the 'c' flag is present this only happens for recognized
1607 comments.
Bram Moolenaar86b68352004-12-27 21:59:20 +00001608n When formatting text, recognize numbered lists. This actually uses
1609 the 'formatlistpat' option, thus any kind of list can be used. The
1610 indent of the text after the number is used for the next line. The
Bram Moolenaar446cb832008-06-24 21:56:24 +00001611 default is to find a number, optionally followed by '.', ':', ')',
Bram Moolenaar86b68352004-12-27 21:59:20 +00001612 ']' or '}'. Note that 'autoindent' must be set too. Doesn't work
1613 well together with "2".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001614 Example: >
1615 1. the first item
1616 wraps
1617 2. the second item
16182 When formatting text, use the indent of the second line of a paragraph
1619 for the rest of the paragraph, instead of the indent of the first
1620 line. This supports paragraphs in which the first line has a
1621 different indent than the rest. Note that 'autoindent' must be set
1622 too. Example: >
1623 first line of a paragraph
1624 second line of the same paragraph
1625 third line.
Bram Moolenaar30b65812012-07-12 22:01:11 +02001626< This also works inside comments, ignoring the comment leader.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001627v Vi-compatible auto-wrapping in insert mode: Only break a line at a
1628 blank that you have entered during the current insert command. (Note:
1629 this is not 100% Vi compatible. Vi has some "unexpected features" or
1630 bugs in this area. It uses the screen column instead of the line
1631 column.)
1632b Like 'v', but only auto-wrap if you enter a blank at or before
1633 the wrap margin. If the line was longer than 'textwidth' when you
1634 started the insert, or you do not enter a blank in the insert before
1635 reaching 'textwidth', Vim does not perform auto-wrapping.
1636l Long lines are not broken in insert mode: When a line was longer than
1637 'textwidth' when the insert command started, Vim does not
1638 automatically format it.
1639m Also break at a multi-byte character above 255. This is useful for
1640 Asian text where every character is a word on its own.
1641M When joining lines, don't insert a space before or after a multi-byte
1642 character. Overrules the 'B' flag.
1643B When joining lines, don't insert a space between two multi-byte
1644 characters. Overruled by the 'M' flag.
16451 Don't break a line after a one-letter word. It's broken before it
1646 instead (if possible).
Bram Moolenaar81340392012-06-06 16:12:59 +02001647j Where it makes sense, remove a comment leader when joining lines. For
1648 example, joining:
1649 int i; // the index ~
1650 // in the list ~
1651 Becomes:
1652 int i; // the index in the list ~
Bram Moolenaar071d4272004-06-13 20:20:40 +00001653
1654
1655With 't' and 'c' you can specify when Vim performs auto-wrapping:
1656value action ~
1657"" no automatic formatting (you can use "gq" for manual formatting)
1658"t" automatic formatting of text, but not comments
1659"c" automatic formatting for comments, but not text (good for C code)
1660"tc" automatic formatting for text and comments
1661
Bram Moolenaar91170f82006-05-05 21:15:17 +00001662Note that when 'textwidth' is 0, Vim does no automatic formatting anyway (but
1663does insert comment leaders according to the 'comments' option). An exception
1664is when the 'a' flag is present. |auto-format|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001665
1666Note that when 'paste' is on, Vim does no formatting at all.
1667
1668Note that 'textwidth' can be non-zero even if Vim never performs auto-wrapping;
1669'textwidth' is still useful for formatting with "gq".
1670
1671If the 'comments' option includes "/*", "*" and/or "*/", then Vim has some
1672built in stuff to treat these types of comments a bit more cleverly.
1673Opening a new line before or after "/*" or "*/" (with 'r' or 'o' present in
1674'formatoptions') gives the correct start of the line automatically. The same
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00001675happens with formatting and auto-wrapping. Opening a line after a line
Bram Moolenaar071d4272004-06-13 20:20:40 +00001676starting with "/*" or "*" and containing "*/", will cause no comment leader to
1677be inserted, and the indent of the new line is taken from the line containing
1678the start of the comment.
1679E.g.:
1680 /* ~
1681 * Your typical comment. ~
1682 */ ~
1683 The indent on this line is the same as the start of the above
1684 comment.
1685
1686All of this should be really cool, especially in conjunction with the new
1687:autocmd command to prepare different settings for different types of file.
1688
1689Some examples:
1690 for C code (only format comments): >
1691 :set fo=croq
1692< for Mail/news (format all, don't start comment with "o" command): >
1693 :set fo=tcrq
1694<
1695
Bram Moolenaard38b0552012-04-25 19:07:41 +02001696Automatic formatting *auto-format* *autoformat*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001697
1698When the 'a' flag is present in 'formatoptions' text is formatted
1699automatically when inserting text or deleting text. This works nice for
1700editing text paragraphs. A few hints on how to use this:
1701
1702- You need to properly define paragraphs. The simplest is paragraphs that are
1703 separated by a blank line. When there is no separating blank line, consider
1704 using the 'w' flag and adding a space at the end of each line in the
1705 paragraphs except the last one.
1706
1707- You can set the 'formatoptions' based on the type of file |filetype| or
1708 specifically for one file with a |modeline|.
1709
1710- Set 'formatoptions' to "aw2tq" to make text with indents like this:
1711
1712 bla bla foobar bla
1713 bla foobar bla foobar bla
1714 bla bla foobar bla
1715 bla foobar bla bla foobar
1716
1717- Add the 'c' flag to only auto-format comments. Useful in source code.
1718
Bram Moolenaar91170f82006-05-05 21:15:17 +00001719- Set 'textwidth' to the desired width. If it is zero then 79 is used, or the
1720 width of the screen if this is smaller.
1721
Bram Moolenaar071d4272004-06-13 20:20:40 +00001722And a few warnings:
1723
1724- When part of the text is not properly separated in paragraphs, making
1725 changes in this text will cause it to be formatted anyway. Consider doing >
1726
1727 :set fo-=a
1728
1729- When using the 'w' flag (trailing space means paragraph continues) and
1730 deleting the last line of a paragraph with |dd|, the paragraph will be
1731 joined with the next one.
1732
1733- Changed text is saved for undo. Formatting is also a change. Thus each
1734 format action saves text for undo. This may consume quite a lot of memory.
1735
1736- Formatting a long paragraph and/or with complicated indenting may be slow.
1737
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00001738==============================================================================
17397. Sorting text *sorting*
1740
1741Vim has a sorting function and a sorting command. The sorting function can be
Bram Moolenaar327aa022014-03-25 18:24:23 +01001742found here: |sort()|, |uniq()|.
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00001743
1744 *:sor* *:sort*
Bram Moolenaarf7edf402016-01-19 23:36:15 +01001745:[range]sor[t][!] [b][f][i][n][o][r][u][x] [/{pattern}/]
Bram Moolenaare5180522005-12-10 20:19:46 +00001746 Sort lines in [range]. When no range is given all
1747 lines are sorted.
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00001748
1749 With [!] the order is reversed.
1750
1751 With [i] case is ignored.
1752
Bram Moolenaarf7edf402016-01-19 23:36:15 +01001753 Options [n][f][x][o][b] are mutually exclusive.
1754
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001755 With [n] sorting is done on the first decimal number
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00001756 in the line (after or inside a {pattern} match).
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001757 One leading '-' is included in the number.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001758
Bram Moolenaarf7edf402016-01-19 23:36:15 +01001759 With [f] sorting is done on the Float in the line.
1760 The value of Float is determined similar to passing
1761 the text (after or inside a {pattern} match) to
1762 str2float() function. This option is available only
1763 if Vim was compiled with Floating point support.
1764
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001765 With [x] sorting is done on the first hexadecimal
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00001766 number in the line (after or inside a {pattern}
1767 match). A leading "0x" or "0X" is ignored.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00001768 One leading '-' is included in the number.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001769
1770 With [o] sorting is done on the first octal number in
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00001771 the line (after or inside a {pattern} match).
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001772
Bram Moolenaar887c1fe2016-01-02 17:56:35 +01001773 With [b] sorting is done on the first binary number in
1774 the line (after or inside a {pattern} match).
1775
Bram Moolenaarf7edf402016-01-19 23:36:15 +01001776 With [u] (u stands for unique) only keep the first of
1777 a sequence of identical lines (ignoring case when [i]
1778 is used). Without this flag, a sequence of identical
1779 lines will be kept in their original order.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001780 Note that leading and trailing white space may cause
1781 lines to be different.
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00001782
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00001783 When /{pattern}/ is specified and there is no [r] flag
1784 the text matched with {pattern} is skipped, so that
1785 you sort on what comes after the match.
Bram Moolenaar2389c3c2005-05-22 22:07:59 +00001786 Instead of the slash any non-letter can be used.
1787 For example, to sort on the second comma-separated
1788 field: >
1789 :sort /[^,]*,/
1790< To sort on the text at virtual column 10 (thus
1791 ignoring the difference between tabs and spaces): >
1792 :sort /.*\%10v/
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001793< To sort on the first number in the line, no matter
1794 what is in front of it: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00001795 :sort /.\{-}\ze\d/
1796< (Explanation: ".\{-}" matches any text, "\ze" sets the
1797 end of the match and \d matches a digit.)
1798 With [r] sorting is done on the matching {pattern}
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00001799 instead of skipping past it as described above.
1800 For example, to sort on only the first three letters
1801 of each line: >
1802 :sort /\a\a\a/ r
1803
1804< If a {pattern} is used, any lines which don't have a
1805 match for {pattern} are kept in their current order,
1806 but separate from the lines which do match {pattern}.
1807 If you sorted in reverse, they will be in reverse
1808 order after the sorted lines, otherwise they will be
1809 in their original order, right before the sorted
1810 lines.
1811
Bram Moolenaar1256e722007-07-10 15:26:20 +00001812 If {pattern} is empty (e.g. // is specified), the
1813 last search pattern is used. This allows trying out
1814 a pattern first.
1815
Bram Moolenaard38b0552012-04-25 19:07:41 +02001816Note that using `:sort` with `:global` doesn't sort the matching lines, it's
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00001817quite useless.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001818
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00001819The details about sorting depend on the library function used. There is no
Bram Moolenaar8bb1c3e2014-07-04 16:43:17 +02001820guarantee that sorting obeys the current locale. You will have to try it out.
1821Vim does do a "stable" sort.
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00001822
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00001823The sorting can be interrupted, but if you interrupt it too late in the
1824process you may end up with duplicated lines. This also depends on the system
1825library function used.
Bram Moolenaarae5bce12005-08-15 21:41:48 +00001826
Bram Moolenaar071d4272004-06-13 20:20:40 +00001827 vim:tw=78:ts=8:ft=help:norl: