annotate runtime/doc/change.txt @ 5745:2f225a17c26b v7.4.217

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