|
168
|
1 *change.txt* For Vim version 7.0aa. Last change: 2005 Feb 21
|
|
7
|
2
|
|
|
3
|
|
|
4 VIM REFERENCE MANUAL by Bram Moolenaar
|
|
|
5
|
|
|
6
|
|
|
7 This file describes commands that delete or change text. In this context,
|
|
|
8 changing text means deleting the text and replacing it with other text using
|
|
|
9 one command. You can undo all of these commands. You can repeat the non-Ex
|
|
|
10 commands with the "." command.
|
|
|
11
|
|
|
12 1. Deleting text |deleting|
|
|
|
13 2. Delete and insert |delete-insert|
|
|
|
14 3. Simple changes |simple-change| *changing*
|
|
|
15 4. Complex changes |complex-change|
|
|
32
|
16 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|
|
|
7
|
20 5. Copying and moving text |copy-move|
|
|
|
21 6. Formatting text |formatting|
|
|
|
22
|
|
|
23 For inserting text see |insert.txt|.
|
|
|
24
|
|
|
25 ==============================================================================
|
|
|
26 1. Deleting text *deleting* *E470*
|
|
|
27
|
|
|
28 ["x]<Del> or *<Del>* *x* *dl*
|
|
|
29 ["x]x Delete [count] characters under and after the cursor
|
|
|
30 [into register x] (not |linewise|). Does the same as
|
|
|
31 "dl".
|
|
|
32 The <Del> key does not take a [count]. Instead, it
|
|
|
33 deletes the last character of the count.
|
|
|
34 See |:fixdel| if the <Del> key does not do what you
|
|
|
35 want. See |'whichwrap'| for deleting a line break
|
|
|
36 (join lines). {Vi does not support <Del>}
|
|
|
37
|
|
|
38 *X* *dh*
|
|
|
39 ["x]X Delete [count] characters before the cursor [into
|
|
|
40 register x] (not |linewise|). Does the same as "dh".
|
|
|
41 Also see |'whichwrap'|.
|
|
|
42
|
|
|
43 *d*
|
|
|
44 ["x]d{motion} Delete text that {motion} moves over [into register
|
|
|
45 x]. See below for exceptions.
|
|
|
46
|
|
|
47 *dd*
|
|
|
48 ["x]dd Delete [count] lines [into register x] |linewise|.
|
|
|
49
|
|
|
50 *D*
|
|
|
51 ["x]D Delete the characters under the cursor until the end
|
|
|
52 of the line and [count]-1 more lines [into register
|
|
|
53 x]; synonym for "d$".
|
|
|
54 (not |linewise|)
|
|
164
|
55 When the '#' flag is in 'cpoptions' the count is
|
|
|
56 ignored.
|
|
7
|
57
|
|
|
58 {Visual}["x]x or *v_x* *v_d* *v_<Del>*
|
|
|
59 {Visual}["x]d or
|
|
|
60 {Visual}["x]<Del> Delete the highlighted text [into register x] (for
|
|
|
61 {Visual} see |Visual-mode|). {not in Vi}
|
|
|
62
|
|
|
63 {Visual}["x]CTRL-H or *v_CTRL-H* *v_<BS>*
|
|
|
64 {Visual}["x]<BS> When in Select mode: Delete the highlighted text [into
|
|
|
65 register x].
|
|
|
66
|
|
|
67 {Visual}["x]X or *v_X* *v_D* *v_b_D*
|
|
|
68 {Visual}["x]D Delete the highlighted lines [into register x] (for
|
|
|
69 {Visual} see |Visual-mode|). In Visual block mode,
|
|
|
70 "D" deletes the highlighted text plus all text until
|
|
|
71 the end of the line. {not in Vi}
|
|
|
72
|
|
|
73 *:d* *:de* *:del* *:delete*
|
|
|
74 :[range]d[elete] [x] Delete [range] lines (default: current line) [into
|
|
|
75 register x].
|
|
|
76
|
|
|
77 :[range]d[elete] [x] {count}
|
|
|
78 Delete {count} lines, starting with [range]
|
|
|
79 (default: current line |cmdline-ranges|) [into
|
|
|
80 register x].
|
|
|
81
|
|
|
82 These commands delete text. You can repeat them with the "." command
|
|
|
83 (except ":d") and undo them. Use Visual mode to delete blocks of text. See
|
|
|
84 |registers| for an explanation of registers.
|
|
|
85
|
|
|
86 An exception for the d{motion} command: If the motion is not linewise, the
|
|
|
87 start and end of the motion are not in the same line, and there are only
|
|
|
88 blanks before the start and after the end of the motion, the delete becomes
|
|
|
89 linewise. This means that the delete also removes the line of blanks that you
|
|
|
90 might expect to remain.
|
|
|
91
|
|
|
92 Trying to delete an empty region of text (e.g., "d0" in the first column)
|
|
|
93 is an error when 'cpoptions' includes the 'E' flag.
|
|
|
94
|
|
|
95 *J*
|
|
|
96 J Join [count] lines, with a minimum of two lines.
|
|
|
97 Remove the indent and insert up to two spaces (see
|
|
|
98 below).
|
|
|
99
|
|
|
100 *v_J*
|
|
|
101 {Visual}J Join the highlighted lines, with a minimum of two
|
|
|
102 lines. Remove the indent and insert up to two spaces
|
|
|
103 (see below). {not in Vi}
|
|
|
104
|
|
|
105 *gJ*
|
|
|
106 gJ Join [count] lines, with a minimum of two lines.
|
|
|
107 Don't insert or remove any spaces. {not in Vi}
|
|
|
108
|
|
|
109 *v_gJ*
|
|
|
110 {Visual}gJ Join the highlighted lines, with a minimum of two
|
|
|
111 lines. Don't insert or remove any spaces. {not in
|
|
|
112 Vi}
|
|
|
113
|
|
|
114 *:j* *:join*
|
|
168
|
115 :[range]j[oin][!] [flags]
|
|
|
116 Join [range] lines. Same as "J", except with [!]
|
|
7
|
117 the join does not insert or delete any spaces.
|
|
|
118 If a [range] has equal start and end values, this
|
|
|
119 command does nothing. The default behavior is to
|
|
|
120 join the current line with the line below it.
|
|
|
121 {not in Vi: !}
|
|
168
|
122 See |ex-flags| for [flags].
|
|
7
|
123
|
|
168
|
124 :[range]j[oin][!] {count} [flags]
|
|
7
|
125 Join {count} lines, starting with [range] (default:
|
|
|
126 current line |cmdline-ranges|). Same as "J", except
|
|
|
127 with [!] the join does not insert or delete any
|
|
|
128 spaces.
|
|
|
129 {not in Vi: !}
|
|
168
|
130 See |ex-flags| for [flags].
|
|
7
|
131
|
|
|
132 These commands delete the <EOL> between lines. This has the effect of joining
|
|
|
133 multiple lines into one line. You can repeat these commands (except ":j") and
|
|
|
134 undo them.
|
|
|
135
|
|
|
136 These commands, except "gJ", insert one space in place of the <EOL> unless
|
|
|
137 there is trailing white space or the next line starts with a ')'. These
|
|
|
138 commands, except "gJ", delete any leading white space on the next line. If
|
|
|
139 the 'joinspaces' option is on, these commands insert two spaces after a '.',
|
|
|
140 '!' or '?' (but if 'cpoptions' includes the 'j' flag, they insert two spaces
|
|
|
141 only after a '.').
|
|
|
142 The 'B' and 'M' flags in 'formatoptions' change the behavior for inserting
|
|
|
143 spaces before and after a multi-byte character |fo-table|.
|
|
|
144
|
|
|
145
|
|
|
146 ==============================================================================
|
|
|
147 2. Delete and insert *delete-insert* *replacing*
|
|
|
148
|
|
|
149 *R*
|
|
|
150 R Enter Replace mode: Each character you type replaces
|
|
|
151 an existing character, starting with the character
|
|
|
152 under the cursor. Repeat the entered text [count]-1
|
|
|
153 times. See |Replace-mode| for more details.
|
|
|
154
|
|
|
155 *gR*
|
|
|
156 gR Enter Virtual Replace mode: Each character you type
|
|
|
157 replaces existing characters in screen space. So a
|
|
|
158 <Tab> may replace several characters at once.
|
|
|
159 Repeat the entered text [count]-1 times. See
|
|
|
160 |Virtual-Replace-mode| for more details.
|
|
|
161 {not available when compiled without the +vreplace
|
|
|
162 feature}
|
|
|
163
|
|
|
164 *c*
|
|
|
165 ["x]c{motion} Delete {motion} text [into register x] and start
|
|
|
166 insert. When 'cpoptions' includes the 'E' flag and
|
|
|
167 there is no text to delete (e.g., with "cTx" when the
|
|
|
168 cursor is just after an 'x'), an error occurs and
|
|
|
169 insert mode does not start (this is Vi compatible).
|
|
|
170 When 'cpoptions' does not include the 'E' flag, the
|
|
|
171 "c" command always starts insert mode, even if there
|
|
|
172 is no text to delete.
|
|
|
173
|
|
|
174 *cc*
|
|
|
175 ["x]cc Delete [count] lines [into register x] and start
|
|
|
176 insert |linewise|. If 'autoindent' is on, preserve
|
|
|
177 the indent of the first line.
|
|
|
178
|
|
|
179 *C*
|
|
|
180 ["x]C Delete from the cursor position to the end of the
|
|
|
181 line and [count]-1 more lines [into register x], and
|
|
|
182 start insert. Synonym for c$ (not |linewise|).
|
|
|
183
|
|
|
184 *s*
|
|
|
185 ["x]s Delete [count] characters [into register x] and start
|
|
|
186 insert (s stands for Substitute). Synonym for "cl"
|
|
|
187 (not |linewise|).
|
|
|
188
|
|
|
189 *S*
|
|
|
190 ["x]S Delete [count] lines [into register x] and start
|
|
|
191 insert. Synonym for "cc" |linewise|.
|
|
|
192
|
|
|
193 {Visual}["x]c or *v_c* *v_s*
|
|
|
194 {Visual}["x]s Delete the highlighted text [into register x] and
|
|
|
195 start insert (for {Visual} see |Visual-mode|). {not
|
|
|
196 in Vi}
|
|
|
197
|
|
|
198 *v_r*
|
|
|
199 {Visual}["x]r{char} Replace all selected characters by {char}.
|
|
|
200
|
|
|
201 *v_C*
|
|
|
202 {Visual}["x]C Delete the highlighted lines [into register x] and
|
|
|
203 start insert. In Visual block mode it works
|
|
|
204 differently |v_b_C|. {not in Vi}
|
|
|
205 *v_S*
|
|
|
206 {Visual}["x]S Delete the highlighted lines [into register x] and
|
|
|
207 start insert (for {Visual} see |Visual-mode|). {not
|
|
|
208 in Vi}
|
|
|
209 *v_R*
|
|
|
210 {Visual}["x]R Currently just like {Visual}["x]S. In a next version
|
|
|
211 it might work differently. {not in Vi}
|
|
|
212
|
|
|
213 Notes:
|
|
|
214 - You can end Insert and Replace mode with <Esc>.
|
|
|
215 - See the section "Insert and Replace mode" |mode-ins-repl| for the other
|
|
|
216 special characters in these modes.
|
|
|
217 - The effect of [count] takes place after Vim exits Insert or Replace mode.
|
|
|
218 - When the 'cpoptions' option contains '$' and the change is within one line,
|
|
|
219 Vim continues to show the text to be deleted and puts a '$' at the last
|
|
|
220 deleted character.
|
|
|
221
|
|
|
222 See |registers| for an explanation of registers.
|
|
|
223
|
|
|
224 Replace mode is just like Insert mode, except that every character you enter
|
|
|
225 deletes one character. If you reach the end of a line, Vim appends any
|
|
|
226 further characters (just like Insert mode). In Replace mode, the backspace
|
|
|
227 key restores the original text (if there was any). (See section "Insert and
|
|
|
228 Replace mode" |mode-ins-repl|).
|
|
|
229
|
|
|
230 *cw* *cW*
|
|
|
231 Special case: "cw" and "cW" work the same as "ce" and "cE" if the cursor is
|
|
|
232 on a non-blank. This is because Vim interprets "cw" as change-word, and a
|
|
|
233 word does not include the following white space. {Vi: "cw" when on a blank
|
|
|
234 followed by other blanks changes only the first blank; this is probably a
|
|
|
235 bug, because "dw" deletes all the blanks; use the 'w' flag in 'cpoptions' to
|
|
|
236 make it work like Vi anyway}
|
|
|
237
|
|
|
238 If you prefer "cw" to include the space after a word, use this mapping: >
|
|
|
239 :map cw dwi
|
|
|
240 <
|
|
|
241 *:c* *:ch* *:change*
|
|
168
|
242 :{range}c[hange][!] Replace lines of text with some different text.
|
|
7
|
243 Type a line containing only "." to stop replacing.
|
|
|
244 Without {range}, this command changes only the current
|
|
|
245 line.
|
|
168
|
246 Adding [!] toggles 'autoindent' for the time this
|
|
|
247 command is executed.
|
|
7
|
248
|
|
|
249 ==============================================================================
|
|
|
250 3. Simple changes *simple-change*
|
|
|
251
|
|
|
252 *r*
|
|
|
253 r{char} Replace the character under the cursor with {char}.
|
|
|
254 If {char} is a <CR> or <NL>, a line break replaces the
|
|
|
255 character. To replace with a real <CR>, use CTRL-V
|
|
|
256 <CR>. CTRL-V <NL> replaces with a <Nul>.
|
|
|
257 {Vi: CTRL-V <CR> still replaces with a line break,
|
|
|
258 cannot replace something with a <CR>}
|
|
|
259 If you give a [count], Vim replaces [count] characters
|
|
|
260 with [count] {char}s. When {char} is a <CR> or <NL>,
|
|
|
261 however, Vim inserts only one <CR>: "5r<CR>" replaces
|
|
|
262 five characters with a single line break.
|
|
|
263 When {char} is a <CR> or <NL>, Vim performs
|
|
|
264 autoindenting. This works just like deleting the
|
|
|
265 characters that are replaced and then doing
|
|
|
266 "i<CR><Esc>".
|
|
|
267 {char} can be entered as a digraph |digraph-arg|.
|
|
|
268 |:lmap| mappings apply to {char}. The CTRL-^ command
|
|
|
269 in Insert mode can be used to switch this on/off
|
|
|
270 |i_CTRL-^|. See |utf-8-char-arg| about using
|
|
|
271 composing characters when 'encoding' is Unicode.
|
|
|
272
|
|
|
273 *gr*
|
|
|
274 gr{char} Replace the virtual characters under the cursor with
|
|
|
275 {char}. This replaces in screen space, not file
|
|
|
276 space. See |gR| and |Virtual-Replace-mode| for more
|
|
|
277 details. As with |r| a count may be given.
|
|
|
278 {char} can be entered like with |r|.
|
|
|
279 {not available when compiled without the +vreplace
|
|
|
280 feature}
|
|
|
281
|
|
|
282 *digraph-arg*
|
|
|
283 The argument for Normal mode commands like |r| and |t| is a single character.
|
|
|
284 When 'cpo' doesn't contain the 'D' flag, this character can also be entered
|
|
|
285 like |digraphs|. First type CTRL-K and then the two digraph characters.
|
|
|
286 {not available when compiled without the |+digraphs| feature}
|
|
|
287
|
|
|
288 *case*
|
|
|
289 The following commands change the case of letters. The currently active
|
|
|
290 |locale| is used. See |:language|. The LC_CTYPE value matters here.
|
|
|
291
|
|
|
292 *~*
|
|
|
293 ~ 'notildeop' option: Switch case of the character
|
|
|
294 under the cursor and move the cursor to the right.
|
|
|
295 If a [count] is given, do that many characters. {Vi:
|
|
|
296 no count}
|
|
|
297
|
|
|
298 ~{motion} 'tildeop' option: switch case of {motion} text. {Vi:
|
|
|
299 tilde cannot be used as an operator}
|
|
|
300
|
|
|
301 *g~*
|
|
|
302 g~{motion} Switch case of {motion} text. {not in Vi}
|
|
|
303
|
|
|
304 g~g~ *g~g~* *g~~*
|
|
|
305 g~~ Switch case of current line. {not in Vi}.
|
|
|
306
|
|
|
307 *v_~*
|
|
|
308 {Visual}~ Switch case of highlighted text (for {Visual} see
|
|
|
309 |Visual-mode|). {not in Vi}
|
|
|
310
|
|
|
311 *v_U*
|
|
|
312 {Visual}U Make highlighted text uppercase (for {Visual} see
|
|
|
313 |Visual-mode|). {not in Vi}
|
|
|
314
|
|
|
315 *gU* *uppercase*
|
|
|
316 gU{motion} Make {motion} text uppercase. {not in Vi}
|
|
|
317 Example: >
|
|
|
318 :map! <C-F> <Esc>gUiw`]a
|
|
|
319 < This works in Insert mode: press CTRL-F to make the
|
|
|
320 word before the cursor uppercase. Handy to type
|
|
|
321 words in lowercase and then make them uppercase.
|
|
|
322
|
|
|
323
|
|
|
324 gUgU *gUgU* *gUU*
|
|
|
325 gUU Make current line uppercase. {not in Vi}.
|
|
|
326
|
|
|
327 *v_u*
|
|
|
328 {Visual}u Make highlighted text lowercase (for {Visual} see
|
|
|
329 |Visual-mode|). {not in Vi}
|
|
|
330
|
|
|
331 *gu* *lowercase*
|
|
|
332 gu{motion} Make {motion} text lowercase. {not in Vi}
|
|
|
333
|
|
|
334 gugu *gugu* *guu*
|
|
|
335 guu Make current line lowercase. {not in Vi}.
|
|
|
336
|
|
|
337 *g?* *rot13*
|
|
|
338 g?{motion} Rot13 encode {motion} text. {not in Vi}
|
|
|
339
|
|
|
340 *v_g?*
|
|
|
341 {Visual}g? Rot13 encode the highlighted text (for {Visual} see
|
|
|
342 |Visual-mode|). {not in Vi}
|
|
|
343
|
|
|
344 g?g? *g?g?* *g??*
|
|
|
345 g?? Rot13 encode current line. {not in Vi}.
|
|
|
346
|
|
|
347
|
|
|
348 Adding and subtracting ~
|
|
|
349 *CTRL-A*
|
|
|
350 CTRL-A Add [count] to the number or alphabetic character at
|
|
|
351 or after the cursor. {not in Vi}
|
|
|
352
|
|
|
353 *CTRL-X*
|
|
|
354 CTRL-X Subtract [count] from the number or alphabetic
|
|
|
355 character at or after the cursor. {not in Vi}
|
|
|
356
|
|
|
357 The CTRL-A and CTRL-X commands work for (signed) decimal numbers, unsigned
|
|
|
358 octal and hexadecimal numbers and alphabetic characters. This depends on the
|
|
|
359 'nrformats' option.
|
|
36
|
360 - When 'nrformats' includes "octal", Vim considers numbers starting with a '0'
|
|
39
|
361 to be octal, unless the number includes a '8' or '9'. Other numbers are
|
|
|
362 decimal and may have a preceding minus sign.
|
|
36
|
363 If the cursor is on a number, the commands apply to that number; otherwise
|
|
|
364 Vim uses the number to the right of the cursor.
|
|
7
|
365 - When 'nrformats' includes "hex", Vim assumes numbers starting with '0x' or
|
|
|
366 '0X' are hexadecimal. The case of the rightmost letter in the number
|
|
|
367 determines the case of the resulting hexadecimal number. If there is no
|
|
|
368 letter in the current number, Vim uses the previously detected case.
|
|
36
|
369 - When 'nrformats' includes "alpha", Vim will change the alphabetic character
|
|
|
370 under or after the cursor. This is useful to make lists with an alphabetic
|
|
|
371 index.
|
|
7
|
372
|
|
|
373 For numbers with leading zeros (including all octal and hexadecimal numbers),
|
|
|
374 Vim preserves the number of characters in the number when possible. CTRL-A on
|
|
36
|
375 "0077" results in "0100", CTRL-X on "0x100" results in "0x0ff".
|
|
39
|
376 There is one exception: When a number that starts with a zero is found not to
|
|
|
377 be octal (it contains a '8' or '9'), but 'nrformats' does include "octal",
|
|
|
378 leading zeros are removed to avoid that the result may be recognized as an
|
|
|
379 octal number.
|
|
36
|
380
|
|
|
381 Note that when 'nrformats' includes "octal", decimal numbers with leading
|
|
39
|
382 zeros cause mistakes, because they can be confused with octal numbers.
|
|
7
|
383
|
|
|
384 The CTRL-A command is very useful in a macro. Example: Use the following
|
|
|
385 steps to make a numbered list.
|
|
|
386
|
|
|
387 1. Create the first list entry, make sure it starts with a number.
|
|
99
|
388 2. qa - start recording into register 'a'
|
|
7
|
389 3. Y - yank the entry
|
|
|
390 4. p - put a copy of the entry below the first one
|
|
|
391 5. CTRL-A - increment the number
|
|
|
392 6. q - stop recording
|
|
|
393 7. <count>@a - repeat the yank, put and increment <count> times
|
|
|
394
|
|
|
395
|
|
|
396 SHIFTING LINES LEFT OR RIGHT *shift-left-right*
|
|
|
397
|
|
|
398 *<*
|
|
|
399 <{motion} Shift {motion} lines one 'shiftwidth' leftwards.
|
|
|
400
|
|
|
401 *<<*
|
|
|
402 << Shift [count] lines one 'shiftwidth' leftwards.
|
|
|
403
|
|
|
404 *v_<*
|
|
|
405 {Visual}[count]< Shift the highlighted lines [count] 'shiftwidth'
|
|
|
406 leftwards (for {Visual} see |Visual-mode|). {not in
|
|
|
407 Vi}
|
|
|
408
|
|
|
409 *>*
|
|
|
410 >{motion} Shift {motion} lines one 'shiftwidth' rightwards.
|
|
|
411
|
|
|
412 *>>*
|
|
|
413 >> Shift [count] lines one 'shiftwidth' rightwards.
|
|
|
414
|
|
|
415 *v_>*
|
|
|
416 {Visual}[count]> Shift the highlighted lines [count] 'shiftwidth'
|
|
|
417 rightwards (for {Visual} see |Visual-mode|). {not in
|
|
|
418 Vi}
|
|
|
419
|
|
|
420 *:<*
|
|
|
421 :[range]< Shift [range] lines one 'shiftwidth' left. Repeat '<'
|
|
|
422 for shifting multiple 'shiftwidth's.
|
|
|
423
|
|
|
424 :[range]< {count} Shift {count} lines one 'shiftwidth' left, starting
|
|
|
425 with [range] (default current line |cmdline-ranges|).
|
|
|
426 Repeat '<' for shifting multiple 'shiftwidth's.
|
|
|
427
|
|
|
428 :[range]le[ft] [indent] left align lines in [range]. Sets the indent in the
|
|
|
429 lines to [indent] (default 0). {not in Vi}
|
|
|
430
|
|
|
431 *:>*
|
|
168
|
432 :[range]> [flags] Shift {count} [range] lines one 'shiftwidth' right.
|
|
7
|
433 Repeat '>' for shifting multiple 'shiftwidth's.
|
|
168
|
434 See |ex-flags| for [flags].
|
|
7
|
435
|
|
168
|
436 :[range]> {count} [flags]
|
|
|
437 Shift {count} lines one 'shiftwidth' right, starting
|
|
7
|
438 with [range] (default current line |cmdline-ranges|).
|
|
|
439 Repeat '>' for shifting multiple 'shiftwidth's.
|
|
168
|
440 See |ex-flags| for [flags].
|
|
7
|
441
|
|
|
442 The ">" and "<" commands are handy for changing the indentation within
|
|
|
443 programs. Use the 'shiftwidth' option to set the size of the white space
|
|
|
444 which these commands insert or delete. Normally the 'shiftwidth' option is 8,
|
|
|
445 but you can set it to, say, 3 to make smaller indents. The shift leftwards
|
|
|
446 stops when there is no indent. The shift right does not affect empty lines.
|
|
|
447
|
|
|
448 If the 'shiftround' option is on, the indent is rounded to a multiple of
|
|
|
449 'shiftwidth'.
|
|
|
450
|
|
|
451 If the 'smartindent' option is on, or 'cindent' is on and 'cinkeys' contains
|
|
|
452 '#', shift right does not affect lines starting with '#' (these are supposed
|
|
|
453 to be C preprocessor lines that must stay in column 1).
|
|
|
454
|
|
|
455 When the 'expandtab' option is off (this is the default) Vim uses <Tab>s as
|
|
|
456 much as possible to make the indent. You can use ">><<" to replace an indent
|
|
|
457 made out of spaces with the same indent made out of <Tab>s (and a few spaces
|
|
|
458 if necessary). If the 'expandtab' option is on, Vim uses only spaces. Then
|
|
|
459 you can use ">><<" to replace <Tab>s in the indent by spaces (or use
|
|
|
460 ":retab!").
|
|
|
461
|
|
|
462 To move a line several 'shiftwidth's, use Visual mode or the ":" commands.
|
|
|
463 For example: >
|
|
|
464 Vjj4> move three lines 4 indents to the right
|
|
|
465 :<<< move current line 3 indents to the left
|
|
|
466 :>> 5 move 5 lines 2 indents to the right
|
|
|
467 :5>> move line 5 2 indents to the right
|
|
|
468
|
|
|
469 ==============================================================================
|
|
|
470 4. Complex changes *complex-change*
|
|
|
471
|
|
32
|
472 4.1 Filter commands *filter*
|
|
|
473
|
|
|
474 A filter is a program that accepts text at standard input, changes it in some
|
|
|
475 way, and sends it to standard output. You can use the commands below to send
|
|
|
476 some text through a filter, so that it is replace by the filter output.
|
|
|
477 Examples of filters are "sort", which sorts lines alphabetically, and
|
|
|
478 "indent", which formats C program files (you need a version of indent that
|
|
|
479 works like a filter; not all versions do). The 'shell' option specifies the
|
|
|
480 shell Vim uses to execute the filter command (See also the 'shelltype'
|
|
|
481 option). You can repeat filter commands with ".". Vim does not recognize a
|
|
|
482 comment (starting with '"') after the ":!" command.
|
|
|
483
|
|
|
484 *!*
|
|
7
|
485 !{motion}{filter} Filter {motion} text lines through the external
|
|
|
486 program {filter}.
|
|
|
487
|
|
|
488 *!!*
|
|
|
489 !!{filter} Filter [count] lines through the external program
|
|
|
490 {filter}.
|
|
|
491
|
|
|
492 *v_!*
|
|
|
493 {Visual}!{filter} Filter the highlighted lines through the external
|
|
|
494 program {filter} (for {Visual} see |Visual-mode|).
|
|
|
495 {not in Vi}
|
|
|
496
|
|
|
497 :{range}![!]{filter} [!][arg] *:range!*
|
|
|
498 Filter {range} lines through the external program
|
|
|
499 {filter}. Vim replaces the optional bangs with the
|
|
|
500 latest given command and appends the optional [arg].
|
|
|
501 Vim saves the output of the filter command in a
|
|
|
502 temporary file and then reads the file into the
|
|
|
503 buffer. Vim uses the 'shellredir' option to redirect
|
|
|
504 the filter output to the temporary file.
|
|
|
505 When the 'R' flag is included in 'cpoptions' marks in
|
|
|
506 the filtered lines are deleted, unless the
|
|
|
507 |:keepmarks| command is used. Example: >
|
|
|
508 :keepmarks '<,'>!sort
|
|
|
509 < When the number of lines after filtering is less than
|
|
|
510 before, marks in the missing lines are deleted anyway.
|
|
|
511
|
|
|
512 *=*
|
|
|
513 ={motion} Filter {motion} lines through the external program
|
|
|
514 given with the 'equalprg' option. When the 'equalprg'
|
|
|
515 option is empty (this is the default), use the
|
|
|
516 internal formatting function |C-indenting|. But when
|
|
|
517 'indentexpr' is not empty, it will be used instead
|
|
|
518 |indent-expression|.
|
|
|
519
|
|
|
520 *==*
|
|
|
521 == Filter [count] lines like with ={motion}.
|
|
|
522
|
|
|
523 *v_=*
|
|
|
524 {Visual}= Filter the highlighted lines like with ={motion}.
|
|
|
525 {not in Vi}
|
|
|
526
|
|
|
527
|
|
32
|
528 4.2 Substitute *:substitute*
|
|
|
529 *:s* *:su*
|
|
168
|
530 :[range]s[ubstitute]/{pattern}/{string}/[&][#][c][e][g][p][r][i][I] [count]
|
|
7
|
531 For each line in [range] replace a match of {pattern}
|
|
|
532 with {string}.
|
|
|
533 For the {pattern} see |pattern|.
|
|
|
534 {string} can be a literal string, or something
|
|
|
535 special; see |sub-replace-special|.
|
|
|
536 When [range] and [count] are omitted, replace in the
|
|
|
537 current line only.
|
|
|
538 When [count] is given, replace in [count] lines,
|
|
|
539 starting with the last line in [range]. When [range]
|
|
|
540 is omitted start in the current line.
|
|
|
541 Also see |cmdline-ranges|.
|
|
|
542 See |:s_flags| for the flags.
|
|
|
543
|
|
168
|
544 :[range]s[ubstitute] [#][c][e][g][p][r][i][I] [count]
|
|
|
545 :[range]&[&][#][c][e][g][p][r][i][I] [count] *:&*
|
|
7
|
546 Repeat last :substitute with same search pattern and
|
|
|
547 substitute string, but without the same flags. You
|
|
|
548 may add extra flags (see |:s_flags|).
|
|
|
549 Note that after ":substitute" the '&' flag can't be
|
|
|
550 used, it's recognized as a pattern separator.
|
|
|
551 The space between ":substitute" and the 'c', 'g' and
|
|
|
552 'r' flags isn't required, but in scripts it's a good
|
|
|
553 idea to keep it to avoid confusion.
|
|
|
554
|
|
168
|
555 :[range]~[&][#][c][e][g][p][r][i][I] [count] *:~*
|
|
7
|
556 Repeat last substitute with same substitute string
|
|
|
557 but with last used search pattern. This is like
|
|
|
558 ":&r". See |:s_flags| for the flags.
|
|
|
559
|
|
|
560 *&*
|
|
|
561 & Synonym for ":s//~/" (repeat last substitute). Note
|
|
|
562 that the flags are not remembered, thus it might
|
|
|
563 actually work differently. You can use ":&&" to keep
|
|
|
564 the flags.
|
|
|
565
|
|
|
566 *g&*
|
|
|
567 g& Synonym for ":%s//~/&" (repeat last substitute on all
|
|
|
568 lines with the same flags).
|
|
|
569 Mnemonic: global substitute. {not in Vi}
|
|
|
570
|
|
|
571 *:snomagic* *:sno*
|
|
|
572 :[range]sno[magic] ... Same as ":substitute", but always use 'nomagic'.
|
|
|
573 {not in Vi}
|
|
|
574
|
|
|
575 *:smagic* *:sm*
|
|
|
576 :[range]sm[agic] ... Same as ":substitute", but always use 'magic'.
|
|
|
577 {not in Vi}
|
|
|
578
|
|
|
579 *:s_flags*
|
|
|
580 The flags that you can use for the substitute commands:
|
|
|
581
|
|
|
582 [&] Must be the first one: Keep the flags from the previous substitute
|
|
|
583 command. Examples: >
|
|
|
584 :&&
|
|
|
585 :s/this/that/&
|
|
|
586 < Note that ":s" and ":&" don't keep the flags.
|
|
|
587 {not in Vi}
|
|
|
588
|
|
|
589 [c] Confirm each substitution. Vim highlights the matching string (with
|
|
|
590 |hl-IncSearch|). You can type: *:s_c*
|
|
|
591 'y' to substitute this match
|
|
|
592 'l' to substitute this match and then quit ("last")
|
|
|
593 'n' to skip this match
|
|
|
594 <Esc> to quit substituting
|
|
|
595 'a' to substitute this and all remaining matches {not in Vi}
|
|
|
596 'q' to quit substituting {not in Vi}
|
|
|
597 CTRL-E to scroll the screen up {not in Vi, not available when
|
|
|
598 compiled without the +insert_expand feature}
|
|
|
599 CTRL-Y to scroll the screen down {not in Vi, not available when
|
|
|
600 compiled without the +insert_expand feature}
|
|
|
601 If the 'edcompatible' option is on, Vim remembers the [c] flag and
|
|
|
602 toggles it each time you use it, but resets it when you give a new
|
|
|
603 search pattern.
|
|
|
604 {not in Vi: highlighting of the match, other responses than 'y' or 'n'}
|
|
|
605
|
|
|
606 [e] When the search pattern fails, do not issue an error message and, in
|
|
|
607 particular, continue in maps as if no error occurred. This is most
|
|
|
608 useful to prevent the "No match" error from breaking a mapping. Vim
|
|
|
609 does not suppress the following error messages, however:
|
|
|
610 Regular expressions can't be delimited by letters
|
|
|
611 \ should be followed by /, ? or &
|
|
|
612 No previous substitute regular expression
|
|
|
613 Trailing characters
|
|
|
614 Interrupted
|
|
|
615 {not in Vi}
|
|
|
616
|
|
|
617 [g] Replace all occurrences in the line. Without this argument,
|
|
|
618 replacement occurs only for the first occurrence in each line. If
|
|
|
619 the 'edcompatible' option is on, Vim remembers this flag and toggles
|
|
|
620 it each time you use it, but resets it when you give a new search
|
|
|
621 pattern. If the 'gdefault' option is on, this flag is on by default
|
|
|
622 and the [g] argument switches it off.
|
|
|
623
|
|
|
624 [i] Ignore case for the pattern. The 'ignorecase' and 'smartcase' options
|
|
|
625 are not used.
|
|
|
626 {not in Vi}
|
|
|
627
|
|
|
628 [I] Don't ignore case for the pattern. The 'ignorecase' and 'smartcase'
|
|
|
629 options are not used.
|
|
|
630 {not in Vi}
|
|
|
631
|
|
|
632 [p] Print the line containing the last substitute.
|
|
168
|
633
|
|
|
634 [#] Like [p] and prepend the line number.
|
|
|
635
|
|
|
636 [l] Like [l] but print the text like |:list|.
|
|
7
|
637
|
|
|
638 [r] Only useful in combination with ":&" or ":s" without arguments. ":&r"
|
|
|
639 works the same way as ":~": When the search pattern is empty, use the
|
|
|
640 previously used search pattern instead of the search pattern from the
|
|
|
641 last substitute or ":global". If the last command that did a search
|
|
|
642 was a substitute or ":global", there is no effect. If the last
|
|
|
643 command was a search command such as "/", use the pattern from that
|
|
|
644 command.
|
|
|
645 For ":s" with an argument this already happens: >
|
|
|
646 :s/blue/red/
|
|
|
647 /green
|
|
|
648 :s//red/ or :~ or :&r
|
|
|
649 < The last commands will replace "green" with "red". >
|
|
|
650 :s/blue/red/
|
|
|
651 /green
|
|
|
652 :&
|
|
|
653 < The last command will replace "blue" with "red".
|
|
|
654 {not in Vi}
|
|
|
655
|
|
|
656 Note that there is no flag to change the "magicness" of the pattern. A
|
|
|
657 different command is used instead. The reason is that the flags can only be
|
|
|
658 found by skipping the pattern, and in order to skip the pattern the
|
|
|
659 "magicness" must be known. Catch 22!
|
|
|
660
|
|
|
661 If the {pattern} for the substitute command is empty, the command uses the
|
|
|
662 pattern from the last substitute or ":global" command. With the [r] flag, the
|
|
|
663 command uses the pattern from the last substitute, ":global", or search
|
|
|
664 command.
|
|
|
665
|
|
|
666 For compatibility with Vi these two exceptions are allowed:
|
|
|
667 "\/{string}/" and "\?{string}?" do the same as "//{string}/r".
|
|
|
668 "\&{string}&" does the same as "//{string}/".
|
|
|
669 *E146*
|
|
|
670 Instead of the '/' which surrounds the pattern and replacement string, you
|
|
|
671 can use any other character, but not an alphanumeric character, '\', '"' or
|
|
|
672 '|'. This is useful if you want to include a '/' in the search pattern or
|
|
|
673 replacement string. Example: >
|
|
|
674 :s+/+//+
|
|
|
675
|
|
|
676 For the definition of a pattern, see |pattern|.
|
|
|
677
|
|
|
678 *sub-replace-special* *:s\=*
|
|
|
679 When the {string} starts with "\=" it is evaluated as an expression, see
|
|
|
680 |sub-replace-expression|. Otherwise these characters in {string} have a
|
|
|
681 special meaning:
|
|
168
|
682 *:s%*
|
|
|
683 When {string} is equal to "%" and '/' is included with the 'cpotions' option,
|
|
|
684 then the {string} of the previous substitute command is used. |cpo-/|
|
|
7
|
685
|
|
|
686 magic nomagic action ~
|
|
|
687 & \& replaced with the whole matched pattern *s/\&*
|
|
|
688 \& & replaced with &
|
|
|
689 \0 replaced with the whole matched pattern *\0* *s/\0*
|
|
|
690 \1 replaced with the matched pattern in the first
|
|
|
691 pair of () *s/\1*
|
|
26
|
692 \2 replaced with the matched pattern in the second
|
|
7
|
693 pair of () *s/\2*
|
|
|
694 .. .. *s/\3*
|
|
|
695 \9 replaced with the matched pattern in the ninth
|
|
|
696 pair of () *s/\9*
|
|
|
697 ~ \~ replaced with the {string} of the previous
|
|
|
698 substitute *s~*
|
|
|
699 \~ ~ replaced with ~ *s/\~*
|
|
|
700 \u next character made uppercase *s/\u*
|
|
|
701 \U following characters made uppercase, until \E *s/\U*
|
|
|
702 \l next character made lowercase *s/\l*
|
|
|
703 \L following characters made lowercase, until \E *s/\L*
|
|
|
704 \e end of \u, \U, \l and \L (NOTE: not <Esc>!) *s/\e*
|
|
|
705 \E end of \u, \U, \l and \L *s/\E*
|
|
|
706 <CR> split line in two at this point
|
|
|
707 (Type the <CR> as CTRL-V <Enter>) *s<CR>*
|
|
|
708 \r idem *s/\r*
|
|
|
709 \<CR> insert a carriage-return (CTRL-M)
|
|
|
710 (Type the <CR> as CTRL-V <Enter>) *s/\<CR>*
|
|
|
711 \n insert a <NL> (<NUL> in the file)
|
|
|
712 (does NOT break the line) *s/\n*
|
|
|
713 \b insert a <BS> *s/\b*
|
|
|
714 \t insert a <Tab> *s/\t*
|
|
|
715 \\ insert a single backslash *s/\\*
|
|
|
716 \x where x is any character not mentioned above:
|
|
|
717 Reserved for future expansion
|
|
|
718
|
|
|
719 Examples: >
|
|
|
720 :s/a\|b/xxx\0xxx/g modifies "a b" to "xxxaxxx xxxbxxx"
|
|
|
721 :s/\([abc]\)\([efg]\)/\2\1/g modifies "af fa bg" to "fa fa gb"
|
|
|
722 :s/abcde/abc^Mde/ modifies "abcde" to "abc", "de" (two lines)
|
|
|
723 :s/$/\^M/ modifies "abcde" to "abcde^M"
|
|
|
724
|
|
|
725 Note: In previous versions CTRL-V was handled in a special way. Since this is
|
|
|
726 not Vi compatible, this was removed. Use a backslash instead.
|
|
|
727
|
|
|
728 command text result ~
|
|
|
729 :s/aa/a^Ma/ aa a<line-break>a
|
|
|
730 :s/aa/a\^Ma/ aa a^Ma
|
|
|
731 :s/aa/a\\^Ma/ aa a\<line-break>a
|
|
|
732
|
|
|
733 (you need to type CTRL-V <CR> to get a ^M here)
|
|
|
734
|
|
|
735 The numbering of "\1", "\2" etc. is done based on which "\(" comes first in
|
|
|
736 the pattern (going left to right). When a parentheses group matches several
|
|
|
737 times, the last one will be used for "\1", "\2", etc. Example: >
|
|
|
738 :s/\(\(a[a-d] \)*\)/\2/ modifies "aa ab x" to "ab x"
|
|
|
739
|
|
|
740 When using parentheses in combination with '|', like in \([ab]\)\|\([cd]\),
|
|
|
741 either the first or second pattern in parentheses did not match, so either
|
|
|
742 \1 or \2 is empty. Example: >
|
|
|
743 :s/\([ab]\)\|\([cd]\)/\1x/g modifies "a b c d" to "ax bx x x"
|
|
|
744 <
|
|
|
745
|
|
|
746 Substitute with an expression *sub-replace-expression*
|
|
|
747
|
|
|
748 When the substitute string starts with "\=" the remainer is interpreted as an
|
|
|
749 expression. This does not work recursively: a substitute() function inside
|
|
|
750 the expression cannot use "\=" for the substitute string.
|
|
|
751
|
|
|
752 The special meaning for characters as mentioned at |sub-replace-special| does
|
|
|
753 not apply except "<CR>", "\<CR>" and "\\". Thus in the result of the
|
|
|
754 expression you need to use two backslashes get one, put a backslash before a
|
|
|
755 <CR> you want to insert and use a <CR> without a backslash where you want to
|
|
|
756 break the line.
|
|
|
757
|
|
|
758 For convenience a <NL> character is also used as a line break. Prepend a
|
|
|
759 backslash to get a real <NL> character (which will be a NUL in the file).
|
|
|
760
|
|
|
761 The whole matched text can be accessed with "submatch(0)". The text matched
|
|
|
762 with the first pair of () with "submatch(1)". Likewise for further
|
|
|
763 sub-matches in ().
|
|
|
764
|
|
|
765 Be careful: The separation character must not appear in the expression!
|
|
|
766 Consider using a character like "@" or ":". There is no problem if the result
|
|
|
767 of the expression contains the separation character.
|
|
|
768
|
|
|
769 Example: >
|
|
|
770 :s@\n@\="\r" . expand("$HOME") . "\r"@
|
|
|
771 This replaces an end-of-line with a new line containing the value of $HOME.
|
|
|
772
|
|
|
773
|
|
32
|
774 4.3 Search and replace *search-replace*
|
|
|
775
|
|
|
776 *:pro* *:promptfind*
|
|
7
|
777 :promptf[ind] [string]
|
|
|
778 Put up a Search dialog. When [string] is given, it is
|
|
|
779 used as the initial search string.
|
|
|
780 {only for Win32, Motif and GTK GUI}
|
|
|
781
|
|
|
782 *:promptr* *:promptrepl*
|
|
|
783 :promptr[epl] [string]
|
|
|
784 Put up a Search/Replace dialog. When [string] is
|
|
|
785 given, it is used as the initial search string.
|
|
|
786 {only for Win32, Motif and GTK GUI}
|
|
|
787
|
|
32
|
788
|
|
|
789 4.4 Changing tabs *change-tabs*
|
|
7
|
790 *:ret* *:retab*
|
|
|
791 :[range]ret[ab][!] [new_tabstop]
|
|
|
792 Replace all sequences of white-space containing a
|
|
|
793 <Tab> with new strings of white-space using the new
|
|
|
794 tabstop value given. If you do not specify a new
|
|
|
795 tabstop size or it is zero, Vim uses the current value
|
|
|
796 of 'tabstop'.
|
|
|
797 The current value of 'tabstop' is always used to
|
|
|
798 compute the width of existing tabs.
|
|
|
799 With !, Vim also replaces strings of only normal
|
|
|
800 spaces with tabs where appropriate.
|
|
|
801 With 'expandtab' on, Vim replaces all tabs with the
|
|
|
802 appropriate number of spaces.
|
|
|
803 This command sets 'tabstop' to the new value given,
|
|
|
804 and if performed on the whole file, which is default,
|
|
|
805 should not make any visible change.
|
|
|
806 Careful: This command modifies any <Tab> characters
|
|
|
807 inside of strings in a C program. Use "\t" to avoid
|
|
|
808 this (that's a good habit anyway).
|
|
|
809 ":retab!" may also change a sequence of spaces by
|
|
|
810 <Tab> characters, which can mess up a printf().
|
|
|
811 {not in Vi}
|
|
|
812 Not available when |+ex_extra| feature was disabled at
|
|
|
813 compile time.
|
|
|
814
|
|
|
815 *retab-example*
|
|
|
816 Example for using autocommands and ":retab" to edit a file which is stored
|
|
|
817 with tabstops at 8 but edited with tabstops set at 4. Warning: white space
|
|
|
818 inside of strings can change! Also see 'softtabstop' option. >
|
|
|
819
|
|
|
820 :auto BufReadPost *.xx retab! 4
|
|
|
821 :auto BufWritePre *.xx retab! 8
|
|
|
822 :auto BufWritePost *.xx retab! 4
|
|
|
823 :auto BufNewFile *.xx set ts=4
|
|
|
824
|
|
|
825 ==============================================================================
|
|
|
826 5. Copying and moving text *copy-move*
|
|
|
827
|
|
|
828 *quote*
|
|
|
829 "{a-zA-Z0-9.%#:-"} Use register {a-zA-Z0-9.%#:-"} for next delete, yank
|
|
|
830 or put (use uppercase character to append with
|
|
|
831 delete and yank) ({.%#:} only work with put).
|
|
|
832
|
|
|
833 *:reg* *:registers*
|
|
|
834 :reg[isters] Display the contents of all numbered and named
|
|
|
835 registers. {not in Vi}
|
|
|
836
|
|
|
837 :reg[isters] {arg} Display the contents of the numbered and named
|
|
|
838 registers that are mentioned in {arg}. For example: >
|
|
|
839 :dis 1a
|
|
|
840 < to display registers '1' and 'a'. Spaces are allowed
|
|
|
841 in {arg}. {not in Vi}
|
|
|
842
|
|
|
843 *:di* *:display*
|
|
|
844 :di[splay] [arg] Same as :registers. {not in Vi}
|
|
|
845
|
|
|
846 *y* *yank*
|
|
|
847 ["x]y{motion} Yank {motion} text [into register x]. When no
|
|
|
848 characters are to be yanked (e.g., "y0" in column 1),
|
|
|
849 this is an error when 'cpoptions' includes the 'E'
|
|
|
850 flag.
|
|
|
851
|
|
|
852 *yy*
|
|
|
853 ["x]yy Yank [count] lines [into register x] |linewise|.
|
|
|
854
|
|
|
855 *Y*
|
|
|
856 ["x]Y yank [count] lines [into register x] (synonym for
|
|
|
857 yy, |linewise|). If you like "Y" to work from the
|
|
|
858 cursor to the end of line (which is more logical,
|
|
|
859 but not Vi-compatible) use ":map Y y$".
|
|
|
860
|
|
|
861 *v_y*
|
|
|
862 {Visual}["x]y Yank the highlighted text [into register x] (for
|
|
|
863 {Visual} see |Visual-mode|). {not in Vi}
|
|
|
864
|
|
|
865 *v_Y*
|
|
|
866 {Visual}["x]Y Yank the highlighted lines [into register x] (for
|
|
|
867 {Visual} see |Visual-mode|). {not in Vi}
|
|
|
868
|
|
|
869 *:y* *:yank*
|
|
|
870 :[range]y[ank] [x] Yank [range] lines [into register x].
|
|
|
871
|
|
|
872 :[range]y[ank] [x] {count}
|
|
|
873 Yank {count} lines, starting with last line number
|
|
|
874 in [range] (default: current line |cmdline-ranges|),
|
|
|
875 [into register x].
|
|
|
876
|
|
|
877 *p* *put* *E353*
|
|
|
878 ["x]p Put the text [from register x] after the cursor
|
|
|
879 [count] times. {Vi: no count}
|
|
|
880
|
|
|
881 *P*
|
|
|
882 ["x]P Put the text [from register x] before the cursor
|
|
|
883 [count] times. {Vi: no count}
|
|
|
884
|
|
|
885 *<MiddleMouse>*
|
|
|
886 ["x]<MiddleMouse> Put the text from a register before the cursor [count]
|
|
|
887 times. Uses the "* register, unless another is
|
|
36
|
888 specified.
|
|
|
889 Leaves the cursor at the end of the new text.
|
|
|
890 Using the mouse only works when 'mouse' contains 'n'
|
|
|
891 or 'a'.
|
|
7
|
892 {not in Vi}
|
|
|
893 If you have a scrollwheel and often accidentally paste
|
|
|
894 text, you can use these mappings to disable the
|
|
|
895 pasting with the middle mouse button: >
|
|
|
896 :map <MiddleMouse> <Nop>
|
|
|
897 :imap <MiddleMouse> <Nop>
|
|
|
898 < You might want to disable the multi-click versions
|
|
|
899 too, see |double-click|.
|
|
|
900
|
|
|
901 *gp*
|
|
|
902 ["x]gp Just like "p", but leave the cursor just after the new
|
|
|
903 text. {not in Vi}
|
|
|
904
|
|
|
905 *gP*
|
|
|
906 ["x]gP Just like "P", but leave the cursor just after the new
|
|
|
907 text. {not in Vi}
|
|
|
908
|
|
|
909 *:pu* *:put*
|
|
|
910 :[line]pu[t] [x] Put the text [from register x] after [line] (default
|
|
|
911 current line). This always works |linewise|, thus
|
|
|
912 this command can be used to put a yanked block as new
|
|
|
913 lines.
|
|
|
914 The register can also be '=' followed by an optional
|
|
|
915 expression. The expression continues until the end of
|
|
|
916 the command. You need to escape the '|' and '"'
|
|
|
917 characters to prevent them from terminating the
|
|
|
918 command. Example: >
|
|
|
919 :put ='path' . \",/test\"
|
|
|
920 < If there is no expression after '=', Vim uses the
|
|
|
921 previous expression. You can see it with ":dis =".
|
|
|
922
|
|
|
923 :[line]pu[t]! [x] Put the text [from register x] before [line] (default
|
|
|
924 current line).
|
|
|
925
|
|
|
926 ["x]]p or *]p* *]<MiddleMouse>*
|
|
|
927 ["x]]<MiddleMouse> Like "p", but adjust the indent to the current line.
|
|
|
928 Using the mouse only works when 'mouse' contains 'n'
|
|
|
929 or 'a'. {not in Vi}
|
|
|
930
|
|
|
931 ["x][P or *[P*
|
|
|
932 ["x]]P or *]P*
|
|
|
933 ["x][p or *[p* *[<MiddleMouse>*
|
|
|
934 ["x][<MiddleMouse> Like "P", but adjust the indent to the current line.
|
|
|
935 Using the mouse only works when 'mouse' contains 'n'
|
|
|
936 or 'a'. {not in Vi}
|
|
|
937
|
|
|
938 You can use these commands to copy text from one place to another. Do this
|
|
|
939 by first getting the text into a register with a yank, delete or change
|
|
|
940 command, then inserting the register contents with a put command. You can
|
|
|
941 also use these commands to move text from one file to another, because Vim
|
|
|
942 preserves all registers when changing buffers (the CTRL-^ command is a quick
|
|
|
943 way to toggle between two files).
|
|
|
944
|
|
|
945 *linewise-register* *characterwise-register*
|
|
|
946 You can repeat the put commands with "." (except for :put) and undo them. If
|
|
|
947 the command that was used to get the text into the register was |linewise|,
|
|
|
948 Vim inserts the text below ("p") or above ("P") the line where the cursor is.
|
|
|
949 Otherwise Vim inserts the text after ("p") or before ("P") the cursor. With
|
|
|
950 the ":put" command, Vim always inserts the text in the next line. You can
|
|
|
951 exchange two characters with the command sequence "xp". You can exchange two
|
|
|
952 lines with the command sequence "ddp". You can exchange two words with the
|
|
|
953 command sequence "deep" (start with the cursor in the blank space before the
|
|
|
954 first word). You can use the "']" or "`]" command after the put command to
|
|
|
955 move the cursor to the end of the inserted text, or use "'[" or "`[" to move
|
|
|
956 the cursor to the start.
|
|
|
957
|
|
|
958 *put-Visual-mode* *v_p* *v_P*
|
|
|
959 When using a put command like |p| or |P| in Visual mode, Vim will try to
|
|
|
960 replace the selected text with the contents of the register. Whether this
|
|
|
961 works well depends on the type of selection and the type of the text in the
|
|
|
962 register. With blockwise selection it also depends on the size of the block
|
|
|
963 and whether the corners are on an existing character. (implementation detail:
|
|
|
964 it actually works by first putting the register after the selection and then
|
|
|
965 deleting the selection).
|
|
|
966
|
|
|
967 *blockwise-register*
|
|
|
968 If you use a blockwise Visual mode command to get the text into the register,
|
|
|
969 the block of text will be inserted before ("P") or after ("p") the cursor
|
|
|
970 column in the current and next lines. Vim makes the whole block of text start
|
|
|
971 in the same column. Thus the inserted text looks the same as when it was
|
|
|
972 yanked or deleted. Vim may replace some <Tab> characters with spaces to make
|
|
|
973 this happen. However, if the width of the block is not a multiple of a <Tab>
|
|
|
974 width and the text after the inserted block contains <Tab>s, that text may be
|
|
|
975 misaligned.
|
|
|
976
|
|
|
977 Note that after a characterwise yank command, Vim leaves the cursor on the
|
|
|
978 first yanked character that is closest to the start of the buffer. This means
|
|
|
979 that "yl" doesn't move the cursor, but "yh" moves the cursor one character
|
|
|
980 left.
|
|
|
981 Rationale: In Vi the "y" command followed by a backwards motion would
|
|
|
982 sometimes not move the cursor to the first yanked character,
|
|
|
983 because redisplaying was skipped. In Vim it always moves to
|
|
|
984 the first character, as specified by Posix.
|
|
|
985 With a linewise yank command the cursor is put in the first line, but the
|
|
|
986 column is unmodified, thus it may not be on the first yanked character.
|
|
|
987
|
|
|
988 There are nine types of registers: *registers* *E354*
|
|
|
989 1. The unnamed register ""
|
|
|
990 2. 10 numbered registers "0 to "9
|
|
|
991 3. The small delete register "-
|
|
|
992 4. 26 named registers "a to "z or "A to "Z
|
|
|
993 5. four read-only registers ":, "., "% and "#
|
|
|
994 6. the expression register "=
|
|
|
995 7. The selection and drop registers "*, "+ and "~
|
|
|
996 8. The black hole register "_
|
|
|
997 9. Last search pattern register "/
|
|
|
998
|
|
|
999 1. Unnamed register "" *quote_quote* *quotequote*
|
|
|
1000 Vim fills this register with text deleted with the "d", "c", "s", "x" commands
|
|
|
1001 or copied with the yank "y" command, regardless of whether or not a specific
|
|
8
|
1002 register was used (e.g. "xdd). This is like the unnamed register is pointing
|
|
|
1003 to the last used register. An exception is the '_' register: "_dd does not
|
|
42
|
1004 store the deleted text in any register.
|
|
|
1005 Vim uses the contents of the unnamed register for any put command (p or P)
|
|
|
1006 which does not specify a register. Additionally you can access it with the
|
|
|
1007 name '"'. This means you have to type two double quotes. Writing to the ""
|
|
|
1008 register writes to register "0.
|
|
7
|
1009 {Vi: register contents are lost when changing files, no '"'}
|
|
|
1010
|
|
|
1011 2. Numbered registers "0 to "9 *quote_number* *quote0* *quote1*
|
|
|
1012 *quote2* *quote3* *quote4* *quote9*
|
|
|
1013 Vim fills these registers with text from yank and delete commands.
|
|
|
1014 Numbered register 0 contains the text from the most recent yank command,
|
|
|
1015 unless the command specified another register with ["x].
|
|
|
1016 Numbered register 1 contains the text deleted by the most recent delete or
|
|
|
1017 change command, unless the command specified another register or the text is
|
|
|
1018 less than one line (the small delete register is used then). An exception is
|
|
42
|
1019 made for the delete operator with these movement commands: |%|, |(|, |)|, |`|,
|
|
|
1020 |/|, |?|, |n|, |N|, |{| and |}|. Register "1 is always used then (this is Vi
|
|
|
1021 compatible). The "- register is used as well if the delete is within a line.
|
|
7
|
1022 With each successive deletion or change, Vim shifts the previous contents
|
|
|
1023 of register 1 into register 2, 2 into 3, and so forth, losing the previous
|
|
|
1024 contents of register 9.
|
|
|
1025 {Vi: numbered register contents are lost when changing files; register 0 does
|
|
|
1026 not exist}
|
|
|
1027
|
|
|
1028 3. Small delete register "- *quote_-* *quote-*
|
|
|
1029 This register contains text from commands that delete less than one line,
|
|
|
1030 except when the command specifies a register with ["x].
|
|
|
1031 {not in Vi}
|
|
|
1032
|
|
|
1033 4. Named registers "a to "z or "A to "Z *quote_alpha* *quotea*
|
|
|
1034 Vim fills these registers only when you say so. Specify them as lowercase
|
|
|
1035 letters to replace their previous contents or as uppercase letters to append
|
|
164
|
1036 to their previous contents. When the '>' flag is present in 'cpoptions' then
|
|
|
1037 a line break is inserted before the appended text.
|
|
7
|
1038
|
|
|
1039 5. Read-only registers ":, "., "% and "#
|
|
|
1040 These are '%', '#', ':' and '.'. You can use them only with the "p", "P",
|
|
|
1041 and ":put" commands and with CTRL-R. {not in Vi}
|
|
|
1042 *quote_.* *quote.* *E29*
|
|
|
1043 ". Contains the last inserted text (the same as what is inserted
|
|
|
1044 with the insert mode commands CTRL-A and CTRL-@). Note: this
|
|
|
1045 doesn't work with CTRL-R on the command-line. It works a bit
|
|
|
1046 differently, like inserting the text instead of putting it
|
|
|
1047 ('textwidth' and other options affect what is inserted).
|
|
|
1048 *quote_%* *quote%*
|
|
|
1049 "% Contains the name of the current file.
|
|
|
1050 *quote_#* *quote#*
|
|
|
1051 "# Contains the name of the alternate file.
|
|
|
1052 *quote_:* *quote:* *E30*
|
|
|
1053 ": Contains the most recent executed command-line. Example: Use
|
|
|
1054 "@:" to repeat the previous command-line command.
|
|
|
1055 The command-line is only stored in this register when at least
|
|
|
1056 one character of it was typed. Thus it remains unchanged if
|
|
|
1057 the command was completely from a mapping.
|
|
|
1058 {not available when compiled without the |+cmdline_hist|
|
|
|
1059 feature}
|
|
|
1060
|
|
|
1061 6. Expression register "= *quote_=* *quote=*
|
|
|
1062 This is not really a register that stores text, but is a way to use an
|
|
|
1063 expression in commands which use a register. The expression register is
|
|
|
1064 read-only; you cannot put text into it. After the '=', the cursor moves to
|
|
|
1065 the command-line, where you can enter any expression (see |expression|). All
|
|
|
1066 normal command-line editing commands are available, including a special
|
|
|
1067 history for expressions. When you end the command-line by typing <CR>, Vim
|
|
|
1068 computes the result of the expression. If you end it with <Esc>, Vim abandons
|
|
|
1069 the expression. If you do not enter an expression, Vim uses the previous
|
|
|
1070 expression (like with the "/" command). If the "= register is used for the
|
|
|
1071 "p" command, the string is split up at <NL> characters. If the string ends in
|
|
|
1072 a <NL>, it is regarded as a linewise register. {not in Vi}
|
|
|
1073
|
|
|
1074 7. Selection and drop registers "*, "+ and "~
|
|
|
1075 Use these register for storing and retrieving the selected text for the GUI.
|
|
|
1076 See |quotestar| and |quoteplus|. When the clipboard is not available or not
|
|
|
1077 working, the unnamed register is used instead. {not in Vi}
|
|
|
1078
|
|
|
1079 Note that there is only a distinction between "* and "+ for X11 systems. For
|
|
|
1080 an explanation of the difference, see |x11-selection|. Under MS-Windows, use
|
|
|
1081 of "* and "+ is actually synonymous and refers to the |gui-clipboard|.
|
|
|
1082
|
|
|
1083 *quote_~* *quote~* *<Drop>*
|
|
|
1084 The read-only "~ register stores the dropped text from the last drag'n'drop
|
|
|
1085 operation. When something has been dropped onto Vim, the "~ register is
|
|
|
1086 filled in and the <Drop> pseudo key is sent for notification. You can remap
|
|
|
1087 this key if you want; the default action (for all modes) is to insert the
|
|
|
1088 contents of the "~ register at the cursor position. {not in Vi}
|
|
9
|
1089 {only available when compiled with the |+dnd| feature, currently only with the
|
|
7
|
1090 GTK GUI}
|
|
|
1091
|
|
|
1092 Note: The "~ register is only used when dropping plain text onto Vim.
|
|
|
1093 Drag'n'drop of URI lists is handled internally.
|
|
|
1094
|
|
|
1095 8. Black hole register "_ *quote_*
|
|
|
1096 When writing to this register, nothing happens. This can be used to delete
|
|
|
1097 text without affecting the normal registers. When reading from this register,
|
|
|
1098 nothing is returned. {not in Vi}
|
|
|
1099
|
|
|
1100 9. Last search pattern register "/ *quote_/* *quote/*
|
|
|
1101 Contains the most recent search-pattern. This is used for "n" and 'hlsearch'.
|
|
|
1102 It is writable with ":let", you can change it to have 'hlsearch' highlight
|
|
|
1103 other matches without actually searching. You can't yank or delete into this
|
|
|
1104 register. {not in Vi}
|
|
|
1105
|
|
|
1106 *@/*
|
|
|
1107 You can write to a register with a ":let" command |:let-@|. Example: >
|
|
|
1108 :let @/ = "the"
|
|
|
1109
|
|
|
1110 If you use a put command without specifying a register, Vim uses the register
|
|
|
1111 that was last filled (this is also the contents of the unnamed register). If
|
|
|
1112 you are confused, use the ":dis" command to find out what Vim will put (this
|
|
|
1113 command displays all named and numbered registers; the unnamed register is
|
|
|
1114 labelled '"').
|
|
|
1115
|
|
|
1116 The next three commands always work on whole lines.
|
|
|
1117
|
|
|
1118 :[range]co[py] {address} *:co* *:copy*
|
|
|
1119 Copy the lines given by [range] to below the line
|
|
|
1120 given by {address}.
|
|
|
1121
|
|
|
1122 *:t*
|
|
|
1123 :t Synonym for copy.
|
|
|
1124
|
|
|
1125 :[range]m[ove] {address} *:m* *:mo* *:move* *E134*
|
|
|
1126 Move the lines given by [range] to below the line
|
|
|
1127 given by {address}.
|
|
|
1128
|
|
|
1129 ==============================================================================
|
|
|
1130 6. Formatting text *formatting*
|
|
|
1131
|
|
|
1132 :[range]ce[nter] [width] *:ce* *:center*
|
|
|
1133 Center lines in [range] between [width] columns
|
|
|
1134 (default 'textwidth' or 80 when 'textwidth' is 0).
|
|
|
1135 {not in Vi}
|
|
|
1136 Not available when |+ex_extra| feature was disabled at
|
|
|
1137 compile time.
|
|
|
1138
|
|
|
1139 :[range]ri[ght] [width] *:ri* *:right*
|
|
|
1140 Right-align lines in [range] at [width] columns
|
|
|
1141 (default 'textwidth' or 80 when 'textwidth' is 0).
|
|
|
1142 {not in Vi}
|
|
|
1143 Not available when |+ex_extra| feature was disabled at
|
|
|
1144 compile time.
|
|
|
1145
|
|
|
1146 *:le* *:left*
|
|
|
1147 :[range]le[ft] [indent]
|
|
|
1148 Left-align lines in [range]. Sets the indent in the
|
|
|
1149 lines to [indent] (default 0). {not in Vi}
|
|
|
1150 Not available when |+ex_extra| feature was disabled at
|
|
|
1151 compile time.
|
|
|
1152
|
|
|
1153 *gq*
|
|
|
1154 gq{motion} Format the lines that {motion} moves over. The
|
|
|
1155 'textwidth' option controls the length of each
|
|
|
1156 formatted line (see below). If the 'textwidth' option
|
|
|
1157 is 0, the formatted line length is the screen width
|
|
|
1158 (with a maximum width of 79). {not in Vi}
|
|
|
1159 The 'formatoptions' option controls the type of
|
|
|
1160 formatting |fo-table|.
|
|
|
1161 NOTE: The "Q" command formerly performed this
|
|
|
1162 function. If you still want to use "Q" for
|
|
|
1163 formatting, use this mapping: >
|
|
|
1164 :nnoremap Q gq
|
|
|
1165
|
|
|
1166 gqgq *gqgq* *gqq*
|
|
|
1167 gqq Format the current line. {not in Vi}
|
|
|
1168
|
|
|
1169 *v_gq*
|
|
|
1170 {Visual}gq Format the highlighted text. (for {Visual} see
|
|
|
1171 |Visual-mode|). {not in Vi}
|
|
|
1172
|
|
|
1173 *gw*
|
|
|
1174 gw{motion} Format the lines that {motion} moves over. Similar to
|
|
|
1175 |gq| but puts the cursor back at the same position in
|
|
|
1176 the text. However, 'formatprg' is not used.
|
|
|
1177 {not in Vi}
|
|
|
1178
|
|
9
|
1179 gwgw *gwgw* *gww*
|
|
|
1180 gww Format the current line as with "gw". {not in Vi}
|
|
|
1181
|
|
|
1182 *v_gw*
|
|
|
1183 {Visual}gw Format the highlighted text as with "gw". (for
|
|
|
1184 {Visual} see |Visual-mode|). {not in Vi}
|
|
|
1185
|
|
7
|
1186 Example: To format the current paragraph use: *gqap* >
|
|
|
1187 gqap
|
|
|
1188
|
|
|
1189 The "gq" command leaves the cursor in the line where the motion command takes
|
|
|
1190 the cursor. This allows you to repeat formatting repeated with ".". This
|
|
|
1191 works well with "gqj" (format current and next line) and "gq}" (format until
|
|
|
1192 end of paragraph). Note: When 'formatprg' is set, "gq" leaves the cursor on
|
|
|
1193 the first formatted line (as with using a filter command).
|
|
|
1194
|
|
|
1195 If you want to format the current paragraph and continue where you were, use: >
|
|
|
1196 gwap
|
|
|
1197 If you always want to keep paragraphs formatted you may want to add the 'a'
|
|
|
1198 flag to 'formatoptions'. See |auto-format|.
|
|
|
1199
|
|
|
1200 If the 'autoindent' option is on, Vim uses the indent of the first line for
|
|
|
1201 the following lines.
|
|
|
1202
|
|
|
1203 Formatting does not change empty lines (but it does change lines with only
|
|
|
1204 white space!).
|
|
|
1205
|
|
|
1206 The 'joinspaces' option is used when lines are joined together.
|
|
|
1207
|
|
|
1208 You can set the 'formatprg' option to the name of an external program for Vim
|
|
|
1209 to use for text formatting. The 'textwidth' and other options have no effect
|
|
|
1210 on formatting by an external program.
|
|
|
1211
|
|
|
1212 *right-justify*
|
|
|
1213 There is no command in Vim to right justify text. You can do it with
|
|
|
1214 an external command, like "par" (e.g.: "!}par" to format until the end of the
|
|
|
1215 paragraph) or set 'formatprg' to "par".
|
|
|
1216
|
|
|
1217 *format-comments*
|
|
|
1218 Vim can format comments in a special way. Vim recognizes a comment by a
|
|
|
1219 specific string at the start of the line (ignoring white space). Three types
|
|
|
1220 of comments can be used:
|
|
|
1221
|
|
|
1222 - A comment string that repeats at the start of each line. An example is the
|
|
|
1223 type of comment used in shell scripts, starting with "#".
|
|
|
1224 - A comment string that occurs only in the first line, not in the following
|
|
|
1225 lines. An example is this list with dashes.
|
|
|
1226 - Three-piece comments that have a start string, an end string, and optional
|
|
|
1227 lines in between. The strings for the start, middle and end are different.
|
|
|
1228 An example is the C-style comment:
|
|
|
1229 /*
|
|
|
1230 * this is a C comment
|
|
|
1231 */
|
|
|
1232
|
|
|
1233 The 'comments' option is a comma-separated list of parts. Each part defines a
|
|
|
1234 type of comment string. A part consists of:
|
|
|
1235 {flags}:{string}
|
|
|
1236
|
|
|
1237 {string} is the literal text that must appear.
|
|
|
1238
|
|
|
1239 {flags}:
|
|
|
1240 n Nested comment. Nesting with mixed parts is allowed. If 'comments'
|
|
|
1241 is "n:),n:>" a line starting with "> ) >" is a comment.
|
|
|
1242
|
|
|
1243 b Blank (<Space>, <Tab> or <EOL>) required after {string}.
|
|
|
1244
|
|
|
1245 f Only the first line has the comment string. Do not repeat comment on
|
|
|
1246 the next line, but preserve indentation (e.g., a bullet-list).
|
|
|
1247
|
|
|
1248 s Start of three-piece comment
|
|
|
1249
|
|
|
1250 m Middle of a three-piece comment
|
|
|
1251
|
|
|
1252 e End of a three-piece comment
|
|
|
1253
|
|
|
1254 l Left adjust middle with start or end (default). Only recognized when
|
|
|
1255 used together with 's' or 'e'.
|
|
|
1256
|
|
|
1257 r Right adjust middle with start or end. Only recognized when used
|
|
|
1258 together with 's' or 'e'.
|
|
|
1259
|
|
|
1260 O Don't use this one for the "O" command.
|
|
|
1261
|
|
|
1262 x Allows three-piece comments to be ended by just typing the last
|
|
|
1263 character of the end-comment string as the first character on a new
|
|
|
1264 line, when the middle-comment string has already been inserted
|
|
|
1265 automatically. See below for more details.
|
|
|
1266
|
|
|
1267 {digits}
|
|
|
1268 When together with 's' or 'e': add extra indent for the middle part.
|
|
|
1269 This can be used to left-align the middle part with the start or end
|
|
|
1270 and then add an offset.
|
|
|
1271
|
|
|
1272 -{digits}
|
|
|
1273 Like {digits} but reduce the indent. This only works when there is
|
|
|
1274 some indent for the start or end part that can be removed.
|
|
|
1275
|
|
|
1276 When a string has none of the 'f', 's', 'm' or 'e' flags, Vim assumes the
|
|
|
1277 comment string repeats at the start of each line. The flags field may be
|
|
|
1278 empty.
|
|
|
1279
|
|
|
1280 Any blank space in the text before and after the {string} is part of the
|
|
|
1281 {string}, so do not include leading or trailing blanks unless the blanks are a
|
|
|
1282 required part of the comment string.
|
|
|
1283
|
|
|
1284 When one comment leader is part of another, specify the part after the whole.
|
|
|
1285 For example, to include both "-" and "->", use >
|
|
|
1286 :set comments=f:->,f:-
|
|
|
1287
|
|
|
1288 A three-piece comment must always be given as start,middle,end, with no other
|
|
|
1289 parts in between. An example of a three-piece comment is >
|
|
|
1290 sr:/*,mb:*,ex:*/
|
|
|
1291 for C-comments. To avoid recognizing "*ptr" as a comment, the middle string
|
|
|
1292 includes the 'b' flag. For three-piece comments, Vim checks the text after
|
|
|
1293 the start and middle strings for the end string. If Vim finds the end string,
|
|
|
1294 the comment does not continue on the next line. Three-piece comments must
|
|
|
1295 have a middle string because otherwise Vim can't recognize the middle lines.
|
|
|
1296
|
|
|
1297 Notice the use of the "x" flag in the above three-piece comment definition.
|
|
|
1298 When you hit Return in a C-comment, Vim will insert the middle comment leader
|
|
|
1299 for the new line, e.g. " * ". To close this comment you just have to type "/"
|
|
|
1300 before typing anything else on the new line. This will replace the
|
|
|
1301 middle-comment leader with the end-comment leader, leaving just " */". There
|
|
|
1302 is no need to hit BackSpace first.
|
|
|
1303
|
|
|
1304 Examples: >
|
|
|
1305 "b:*" Includes lines starting with "*", but not if the "*" is
|
|
|
1306 followed by a non-blank. This avoids a pointer dereference
|
|
|
1307 like "*str" to be recognized as a comment.
|
|
|
1308 "n:>" Includes a line starting with ">", ">>", ">>>", etc.
|
|
|
1309 "fb:-" Format a list that starts with "- ".
|
|
|
1310
|
|
|
1311 By default, "b:#" is included. This means that a line that starts with
|
|
|
1312 "#include" is not recognized as a comment line. But a line that starts with
|
|
|
1313 "# define" is recognized. This is a compromise.
|
|
|
1314
|
|
|
1315 Often the alignment can be changed from right alignment to a left alignment
|
|
|
1316 with an additional space. For example, for Javadoc comments, this can be
|
|
|
1317 used (insert a backslash before the space when using ":set"): >
|
|
|
1318 s1:/*,mb:*,ex:*/
|
|
|
1319 Note that an offset is included with start, so that the middle part is left
|
|
|
1320 aligned with the start and then an offset of one character added. This makes
|
|
|
1321 it possible to left align the start and middle for this construction: >
|
|
|
1322 /**
|
|
|
1323 * comment
|
|
|
1324 */
|
|
|
1325
|
|
|
1326 {not available when compiled without the |+comments| feature}
|
|
|
1327
|
|
|
1328 *fo-table*
|
|
|
1329 You can use the 'formatoptions' option to influence how Vim formats text.
|
|
|
1330 'formatoptions' is a string that can contain any of the letters below. The
|
|
|
1331 default setting is "tcq". You can separate the option letters with commas for
|
|
|
1332 readability.
|
|
|
1333
|
|
|
1334 letter meaning when present in 'formatoptions' ~
|
|
|
1335
|
|
|
1336 t Auto-wrap text using textwidth (does not apply to comments)
|
|
|
1337 c Auto-wrap comments using textwidth, inserting the current comment
|
|
|
1338 leader automatically.
|
|
|
1339 r Automatically insert the current comment leader after hitting
|
|
|
1340 <Enter> in Insert mode.
|
|
|
1341 o Automatically insert the current comment leader after hitting 'o' or
|
|
|
1342 'O' in Normal mode.
|
|
|
1343 q Allow formatting of comments with "gq".
|
|
|
1344 Note that formatting will not change blank lines or lines containing
|
|
|
1345 only the comment leader. A new paragraph starts after such a line,
|
|
|
1346 or when the comment leader changes.
|
|
|
1347 w Trailing white space indicates a paragraph continues in the next line.
|
|
|
1348 A line that ends in a non-white character ends a paragraph.
|
|
|
1349 a Automatic formatting of paragraphs. Every time text is inserted or
|
|
|
1350 deleted the paragraph will be reformatted. See |auto-format|.
|
|
|
1351 When the 'c' flag is present this only happens for recognized
|
|
|
1352 comments.
|
|
41
|
1353 n When formatting text, recognize numbered lists. This actually uses
|
|
|
1354 the 'formatlistpat' option, thus any kind of list can be used. The
|
|
|
1355 indent of the text after the number is used for the next line. The
|
|
|
1356 default is to find a number, optionally be followed by '.', ':', ')',
|
|
|
1357 ']' or '}'. Note that 'autoindent' must be set too. Doesn't work
|
|
|
1358 well together with "2".
|
|
7
|
1359 Example: >
|
|
|
1360 1. the first item
|
|
|
1361 wraps
|
|
|
1362 2. the second item
|
|
|
1363 2 When formatting text, use the indent of the second line of a paragraph
|
|
|
1364 for the rest of the paragraph, instead of the indent of the first
|
|
|
1365 line. This supports paragraphs in which the first line has a
|
|
|
1366 different indent than the rest. Note that 'autoindent' must be set
|
|
|
1367 too. Example: >
|
|
|
1368 first line of a paragraph
|
|
|
1369 second line of the same paragraph
|
|
|
1370 third line.
|
|
|
1371 v Vi-compatible auto-wrapping in insert mode: Only break a line at a
|
|
|
1372 blank that you have entered during the current insert command. (Note:
|
|
|
1373 this is not 100% Vi compatible. Vi has some "unexpected features" or
|
|
|
1374 bugs in this area. It uses the screen column instead of the line
|
|
|
1375 column.)
|
|
|
1376 b Like 'v', but only auto-wrap if you enter a blank at or before
|
|
|
1377 the wrap margin. If the line was longer than 'textwidth' when you
|
|
|
1378 started the insert, or you do not enter a blank in the insert before
|
|
|
1379 reaching 'textwidth', Vim does not perform auto-wrapping.
|
|
|
1380 l Long lines are not broken in insert mode: When a line was longer than
|
|
|
1381 'textwidth' when the insert command started, Vim does not
|
|
|
1382 automatically format it.
|
|
|
1383 m Also break at a multi-byte character above 255. This is useful for
|
|
|
1384 Asian text where every character is a word on its own.
|
|
|
1385 M When joining lines, don't insert a space before or after a multi-byte
|
|
|
1386 character. Overrules the 'B' flag.
|
|
|
1387 B When joining lines, don't insert a space between two multi-byte
|
|
|
1388 characters. Overruled by the 'M' flag.
|
|
|
1389 1 Don't break a line after a one-letter word. It's broken before it
|
|
|
1390 instead (if possible).
|
|
|
1391
|
|
|
1392
|
|
|
1393 With 't' and 'c' you can specify when Vim performs auto-wrapping:
|
|
|
1394 value action ~
|
|
|
1395 "" no automatic formatting (you can use "gq" for manual formatting)
|
|
|
1396 "t" automatic formatting of text, but not comments
|
|
|
1397 "c" automatic formatting for comments, but not text (good for C code)
|
|
|
1398 "tc" automatic formatting for text and comments
|
|
|
1399
|
|
|
1400 Note that when 'textwidth' is 0, Vim does no formatting anyway (but does
|
|
|
1401 insert comment leaders according to the 'comments' option).
|
|
|
1402
|
|
|
1403 Note that when 'paste' is on, Vim does no formatting at all.
|
|
|
1404
|
|
|
1405 Note that 'textwidth' can be non-zero even if Vim never performs auto-wrapping;
|
|
|
1406 'textwidth' is still useful for formatting with "gq".
|
|
|
1407
|
|
|
1408 If the 'comments' option includes "/*", "*" and/or "*/", then Vim has some
|
|
|
1409 built in stuff to treat these types of comments a bit more cleverly.
|
|
|
1410 Opening a new line before or after "/*" or "*/" (with 'r' or 'o' present in
|
|
|
1411 'formatoptions') gives the correct start of the line automatically. The same
|
|
|
1412 happens with formatting and auto-wrapping. Opening a line after a line
|
|
|
1413 starting with "/*" or "*" and containing "*/", will cause no comment leader to
|
|
|
1414 be inserted, and the indent of the new line is taken from the line containing
|
|
|
1415 the start of the comment.
|
|
|
1416 E.g.:
|
|
|
1417 /* ~
|
|
|
1418 * Your typical comment. ~
|
|
|
1419 */ ~
|
|
|
1420 The indent on this line is the same as the start of the above
|
|
|
1421 comment.
|
|
|
1422
|
|
|
1423 All of this should be really cool, especially in conjunction with the new
|
|
|
1424 :autocmd command to prepare different settings for different types of file.
|
|
|
1425
|
|
|
1426 Some examples:
|
|
|
1427 for C code (only format comments): >
|
|
|
1428 :set fo=croq
|
|
|
1429 < for Mail/news (format all, don't start comment with "o" command): >
|
|
|
1430 :set fo=tcrq
|
|
|
1431 <
|
|
|
1432
|
|
|
1433 Automatic formatting *auto-format*
|
|
|
1434
|
|
|
1435 When the 'a' flag is present in 'formatoptions' text is formatted
|
|
|
1436 automatically when inserting text or deleting text. This works nice for
|
|
|
1437 editing text paragraphs. A few hints on how to use this:
|
|
|
1438
|
|
|
1439 - You need to properly define paragraphs. The simplest is paragraphs that are
|
|
|
1440 separated by a blank line. When there is no separating blank line, consider
|
|
|
1441 using the 'w' flag and adding a space at the end of each line in the
|
|
|
1442 paragraphs except the last one.
|
|
|
1443
|
|
|
1444 - You can set the 'formatoptions' based on the type of file |filetype| or
|
|
|
1445 specifically for one file with a |modeline|.
|
|
|
1446
|
|
|
1447 - Set 'formatoptions' to "aw2tq" to make text with indents like this:
|
|
|
1448
|
|
|
1449 bla bla foobar bla
|
|
|
1450 bla foobar bla foobar bla
|
|
|
1451 bla bla foobar bla
|
|
|
1452 bla foobar bla bla foobar
|
|
|
1453
|
|
|
1454 - Add the 'c' flag to only auto-format comments. Useful in source code.
|
|
|
1455
|
|
|
1456 And a few warnings:
|
|
|
1457
|
|
|
1458 - When part of the text is not properly separated in paragraphs, making
|
|
|
1459 changes in this text will cause it to be formatted anyway. Consider doing >
|
|
|
1460
|
|
|
1461 :set fo-=a
|
|
|
1462
|
|
|
1463 - When using the 'w' flag (trailing space means paragraph continues) and
|
|
|
1464 deleting the last line of a paragraph with |dd|, the paragraph will be
|
|
|
1465 joined with the next one.
|
|
|
1466
|
|
|
1467 - Changed text is saved for undo. Formatting is also a change. Thus each
|
|
|
1468 format action saves text for undo. This may consume quite a lot of memory.
|
|
|
1469
|
|
|
1470 - Formatting a long paragraph and/or with complicated indenting may be slow.
|
|
|
1471
|
|
|
1472
|
|
|
1473 vim:tw=78:ts=8:ft=help:norl:
|
