annotate runtime/doc/pattern.txt @ 1698:f4f8014d516e v7.2c.000

updated for version 7.2c-000
author vimboss
date Wed, 06 Aug 2008 17:06:04 +0000
parents 0b796e045c42
children 5232b9862f23
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1698
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
1 *pattern.txt* For Vim version 7.2c. Last change: 2008 Jul 16
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 Patterns and search commands *pattern-searches*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9 The very basics can be found in section |03.9| of the user manual. A few more
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10 explanations are in chapter 27 |usr_27.txt|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12 1. Search commands |search-commands|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
13 2. The definition of a pattern |search-pattern|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
14 3. Magic |/magic|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
15 4. Overview of pattern items |pattern-overview|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
16 5. Multi items |pattern-multi-items|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
17 6. Ordinary atoms |pattern-atoms|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
18 7. Ignoring case in a pattern |/ignorecase|
714
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
19 8. Composing characters |patterns-composing|
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
20 9. Compare with Perl patterns |perl-patterns|
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
21 10. Highlighting matches |match-highlight|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
22
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
23 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
24 1. Search commands *search-commands* *E486*
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 /{pattern}[/]<CR> Search forward for the [count]'th occurrence of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
28 {pattern} |exclusive|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
29
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
30 /{pattern}/{offset}<CR> Search forward for the [count]'th occurrence of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
31 {pattern} and go |{offset}| lines up or down.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
32 |linewise|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
33
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
34 */<CR>*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
35 /<CR> Search forward for the [count]'th latest used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
36 pattern |last-pattern| with latest used |{offset}|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
37
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
38 //{offset}<CR> Search forward for the [count]'th latest used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
39 pattern |last-pattern| with new |{offset}|. If
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
40 {offset} is empty no offset is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
41
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
42 *?*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
43 ?{pattern}[?]<CR> Search backward for the [count]'th previous
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
44 occurrence of {pattern} |exclusive|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
45
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
46 ?{pattern}?{offset}<CR> Search backward for the [count]'th previous
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
47 occurrence of {pattern} and go |{offset}| lines up or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
48 down |linewise|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
49
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
50 *?<CR>*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
51 ?<CR> Search backward for the [count]'th latest used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
52 pattern |last-pattern| with latest used |{offset}|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
53
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
54 ??{offset}<CR> Search backward for the [count]'th latest used
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
55 pattern |last-pattern| with new |{offset}|. If
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
56 {offset} is empty no offset is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
57
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
58 *n*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
59 n Repeat the latest "/" or "?" [count] times.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
60 |last-pattern| {Vi: no count}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
61
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
62 *N*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
63 N Repeat the latest "/" or "?" [count] times in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
64 opposite direction. |last-pattern| {Vi: no count}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
65
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
66 *star* *E348* *E349*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
67 * Search forward for the [count]'th occurrence of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
68 word nearest to the cursor. The word used for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
69 search is the first of:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
70 1. the keyword under the cursor |'iskeyword'|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
71 2. the first keyword after the cursor, in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
72 current line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
73 3. the non-blank word under the cursor
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
74 4. the first non-blank word after the cursor,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
75 in the current line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
76 Only whole keywords are searched for, like with the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
77 command "/\<keyword\>". |exclusive| {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
78 'ignorecase' is used, 'smartcase' is not.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
79
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
80 *#*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
81 # Same as "*", but search backward. The pound sign
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
82 (character 163) also works. If the "#" key works as
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
83 backspace, try using "stty erase <BS>" before starting
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
84 Vim (<BS> is CTRL-H or a real backspace). {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
85
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
86 *gstar*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
87 g* Like "*", but don't put "\<" and "\>" around the word.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
88 This makes the search also find matches that are not a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
89 whole word. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
90
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
91 *g#*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
92 g# Like "#", but don't put "\<" and "\>" around the word.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
93 This makes the search also find matches that are not a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
94 whole word. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
95
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
96 *gd*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
97 gd Goto local Declaration. When the cursor is on a local
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
98 variable, this command will jump to its declaration.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
99 First Vim searches for the start of the current
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
100 function, just like "[[". If it is not found the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
101 search stops in line 1. If it is found, Vim goes back
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
102 until a blank line is found. From this position Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
103 searches for the keyword under the cursor, like with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
104 "*", but lines that look like a comment are ignored
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
105 (see 'comments' option).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
106 Note that this is not guaranteed to work, Vim does not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
107 really check the syntax, it only searches for a match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
108 with the keyword. If included files also need to be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
109 searched use the commands listed in |include-search|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
110 After this command |n| searches forward for the next
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
111 match (not backward).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
112 {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
113
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
114 *gD*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
115 gD Goto global Declaration. When the cursor is on a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
116 global variable that is defined in the file, this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
117 command will jump to its declaration. This works just
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
118 like "gd", except that the search for the keyword
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
119 always starts in line 1. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
120
523
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 484
diff changeset
121 *1gd*
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 484
diff changeset
122 1gd Like "gd", but ignore matches inside a {} block that
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 484
diff changeset
123 ends before the cursor position. {not in Vi}
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 484
diff changeset
124
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 484
diff changeset
125 *1gD*
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 484
diff changeset
126 1gD Like "gD", but ignore matches inside a {} block that
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 484
diff changeset
127 ends before the cursor position. {not in Vi}
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 484
diff changeset
128
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
129 *CTRL-C*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
130 CTRL-C Interrupt current (search) command. Use CTRL-Break on
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
131 MS-DOS |dos-CTRL-Break|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
132 In Normal mode, any pending command is aborted.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
133
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
134 *:noh* *:nohlsearch*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
135 :noh[lsearch] Stop the highlighting for the 'hlsearch' option. It
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
136 is automatically turned back on when using a search
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
137 command, or setting the 'hlsearch' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
138 This command doesn't work in an autocommand, because
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
139 the highlighting state is saved and restored when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
140 executing autocommands |autocmd-searchpat|.
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
141 Same thing for when invoking a user function.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
142
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
143 While typing the search pattern the current match will be shown if the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
144 'incsearch' option is on. Remember that you still have to finish the search
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
145 command with <CR> to actually position the cursor at the displayed match. Or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
146 use <Esc> to abandon the search.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
147
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
148 All matches for the last used search pattern will be highlighted if you set
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
149 the 'hlsearch' option. This can be suspended with the |:nohlsearch| command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
150
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
151 *search-offset* *{offset}*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
152 These commands search for the specified pattern. With "/" and "?" an
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
153 additional offset may be given. There are two types of offsets: line offsets
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
154 and character offsets. {the character offsets are not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
155
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
156 The offset gives the cursor position relative to the found match:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
157 [num] [num] lines downwards, in column 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
158 +[num] [num] lines downwards, in column 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
159 -[num] [num] lines upwards, in column 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
160 e[+num] [num] characters to the right of the end of the match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
161 e[-num] [num] characters to the left of the end of the match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
162 s[+num] [num] characters to the right of the start of the match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
163 s[-num] [num] characters to the left of the start of the match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
164 b[+num] [num] identical to s[+num] above (mnemonic: begin)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
165 b[-num] [num] identical to s[-num] above (mnemonic: begin)
667
9090f866cd57 updated for version 7.0197
vimboss
parents: 651
diff changeset
166 ;{pattern} perform another search, see |//;|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
167
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
168 If a '-' or '+' is given but [num] is omitted, a count of one will be used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
169 When including an offset with 'e', the search becomes inclusive (the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
170 character the cursor lands on is included in operations).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
171
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
172 Examples:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
173
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
174 pattern cursor position ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
175 /test/+1 one line below "test", in column 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
176 /test/e on the last t of "test"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
177 /test/s+2 on the 's' of "test"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
178 /test/b-3 three characters before "test"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
179
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
180 If one of these commands is used after an operator, the characters between
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
181 the cursor position before and after the search is affected. However, if a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
182 line offset is given, the whole lines between the two cursor positions are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
183 affected.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
184
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
185 An example of how to search for matches with a pattern and change the match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
186 with another word: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
187 /foo<CR> find "foo"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
188 c//e change until end of match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
189 bar<Esc> type replacement
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
190 //<CR> go to start of next match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
191 c//e change until end of match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
192 beep<Esc> type another replacement
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
193 etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
194 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
195 *//;* *E386*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
196 A very special offset is ';' followed by another search command. For example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
197
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
198 /test 1/;/test
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
199 /test.*/+1;?ing?
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
200
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
201 The first one first finds the next occurrence of "test 1", and then the first
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
202 occurrence of "test" after that.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
203
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
204 This is like executing two search commands after each other, except that:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
205 - It can be used as a single motion command after an operator.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
206 - The direction for a following "n" or "N" command comes from the first
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
207 search command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
208 - When an error occurs the cursor is not moved at all.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
209
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
210 *last-pattern*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
211 The last used pattern and offset are remembered. They can be used to repeat
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
212 the search, possibly in another direction or with another count. Note that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
213 two patterns are remembered: One for 'normal' search commands and one for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
214 substitute command ":s". Each time an empty pattern is given, the previously
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
215 used pattern is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
216
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
217 The 'magic' option sticks with the last used pattern. If you change 'magic',
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
218 this will not change how the last used pattern will be interpreted.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
219 The 'ignorecase' option does not do this. When 'ignorecase' is changed, it
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
220 will result in the pattern to match other text.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
221
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
222 All matches for the last used search pattern will be highlighted if you set
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
223 the 'hlsearch' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
224
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
225 To clear the last used search pattern: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
226 :let @/ = ""
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
227 This will not set the pattern to an empty string, because that would match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
228 everywhere. The pattern is really cleared, like when starting Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
229
133
bcb347a8f934 updated for version 7.0044
vimboss
parents: 39
diff changeset
230 The search usually skips matches that don't move the cursor. Whether the next
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
231 match is found at the next character or after the skipped match depends on the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
232 'c' flag in 'cpoptions'. See |cpo-c|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
233 with 'c' flag: "/..." advances 1 to 3 characters
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
234 without 'c' flag: "/..." advances 1 character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
235 The unpredictability with the 'c' flag is caused by starting the search in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
236 first column, skipping matches until one is found past the cursor position.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
237
133
bcb347a8f934 updated for version 7.0044
vimboss
parents: 39
diff changeset
238 When searching backwards, searching starts at the start of the line, using the
bcb347a8f934 updated for version 7.0044
vimboss
parents: 39
diff changeset
239 'c' flag in 'cpoptions' as described above. Then the last match before the
bcb347a8f934 updated for version 7.0044
vimboss
parents: 39
diff changeset
240 cursor position is used.
bcb347a8f934 updated for version 7.0044
vimboss
parents: 39
diff changeset
241
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
242 In Vi the ":tag" command sets the last search pattern when the tag is searched
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
243 for. In Vim this is not done, the previous search pattern is still remembered,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
244 unless the 't' flag is present in 'cpoptions'. The search pattern is always
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
245 put in the search history.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
246
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
247 If the 'wrapscan' option is on (which is the default), searches wrap around
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
248 the end of the buffer. If 'wrapscan' is not set, the backward search stops
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
249 at the beginning and the forward search stops at the end of the buffer. If
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
250 'wrapscan' is set and the pattern was not found the error message "pattern
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
251 not found" is given, and the cursor will not be moved. If 'wrapscan' is not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
252 set the message becomes "search hit BOTTOM without match" when searching
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
253 forward, or "search hit TOP without match" when searching backward. If
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
254 wrapscan is set and the search wraps around the end of the file the message
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
255 "search hit TOP, continuing at BOTTOM" or "search hit BOTTOM, continuing at
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
256 TOP" is given when searching backwards or forwards respectively. This can be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
257 switched off by setting the 's' flag in the 'shortmess' option. The highlight
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
258 method 'w' is used for this message (default: standout).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
259
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
260 *search-range*
625
81fe2ccc1207 updated for version 7.0179
vimboss
parents: 523
diff changeset
261 You can limit the search command "/" to a certain range of lines by including
81fe2ccc1207 updated for version 7.0179
vimboss
parents: 523
diff changeset
262 \%>l items. For example, to match the word "limit" below line 199 and above
81fe2ccc1207 updated for version 7.0179
vimboss
parents: 523
diff changeset
263 line 300: >
81fe2ccc1207 updated for version 7.0179
vimboss
parents: 523
diff changeset
264 /\%>199l\%<300llimit
81fe2ccc1207 updated for version 7.0179
vimboss
parents: 523
diff changeset
265 Also see |/\%>l|.
81fe2ccc1207 updated for version 7.0179
vimboss
parents: 523
diff changeset
266
81fe2ccc1207 updated for version 7.0179
vimboss
parents: 523
diff changeset
267 Another way is to use the ":substitute" command with the 'c' flag. Example: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
268 :.,300s/Pattern//gc
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
269 This command will search from the cursor position until line 300 for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
270 "Pattern". At the match, you will be asked to type a character. Type 'q' to
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
271 stop at this match, type 'n' to find the next match.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
272
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
273 The "*", "#", "g*" and "g#" commands look for a word near the cursor in this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
274 order, the first one that is found is used:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
275 - The keyword currently under the cursor.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
276 - The first keyword to the right of the cursor, in the same line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
277 - The WORD currently under the cursor.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
278 - The first WORD to the right of the cursor, in the same line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
279 The keyword may only contain letters and characters in 'iskeyword'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
280 The WORD may contain any non-blanks (<Tab>s and/or <Space>s).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
281 Note that if you type with ten fingers, the characters are easy to remember:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
282 the "#" is under your left hand middle finger (search to the left and up) and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
283 the "*" is under your right hand middle finger (search to the right and down).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
284 (this depends on your keyboard layout though).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
285
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
286 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
287 2. The definition of a pattern *search-pattern* *pattern* *[pattern]*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
288 *regular-expression* *regexp* *Pattern*
190
a1f18bd133d6 updated for version 7.0057
vimboss
parents: 168
diff changeset
289 *E76* *E383* *E476*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
290
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
291 For starters, read chapter 27 of the user manual |usr_27.txt|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
292
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
293 */bar* */\bar* */pattern*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
294 1. A pattern is one or more branches, separated by "\|". It matches anything
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
295 that matches one of the branches. Example: "foo\|beep" matches "foo" and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
296 matches "beep". If more than one branch matches, the first one is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
297
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
298 pattern ::= branch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
299 or branch \| branch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
300 or branch \| branch \| branch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
301 etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
302
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
303 */branch* */\&*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
304 2. A branch is one or more concats, separated by "\&". It matches the last
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
305 concat, but only if all the preceding concats also match at the same
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
306 position. Examples:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
307 "foobeep\&..." matches "foo" in "foobeep".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
308 ".*Peter\&.*Bob" matches in a line containing both "Peter" and "Bob"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
309
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
310 branch ::= concat
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
311 or concat \& concat
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
312 or concat \& concat \& concat
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
313 etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
314
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
315 */concat*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
316 3. A concat is one or more pieces, concatenated. It matches a match for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
317 first piece, followed by a match for the second piece, etc. Example:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
318 "f[0-9]b", first matches "f", then a digit and then "b".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
319
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
320 concat ::= piece
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
321 or piece piece
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
322 or piece piece piece
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
323 etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
324
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
325 */piece*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
326 4. A piece is an atom, possibly followed by a multi, an indication of how many
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
327 times the atom can be matched. Example: "a*" matches any sequence of "a"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
328 characters: "", "a", "aa", etc. See |/multi|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
329
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
330 piece ::= atom
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
331 or atom multi
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
332
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
333 */atom*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
334 5. An atom can be one of a long list of items. Many atoms match one character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
335 in the text. It is often an ordinary character or a character class.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
336 Braces can be used to make a pattern into an atom. The "\z(\)" construct
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
337 is only for syntax highlighting.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
338
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
339 atom ::= ordinary-atom |/ordinary-atom|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
340 or \( pattern \) |/\(|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
341 or \%( pattern \) |/\%(|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
342 or \z( pattern \) |/\z(|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
343
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
344
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
345 ==============================================================================
840
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
346 3. Magic */magic*
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
347
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
348 Some characters in the pattern are taken literally. They match with the same
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
349 character in the text. When preceded with a backslash however, these
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
350 characters get a special meaning.
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
351
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
352 Other characters have a special meaning without a backslash. They need to be
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
353 preceded with a backslash to match literally.
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
354
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
355 If a character is taken literally or not depends on the 'magic' option and the
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
356 items mentioned next.
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
357 */\m* */\M*
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
358 Use of "\m" makes the pattern after it be interpreted as if 'magic' is set,
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
359 ignoring the actual value of the 'magic' option.
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
360 Use of "\M" makes the pattern after it be interpreted as if 'nomagic' is used.
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
361 */\v* */\V*
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
362 Use of "\v" means that in the pattern after it all ASCII characters except
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
363 '0'-'9', 'a'-'z', 'A'-'Z' and '_' have a special meaning. "very magic"
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
364
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
365 Use of "\V" means that in the pattern after it only the backslash has a
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
366 special meaning. "very nomagic"
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
367
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
368 Examples:
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
369 after: \v \m \M \V matches ~
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
370 'magic' 'nomagic'
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
371 $ $ $ \$ matches end-of-line
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
372 . . \. \. matches any character
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
373 * * \* \* any number of the previous atom
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
374 () \(\) \(\) \(\) grouping into an atom
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
375 | \| \| \| separating alternatives
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
376 \a \a \a \a alphabetic character
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
377 \\ \\ \\ \\ literal backslash
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
378 \. \. . . literal dot
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
379 \{ { { { literal '{'
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
380 a a a a literal 'a'
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
381
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
382 {only Vim supports \m, \M, \v and \V}
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
383
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
384 It is recommended to always keep the 'magic' option at the default setting,
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
385 which is 'magic'. This avoids portability problems. To make a pattern immune
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
386 to the 'magic' option being set or not, put "\m" or "\M" at the start of the
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
387 pattern.
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
388
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
389 ==============================================================================
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
390 4. Overview of pattern items *pattern-overview*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
391
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
392 Overview of multi items. */multi* *E61* *E62*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
393 More explanation and examples below, follow the links. *E64*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
394
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
395 multi ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
396 'magic' 'nomagic' matches of the preceding atom ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
397 |/star| * \* 0 or more as many as possible
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
398 |/\+| \+ \+ 1 or more as many as possible (*)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
399 |/\=| \= \= 0 or 1 as many as possible (*)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
400 |/\?| \? \? 0 or 1 as many as possible (*)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
401
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
402 |/\{| \{n,m} \{n,m} n to m as many as possible (*)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
403 \{n} \{n} n exactly (*)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
404 \{n,} \{n,} at least n as many as possible (*)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
405 \{,m} \{,m} 0 to m as many as possible (*)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
406 \{} \{} 0 or more as many as possible (same as *) (*)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
407
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
408 |/\{-| \{-n,m} \{-n,m} n to m as few as possible (*)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
409 \{-n} \{-n} n exactly (*)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
410 \{-n,} \{-n,} at least n as few as possible (*)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
411 \{-,m} \{-,m} 0 to m as few as possible (*)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
412 \{-} \{-} 0 or more as few as possible (*)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
413
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
414 *E59*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
415 |/\@>| \@> \@> 1, like matching a whole pattern (*)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
416 |/\@=| \@= \@= nothing, requires a match |/zero-width| (*)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
417 |/\@!| \@! \@! nothing, requires NO match |/zero-width| (*)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
418 |/\@<=| \@<= \@<= nothing, requires a match behind |/zero-width| (*)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
419 |/\@<!| \@<! \@<! nothing, requires NO match behind |/zero-width| (*)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
420
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
421 (*) {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
422
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
423
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
424 Overview of ordinary atoms. */ordinary-atom*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
425 More explanation and examples below, follow the links.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
426
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
427 ordinary atom ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
428 magic nomagic matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
429 |/^| ^ ^ start-of-line (at start of pattern) |/zero-width|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
430 |/\^| \^ \^ literal '^'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
431 |/\_^| \_^ \_^ start-of-line (used anywhere) |/zero-width|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
432 |/$| $ $ end-of-line (at end of pattern) |/zero-width|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
433 |/\$| \$ \$ literal '$'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
434 |/\_$| \_$ \_$ end-of-line (used anywhere) |/zero-width|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
435 |/.| . \. any single character (not an end-of-line)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
436 |/\_.| \_. \_. any single character or end-of-line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
437 |/\<| \< \< beginning of a word |/zero-width|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
438 |/\>| \> \> end of a word |/zero-width|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
439 |/\zs| \zs \zs anything, sets start of match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
440 |/\ze| \ze \ze anything, sets end of match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
441 |/\%^| \%^ \%^ beginning of file |/zero-width| *E71*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
442 |/\%$| \%$ \%$ end of file |/zero-width|
640
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
443 |/\%V| \%V \%V inside Visual area |/zero-width|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
444 |/\%#| \%# \%# cursor position |/zero-width|
640
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
445 |/\%'m| \%'m \%'m mark m position |/zero-width|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
446 |/\%l| \%23l \%23l in line 23 |/zero-width|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
447 |/\%c| \%23c \%23c in column 23 |/zero-width|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
448 |/\%v| \%23v \%23v in virtual column 23 |/zero-width|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
449
20
4ac1dce8dd5e updated for version 7.0012
vimboss
parents: 7
diff changeset
450 Character classes {not in Vi}: */character-classes*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
451 |/\i| \i \i identifier character (see 'isident' option)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
452 |/\I| \I \I like "\i", but excluding digits
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
453 |/\k| \k \k keyword character (see 'iskeyword' option)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
454 |/\K| \K \K like "\k", but excluding digits
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
455 |/\f| \f \f file name character (see 'isfname' option)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
456 |/\F| \F \F like "\f", but excluding digits
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
457 |/\p| \p \p printable character (see 'isprint' option)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
458 |/\P| \P \P like "\p", but excluding digits
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
459 |/\s| \s \s whitespace character: <Space> and <Tab>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
460 |/\S| \S \S non-whitespace character; opposite of \s
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
461 |/\d| \d \d digit: [0-9]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
462 |/\D| \D \D non-digit: [^0-9]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
463 |/\x| \x \x hex digit: [0-9A-Fa-f]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
464 |/\X| \X \X non-hex digit: [^0-9A-Fa-f]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
465 |/\o| \o \o octal digit: [0-7]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
466 |/\O| \O \O non-octal digit: [^0-7]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
467 |/\w| \w \w word character: [0-9A-Za-z_]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
468 |/\W| \W \W non-word character: [^0-9A-Za-z_]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
469 |/\h| \h \h head of word character: [A-Za-z_]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
470 |/\H| \H \H non-head of word character: [^A-Za-z_]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
471 |/\a| \a \a alphabetic character: [A-Za-z]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
472 |/\A| \A \A non-alphabetic character: [^A-Za-z]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
473 |/\l| \l \l lowercase character: [a-z]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
474 |/\L| \L \L non-lowercase character: [^a-z]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
475 |/\u| \u \u uppercase character: [A-Z]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
476 |/\U| \U \U non-uppercase character [^A-Z]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
477 |/\_| \_x \_x where x is any of the characters above: character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
478 class with end-of-line included
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
479 (end of character classes)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
480
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
481 |/\e| \e \e <Esc>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
482 |/\t| \t \t <Tab>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
483 |/\r| \r \r <CR>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
484 |/\b| \b \b <BS>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
485 |/\n| \n \n end-of-line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
486 |/~| ~ \~ last given substitute string
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
487 |/\1| \1 \1 same string as matched by first \(\) {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
488 |/\2| \2 \2 Like "\1", but uses second \(\)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
489 ...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
490 |/\9| \9 \9 Like "\1", but uses ninth \(\)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
491 *E68*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
492 |/\z1| \z1 \z1 only for syntax highlighting, see |:syn-ext-match|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
493 ...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
494 |/\z1| \z9 \z9 only for syntax highlighting, see |:syn-ext-match|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
495
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
496 x x a character with no special meaning matches itself
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
497
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
498 |/[]| [] \[] any character specified inside the []
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
499 |/\%[]| \%[] \%[] a sequence of optionally matched atoms
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
500
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
501 |/\c| \c \c ignore case, do not use the 'ignorecase' option
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
502 |/\C| \C \C match case, do not use the 'ignorecase' option
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
503 |/\m| \m \m 'magic' on for the following chars in the pattern
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
504 |/\M| \M \M 'magic' off for the following chars in the pattern
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
505 |/\v| \v \v the following chars in the pattern are "very magic"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
506 |/\V| \V \V the following chars in the pattern are "very nomagic"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
507 |/\Z| \Z \Z ignore differences in Unicode "combining characters".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
508 Useful when searching voweled Hebrew or Arabic text.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
509
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
510 |/\%d| \%d \%d match specified decimal character (eg \%d123
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
511 |/\%x| \%x \%x match specified hex character (eg \%x2a)
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
512 |/\%o| \%o \%o match specified octal character (eg \%o040)
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
513 |/\%u| \%u \%u match specified multibyte character (eg \%u20ac)
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
514 |/\%U| \%U \%U match specified large multibyte character (eg
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
515 \%U12345678)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
516
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
517 Example matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
518 \<\I\i* or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
519 \<\h\w*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
520 \<[a-zA-Z_][a-zA-Z0-9_]*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
521 An identifier (e.g., in a C program).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
522
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
523 \(\.$\|\. \) A period followed by <EOL> or a space.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
524
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
525 [.!?][])"']*\($\|[ ]\) A search pattern that finds the end of a sentence,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
526 with almost the same definition as the ")" command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
527
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
528 cat\Z Both "cat" and "càt" ("a" followed by 0x0300)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
529 Does not match "càt" (character 0x00e0), even
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
530 though it may look the same.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
531
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
532
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
533 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
534 5. Multi items *pattern-multi-items*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
535
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
536 An atom can be followed by an indication of how many times the atom can be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
537 matched and in what way. This is called a multi. See |/multi| for an
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
538 overview.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
539
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
540 */star* */\star* *E56*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
541 * (use \* when 'magic' is not set)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
542 Matches 0 or more of the preceding atom, as many as possible.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
543 Example 'nomagic' matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
544 a* a\* "", "a", "aa", "aaa", etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
545 .* \.\* anything, also an empty string, no end-of-line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
546 \_.* \_.\* everything up to the end of the buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
547 \_.*END \_.\*END everything up to and including the last "END"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
548 in the buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
549
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
550 Exception: When "*" is used at the start of the pattern or just after
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
551 "^" it matches the star character.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
552
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
553 Be aware that repeating "\_." can match a lot of text and take a long
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
554 time. For example, "\_.*END" matches all text from the current
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
555 position to the last occurrence of "END" in the file. Since the "*"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
556 will match as many as possible, this first skips over all lines until
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
557 the end of the file and then tries matching "END", backing up one
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
558 character at a time.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
559
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
560 */\+* *E57*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
561 \+ Matches 1 or more of the preceding atom, as many as possible. {not in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
562 Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
563 Example matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
564 ^.\+$ any non-empty line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
565 \s\+ white space of at least one character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
566
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
567 */\=*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
568 \= Matches 0 or 1 of the preceding atom, as many as possible. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
569 Example matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
570 foo\= "fo" and "foo"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
571
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
572 */\?*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
573 \? Just like \=. Cannot be used when searching backwards with the "?"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
574 command. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
575
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
576 */\{* *E58* *E60* *E554*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
577 \{n,m} Matches n to m of the preceding atom, as many as possible
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
578 \{n} Matches n of the preceding atom
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
579 \{n,} Matches at least n of the preceding atom, as many as possible
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
580 \{,m} Matches 0 to m of the preceding atom, as many as possible
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
581 \{} Matches 0 or more of the preceding atom, as many as possible (like *)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
582 */\{-*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
583 \{-n,m} matches n to m of the preceding atom, as few as possible
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
584 \{-n} matches n of the preceding atom
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
585 \{-n,} matches at least n of the preceding atom, as few as possible
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
586 \{-,m} matches 0 to m of the preceding atom, as few as possible
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
587 \{-} matches 0 or more of the preceding atom, as few as possible
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
588 {Vi does not have any of these}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
589
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 140
diff changeset
590 n and m are positive decimal numbers or zero
1125
96cd8222a819 updated for version 7.1a
vimboss
parents: 874
diff changeset
591 *non-greedy*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
592 If a "-" appears immediately after the "{", then a shortest match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
593 first algorithm is used (see example below). In particular, "\{-}" is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
594 the same as "*" but uses the shortest match first algorithm. BUT: A
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
595 match that starts earlier is preferred over a shorter match: "a\{-}b"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
596 matches "aaab" in "xaaab".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
597
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
598 Example matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
599 ab\{2,3}c "abbc" or "abbbc"
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
600 a\{5} "aaaaa"
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
601 ab\{2,}c "abbc", "abbbc", "abbbbc", etc.
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
602 ab\{,3}c "ac", "abc", "abbc" or "abbbc"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
603 a[bc]\{3}d "abbbd", "abbcd", "acbcd", "acccd", etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
604 a\(bc\)\{1,2}d "abcd" or "abcbcd"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
605 a[bc]\{-}[cd] "abc" in "abcd"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
606 a[bc]*[cd] "abcd" in "abcd"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
607
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
608 The } may optionally be preceded with a backslash: \{n,m\}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
609
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
610 */\@=*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
611 \@= Matches the preceding atom with zero width. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
612 Like "(?=pattern)" in Perl.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
613 Example matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
614 foo\(bar\)\@= "foo" in "foobar"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
615 foo\(bar\)\@=foo nothing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
616 */zero-width*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
617 When using "\@=" (or "^", "$", "\<", "\>") no characters are included
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
618 in the match. These items are only used to check if a match can be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
619 made. This can be tricky, because a match with following items will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
620 be done in the same position. The last example above will not match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
621 "foobarfoo", because it tries match "foo" in the same position where
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
622 "bar" matched.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
623
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
624 Note that using "\&" works the same as using "\@=": "foo\&.." is the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
625 same as "\(foo\)\@=..". But using "\&" is easier, you don't need the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
626 braces.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
627
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
628
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
629 */\@!*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
630 \@! Matches with zero width if the preceding atom does NOT match at the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
631 current position. |/zero-width| {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
632 Like '(?!pattern)" in Perl.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
633 Example matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
634 foo\(bar\)\@! any "foo" not followed by "bar"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
635 a.\{-}p\@! "a", "ap", "app", etc. not followed by a "p"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
636 if \(\(then\)\@!.\)*$ "if " not followed by "then"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
637
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
638 Using "\@!" is tricky, because there are many places where a pattern
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
639 does not match. "a.*p\@!" will match from an "a" to the end of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
640 line, because ".*" can match all characters in the line and the "p"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
641 doesn't match at the end of the line. "a.\{-}p\@!" will match any
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
642 "a", "ap", "aap", etc. that isn't followed by a "p", because the "."
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
643 can match a "p" and "p\@!" doesn't match after that.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
644
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
645 You can't use "\@!" to look for a non-match before the matching
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
646 position: "\(foo\)\@!bar" will match "bar" in "foobar", because at the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
647 position where "bar" matches, "foo" does not match. To avoid matching
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
648 "foobar" you could use "\(foo\)\@!...bar", but that doesn't match a
237
73354c21f1e4 updated for version 7.0066
vimboss
parents: 190
diff changeset
649 bar at the start of a line. Use "\(foo\)\@<!bar".
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
650
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
651 */\@<=*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
652 \@<= Matches with zero width if the preceding atom matches just before what
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
653 follows. |/zero-width| {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
654 Like '(?<=pattern)" in Perl, but Vim allows non-fixed-width patterns.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
655 Example matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
656 \(an\_s\+\)\@<=file "file" after "an" and white space or an
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
657 end-of-line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
658 For speed it's often much better to avoid this multi. Try using "\zs"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
659 instead |/\zs|. To match the same as the above example:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
660 an\_s\+\zsfile
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
661
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
662 "\@<=" and "\@<!" check for matches just before what follows.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
663 Theoretically these matches could start anywhere before this position.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
664 But to limit the time needed, only the line where what follows matches
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
665 is searched, and one line before that (if there is one). This should
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
666 be sufficient to match most things and not be too slow.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
667 The part of the pattern after "\@<=" and "\@<!" are checked for a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
668 match first, thus things like "\1" don't work to reference \(\) inside
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
669 the preceding atom. It does work the other way around:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
670 Example matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
671 \1\@<=,\([a-z]\+\) ",abc" in "abc,abc"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
672
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
673 */\@<!*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
674 \@<! Matches with zero width if the preceding atom does NOT match just
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
675 before what follows. Thus this matches if there is no position in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
676 current or previous line where the atom matches such that it ends just
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
677 before what follows. |/zero-width| {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
678 Like '(?<!pattern)" in Perl, but Vim allows non-fixed-width patterns.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
679 The match with the preceding atom is made to end just before the match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
680 with what follows, thus an atom that ends in ".*" will work.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
681 Warning: This can be slow (because many positions need to be checked
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
682 for a match).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
683 Example matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
684 \(foo\)\@<!bar any "bar" that's not in "foobar"
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
685 \(\/\/.*\)\@<!in "in" which is not after "//"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
686
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
687 */\@>*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
688 \@> Matches the preceding atom like matching a whole pattern. {not in Vi}
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
689 Like "(?>pattern)" in Perl.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
690 Example matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
691 \(a*\)\@>a nothing (the "a*" takes all the "a"'s, there can't be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
692 another one following)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
693
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
694 This matches the preceding atom as if it was a pattern by itself. If
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
695 it doesn't match, there is no retry with shorter sub-matches or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
696 anything. Observe this difference: "a*b" and "a*ab" both match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
697 "aaab", but in the second case the "a*" matches only the first two
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
698 "a"s. "\(a*\)\@>ab" will not match "aaab", because the "a*" matches
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
699 the "aaa" (as many "a"s as possible), thus the "ab" can't match.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
700
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
701
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
702 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
703 6. Ordinary atoms *pattern-atoms*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
704
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
705 An ordinary atom can be:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
706
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
707 */^*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
708 ^ At beginning of pattern or after "\|", "\(", "\%(" or "\n": matches
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
709 start-of-line; at other positions, matches literal '^'. |/zero-width|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
710 Example matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
711 ^beep( the start of the C function "beep" (probably).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
712
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
713 */\^*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
714 \^ Matches literal '^'. Can be used at any position in the pattern.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
715
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
716 */\_^*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
717 \_^ Matches start-of-line. |/zero-width| Can be used at any position in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
718 the pattern.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
719 Example matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
720 \_s*\_^foo white space and blank lines and then "foo" at
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
721 start-of-line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
722
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
723 */$*
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
724 $ At end of pattern or in front of "\|", "\)" or "\n" ('magic' on):
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
725 matches end-of-line <EOL>; at other positions, matches literal '$'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
726 |/zero-width|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
727
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
728 */\$*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
729 \$ Matches literal '$'. Can be used at any position in the pattern.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
730
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
731 */\_$*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
732 \_$ Matches end-of-line. |/zero-width| Can be used at any position in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
733 pattern. Note that "a\_$b" never matches, since "b" cannot match an
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
734 end-of-line. Use "a\nb" instead |/\n|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
735 Example matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
736 foo\_$\_s* "foo" at end-of-line and following white space and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
737 blank lines
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
738
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
739 . (with 'nomagic': \.) */.* */\.*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
740 Matches any single character, but not an end-of-line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
741
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
742 */\_.*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
743 \_. Matches any single character or end-of-line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
744 Careful: "\_.*" matches all text to the end of the buffer!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
745
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
746 */\<*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
747 \< Matches the beginning of a word: The next char is the first char of a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
748 word. The 'iskeyword' option specifies what is a word character.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
749 |/zero-width|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
750
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
751 */\>*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
752 \> Matches the end of a word: The previous char is the last char of a
237
73354c21f1e4 updated for version 7.0066
vimboss
parents: 190
diff changeset
753 word. The 'iskeyword' option specifies what is a word character.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
754 |/zero-width|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
755
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
756 */\zs*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
757 \zs Matches at any position, and sets the start of the match there: The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
758 next char is the first char of the whole match. |/zero-width|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
759 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
760 /^\s*\zsif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
761 < matches an "if" at the start of a line, ignoring white space.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
762 Can be used multiple times, the last one encountered in a matching
237
73354c21f1e4 updated for version 7.0066
vimboss
parents: 190
diff changeset
763 branch is used. Example: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
764 /\(.\{-}\zsFab\)\{3}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
765 < Finds the third occurrence of "Fab".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
766 {not in Vi} {not available when compiled without the +syntax feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
767 */\ze*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
768 \ze Matches at any position, and sets the end of the match there: The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
769 previous char is the last char of the whole match. |/zero-width|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
770 Can be used multiple times, the last one encountered in a matching
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
771 branch is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
772 Example: "end\ze\(if\|for\)" matches the "end" in "endif" and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
773 "endfor".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
774 {not in Vi} {not available when compiled without the +syntax feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
775
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
776 */\%^* *start-of-file*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
777 \%^ Matches start of the file. When matching with a string, matches the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
778 start of the string. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
779 For example, to find the first "VIM" in a file: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
780 /\%^\_.\{-}\zsVIM
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
781 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
782 */\%$* *end-of-file*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
783 \%$ Matches end of the file. When matching with a string, matches the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
784 end of the string. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
785 Note that this does NOT find the last "VIM" in a file: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
786 /VIM\_.\{-}\%$
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
787 < It will find the next VIM, because the part after it will always
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
788 match. This one will find the last "VIM" in the file: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
789 /VIM\ze\(\(VIM\)\@!\_.\)*\%$
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
790 < This uses |/\@!| to ascertain that "VIM" does NOT match in any
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
791 position after the first "VIM".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
792 Searching from the end of the file backwards is easier!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
793
640
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
794 */\%V*
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
795 \%V Match inside the Visual area. When Visual mode has already been
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
796 stopped match in the area that |gv| would reselect.
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
797 Only works for the current buffer.
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
798
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
799 */\%#* *cursor-position*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
800 \%# Matches with the cursor position. Only works when matching in a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
801 buffer displayed in a window. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
802 WARNING: When the cursor is moved after the pattern was used, the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
803 result becomes invalid. Vim doesn't automatically update the matches.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
804 This is especially relevant for syntax highlighting and 'hlsearch'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
805 In other words: When the cursor moves the display isn't updated for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
806 this change. An update is done for lines which are changed (the whole
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
807 line is updated) or when using the |CTRL-L| command (the whole screen
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
808 is updated). Example, to highlight the word under the cursor: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
809 /\k*\%#\k*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
810 < When 'hlsearch' is set and you move the cursor around and make changes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
811 this will clearly show when the match is updated or not.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
812
640
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
813 */\%'m* */\%<'m* */\%>'m*
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
814 \%'m Matches with the position of mark m.
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
815 \%<'m Matches before the position of mark m.
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
816 \%>'m Matches after the position of mark m.
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
817 Example, to highlight the text from mark 's to 'e: >
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
818 /.\%>'s.*\%<'e..
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
819 < Note that two dots are required to include mark 'e in the match. That
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
820 is because "\%<'e" matches at the character before the 'e mark, and
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
821 since it's a |/zero-width| match it doesn't include that character.
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
822 {not in Vi}
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
823 WARNING: When the mark is moved after the pattern was used, the result
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
824 becomes invalid. Vim doesn't automatically update the matches.
651
bc95c6c4bac1 updated for version 7.0191
vimboss
parents: 640
diff changeset
825 Similar to moving the cursor for "\%#" |/\%#|.
640
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
826
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
827 */\%l* */\%>l* */\%<l*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
828 \%23l Matches in a specific line.
625
81fe2ccc1207 updated for version 7.0179
vimboss
parents: 523
diff changeset
829 \%<23l Matches above a specific line (lower line number).
81fe2ccc1207 updated for version 7.0179
vimboss
parents: 523
diff changeset
830 \%>23l Matches below a specific line (higher line number).
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
831 These three can be used to match specific lines in a buffer. The "23"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
832 can be any line number. The first line is 1. {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
833 WARNING: When inserting or deleting lines Vim does not automatically
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
834 update the matches. This means Syntax highlighting quickly becomes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
835 wrong.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
836 Example, to highlight the line where the cursor currently is: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
837 :exe '/\%' . line(".") . 'l.*'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
838 < When 'hlsearch' is set and you move the cursor around and make changes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
839 this will clearly show when the match is updated or not.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
840
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
841 */\%c* */\%>c* */\%<c*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
842 \%23c Matches in a specific column.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
843 \%<23c Matches before a specific column.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
844 \%>23c Matches after a specific column.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
845 These three can be used to match specific columns in a buffer or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
846 string. The "23" can be any column number. The first column is 1.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
847 Actually, the column is the byte number (thus it's not exactly right
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
848 for multi-byte characters). {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
849 WARNING: When inserting or deleting text Vim does not automatically
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
850 update the matches. This means Syntax highlighting quickly becomes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
851 wrong.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
852 Example, to highlight the column where the cursor currently is: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
853 :exe '/\%' . col(".") . 'c'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
854 < When 'hlsearch' is set and you move the cursor around and make changes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
855 this will clearly show when the match is updated or not.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
856 Example for matching a single byte in column 44: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
857 /\%>43c.\%<46c
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
858 < Note that "\%<46c" matches in column 45 when the "." matches a byte in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
859 column 44.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
860 */\%v* */\%>v* */\%<v*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
861 \%23v Matches in a specific virtual column.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
862 \%<23v Matches before a specific virtual column.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
863 \%>23v Matches after a specific virtual column.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
864 These three can be used to match specific virtual columns in a buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
865 or string. When not matching with a buffer in a window, the option
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
866 values of the current window are used (e.g., 'tabstop').
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
867 The "23" can be any column number. The first column is 1.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
868 Note that some virtual column positions will never match, because they
1270
d9d524594fe5 updated for version 7.1
vimboss
parents: 1221
diff changeset
869 are halfway through a tab or other character that occupies more than
d9d524594fe5 updated for version 7.1
vimboss
parents: 1221
diff changeset
870 one screen character. {not in Vi}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
871 WARNING: When inserting or deleting text Vim does not automatically
283
a2ff714de3db updated for version 7.0075
vimboss
parents: 237
diff changeset
872 update highlighted matches. This means Syntax highlighting quickly
a2ff714de3db updated for version 7.0075
vimboss
parents: 237
diff changeset
873 becomes wrong.
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
874 Example, to highlight all the characters after virtual column 72: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
875 /\%>72v.*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
876 < When 'hlsearch' is set and you move the cursor around and make changes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
877 this will clearly show when the match is updated or not.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
878 To match the text up to column 17: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
879 /.*\%17v
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
880 < Column 17 is not included, because that's where the "\%17v" matches,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
881 and since this is a |/zero-width| match, column 17 isn't included in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
882 the match. This does the same: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
883 /.*\%<18v
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
884 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
885
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
886 Character classes: {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
887 \i identifier character (see 'isident' option) */\i*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
888 \I like "\i", but excluding digits */\I*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
889 \k keyword character (see 'iskeyword' option) */\k*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
890 \K like "\k", but excluding digits */\K*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
891 \f file name character (see 'isfname' option) */\f*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
892 \F like "\f", but excluding digits */\F*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
893 \p printable character (see 'isprint' option) */\p*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
894 \P like "\p", but excluding digits */\P*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
895
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
896 NOTE: the above also work for multi-byte characters. The ones below only
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
897 match ASCII characters, as indicated by the range.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
898
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
899 *whitespace* *white-space*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
900 \s whitespace character: <Space> and <Tab> */\s*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
901 \S non-whitespace character; opposite of \s */\S*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
902 \d digit: [0-9] */\d*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
903 \D non-digit: [^0-9] */\D*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
904 \x hex digit: [0-9A-Fa-f] */\x*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
905 \X non-hex digit: [^0-9A-Fa-f] */\X*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
906 \o octal digit: [0-7] */\o*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
907 \O non-octal digit: [^0-7] */\O*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
908 \w word character: [0-9A-Za-z_] */\w*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
909 \W non-word character: [^0-9A-Za-z_] */\W*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
910 \h head of word character: [A-Za-z_] */\h*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
911 \H non-head of word character: [^A-Za-z_] */\H*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
912 \a alphabetic character: [A-Za-z] */\a*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
913 \A non-alphabetic character: [^A-Za-z] */\A*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
914 \l lowercase character: [a-z] */\l*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
915 \L non-lowercase character: [^a-z] */\L*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
916 \u uppercase character: [A-Z] */\u*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
917 \U non-uppercase character [^A-Z] */\U*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
918
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
919 NOTE: Using the atom is faster than the [] form.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
920
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
921 NOTE: 'ignorecase', "\c" and "\C" are not used by character classes.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
922
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
923 */\_* *E63* */\_i* */\_I* */\_k* */\_K* */\_f* */\_F*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
924 */\_p* */\_P* */\_s* */\_S* */\_d* */\_D* */\_x* */\_X*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
925 */\_o* */\_O* */\_w* */\_W* */\_h* */\_H* */\_a* */\_A*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
926 */\_l* */\_L* */\_u* */\_U*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
927 \_x Where "x" is any of the characters above: The character class with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
928 end-of-line added
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
929 (end of character classes)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
930
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
931 \e matches <Esc> */\e*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
932 \t matches <Tab> */\t*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
933 \r matches <CR> */\r*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
934 \b matches <BS> */\b*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
935 \n matches an end-of-line */\n*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
936 When matching in a string instead of buffer text a literal newline
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
937 character is matched.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
938
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
939 ~ matches the last given substitute string */~* */\~*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
940
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
941 \(\) A pattern enclosed by escaped parentheses. */\(* */\(\)* */\)*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
942 E.g., "\(^a\)" matches 'a' at the start of a line. *E51* *E54* *E55*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
943
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
944 \1 Matches the same string that was matched by */\1* *E65*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
945 the first sub-expression in \( and \). {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
946 Example: "\([a-z]\).\1" matches "ata", "ehe", "tot", etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
947 \2 Like "\1", but uses second sub-expression, */\2*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
948 ... */\3*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
949 \9 Like "\1", but uses ninth sub-expression. */\9*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
950 Note: The numbering of groups is done based on which "\(" comes first
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
951 in the pattern (going left to right), NOT based on what is matched
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
952 first.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
953
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
954 \%(\) A pattern enclosed by escaped parentheses. */\%(\)* */\%(* *E53*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
955 Just like \(\), but without counting it as a sub-expression. This
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
956 allows using more groups and it's a little bit faster.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
957 {not in Vi}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
958
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
959 x A single character, with no special meaning, matches itself
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
960
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
961 */\* */\\*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
962 \x A backslash followed by a single character, with no special meaning,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
963 is reserved for future expansions
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
964
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
965 [] (with 'nomagic': \[]) */[]* */\[]* */\_[]* */collection*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
966 \_[]
237
73354c21f1e4 updated for version 7.0066
vimboss
parents: 190
diff changeset
967 A collection. This is a sequence of characters enclosed in brackets.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
968 It matches any single character in the collection.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
969 Example matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
970 [xyz] any 'x', 'y' or 'z'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
971 [a-zA-Z]$ any alphabetic character at the end of a line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
972 \c[a-z]$ same
1125
96cd8222a819 updated for version 7.1a
vimboss
parents: 874
diff changeset
973 */[\n]*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
974 With "\_" prepended the collection also includes the end-of-line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
975 The same can be done by including "\n" in the collection. The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
976 end-of-line is also matched when the collection starts with "^"! Thus
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
977 "\_[^ab]" matches the end-of-line and any character but "a" and "b".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
978 This makes it Vi compatible: Without the "\_" or "\n" the collection
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
979 does not match an end-of-line.
484
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 481
diff changeset
980 *E769*
481
66080ac5dab7 updated for version 7.0130
vimboss
parents: 283
diff changeset
981 When the ']' is not there Vim will not give an error message but
484
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 481
diff changeset
982 assume no collection is used. Useful to search for '['. However, you
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 481
diff changeset
983 do get E769 for internal searching.
481
66080ac5dab7 updated for version 7.0130
vimboss
parents: 283
diff changeset
984
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
985 If the sequence begins with "^", it matches any single character NOT
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
986 in the collection: "[^xyz]" matches anything but 'x', 'y' and 'z'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
987 - If two characters in the sequence are separated by '-', this is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
988 shorthand for the full list of ASCII characters between them. E.g.,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
989 "[0-9]" matches any decimal digit.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
990 - A character class expression is evaluated to the set of characters
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
991 belonging to that character class. The following character classes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
992 are supported:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
993 Name Contents ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
994 *[:alnum:]* [:alnum:] letters and digits
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
995 *[:alpha:]* [:alpha:] letters
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
996 *[:blank:]* [:blank:] space and tab characters
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
997 *[:cntrl:]* [:cntrl:] control characters
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
998 *[:digit:]* [:digit:] decimal digits
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
999 *[:graph:]* [:graph:] printable characters excluding space
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1000 *[:lower:]* [:lower:] lowercase letters (all letters when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1001 'ignorecase' is used)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1002 *[:print:]* [:print:] printable characters including space
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1003 *[:punct:]* [:punct:] punctuation characters
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1004 *[:space:]* [:space:] whitespace characters
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1005 *[:upper:]* [:upper:] uppercase letters (all letters when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1006 'ignorecase' is used)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1007 *[:xdigit:]* [:xdigit:] hexadecimal digits
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1008 *[:return:]* [:return:] the <CR> character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1009 *[:tab:]* [:tab:] the <Tab> character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1010 *[:escape:]* [:escape:] the <Esc> character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1011 *[:backspace:]* [:backspace:] the <BS> character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1012 The brackets in character class expressions are additional to the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1013 brackets delimiting a collection. For example, the following is a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1014 plausible pattern for a UNIX filename: "[-./[:alnum:]_~]\+" That is,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1015 a list of at least one character, each of which is either '-', '.',
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1016 '/', alphabetic, numeric, '_' or '~'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1017 These items only work for 8-bit characters.
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 140
diff changeset
1018 */[[=* *[==]*
4d9eabb1396e updated for version 7.0051
vimboss
parents: 140
diff changeset
1019 - An equivalence class. This means that characters are matched that
4d9eabb1396e updated for version 7.0051
vimboss
parents: 140
diff changeset
1020 have almost the same meaning, e.g., when ignoring accents. The form
4d9eabb1396e updated for version 7.0051
vimboss
parents: 140
diff changeset
1021 is:
856
8cd729851562 updated for version 7.0g
vimboss
parents: 853
diff changeset
1022 [=a=]
853
d10fbefd3bc1 updated for version 7.0f05
vimboss
parents: 842
diff changeset
1023 Currently this is only implemented for latin1. Also works for the
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 140
diff changeset
1024 latin1 characters in utf-8 and latin9.
4d9eabb1396e updated for version 7.0051
vimboss
parents: 140
diff changeset
1025 */[[.* *[..]*
4d9eabb1396e updated for version 7.0051
vimboss
parents: 140
diff changeset
1026 - A collation element. This currently simply accepts a single
4d9eabb1396e updated for version 7.0051
vimboss
parents: 140
diff changeset
1027 character in the form:
856
8cd729851562 updated for version 7.0g
vimboss
parents: 853
diff changeset
1028 [.a.]
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1029 */\]*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1030 - To include a literal ']', '^', '-' or '\' in the collection, put a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1031 backslash before it: "[xyz\]]", "[\^xyz]", "[xy\-z]" and "[xyz\\]".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1032 (Note: POSIX does not support the use of a backslash this way). For
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1033 ']' you can also make it the first character (following a possible
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1034 "^"): "[]xyz]" or "[^]xyz]" {not in Vi}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1035 For '-' you can also make it the first or last character: "[-xyz]",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1036 "[^-xyz]" or "[xyz-]". For '\' you can also let it be followed by
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1037 any character that's not in "^]-\bertn". "[\xyz]" matches '\', 'x',
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1038 'y' and 'z'. It's better to use "\\" though, future expansions may
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1039 use other characters after '\'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1040 - The following translations are accepted when the 'l' flag is not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1041 included in 'cpoptions' {not in Vi}:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1042 \e <Esc>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1043 \t <Tab>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1044 \r <CR> (NOT end-of-line!)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1045 \b <BS>
1125
96cd8222a819 updated for version 7.1a
vimboss
parents: 874
diff changeset
1046 \n line break, see above |/[\n]|
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
1047 \d123 decimal number of character
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
1048 \o40 octal number of character up to 0377
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
1049 \x20 hexadecimal number of character up to 0xff
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
1050 \u20AC hex. number of multibyte character up to 0xffff
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
1051 \U1234 hex. number of multibyte character up to 0xffffffff
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1052 NOTE: The other backslash codes mentioned above do not work inside
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1053 []!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1054 - Matching with a collection can be slow, because each character in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1055 the text has to be compared with each character in the collection.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1056 Use one of the other atoms above when possible. Example: "\d" is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1057 much faster than "[0-9]" and matches the same characters.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1058
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1059 */\%[]* *E69* *E70* *E369*
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
1060 \%[] A sequence of optionally matched atoms. This always matches.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1061 It matches as much of the list of atoms it contains as possible. Thus
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1062 it stops at the first atom that doesn't match. For example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1063 /r\%[ead]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1064 < matches "r", "re", "rea" or "read". The longest that matches is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1065 To match the Ex command "function", where "fu" is required and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1066 "nction" is optional, this would work: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1067 /\<fu\%[nction]\>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1068 < The end-of-word atom "\>" is used to avoid matching "fu" in "full".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1069 It gets more complicated when the atoms are not ordinary characters.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1070 You don't often have to use it, but it is possible. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1071 /\<r\%[[eo]ad]\>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1072 < Matches the words "r", "re", "ro", "rea", "roa", "read" and "road".
1125
96cd8222a819 updated for version 7.1a
vimboss
parents: 874
diff changeset
1073 There can be no \(\), \%(\) or \z(\) items inside the [] and \%[] does
96cd8222a819 updated for version 7.1a
vimboss
parents: 874
diff changeset
1074 not nest.
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
1075 To include a "[" use "[[]" and for "]" use []]", e.g.,: >
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
1076 /index\%[[[]0[]]]
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
1077 < matches "index" "index[", "index[0" and "index[0]".
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1078 {not available when compiled without the +syntax feature}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1079
140
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
1080 */\%d* */\%x* */\%o* */\%u* */\%U* *E678*
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
1081
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
1082 \%d123 Matches the character specified with a decimal number. Must be
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
1083 followed by a non-digit.
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
1084 \%o40 Matches the character specified with an octal number up to 0377.
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
1085 Numbers below 040 must be followed by a non-octal digit or a non-digit.
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
1086 \%x2a Matches the character specified with up to two hexadecimal characters.
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
1087 \%u20AC Matches the character specified with up to four hexadecimal
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
1088 characters.
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
1089 \%U1234abcd Matches the character specified with up to eight hexadecimal
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
1090 characters.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1091
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1092 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1093 7. Ignoring case in a pattern */ignorecase*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1094
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1095 If the 'ignorecase' option is on, the case of normal letters is ignored.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1096 'smartcase' can be set to ignore case when the pattern contains lowercase
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1097 letters only.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1098 */\c* */\C*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1099 When "\c" appears anywhere in the pattern, the whole pattern is handled like
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1100 'ignorecase' is on. The actual value of 'ignorecase' and 'smartcase' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1101 ignored. "\C" does the opposite: Force matching case for the whole pattern.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1102 {only Vim supports \c and \C}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1103 Note that 'ignorecase', "\c" and "\C" are not used for the character classes.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1104
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1105 Examples:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1106 pattern 'ignorecase' 'smartcase' matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1107 foo off - foo
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1108 foo on - foo Foo FOO
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1109 Foo on off foo Foo FOO
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1110 Foo on on Foo
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1111 \cfoo - - foo Foo FOO
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1112 foo\C - - foo
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1113
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1114 Technical detail: *NL-used-for-Nul*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1115 <Nul> characters in the file are stored as <NL> in memory. In the display
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1116 they are shown as "^@". The translation is done when reading and writing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1117 files. To match a <Nul> with a search pattern you can just enter CTRL-@ or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1118 "CTRL-V 000". This is probably just what you expect. Internally the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1119 character is replaced with a <NL> in the search pattern. What is unusual is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1120 that typing CTRL-V CTRL-J also inserts a <NL>, thus also searches for a <Nul>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1121 in the file. {Vi cannot handle <Nul> characters in the file at all}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1122
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1123 *CR-used-for-NL*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1124 When 'fileformat' is "mac", <NL> characters in the file are stored as <CR>
1698
f4f8014d516e updated for version 7.2c-000
vimboss
parents: 1668
diff changeset
1125 characters internally. In the text they are shown as "^J". Otherwise this
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1126 works similar to the usage of <NL> for a <Nul>.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1127
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1128 When working with expression evaluation, a <NL> character in the pattern
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1129 matches a <NL> in the string. The use of "\n" (backslash n) to match a <NL>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1130 doesn't work there, it only works to match text in the buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1131
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1132 *pattern-multi-byte*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1133 Patterns will also work with multi-byte characters, mostly as you would
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1134 expect. But invalid bytes may cause trouble, a pattern with an invalid byte
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1135 will probably never match.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1136
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1137 ==============================================================================
714
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1138 8. Composing characters *patterns-composing*
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1139
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1140 */\Z*
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1141 When "\Z" appears anywhere in the pattern, composing characters are ignored.
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1142 Thus only the base characters need to match, the composing characters may be
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1143 different and the number of composing characters may differ. Only relevant
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1144 when 'encoding' is "utf-8".
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1145
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1146 When a composing character appears at the start of the pattern of after an
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1147 item that doesn't include the composing character, a match is found at any
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1148 character that includes this composing character.
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1149
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1150 When using a dot and a composing character, this works the same as the
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1151 composing character by itself, except that it doesn't matter what comes before
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1152 this.
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1153
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1154 The order of composing characters matters, even though changing the order
1125
96cd8222a819 updated for version 7.1a
vimboss
parents: 874
diff changeset
1155 doesn't change what a character looks like. This may change in the future.
714
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1156
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1157 ==============================================================================
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1158 9. Compare with Perl patterns *perl-patterns*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1159
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1160 Vim's regexes are most similar to Perl's, in terms of what you can do. The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1161 difference between them is mostly just notation; here's a summary of where
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1162 they differ:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1163
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1164 Capability in Vimspeak in Perlspeak ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1165 ----------------------------------------------------------------
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1166 force case insensitivity \c (?i)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1167 force case sensitivity \C (?-i)
714
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1168 backref-less grouping \%(atom\) (?:atom)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1169 conservative quantifiers \{-n,m} *?, +?, ??, {}?
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1170 0-width match atom\@= (?=atom)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1171 0-width non-match atom\@! (?!atom)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1172 0-width preceding match atom\@<= (?<=atom)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1173 0-width preceding non-match atom\@<! (?<!atom)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1174 match without retry atom\@> (?>atom)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1175
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1176 Vim and Perl handle newline characters inside a string a bit differently:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1177
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1178 In Perl, ^ and $ only match at the very beginning and end of the text,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1179 by default, but you can set the 'm' flag, which lets them match at
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1180 embedded newlines as well. You can also set the 's' flag, which causes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1181 a . to match newlines as well. (Both these flags can be changed inside
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1182 a pattern using the same syntax used for the i flag above, BTW.)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1183
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1184 On the other hand, Vim's ^ and $ always match at embedded newlines, and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1185 you get two separate atoms, \%^ and \%$, which only match at the very
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1186 start and end of the text, respectively. Vim solves the second problem
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1187 by giving you the \_ "modifier": put it in front of a . or a character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1188 class, and they will match newlines as well.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1189
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1190 Finally, these constructs are unique to Perl:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1191 - execution of arbitrary code in the regex: (?{perl code})
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1192 - conditional expressions: (?(condition)true-expr|false-expr)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1193
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1194 ...and these are unique to Vim:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1195 - changing the magic-ness of a pattern: \v \V \m \M
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1196 (very useful for avoiding backslashitis)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1197 - sequence of optionally matching atoms: \%[atoms]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1198 - \& (which is to \| what "and" is to "or"; it forces several branches
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1199 to match at one spot)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1200 - matching lines/columns by number: \%5l \%5c \%5v
714
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1201 - setting the start and end of the match: \zs \ze
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1202
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1203 ==============================================================================
714
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1204 10. Highlighting matches *match-highlight*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1205
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1206 *:mat* *:match*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1207 :mat[ch] {group} /{pattern}/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1208 Define a pattern to highlight in the current window. It will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1209 be highlighted with {group}. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1210 :highlight MyGroup ctermbg=green guibg=green
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1211 :match MyGroup /TODO/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1212 < Instead of // any character can be used to mark the start and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1213 end of the {pattern}. Watch out for using special characters,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1214 such as '"' and '|'.
699
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1215
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1216 {group} must exist at the moment this command is executed.
699
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1217
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1218 The {group} highlighting still applies when a character is
1326
22886f3d882d updated for version 7.1-040
vimboss
parents: 1270
diff changeset
1219 to be highlighted for 'hlsearch', as the highlighting for
22886f3d882d updated for version 7.1-040
vimboss
parents: 1270
diff changeset
1220 matches is given higher priority than that of 'hlsearch'.
22886f3d882d updated for version 7.1-040
vimboss
parents: 1270
diff changeset
1221 Syntax highlighting (see 'syntax') is also overruled by
22886f3d882d updated for version 7.1-040
vimboss
parents: 1270
diff changeset
1222 matches.
699
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1223
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1224 Note that highlighting the last used search pattern with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1225 'hlsearch' is used in all windows, while the pattern defined
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1226 with ":match" only exists in the current window. It is kept
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1227 when switching to another buffer.
699
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1228
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1229 'ignorecase' does not apply, use |/\c| in the pattern to
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1230 ignore case. Otherwise case is not ignored.
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1231
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
1232 'redrawtime' defines the maximum time searched for pattern
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
1233 matches.
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
1234
1125
96cd8222a819 updated for version 7.1a
vimboss
parents: 874
diff changeset
1235 When matching end-of-line and Vim redraws only part of the
96cd8222a819 updated for version 7.1a
vimboss
parents: 874
diff changeset
1236 display you may get unexpected results. That is because Vim
96cd8222a819 updated for version 7.1a
vimboss
parents: 874
diff changeset
1237 looks for a match in the line where redrawing starts.
96cd8222a819 updated for version 7.1a
vimboss
parents: 874
diff changeset
1238
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
1239 Also see |matcharg()| and |getmatches()|. The former returns
1326
22886f3d882d updated for version 7.1-040
vimboss
parents: 1270
diff changeset
1240 the highlight group and pattern of a previous |:match|
22886f3d882d updated for version 7.1-040
vimboss
parents: 1270
diff changeset
1241 command. The latter returns a list with highlight groups and
22886f3d882d updated for version 7.1-040
vimboss
parents: 1270
diff changeset
1242 patterns defined by both |matchadd()| and |:match|.
22886f3d882d updated for version 7.1-040
vimboss
parents: 1270
diff changeset
1243
22886f3d882d updated for version 7.1-040
vimboss
parents: 1270
diff changeset
1244 Highlighting matches using |:match| are limited to three
22886f3d882d updated for version 7.1-040
vimboss
parents: 1270
diff changeset
1245 matches (aside from |:match|, |:2match| and |:3match|are
22886f3d882d updated for version 7.1-040
vimboss
parents: 1270
diff changeset
1246 available). |matchadd()| does not have this limitation and in
22886f3d882d updated for version 7.1-040
vimboss
parents: 1270
diff changeset
1247 addition makes it possible to prioritize matches.
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 810
diff changeset
1248
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1249 Another example, which highlights all characters in virtual
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1250 column 72 and more: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1251 :highlight rightMargin term=bold ctermfg=blue guifg=blue
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1252 :match rightMargin /.\%>72v/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1253 < To highlight all character that are in virtual column 7: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1254 :highlight col8 ctermbg=grey guibg=grey
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1255 :match col8 /\%<8v.\%>7v/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1256 < Note the use of two items to also match a character that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1257 occupies more than one virtual column, such as a TAB.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1258
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1259 :mat[ch]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1260 :mat[ch] none
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1261 Clear a previously defined match pattern.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1262
699
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1263
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 810
diff changeset
1264 :2mat[ch] {group} /{pattern}/ *:2match*
699
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1265 :2mat[ch]
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1266 :2mat[ch] none
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 810
diff changeset
1267 :3mat[ch] {group} /{pattern}/ *:3match*
699
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1268 :3mat[ch]
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1269 :3mat[ch] none
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1270 Just like |:match| above, but set a separate match. Thus
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1271 there can be three matches active at the same time. The match
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1272 with the lowest number has priority if several match at the
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1273 same position.
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1274 The ":3match" command is used by the |matchparen| plugin. You
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1275 are suggested to use ":match" for manual matching and
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1276 ":2match" for another plugin.
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1277
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1278
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1279 vim:tw=78:ts=8:ft=help:norl: