annotate runtime/doc/pattern.txt @ 25979:05065e623c89

Added tag v8.2.3522 for changeset 40b17deb294f4868e46b295c67add949c23a7b3f
author Bram Moolenaar <Bram@vim.org>
date Sat, 16 Oct 2021 19:00:04 +0200
parents 3b34837f4538
children 3e661b0cf500
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
25402
bdda48f01a68 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 25147
diff changeset
1 *pattern.txt* For Vim version 8.2. Last change: 2021 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|
24636
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
22 11. Fuzzy matching |fuzzy-match|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
23
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
24 ==============================================================================
3153
37ecb8ff4560 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3082
diff changeset
25 1. Search commands *search-commands*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
26
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
27 */*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
28 /{pattern}[/]<CR> Search forward for the [count]'th occurrence of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
29 {pattern} |exclusive|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
30
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
31 /{pattern}/{offset}<CR> Search forward for the [count]'th occurrence of
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
32 {pattern} and go |{offset}| lines up or down.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
33 |linewise|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
34
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
35 */<CR>*
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
36 /<CR> Search forward for the [count]'th occurrence of the
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
37 latest used pattern |last-pattern| with latest used
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
38 |{offset}|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
39
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
40 //{offset}<CR> Search forward for the [count]'th occurrence of the
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
41 latest used pattern |last-pattern| with new
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
42 |{offset}|. If {offset} is empty no offset is used.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
43
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
44 *?*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
45 ?{pattern}[?]<CR> Search backward for the [count]'th previous
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
46 occurrence of {pattern} |exclusive|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
47
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
48 ?{pattern}?{offset}<CR> Search backward for the [count]'th previous
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
49 occurrence of {pattern} and go |{offset}| lines up or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
50 down |linewise|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
51
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
52 *?<CR>*
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
53 ?<CR> Search backward for the [count]'th occurrence of the
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
54 latest used pattern |last-pattern| with latest used
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
55 |{offset}|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
56
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
57 ??{offset}<CR> Search backward for the [count]'th occurrence of the
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
58 latest used pattern |last-pattern| with new
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
59 |{offset}|. If {offset} is empty no offset is used.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
60
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
61 *n*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
62 n Repeat the latest "/" or "?" [count] times.
6647
3af822eb4da5 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6213
diff changeset
63 If the cursor doesn't move the search is repeated with
3af822eb4da5 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6213
diff changeset
64 count + 1.
16808
c002c4899529 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 16553
diff changeset
65 |last-pattern|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
66
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
67 *N*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
68 N Repeat the latest "/" or "?" [count] times in
16808
c002c4899529 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 16553
diff changeset
69 opposite direction. |last-pattern|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
70
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
71 *star* *E348* *E349*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
72 * Search forward for the [count]'th occurrence of the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
73 word nearest to the cursor. The word used for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
74 search is the first of:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
75 1. the keyword under the cursor |'iskeyword'|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
76 2. the first keyword after the cursor, in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
77 current line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
78 3. the non-blank word under the cursor
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
79 4. the first non-blank word after the cursor,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
80 in the current line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
81 Only whole keywords are searched for, like with the
18831
6848b809a26e Runtime file updates.
Bram Moolenaar <Bram@vim.org>
parents: 16808
diff changeset
82 command "/\<keyword\>". |exclusive|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
83 'ignorecase' is used, 'smartcase' is not.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
84
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
85 *#*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
86 # Same as "*", but search backward. The pound sign
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
87 (character 163) also works. If the "#" key works as
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
88 backspace, try using "stty erase <BS>" before starting
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
89 Vim (<BS> is CTRL-H or a real backspace).
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
90
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
91 *gstar*
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
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
94 whole word.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
95
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
96 *g#*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
97 g# Like "#", but don't put "\<" and "\>" around the word.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
98 This makes the search also find matches that are not a
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
99 whole word.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
100
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
101 *gd*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
102 gd Goto local Declaration. When the cursor is on a local
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
103 variable, this command will jump to its declaration.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
104 First Vim searches for the start of the current
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
105 function, just like "[[". If it is not found the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
106 search stops in line 1. If it is found, Vim goes back
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
107 until a blank line is found. From this position Vim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
108 searches for the keyword under the cursor, like with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
109 "*", but lines that look like a comment are ignored
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
110 (see 'comments' option).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
111 Note that this is not guaranteed to work, Vim does not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
112 really check the syntax, it only searches for a match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
113 with the keyword. If included files also need to be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
114 searched use the commands listed in |include-search|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
115 After this command |n| searches forward for the next
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
116 match (not backward).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
117
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
118 *gD*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
119 gD Goto global Declaration. When the cursor is on a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
120 global variable that is defined in the file, this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
121 command will jump to its declaration. This works just
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
122 like "gd", except that the search for the keyword
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
123 always starts in line 1.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
124
523
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
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
127 ends before the cursor position.
523
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 484
diff changeset
128
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 484
diff changeset
129 *1gD*
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 484
diff changeset
130 1gD Like "gD", but ignore matches inside a {} block that
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
131 ends before the cursor position.
523
a7ae7e043e43 updated for version 7.0146
vimboss
parents: 484
diff changeset
132
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
133 *CTRL-C*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
134 CTRL-C Interrupt current (search) command. Use CTRL-Break on
18972
130acb903dbe Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 18879
diff changeset
135 MS-Windows |dos-CTRL-Break|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
136 In Normal mode, any pending command is aborted.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
137
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
138 *:noh* *:nohlsearch*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
139 :noh[lsearch] Stop the highlighting for the 'hlsearch' option. It
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
140 is automatically turned back on when using a search
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
141 command, or setting the 'hlsearch' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
142 This command doesn't work in an autocommand, because
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
143 the highlighting state is saved and restored when
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
144 executing autocommands |autocmd-searchpat|.
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
145 Same thing for when invoking a user function.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
146
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
147 While typing the search pattern the current match will be shown if the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
148 'incsearch' option is on. Remember that you still have to finish the search
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
149 command with <CR> to actually position the cursor at the displayed match. Or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
150 use <Esc> to abandon the search.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
151
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
152 All matches for the last used search pattern will be highlighted if you set
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
153 the 'hlsearch' option. This can be suspended with the |:nohlsearch| command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
154
16533
5e25171e0e75 patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents: 15932
diff changeset
155 When 'shortmess' does not include the "S" flag, Vim will automatically show an
5e25171e0e75 patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents: 15932
diff changeset
156 index, on which the cursor is. This can look like this: >
5e25171e0e75 patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents: 15932
diff changeset
157
5e25171e0e75 patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents: 15932
diff changeset
158 [1/5] Cursor is on first of 5 matches.
5e25171e0e75 patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents: 15932
diff changeset
159 [1/>99] Cursor is on first of more than 99 matches.
5e25171e0e75 patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents: 15932
diff changeset
160 [>99/>99] Cursor is after 99 match of more than 99 matches.
5e25171e0e75 patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents: 15932
diff changeset
161 [?/??] Unknown how many matches exists, generating the
5e25171e0e75 patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents: 15932
diff changeset
162 statistics was aborted because of search timeout.
5e25171e0e75 patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents: 15932
diff changeset
163
5e25171e0e75 patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents: 15932
diff changeset
164 Note: the count does not take offset into account.
5e25171e0e75 patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents: 15932
diff changeset
165
3153
37ecb8ff4560 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3082
diff changeset
166 When no match is found you get the error: *E486* Pattern not found
37ecb8ff4560 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3082
diff changeset
167 Note that for the |:global| command this behaves like a normal message, for Vi
37ecb8ff4560 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3082
diff changeset
168 compatibility. For the |:s| command the "e" flag can be used to avoid the
37ecb8ff4560 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3082
diff changeset
169 error message |:s_flags|.
37ecb8ff4560 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3082
diff changeset
170
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
171 *search-offset* *{offset}*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
172 These commands search for the specified pattern. With "/" and "?" an
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
173 additional offset may be given. There are two types of offsets: line offsets
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
174 and character offsets.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
175
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
176 The offset gives the cursor position relative to the found match:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
177 [num] [num] lines downwards, in column 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
178 +[num] [num] lines downwards, in column 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
179 -[num] [num] lines upwards, in column 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
180 e[+num] [num] characters to the right of the end of the match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
181 e[-num] [num] characters to the left of the end of the match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
182 s[+num] [num] characters to the right of the start of the match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
183 s[-num] [num] characters to the left of the start of the match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
184 b[+num] [num] identical to s[+num] above (mnemonic: begin)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
185 b[-num] [num] identical to s[-num] above (mnemonic: begin)
667
9090f866cd57 updated for version 7.0197
vimboss
parents: 651
diff changeset
186 ;{pattern} perform another search, see |//;|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
187
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
188 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
189 When including an offset with 'e', the search becomes inclusive (the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
190 character the cursor lands on is included in operations).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
191
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
192 Examples:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
193
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
194 pattern cursor position ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
195 /test/+1 one line below "test", in column 1
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
196 /test/e on the last t of "test"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
197 /test/s+2 on the 's' of "test"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
198 /test/b-3 three characters before "test"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
199
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
200 If one of these commands is used after an operator, the characters between
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
201 the cursor position before and after the search is affected. However, if a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
202 line offset is given, the whole lines between the two cursor positions are
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
203 affected.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
204
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
205 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
206 with another word: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
207 /foo<CR> find "foo"
5663
1dea14d4c738 Update runtime files. Add support for systemverilog.
Bram Moolenaar <bram@vim.org>
parents: 5487
diff changeset
208 c//e<CR> change until end of match
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
209 bar<Esc> type replacement
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
210 //<CR> go to start of next match
5663
1dea14d4c738 Update runtime files. Add support for systemverilog.
Bram Moolenaar <bram@vim.org>
parents: 5487
diff changeset
211 c//e<CR> change until end of match
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
212 beep<Esc> type another replacement
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
213 etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
214 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
215 *//;* *E386*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
216 A very special offset is ';' followed by another search command. For example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
217
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
218 /test 1/;/test
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
219 /test.*/+1;?ing?
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
220
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
221 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
222 occurrence of "test" after that.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
223
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
224 This is like executing two search commands after each other, except that:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
225 - It can be used as a single motion command after an operator.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
226 - The direction for a following "n" or "N" command comes from the first
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
227 search command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
228 - When an error occurs the cursor is not moved at all.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
229
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
230 *last-pattern*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
231 The last used pattern and offset are remembered. They can be used to repeat
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
232 the search, possibly in another direction or with another count. Note that
24024
ef454a7f485d Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 23573
diff changeset
233 two patterns are remembered: One for "normal" search commands and one for the
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
234 substitute command ":s". Each time an empty pattern is given, the previously
2725
6f63330ec225 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
235 used pattern is used. However, if there is no previous search command, a
6f63330ec225 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
236 previous substitute pattern is used, if possible.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
237
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
238 The 'magic' option sticks with the last used pattern. If you change 'magic',
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
239 this will not change how the last used pattern will be interpreted.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
240 The 'ignorecase' option does not do this. When 'ignorecase' is changed, it
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
241 will result in the pattern to match other text.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
242
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
243 All matches for the last used search pattern will be highlighted if you set
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
244 the 'hlsearch' option.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
245
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
246 To clear the last used search pattern: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
247 :let @/ = ""
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
248 This will not set the pattern to an empty string, because that would match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
249 everywhere. The pattern is really cleared, like when starting Vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
250
133
bcb347a8f934 updated for version 7.0044
vimboss
parents: 39
diff changeset
251 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
252 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
253 'c' flag in 'cpoptions'. See |cpo-c|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
254 with 'c' flag: "/..." advances 1 to 3 characters
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
255 without 'c' flag: "/..." advances 1 character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
256 The unpredictability with the 'c' flag is caused by starting the search in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
257 first column, skipping matches until one is found past the cursor position.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
258
133
bcb347a8f934 updated for version 7.0044
vimboss
parents: 39
diff changeset
259 When searching backwards, searching starts at the start of the line, using the
bcb347a8f934 updated for version 7.0044
vimboss
parents: 39
diff changeset
260 'c' flag in 'cpoptions' as described above. Then the last match before the
bcb347a8f934 updated for version 7.0044
vimboss
parents: 39
diff changeset
261 cursor position is used.
bcb347a8f934 updated for version 7.0044
vimboss
parents: 39
diff changeset
262
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
263 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
264 for. In Vim this is not done, the previous search pattern is still remembered,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
265 unless the 't' flag is present in 'cpoptions'. The search pattern is always
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
266 put in the search history.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
267
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
268 If the 'wrapscan' option is on (which is the default), searches wrap around
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
269 the end of the buffer. If 'wrapscan' is not set, the backward search stops
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
270 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
271 'wrapscan' is set and the pattern was not found the error message "pattern
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
272 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
273 set the message becomes "search hit BOTTOM without match" when searching
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
274 forward, or "search hit TOP without match" when searching backward. If
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
275 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
276 "search hit TOP, continuing at BOTTOM" or "search hit BOTTOM, continuing at
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
277 TOP" is given when searching backwards or forwards respectively. This can be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
278 switched off by setting the 's' flag in the 'shortmess' option. The highlight
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
279 method 'w' is used for this message (default: standout).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
280
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
281 *search-range*
625
81fe2ccc1207 updated for version 7.0179
vimboss
parents: 523
diff changeset
282 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
283 \%>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
284 line 300: >
81fe2ccc1207 updated for version 7.0179
vimboss
parents: 523
diff changeset
285 /\%>199l\%<300llimit
81fe2ccc1207 updated for version 7.0179
vimboss
parents: 523
diff changeset
286 Also see |/\%>l|.
81fe2ccc1207 updated for version 7.0179
vimboss
parents: 523
diff changeset
287
81fe2ccc1207 updated for version 7.0179
vimboss
parents: 523
diff changeset
288 Another way is to use the ":substitute" command with the 'c' flag. Example: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
289 :.,300s/Pattern//gc
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
290 This command will search from the cursor position until line 300 for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
291 "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
292 stop at this match, type 'n' to find the next match.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
293
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
294 The "*", "#", "g*" and "g#" commands look for a word near the cursor in this
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
295 order, the first one that is found is used:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
296 - The keyword currently under the cursor.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
297 - The first keyword to the right of the cursor, in the same line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
298 - The WORD currently under the cursor.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
299 - The first WORD to the right of the cursor, in the same line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
300 The keyword may only contain letters and characters in 'iskeyword'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
301 The WORD may contain any non-blanks (<Tab>s and/or <Space>s).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
302 Note that if you type with ten fingers, the characters are easy to remember:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
303 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
304 the "*" is under your right hand middle finger (search to the right and down).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
305 (this depends on your keyboard layout though).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
306
14372
2a4a2dc35c55 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13963
diff changeset
307 *E956*
2a4a2dc35c55 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13963
diff changeset
308 In very rare cases a regular expression is used recursively. This can happen
15033
f8b0f1e42f2c Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 14421
diff changeset
309 when executing a pattern takes a long time and when checking for messages on
14372
2a4a2dc35c55 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13963
diff changeset
310 channels a callback is invoked that also uses a pattern or an autocommand is
2a4a2dc35c55 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13963
diff changeset
311 triggered. In most cases this should be fine, but if a pattern is in use when
2a4a2dc35c55 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13963
diff changeset
312 it's used again it fails. Usually this means there is something wrong with
2a4a2dc35c55 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13963
diff changeset
313 the pattern.
2a4a2dc35c55 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13963
diff changeset
314
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
315 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
316 2. The definition of a pattern *search-pattern* *pattern* *[pattern]*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
317 *regular-expression* *regexp* *Pattern*
190
a1f18bd133d6 updated for version 7.0057
vimboss
parents: 168
diff changeset
318 *E76* *E383* *E476*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
319
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
320 For starters, read chapter 27 of the user manual |usr_27.txt|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
321
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
322 */bar* */\bar* */pattern*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
323 1. A pattern is one or more branches, separated by "\|". It matches anything
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
324 that matches one of the branches. Example: "foo\|beep" matches "foo" and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
325 matches "beep". If more than one branch matches, the first one is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
326
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
327 pattern ::= branch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
328 or branch \| branch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
329 or branch \| branch \| branch
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
330 etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
331
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
332 */branch* */\&*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
333 2. A branch is one or more concats, separated by "\&". It matches the last
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
334 concat, but only if all the preceding concats also match at the same
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
335 position. Examples:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
336 "foobeep\&..." matches "foo" in "foobeep".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
337 ".*Peter\&.*Bob" matches in a line containing both "Peter" and "Bob"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
338
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
339 branch ::= concat
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
340 or concat \& concat
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
341 or concat \& concat \& concat
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
342 etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
343
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
344 */concat*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
345 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
346 first piece, followed by a match for the second piece, etc. Example:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
347 "f[0-9]b", first matches "f", then a digit and then "b".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
348
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
349 concat ::= piece
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
350 or piece piece
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
351 or piece piece piece
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
352 etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
353
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
354 */piece*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
355 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
356 times the atom can be matched. Example: "a*" matches any sequence of "a"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
357 characters: "", "a", "aa", etc. See |/multi|.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
358
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
359 piece ::= atom
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
360 or atom multi
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
361
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
362 */atom*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
363 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
364 in the text. It is often an ordinary character or a character class.
23164
99ef85ff1af4 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 22171
diff changeset
365 Parentheses can be used to make a pattern into an atom. The "\z(\)"
99ef85ff1af4 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 22171
diff changeset
366 construct is only for syntax highlighting.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
367
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
368 atom ::= ordinary-atom |/ordinary-atom|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
369 or \( pattern \) |/\(|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
370 or \%( pattern \) |/\%(|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
371 or \z( pattern \) |/\z(|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
372
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
373
5146
6ec6b7ff2d43 Vim 7.4a BETA release.
Bram Moolenaar <bram@vim.org>
parents: 4780
diff changeset
374 */\%#=* *two-engines* *NFA*
4444
ccecb03e5e8b updated for version 7.3.970
Bram Moolenaar <bram@vim.org>
parents: 4339
diff changeset
375 Vim includes two regexp engines:
ccecb03e5e8b updated for version 7.3.970
Bram Moolenaar <bram@vim.org>
parents: 4339
diff changeset
376 1. An old, backtracking engine that supports everything.
10191
01521953bdf1 commit https://github.com/vim/vim/commit/220adb1e9f9e0b27d28185167d2730bf2f93057d
Christian Brabandt <cb@256bit.org>
parents: 9286
diff changeset
377 2. A new, NFA engine that works much faster on some patterns, possibly slower
01521953bdf1 commit https://github.com/vim/vim/commit/220adb1e9f9e0b27d28185167d2730bf2f93057d
Christian Brabandt <cb@256bit.org>
parents: 9286
diff changeset
378 on some patterns.
4444
ccecb03e5e8b updated for version 7.3.970
Bram Moolenaar <bram@vim.org>
parents: 4339
diff changeset
379
ccecb03e5e8b updated for version 7.3.970
Bram Moolenaar <bram@vim.org>
parents: 4339
diff changeset
380 Vim will automatically select the right engine for you. However, if you run
ccecb03e5e8b updated for version 7.3.970
Bram Moolenaar <bram@vim.org>
parents: 4339
diff changeset
381 into a problem or want to specifically select one engine or the other, you can
ccecb03e5e8b updated for version 7.3.970
Bram Moolenaar <bram@vim.org>
parents: 4339
diff changeset
382 prepend one of the following to the pattern:
ccecb03e5e8b updated for version 7.3.970
Bram Moolenaar <bram@vim.org>
parents: 4339
diff changeset
383
ccecb03e5e8b updated for version 7.3.970
Bram Moolenaar <bram@vim.org>
parents: 4339
diff changeset
384 \%#=0 Force automatic selection. Only has an effect when
ccecb03e5e8b updated for version 7.3.970
Bram Moolenaar <bram@vim.org>
parents: 4339
diff changeset
385 'regexpengine' has been set to a non-zero value.
ccecb03e5e8b updated for version 7.3.970
Bram Moolenaar <bram@vim.org>
parents: 4339
diff changeset
386 \%#=1 Force using the old engine.
ccecb03e5e8b updated for version 7.3.970
Bram Moolenaar <bram@vim.org>
parents: 4339
diff changeset
387 \%#=2 Force using the NFA engine.
ccecb03e5e8b updated for version 7.3.970
Bram Moolenaar <bram@vim.org>
parents: 4339
diff changeset
388
ccecb03e5e8b updated for version 7.3.970
Bram Moolenaar <bram@vim.org>
parents: 4339
diff changeset
389 You can also use the 'regexpengine' option to change the default.
ccecb03e5e8b updated for version 7.3.970
Bram Moolenaar <bram@vim.org>
parents: 4339
diff changeset
390
ccecb03e5e8b updated for version 7.3.970
Bram Moolenaar <bram@vim.org>
parents: 4339
diff changeset
391 *E864* *E868* *E874* *E875* *E876* *E877* *E878*
ccecb03e5e8b updated for version 7.3.970
Bram Moolenaar <bram@vim.org>
parents: 4339
diff changeset
392 If selecting the NFA engine and it runs into something that is not implemented
ccecb03e5e8b updated for version 7.3.970
Bram Moolenaar <bram@vim.org>
parents: 4339
diff changeset
393 the pattern will not match. This is only useful when debugging Vim.
ccecb03e5e8b updated for version 7.3.970
Bram Moolenaar <bram@vim.org>
parents: 4339
diff changeset
394
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
395 ==============================================================================
840
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
396 3. Magic */magic*
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
397
23466
15fa3923cc49 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 23164
diff changeset
398 Some characters in the pattern, such as letters, are taken literally. They
15fa3923cc49 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 23164
diff changeset
399 match exactly the same character in the text. When preceded with a backslash
15fa3923cc49 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 23164
diff changeset
400 however, these characters may get a special meaning. For example, "a" matches
15fa3923cc49 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 23164
diff changeset
401 the letter "a", while "\a" matches any alphabetic character.
840
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
402
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
403 Other characters have a special meaning without a backslash. They need to be
23466
15fa3923cc49 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 23164
diff changeset
404 preceded with a backslash to match literally. For example "." matches any
15fa3923cc49 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 23164
diff changeset
405 character while "\." matches a dot.
840
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
406
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
407 If a character is taken literally or not depends on the 'magic' option and the
23466
15fa3923cc49 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 23164
diff changeset
408 items in the pattern mentioned next. The 'magic' option should always be set,
15fa3923cc49 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 23164
diff changeset
409 but it can be switched off for Vi compatibility. We mention the effect of
15fa3923cc49 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 23164
diff changeset
410 'nomagic' here for completeness, but we recommend against using that.
840
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
411 */\m* */\M*
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
412 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
413 ignoring the actual value of the 'magic' option.
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
414 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
415 */\v* */\V*
15281
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15033
diff changeset
416 Use of "\v" means that after it, all ASCII characters except '0'-'9', 'a'-'z',
97b40b4c6911 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15033
diff changeset
417 'A'-'Z' and '_' have special meaning: "very magic"
840
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
418
23466
15fa3923cc49 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 23164
diff changeset
419 Use of "\V" means that after it, only a backslash and the terminating
15fa3923cc49 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 23164
diff changeset
420 character (usually / or ?) have special meaning: "very nomagic"
840
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
421
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
422 Examples:
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
423 after: \v \m \M \V matches ~
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
424 'magic' 'nomagic'
23466
15fa3923cc49 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 23164
diff changeset
425 a a a a literal 'a'
15fa3923cc49 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 23164
diff changeset
426 \a \a \a \a any alphabetic character
15fa3923cc49 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 23164
diff changeset
427 . . \. \. any character
15fa3923cc49 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 23164
diff changeset
428 \. \. . . literal dot
15fa3923cc49 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 23164
diff changeset
429 $ $ $ \$ end-of-line
840
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
430 * * \* \* any number of the previous atom
7384
aea5ebf352c4 commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents: 6697
diff changeset
431 ~ ~ \~ \~ latest substitute string
23466
15fa3923cc49 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 23164
diff changeset
432 () \(\) \(\) \(\) group as an atom
15fa3923cc49 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 23164
diff changeset
433 | \| \| \| nothing: separates alternatives
840
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
434 \\ \\ \\ \\ literal backslash
23466
15fa3923cc49 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 23164
diff changeset
435 \{ { { { literal curly brace
840
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
436
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
437 {only Vim supports \m, \M, \v and \V}
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
438
23466
15fa3923cc49 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 23164
diff changeset
439 If you want to you can make a pattern immune to the 'magic' option being set
15fa3923cc49 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 23164
diff changeset
440 or not by putting "\m" or "\M" at the start of the pattern.
840
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
441
2c885fab04e3 updated for version 7.0e06
vimboss
parents: 834
diff changeset
442 ==============================================================================
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
443 4. Overview of pattern items *pattern-overview*
4444
ccecb03e5e8b updated for version 7.3.970
Bram Moolenaar <bram@vim.org>
parents: 4339
diff changeset
444 *E865* *E866* *E867* *E869*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
445
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
446 Overview of multi items. */multi* *E61* *E62*
4444
ccecb03e5e8b updated for version 7.3.970
Bram Moolenaar <bram@vim.org>
parents: 4339
diff changeset
447 More explanation and examples below, follow the links. *E64* *E871*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
448
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
449 multi ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
450 'magic' 'nomagic' matches of the preceding atom ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
451 |/star| * \* 0 or more as many as possible
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
452 |/\+| \+ \+ 1 or more as many as possible
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
453 |/\=| \= \= 0 or 1 as many as possible
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
454 |/\?| \? \? 0 or 1 as many as possible
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
455
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
456 |/\{| \{n,m} \{n,m} n to m as many as possible
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
457 \{n} \{n} n exactly
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
458 \{n,} \{n,} at least n as many as possible
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
459 \{,m} \{,m} 0 to m as many as possible
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
460 \{} \{} 0 or more as many as possible (same as *)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
461
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
462 |/\{-| \{-n,m} \{-n,m} n to m as few as possible
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
463 \{-n} \{-n} n exactly
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
464 \{-n,} \{-n,} at least n as few as possible
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
465 \{-,m} \{-,m} 0 to m as few as possible
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
466 \{-} \{-} 0 or more as few as possible
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
467
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
468 *E59*
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
469 |/\@>| \@> \@> 1, like matching a whole pattern
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
470 |/\@=| \@= \@= nothing, requires a match |/zero-width|
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
471 |/\@!| \@! \@! nothing, requires NO match |/zero-width|
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
472 |/\@<=| \@<= \@<= nothing, requires a match behind |/zero-width|
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
473 |/\@<!| \@<! \@<! nothing, requires NO match behind |/zero-width|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
474
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
475
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
476 Overview of ordinary atoms. */ordinary-atom*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
477 More explanation and examples below, follow the links.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
478
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
479 ordinary atom ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
480 magic nomagic matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
481 |/^| ^ ^ start-of-line (at start of pattern) |/zero-width|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
482 |/\^| \^ \^ literal '^'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
483 |/\_^| \_^ \_^ start-of-line (used anywhere) |/zero-width|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
484 |/$| $ $ end-of-line (at end of pattern) |/zero-width|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
485 |/\$| \$ \$ literal '$'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
486 |/\_$| \_$ \_$ end-of-line (used anywhere) |/zero-width|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
487 |/.| . \. any single character (not an end-of-line)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
488 |/\_.| \_. \_. any single character or end-of-line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
489 |/\<| \< \< beginning of a word |/zero-width|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
490 |/\>| \> \> end of a word |/zero-width|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
491 |/\zs| \zs \zs anything, sets start of match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
492 |/\ze| \ze \ze anything, sets end of match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
493 |/\%^| \%^ \%^ beginning of file |/zero-width| *E71*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
494 |/\%$| \%$ \%$ end of file |/zero-width|
640
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
495 |/\%V| \%V \%V inside Visual area |/zero-width|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
496 |/\%#| \%# \%# cursor position |/zero-width|
640
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
497 |/\%'m| \%'m \%'m mark m position |/zero-width|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
498 |/\%l| \%23l \%23l in line 23 |/zero-width|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
499 |/\%c| \%23c \%23c in column 23 |/zero-width|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
500 |/\%v| \%23v \%23v in virtual column 23 |/zero-width|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
501
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
502 Character classes: */character-classes*
7384
aea5ebf352c4 commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents: 6697
diff changeset
503 magic nomagic matches ~
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
504 |/\i| \i \i identifier character (see 'isident' option)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
505 |/\I| \I \I like "\i", but excluding digits
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
506 |/\k| \k \k keyword character (see 'iskeyword' option)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
507 |/\K| \K \K like "\k", but excluding digits
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
508 |/\f| \f \f file name character (see 'isfname' option)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
509 |/\F| \F \F like "\f", but excluding digits
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
510 |/\p| \p \p printable character (see 'isprint' option)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
511 |/\P| \P \P like "\p", but excluding digits
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
512 |/\s| \s \s whitespace character: <Space> and <Tab>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
513 |/\S| \S \S non-whitespace character; opposite of \s
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
514 |/\d| \d \d digit: [0-9]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
515 |/\D| \D \D non-digit: [^0-9]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
516 |/\x| \x \x hex digit: [0-9A-Fa-f]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
517 |/\X| \X \X non-hex digit: [^0-9A-Fa-f]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
518 |/\o| \o \o octal digit: [0-7]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
519 |/\O| \O \O non-octal digit: [^0-7]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
520 |/\w| \w \w word character: [0-9A-Za-z_]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
521 |/\W| \W \W non-word character: [^0-9A-Za-z_]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
522 |/\h| \h \h head of word character: [A-Za-z_]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
523 |/\H| \H \H non-head of word character: [^A-Za-z_]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
524 |/\a| \a \a alphabetic character: [A-Za-z]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
525 |/\A| \A \A non-alphabetic character: [^A-Za-z]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
526 |/\l| \l \l lowercase character: [a-z]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
527 |/\L| \L \L non-lowercase character: [^a-z]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
528 |/\u| \u \u uppercase character: [A-Z]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
529 |/\U| \U \U non-uppercase character [^A-Z]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
530 |/\_| \_x \_x where x is any of the characters above: character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
531 class with end-of-line included
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
532 (end of character classes)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
533
7384
aea5ebf352c4 commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents: 6697
diff changeset
534 magic nomagic matches ~
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
535 |/\e| \e \e <Esc>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
536 |/\t| \t \t <Tab>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
537 |/\r| \r \r <CR>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
538 |/\b| \b \b <BS>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
539 |/\n| \n \n end-of-line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
540 |/~| ~ \~ last given substitute string
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
541 |/\1| \1 \1 same string as matched by first \(\)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
542 |/\2| \2 \2 Like "\1", but uses second \(\)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
543 ...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
544 |/\9| \9 \9 Like "\1", but uses ninth \(\)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
545 *E68*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
546 |/\z1| \z1 \z1 only for syntax highlighting, see |:syn-ext-match|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
547 ...
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
548 |/\z1| \z9 \z9 only for syntax highlighting, see |:syn-ext-match|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
549
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
550 x x a character with no special meaning matches itself
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
551
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
552 |/[]| [] \[] any character specified inside the []
4119
61bcafd8c648 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4073
diff changeset
553 |/\%[]| \%[] \%[] a sequence of optionally matched atoms
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
554
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
555 |/\c| \c \c ignore case, do not use the 'ignorecase' option
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
556 |/\C| \C \C match case, do not use the 'ignorecase' option
4444
ccecb03e5e8b updated for version 7.3.970
Bram Moolenaar <bram@vim.org>
parents: 4339
diff changeset
557 |/\Z| \Z \Z ignore differences in Unicode "combining characters".
ccecb03e5e8b updated for version 7.3.970
Bram Moolenaar <bram@vim.org>
parents: 4339
diff changeset
558 Useful when searching voweled Hebrew or Arabic text.
ccecb03e5e8b updated for version 7.3.970
Bram Moolenaar <bram@vim.org>
parents: 4339
diff changeset
559
7384
aea5ebf352c4 commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents: 6697
diff changeset
560 magic nomagic matches ~
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
561 |/\m| \m \m 'magic' on for the following chars in the pattern
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
562 |/\M| \M \M 'magic' off for the following chars in the pattern
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
563 |/\v| \v \v the following chars in the pattern are "very magic"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
564 |/\V| \V \V the following chars in the pattern are "very nomagic"
4444
ccecb03e5e8b updated for version 7.3.970
Bram Moolenaar <bram@vim.org>
parents: 4339
diff changeset
565 |/\%#=| \%#=1 \%#=1 select regexp engine |/zero-width|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
566
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
567 |/\%d| \%d \%d match specified decimal character (eg \%d123)
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
568 |/\%x| \%x \%x match specified hex character (eg \%x2a)
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
569 |/\%o| \%o \%o match specified octal character (eg \%o040)
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
570 |/\%u| \%u \%u match specified multibyte character (eg \%u20ac)
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
571 |/\%U| \%U \%U match specified large multibyte character (eg
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
572 \%U12345678)
5901
10fc95f48546 updated for version 7.4.293
Bram Moolenaar <bram@vim.org>
parents: 5663
diff changeset
573 |/\%C| \%C \%C match any composing characters
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
574
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
575 Example matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
576 \<\I\i* or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
577 \<\h\w*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
578 \<[a-zA-Z_][a-zA-Z0-9_]*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
579 An identifier (e.g., in a C program).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
580
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
581 \(\.$\|\. \) A period followed by <EOL> or a space.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
582
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
583 [.!?][])"']*\($\|[ ]\) A search pattern that finds the end of a sentence,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
584 with almost the same definition as the ")" command.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
585
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
586 cat\Z Both "cat" and "càt" ("a" followed by 0x0300)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
587 Does not match "càt" (character 0x00e0), even
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
588 though it may look the same.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
589
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
590
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
591 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
592 5. Multi items *pattern-multi-items*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
593
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
594 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
595 matched and in what way. This is called a multi. See |/multi| for an
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
596 overview.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
597
8951
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8876
diff changeset
598 */star* */\star*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
599 * (use \* when 'magic' is not set)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
600 Matches 0 or more of the preceding atom, as many as possible.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
601 Example 'nomagic' matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
602 a* a\* "", "a", "aa", "aaa", etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
603 .* \.\* anything, also an empty string, no end-of-line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
604 \_.* \_.\* everything up to the end of the buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
605 \_.*END \_.\*END everything up to and including the last "END"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
606 in the buffer
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
607
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
608 Exception: When "*" is used at the start of the pattern or just after
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
609 "^" it matches the star character.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
610
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
611 Be aware that repeating "\_." can match a lot of text and take a long
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
612 time. For example, "\_.*END" matches all text from the current
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
613 position to the last occurrence of "END" in the file. Since the "*"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
614 will match as many as possible, this first skips over all lines until
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
615 the end of the file and then tries matching "END", backing up one
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
616 character at a time.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
617
8951
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8876
diff changeset
618 */\+*
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
619 \+ Matches 1 or more of the preceding atom, as many as possible.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
620 Example matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
621 ^.\+$ any non-empty line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
622 \s\+ white space of at least one character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
623
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
624 */\=*
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
625 \= Matches 0 or 1 of the preceding atom, as many as possible.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
626 Example matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
627 foo\= "fo" and "foo"
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 \? Just like \=. Cannot be used when searching backwards with the "?"
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
631 command.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
632
8951
0bdeaf7092bc commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents: 8876
diff changeset
633 */\{* *E60* *E554* *E870*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
634 \{n,m} Matches n to m of the preceding atom, as many as possible
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
635 \{n} Matches n of the preceding atom
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
636 \{n,} Matches at least n of the preceding atom, as many as possible
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
637 \{,m} Matches 0 to m of the preceding atom, as many as possible
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
638 \{} Matches 0 or more of the preceding atom, as many as possible (like *)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
639 */\{-*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
640 \{-n,m} matches n to m of the preceding atom, as few as possible
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
641 \{-n} matches n of the preceding atom
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
642 \{-n,} matches at least n of the preceding atom, as few as possible
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
643 \{-,m} matches 0 to m of the preceding atom, as few as possible
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
644 \{-} matches 0 or more of the preceding atom, as few as possible
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
645
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 140
diff changeset
646 n and m are positive decimal numbers or zero
1125
96cd8222a819 updated for version 7.1a
vimboss
parents: 874
diff changeset
647 *non-greedy*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
648 If a "-" appears immediately after the "{", then a shortest match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
649 first algorithm is used (see example below). In particular, "\{-}" is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
650 the same as "*" but uses the shortest match first algorithm. BUT: A
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
651 match that starts earlier is preferred over a shorter match: "a\{-}b"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
652 matches "aaab" in "xaaab".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
653
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
654 Example matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
655 ab\{2,3}c "abbc" or "abbbc"
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
656 a\{5} "aaaaa"
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
657 ab\{2,}c "abbc", "abbbc", "abbbbc", etc.
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
658 ab\{,3}c "ac", "abc", "abbc" or "abbbc"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
659 a[bc]\{3}d "abbbd", "abbcd", "acbcd", "acccd", etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
660 a\(bc\)\{1,2}d "abcd" or "abcbcd"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
661 a[bc]\{-}[cd] "abc" in "abcd"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
662 a[bc]*[cd] "abcd" in "abcd"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
663
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
664 The } may optionally be preceded with a backslash: \{n,m\}.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
665
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
666 */\@=*
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
667 \@= Matches the preceding atom with zero width.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
668 Like "(?=pattern)" in Perl.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
669 Example matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
670 foo\(bar\)\@= "foo" in "foobar"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
671 foo\(bar\)\@=foo nothing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
672 */zero-width*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
673 When using "\@=" (or "^", "$", "\<", "\>") no characters are included
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
674 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
675 made. This can be tricky, because a match with following items will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
676 be done in the same position. The last example above will not match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
677 "foobarfoo", because it tries match "foo" in the same position where
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
678 "bar" matched.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
679
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
680 Note that using "\&" works the same as using "\@=": "foo\&.." is the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
681 same as "\(foo\)\@=..". But using "\&" is easier, you don't need the
23164
99ef85ff1af4 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 22171
diff changeset
682 parentheses.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
683
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
684
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
685 */\@!*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
686 \@! Matches with zero width if the preceding atom does NOT match at the
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
687 current position. |/zero-width|
3513
1b584a6f446c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3224
diff changeset
688 Like "(?!pattern)" in Perl.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
689 Example matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
690 foo\(bar\)\@! any "foo" not followed by "bar"
3513
1b584a6f446c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3224
diff changeset
691 a.\{-}p\@! "a", "ap", "app", "appp", etc. not immediately
2908
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2788
diff changeset
692 followed by a "p"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
693 if \(\(then\)\@!.\)*$ "if " not followed by "then"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
694
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
695 Using "\@!" is tricky, because there are many places where a pattern
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
696 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
697 line, because ".*" can match all characters in the line and the "p"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
698 doesn't match at the end of the line. "a.\{-}p\@!" will match any
3513
1b584a6f446c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3224
diff changeset
699 "a", "ap", "app", etc. that isn't followed by a "p", because the "."
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
700 can match a "p" and "p\@!" doesn't match after that.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
701
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
702 You can't use "\@!" to look for a non-match before the matching
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
703 position: "\(foo\)\@!bar" will match "bar" in "foobar", because at the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
704 position where "bar" matches, "foo" does not match. To avoid matching
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
705 "foobar" you could use "\(foo\)\@!...bar", but that doesn't match a
237
73354c21f1e4 updated for version 7.0066
vimboss
parents: 190
diff changeset
706 bar at the start of a line. Use "\(foo\)\@<!bar".
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
707
2788
0877b8d6370e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2725
diff changeset
708 Useful example: to find "foo" in a line that does not contain "bar": >
0877b8d6370e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2725
diff changeset
709 /^\%(.*bar\)\@!.*\zsfoo
0877b8d6370e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2725
diff changeset
710 < This pattern first checks that there is not a single position in the
0877b8d6370e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2725
diff changeset
711 line where "bar" matches. If ".*bar" matches somewhere the \@! will
0877b8d6370e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2725
diff changeset
712 reject the pattern. When there is no match any "foo" will be found.
0877b8d6370e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2725
diff changeset
713 The "\zs" is to have the match start just before "foo".
0877b8d6370e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2725
diff changeset
714
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
715 */\@<=*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
716 \@<= Matches with zero width if the preceding atom matches just before what
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
717 follows. |/zero-width|
3513
1b584a6f446c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3224
diff changeset
718 Like "(?<=pattern)" in Perl, but Vim allows non-fixed-width patterns.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
719 Example matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
720 \(an\_s\+\)\@<=file "file" after "an" and white space or an
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
721 end-of-line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
722 For speed it's often much better to avoid this multi. Try using "\zs"
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
723 instead |/\zs|. To match the same as the above example:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
724 an\_s\+\zsfile
4681
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
725 At least set a limit for the look-behind, see below.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
726
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
727 "\@<=" and "\@<!" check for matches just before what follows.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
728 Theoretically these matches could start anywhere before this position.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
729 But to limit the time needed, only the line where what follows matches
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
730 is searched, and one line before that (if there is one). This should
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
731 be sufficient to match most things and not be too slow.
6153
1e8ebf870720 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
732
1e8ebf870720 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
733 In the old regexp engine the part of the pattern after "\@<=" and
1e8ebf870720 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
734 "\@<!" are checked for a match first, thus things like "\1" don't work
1e8ebf870720 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
735 to reference \(\) inside the preceding atom. It does work the other
1e8ebf870720 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
736 way around:
1e8ebf870720 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
737 Bad example matches ~
1e8ebf870720 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
738 \%#=1\1\@<=,\([a-z]\+\) ",abc" in "abc,abc"
1e8ebf870720 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
739
1e8ebf870720 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
740 However, the new regexp engine works differently, it is better to not
1e8ebf870720 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
741 rely on this behavior, do not use \@<= if it can be avoided:
1e8ebf870720 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
742 Example matches ~
1e8ebf870720 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5968
diff changeset
743 \([a-z]\+\)\zs,\1 ",abc" in "abc,abc"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
744
4681
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
745 \@123<=
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
746 Like "\@<=" but only look back 123 bytes. This avoids trying lots
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
747 of matches that are known to fail and make executing the pattern very
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
748 slow. Example, check if there is a "<" just before "span":
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
749 /<\@1<=span
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
750 This will try matching "<" only one byte before "span", which is the
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
751 only place that works anyway.
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
752 After crossing a line boundary, the limit is relative to the end of
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
753 the line. Thus the characters at the start of the line with the match
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
754 are not counted (this is just to keep it simple).
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
755 The number zero is the same as no limit.
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
756
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
757 */\@<!*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
758 \@<! Matches with zero width if the preceding atom does NOT match just
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
759 before what follows. Thus this matches if there is no position in the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
760 current or previous line where the atom matches such that it ends just
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
761 before what follows. |/zero-width|
3513
1b584a6f446c Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3224
diff changeset
762 Like "(?<!pattern)" in Perl, but Vim allows non-fixed-width patterns.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
763 The match with the preceding atom is made to end just before the match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
764 with what follows, thus an atom that ends in ".*" will work.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
765 Warning: This can be slow (because many positions need to be checked
4681
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
766 for a match). Use a limit if you can, see below.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
767 Example matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
768 \(foo\)\@<!bar any "bar" that's not in "foobar"
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
769 \(\/\/.*\)\@<!in "in" which is not after "//"
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
770
4681
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
771 \@123<!
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
772 Like "\@<!" but only look back 123 bytes. This avoids trying lots of
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
773 matches that are known to fail and make executing the pattern very
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
774 slow.
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
775
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
776 */\@>*
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
777 \@> Matches the preceding atom like matching a whole pattern.
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
778 Like "(?>pattern)" in Perl.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
779 Example matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
780 \(a*\)\@>a nothing (the "a*" takes all the "a"'s, there can't be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
781 another one following)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
782
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
783 This matches the preceding atom as if it was a pattern by itself. If
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
784 it doesn't match, there is no retry with shorter sub-matches or
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
785 anything. Observe this difference: "a*b" and "a*ab" both match
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
786 "aaab", but in the second case the "a*" matches only the first two
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
787 "a"s. "\(a*\)\@>ab" will not match "aaab", because the "a*" matches
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
788 the "aaa" (as many "a"s as possible), thus the "ab" can't match.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
789
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
790
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
791 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
792 6. Ordinary atoms *pattern-atoms*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
793
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
794 An ordinary atom can be:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
795
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
796 */^*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
797 ^ At beginning of pattern or after "\|", "\(", "\%(" or "\n": matches
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
798 start-of-line; at other positions, matches literal '^'. |/zero-width|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
799 Example matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
800 ^beep( the start of the C function "beep" (probably).
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
801
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
802 */\^*
22171
d4c7b3e9cd17 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 21991
diff changeset
803 \^ Matches literal '^'. Can be used at any position in the pattern, but
d4c7b3e9cd17 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 21991
diff changeset
804 not inside [].
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
805
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
806 */\_^*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
807 \_^ Matches start-of-line. |/zero-width| Can be used at any position in
22171
d4c7b3e9cd17 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 21991
diff changeset
808 the pattern, but not inside [].
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
809 Example matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
810 \_s*\_^foo white space and blank lines and then "foo" at
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
811 start-of-line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
812
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
813 */$*
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
814 $ At end of pattern or in front of "\|", "\)" or "\n" ('magic' on):
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
815 matches end-of-line <EOL>; at other positions, matches literal '$'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
816 |/zero-width|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
817
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
818 */\$*
22171
d4c7b3e9cd17 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 21991
diff changeset
819 \$ Matches literal '$'. Can be used at any position in the pattern, but
d4c7b3e9cd17 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 21991
diff changeset
820 not inside [].
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
821
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
822 */\_$*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
823 \_$ Matches end-of-line. |/zero-width| Can be used at any position in the
22171
d4c7b3e9cd17 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 21991
diff changeset
824 pattern, but not inside []. Note that "a\_$b" never matches, since
d4c7b3e9cd17 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 21991
diff changeset
825 "b" cannot match an end-of-line. Use "a\nb" instead |/\n|.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
826 Example matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
827 foo\_$\_s* "foo" at end-of-line and following white space and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
828 blank lines
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
829
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
830 . (with 'nomagic': \.) */.* */\.*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
831 Matches any single character, but not an end-of-line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
832
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
833 */\_.*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
834 \_. Matches any single character or end-of-line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
835 Careful: "\_.*" matches all text to the end of the buffer!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
836
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
837 */\<*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
838 \< 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
839 word. The 'iskeyword' option specifies what is a word character.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
840 |/zero-width|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
841
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
842 */\>*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
843 \> 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
844 word. The 'iskeyword' option specifies what is a word character.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
845 |/zero-width|
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
846
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
847 */\zs*
22171
d4c7b3e9cd17 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 21991
diff changeset
848 \zs Matches at any position, but not inside [], and sets the start of the
d4c7b3e9cd17 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 21991
diff changeset
849 match there: The next char is the first char of the whole match.
d4c7b3e9cd17 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 21991
diff changeset
850 |/zero-width|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
851 Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
852 /^\s*\zsif
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
853 < matches an "if" at the start of a line, ignoring white space.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
854 Can be used multiple times, the last one encountered in a matching
237
73354c21f1e4 updated for version 7.0066
vimboss
parents: 190
diff changeset
855 branch is used. Example: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
856 /\(.\{-}\zsFab\)\{3}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
857 < Finds the third occurrence of "Fab".
6180
6921742f396a Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6153
diff changeset
858 This cannot be followed by a multi. *E888*
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
859 {not available when compiled without the |+syntax| feature}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
860 */\ze*
22171
d4c7b3e9cd17 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 21991
diff changeset
861 \ze Matches at any position, but not inside [], and sets the end of the
d4c7b3e9cd17 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 21991
diff changeset
862 match there: The previous char is the last char of the whole match.
d4c7b3e9cd17 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 21991
diff changeset
863 |/zero-width|
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
864 Can be used multiple times, the last one encountered in a matching
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
865 branch is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
866 Example: "end\ze\(if\|for\)" matches the "end" in "endif" and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
867 "endfor".
6213
37c24033b260 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6180
diff changeset
868 This cannot be followed by a multi. |E888|
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
869 {not available when compiled without the |+syntax| feature}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
870
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
871 */\%^* *start-of-file*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
872 \%^ Matches start of the file. When matching with a string, matches the
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
873 start of the string.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
874 For example, to find the first "VIM" in a file: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
875 /\%^\_.\{-}\zsVIM
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
876 <
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
877 */\%$* *end-of-file*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
878 \%$ Matches end of the file. When matching with a string, matches the
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
879 end of the string.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
880 Note that this does NOT find the last "VIM" in a file: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
881 /VIM\_.\{-}\%$
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
882 < It will find the next VIM, because the part after it will always
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
883 match. This one will find the last "VIM" in the file: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
884 /VIM\ze\(\(VIM\)\@!\_.\)*\%$
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
885 < This uses |/\@!| to ascertain that "VIM" does NOT match in any
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
886 position after the first "VIM".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
887 Searching from the end of the file backwards is easier!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
888
640
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
889 */\%V*
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
890 \%V Match inside the Visual area. When Visual mode has already been
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
891 stopped match in the area that |gv| would reselect.
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
892 This is a |/zero-width| match. To make sure the whole pattern is
11062
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
893 inside the Visual area put it at the start and just before the end of
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
894 the pattern, e.g.: >
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
895 /\%Vfoo.*ba\%Vr
11160
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11062
diff changeset
896 < This also works if only "foo bar" was Visually selected. This: >
d0a20101ecb2 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11062
diff changeset
897 /\%Vfoo.*bar\%V
11062
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
898 < would match "foo bar" if the Visual selection continues after the "r".
1218c5353e2b Runtime file updates.
Christian Brabandt <cb@256bit.org>
parents: 10198
diff changeset
899 Only works for the current buffer.
640
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
900
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
901 */\%#* *cursor-position*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
902 \%# Matches with the cursor position. Only works when matching in a
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
903 buffer displayed in a window.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
904 WARNING: When the cursor is moved after the pattern was used, the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
905 result becomes invalid. Vim doesn't automatically update the matches.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
906 This is especially relevant for syntax highlighting and 'hlsearch'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
907 In other words: When the cursor moves the display isn't updated for
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
908 this change. An update is done for lines which are changed (the whole
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
909 line is updated) or when using the |CTRL-L| command (the whole screen
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
910 is updated). Example, to highlight the word under the cursor: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
911 /\k*\%#\k*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
912 < When 'hlsearch' is set and you move the cursor around and make changes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
913 this will clearly show when the match is updated or not.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
914
640
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
915 */\%'m* */\%<'m* */\%>'m*
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
916 \%'m Matches with the position of mark m.
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
917 \%<'m Matches before the position of mark m.
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
918 \%>'m Matches after the position of mark m.
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
919 Example, to highlight the text from mark 's to 'e: >
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
920 /.\%>'s.*\%<'e..
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
921 < 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
922 is because "\%<'e" matches at the character before the 'e mark, and
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
923 since it's a |/zero-width| match it doesn't include that character.
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
924 WARNING: When the mark is moved after the pattern was used, the result
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
925 becomes invalid. Vim doesn't automatically update the matches.
651
bc95c6c4bac1 updated for version 7.0191
vimboss
parents: 640
diff changeset
926 Similar to moving the cursor for "\%#" |/\%#|.
640
8a5a95f7ef2a updated for version 7.0185
vimboss
parents: 625
diff changeset
927
13231
167a030448fa Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11518
diff changeset
928 */\%l* */\%>l* */\%<l* *E951*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
929 \%23l Matches in a specific line.
625
81fe2ccc1207 updated for version 7.0179
vimboss
parents: 523
diff changeset
930 \%<23l Matches above a specific line (lower line number).
81fe2ccc1207 updated for version 7.0179
vimboss
parents: 523
diff changeset
931 \%>23l Matches below a specific line (higher line number).
25147
10b269321459 patch 8.2.3110: a pattern that matches the cursor position is complicated
Bram Moolenaar <Bram@vim.org>
parents: 24911
diff changeset
932 \%.l Matches at the cursor line.
10b269321459 patch 8.2.3110: a pattern that matches the cursor position is complicated
Bram Moolenaar <Bram@vim.org>
parents: 24911
diff changeset
933 \%<.l Matches above the cursor line.
10b269321459 patch 8.2.3110: a pattern that matches the cursor position is complicated
Bram Moolenaar <Bram@vim.org>
parents: 24911
diff changeset
934 \%>.l Matches below the cursor line.
25973
3b34837f4538 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 25402
diff changeset
935 These six can be used to match specific lines in a buffer. The "23"
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
936 can be any line number. The first line is 1.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
937 WARNING: When inserting or deleting lines Vim does not automatically
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
938 update the matches. This means Syntax highlighting quickly becomes
25402
bdda48f01a68 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 25147
diff changeset
939 wrong. Also when referring to the cursor position (".") and
25147
10b269321459 patch 8.2.3110: a pattern that matches the cursor position is complicated
Bram Moolenaar <Bram@vim.org>
parents: 24911
diff changeset
940 the cursor moves the display isn't updated for this change. An update
10b269321459 patch 8.2.3110: a pattern that matches the cursor position is complicated
Bram Moolenaar <Bram@vim.org>
parents: 24911
diff changeset
941 is done when using the |CTRL-L| command (the whole screen is updated).
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
942 Example, to highlight the line where the cursor currently is: >
25147
10b269321459 patch 8.2.3110: a pattern that matches the cursor position is complicated
Bram Moolenaar <Bram@vim.org>
parents: 24911
diff changeset
943 :exe '/\%' . line(".") . 'l'
10b269321459 patch 8.2.3110: a pattern that matches the cursor position is complicated
Bram Moolenaar <Bram@vim.org>
parents: 24911
diff changeset
944 < Alternatively use: >
10b269321459 patch 8.2.3110: a pattern that matches the cursor position is complicated
Bram Moolenaar <Bram@vim.org>
parents: 24911
diff changeset
945 /\%.l
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
946 < When 'hlsearch' is set and you move the cursor around and make changes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
947 this will clearly show when the match is updated or not.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
948
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
949 */\%c* */\%>c* */\%<c*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
950 \%23c Matches in a specific column.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
951 \%<23c Matches before a specific column.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
952 \%>23c Matches after a specific column.
25147
10b269321459 patch 8.2.3110: a pattern that matches the cursor position is complicated
Bram Moolenaar <Bram@vim.org>
parents: 24911
diff changeset
953 \%.c Matches at the cursor column.
10b269321459 patch 8.2.3110: a pattern that matches the cursor position is complicated
Bram Moolenaar <Bram@vim.org>
parents: 24911
diff changeset
954 \%<.c Matches before the cursor column.
10b269321459 patch 8.2.3110: a pattern that matches the cursor position is complicated
Bram Moolenaar <Bram@vim.org>
parents: 24911
diff changeset
955 \%>.c Matches after the cursor column.
25973
3b34837f4538 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 25402
diff changeset
956 These six can be used to match specific columns in a buffer or string.
3b34837f4538 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 25402
diff changeset
957 The "23" can be any column number. The first column is 1. Actually,
3b34837f4538 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 25402
diff changeset
958 the column is the byte number (thus it's not exactly right for
3b34837f4538 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 25402
diff changeset
959 multibyte characters).
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
960 WARNING: When inserting or deleting text Vim does not automatically
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
961 update the matches. This means Syntax highlighting quickly becomes
25402
bdda48f01a68 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 25147
diff changeset
962 wrong. Also when referring to the cursor position (".") and
25147
10b269321459 patch 8.2.3110: a pattern that matches the cursor position is complicated
Bram Moolenaar <Bram@vim.org>
parents: 24911
diff changeset
963 the cursor moves the display isn't updated for this change. An update
10b269321459 patch 8.2.3110: a pattern that matches the cursor position is complicated
Bram Moolenaar <Bram@vim.org>
parents: 24911
diff changeset
964 is done when using the |CTRL-L| command (the whole screen is updated).
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
965 Example, to highlight the column where the cursor currently is: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
966 :exe '/\%' . col(".") . 'c'
25147
10b269321459 patch 8.2.3110: a pattern that matches the cursor position is complicated
Bram Moolenaar <Bram@vim.org>
parents: 24911
diff changeset
967 < Alternatively use: >
10b269321459 patch 8.2.3110: a pattern that matches the cursor position is complicated
Bram Moolenaar <Bram@vim.org>
parents: 24911
diff changeset
968 /\%.c
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
969 < When 'hlsearch' is set and you move the cursor around and make changes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
970 this will clearly show when the match is updated or not.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
971 Example for matching a single byte in column 44: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
972 /\%>43c.\%<46c
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
973 < Note that "\%<46c" matches in column 45 when the "." matches a byte in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
974 column 44.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
975 */\%v* */\%>v* */\%<v*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
976 \%23v Matches in a specific virtual column.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
977 \%<23v Matches before a specific virtual column.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
978 \%>23v Matches after a specific virtual column.
25147
10b269321459 patch 8.2.3110: a pattern that matches the cursor position is complicated
Bram Moolenaar <Bram@vim.org>
parents: 24911
diff changeset
979 \%.v Matches at the current virtual column.
10b269321459 patch 8.2.3110: a pattern that matches the cursor position is complicated
Bram Moolenaar <Bram@vim.org>
parents: 24911
diff changeset
980 \%<.v Matches before the current virtual column.
10b269321459 patch 8.2.3110: a pattern that matches the cursor position is complicated
Bram Moolenaar <Bram@vim.org>
parents: 24911
diff changeset
981 \%>.v Matches after the current virtual column.
25973
3b34837f4538 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 25402
diff changeset
982 These six can be used to match specific virtual columns in a buffer or
3b34837f4538 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 25402
diff changeset
983 string. When not matching with a buffer in a window, the option
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
984 values of the current window are used (e.g., 'tabstop').
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
985 The "23" can be any column number. The first column is 1.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
986 Note that some virtual column positions will never match, because they
1270
d9d524594fe5 updated for version 7.1
vimboss
parents: 1221
diff changeset
987 are halfway through a tab or other character that occupies more than
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
988 one screen character.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
989 WARNING: When inserting or deleting text Vim does not automatically
283
a2ff714de3db updated for version 7.0075
vimboss
parents: 237
diff changeset
990 update highlighted matches. This means Syntax highlighting quickly
25402
bdda48f01a68 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 25147
diff changeset
991 becomes wrong. Also when referring to the cursor position (".") and
25147
10b269321459 patch 8.2.3110: a pattern that matches the cursor position is complicated
Bram Moolenaar <Bram@vim.org>
parents: 24911
diff changeset
992 the cursor moves the display isn't updated for this change. An update
10b269321459 patch 8.2.3110: a pattern that matches the cursor position is complicated
Bram Moolenaar <Bram@vim.org>
parents: 24911
diff changeset
993 is done when using the |CTRL-L| command (the whole screen is updated).
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
994 Example, to highlight all the characters after virtual column 72: >
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
995 /\%>72v.*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
996 < When 'hlsearch' is set and you move the cursor around and make changes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
997 this will clearly show when the match is updated or not.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
998 To match the text up to column 17: >
9286
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9041
diff changeset
999 /^.*\%17v
25147
10b269321459 patch 8.2.3110: a pattern that matches the cursor position is complicated
Bram Moolenaar <Bram@vim.org>
parents: 24911
diff changeset
1000 < To match all characters after the current virtual column (where the
10b269321459 patch 8.2.3110: a pattern that matches the cursor position is complicated
Bram Moolenaar <Bram@vim.org>
parents: 24911
diff changeset
1001 cursor is): >
10b269321459 patch 8.2.3110: a pattern that matches the cursor position is complicated
Bram Moolenaar <Bram@vim.org>
parents: 24911
diff changeset
1002 /\%>.v.*
9286
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9041
diff changeset
1003 < Column 17 is not included, because this is a |/zero-width| match. To
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9041
diff changeset
1004 include the column use: >
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9041
diff changeset
1005 /^.*\%17v.
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
1006 < This command does the same thing, but also matches when there is no
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
1007 character in column 17: >
9286
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9041
diff changeset
1008 /^.*\%<18v.
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9041
diff changeset
1009 < Note that without the "^" to anchor the match in the first column,
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9041
diff changeset
1010 this will also highlight column 17: >
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9041
diff changeset
1011 /.*\%17v
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9041
diff changeset
1012 < Column 17 is highlighted by 'hlsearch' because there is another match
64035abb986b commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents: 9041
diff changeset
1013 where ".*" matches zero characters.
25973
3b34837f4538 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 25402
diff changeset
1014
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1015
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
1016 Character classes:
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1017 \i identifier character (see 'isident' option) */\i*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1018 \I like "\i", but excluding digits */\I*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1019 \k keyword character (see 'iskeyword' option) */\k*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1020 \K like "\k", but excluding digits */\K*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1021 \f file name character (see 'isfname' option) */\f*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1022 \F like "\f", but excluding digits */\F*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1023 \p printable character (see 'isprint' option) */\p*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1024 \P like "\p", but excluding digits */\P*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1025
21991
bbca88cd13d5 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 21250
diff changeset
1026 NOTE: the above also work for multibyte characters. The ones below only
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1027 match ASCII characters, as indicated by the range.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1028
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1029 *whitespace* *white-space*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1030 \s whitespace character: <Space> and <Tab> */\s*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1031 \S non-whitespace character; opposite of \s */\S*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1032 \d digit: [0-9] */\d*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1033 \D non-digit: [^0-9] */\D*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1034 \x hex digit: [0-9A-Fa-f] */\x*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1035 \X non-hex digit: [^0-9A-Fa-f] */\X*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1036 \o octal digit: [0-7] */\o*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1037 \O non-octal digit: [^0-7] */\O*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1038 \w word character: [0-9A-Za-z_] */\w*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1039 \W non-word character: [^0-9A-Za-z_] */\W*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1040 \h head of word character: [A-Za-z_] */\h*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1041 \H non-head of word character: [^A-Za-z_] */\H*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1042 \a alphabetic character: [A-Za-z] */\a*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1043 \A non-alphabetic character: [^A-Za-z] */\A*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1044 \l lowercase character: [a-z] */\l*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1045 \L non-lowercase character: [^a-z] */\L*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1046 \u uppercase character: [A-Z] */\u*
3224
8b8ef1fed009 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3153
diff changeset
1047 \U non-uppercase character: [^A-Z] */\U*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1048
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1049 NOTE: Using the atom is faster than the [] form.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1050
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1051 NOTE: 'ignorecase', "\c" and "\C" are not used by character classes.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1052
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1053 */\_* *E63* */\_i* */\_I* */\_k* */\_K* */\_f* */\_F*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1054 */\_p* */\_P* */\_s* */\_S* */\_d* */\_D* */\_x* */\_X*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1055 */\_o* */\_O* */\_w* */\_W* */\_h* */\_H* */\_a* */\_A*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1056 */\_l* */\_L* */\_u* */\_U*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1057 \_x Where "x" is any of the characters above: The character class with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1058 end-of-line added
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1059 (end of character classes)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1060
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1061 \e matches <Esc> */\e*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1062 \t matches <Tab> */\t*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1063 \r matches <CR> */\r*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1064 \b matches <BS> */\b*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1065 \n matches an end-of-line */\n*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1066 When matching in a string instead of buffer text a literal newline
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1067 character is matched.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1068
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1069 ~ matches the last given substitute string */~* */\~*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1070
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1071 \(\) A pattern enclosed by escaped parentheses. */\(* */\(\)* */\)*
4444
ccecb03e5e8b updated for version 7.3.970
Bram Moolenaar <bram@vim.org>
parents: 4339
diff changeset
1072 E.g., "\(^a\)" matches 'a' at the start of a line.
ccecb03e5e8b updated for version 7.3.970
Bram Moolenaar <bram@vim.org>
parents: 4339
diff changeset
1073 *E51* *E54* *E55* *E872* *E873*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1074
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1075 \1 Matches the same string that was matched by */\1* *E65*
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
1076 the first sub-expression in \( and \).
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1077 Example: "\([a-z]\).\1" matches "ata", "ehe", "tot", etc.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1078 \2 Like "\1", but uses second sub-expression, */\2*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1079 ... */\3*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1080 \9 Like "\1", but uses ninth sub-expression. */\9*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1081 Note: The numbering of groups is done based on which "\(" comes first
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1082 in the pattern (going left to right), NOT based on what is matched
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1083 first.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1084
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1085 \%(\) A pattern enclosed by escaped parentheses. */\%(\)* */\%(* *E53*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1086 Just like \(\), but without counting it as a sub-expression. This
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1087 allows using more groups and it's a little bit faster.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1088
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1089 x A single character, with no special meaning, matches itself
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1090
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1091 */\* */\\*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1092 \x A backslash followed by a single character, with no special meaning,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1093 is reserved for future expansions
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1094
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1095 [] (with 'nomagic': \[]) */[]* */\[]* */\_[]* */collection*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1096 \_[]
23164
99ef85ff1af4 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 22171
diff changeset
1097 A collection. This is a sequence of characters enclosed in square
99ef85ff1af4 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 22171
diff changeset
1098 brackets. It matches any single character in the collection.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1099 Example matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1100 [xyz] any 'x', 'y' or 'z'
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1101 [a-zA-Z]$ any alphabetic character at the end of a line
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1102 \c[a-z]$ same
4073
e362db8b2d7b Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
1103 [А-яЁё] Russian alphabet (with utf-8 and cp1251)
e362db8b2d7b Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3513
diff changeset
1104
1125
96cd8222a819 updated for version 7.1a
vimboss
parents: 874
diff changeset
1105 */[\n]*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1106 With "\_" prepended the collection also includes the end-of-line.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1107 The same can be done by including "\n" in the collection. The
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1108 end-of-line is also matched when the collection starts with "^"! Thus
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1109 "\_[^ab]" matches the end-of-line and any character but "a" and "b".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1110 This makes it Vi compatible: Without the "\_" or "\n" the collection
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1111 does not match an end-of-line.
484
f012c4ed8c38 updated for version 7.0132
vimboss
parents: 481
diff changeset
1112 *E769*
481
66080ac5dab7 updated for version 7.0130
vimboss
parents: 283
diff changeset
1113 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
1114 assume no collection is used. Useful to search for '['. However, you
6697
12155a47f6c2 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6647
diff changeset
1115 do get E769 for internal searching. And be aware that in a
12155a47f6c2 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6647
diff changeset
1116 `:substitute` command the whole command becomes the pattern. E.g.
12155a47f6c2 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6647
diff changeset
1117 ":s/[/x/" searches for "[/x" and replaces it with nothing. It does
12155a47f6c2 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 6647
diff changeset
1118 not search for "[" and replaces it with "x"!
481
66080ac5dab7 updated for version 7.0130
vimboss
parents: 283
diff changeset
1119
11518
63b0b7b79b25 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11347
diff changeset
1120 *E944* *E945*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1121 If the sequence begins with "^", it matches any single character NOT
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1122 in the collection: "[^xyz]" matches anything but 'x', 'y' and 'z'.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1123 - If two characters in the sequence are separated by '-', this is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1124 shorthand for the full list of ASCII characters between them. E.g.,
11518
63b0b7b79b25 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11347
diff changeset
1125 "[0-9]" matches any decimal digit. If the starting character exceeds
63b0b7b79b25 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11347
diff changeset
1126 the ending character, e.g. [c-a], E944 occurs. Non-ASCII characters
63b0b7b79b25 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11347
diff changeset
1127 can be used, but the character values must not be more than 256 apart
63b0b7b79b25 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11347
diff changeset
1128 in the old regexp engine. For example, searching by [\u3000-\u4000]
63b0b7b79b25 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 11347
diff changeset
1129 after setting re=1 emits a E945 error. Prepending \%#=2 will fix it.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1130 - A character class expression is evaluated to the set of characters
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1131 belonging to that character class. The following character classes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1132 are supported:
11267
588de97b40e7 patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1133 Name Func Contents ~
588de97b40e7 patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1134 *[:alnum:]* [:alnum:] isalnum ASCII letters and digits
588de97b40e7 patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1135 *[:alpha:]* [:alpha:] isalpha ASCII letters
588de97b40e7 patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1136 *[:blank:]* [:blank:] space and tab
588de97b40e7 patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1137 *[:cntrl:]* [:cntrl:] iscntrl ASCII control characters
588de97b40e7 patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1138 *[:digit:]* [:digit:] decimal digits '0' to '9'
588de97b40e7 patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1139 *[:graph:]* [:graph:] isgraph ASCII printable characters excluding
588de97b40e7 patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1140 space
588de97b40e7 patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1141 *[:lower:]* [:lower:] (1) lowercase letters (all letters when
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1142 'ignorecase' is used)
11267
588de97b40e7 patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1143 *[:print:]* [:print:] (2) printable characters including space
588de97b40e7 patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1144 *[:punct:]* [:punct:] ispunct ASCII punctuation characters
588de97b40e7 patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1145 *[:space:]* [:space:] whitespace characters: space, tab, CR,
588de97b40e7 patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1146 NL, vertical tab, form feed
588de97b40e7 patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1147 *[:upper:]* [:upper:] (3) uppercase letters (all letters when
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1148 'ignorecase' is used)
11267
588de97b40e7 patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1149 *[:xdigit:]* [:xdigit:] hexadecimal digits: 0-9, a-f, A-F
588de97b40e7 patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1150 *[:return:]* [:return:] the <CR> character
588de97b40e7 patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1151 *[:tab:]* [:tab:] the <Tab> character
588de97b40e7 patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1152 *[:escape:]* [:escape:] the <Esc> character
588de97b40e7 patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1153 *[:backspace:]* [:backspace:] the <BS> character
15709
2e2f07561f4b patch 8.1.0862: no verbose version of character classes
Bram Moolenaar <Bram@vim.org>
parents: 15281
diff changeset
1154 *[:ident:]* [:ident:] identifier character (same as "\i")
2e2f07561f4b patch 8.1.0862: no verbose version of character classes
Bram Moolenaar <Bram@vim.org>
parents: 15281
diff changeset
1155 *[:keyword:]* [:keyword:] keyword character (same as "\k")
2e2f07561f4b patch 8.1.0862: no verbose version of character classes
Bram Moolenaar <Bram@vim.org>
parents: 15281
diff changeset
1156 *[:fname:]* [:fname:] file name character (same as "\f")
23164
99ef85ff1af4 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 22171
diff changeset
1157 The square brackets in character class expressions are additional to
99ef85ff1af4 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 22171
diff changeset
1158 the square brackets delimiting a collection. For example, the
99ef85ff1af4 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 22171
diff changeset
1159 following is a plausible pattern for a UNIX filename:
99ef85ff1af4 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 22171
diff changeset
1160 "[-./[:alnum:]_~]\+". That is, a list of at least one character,
99ef85ff1af4 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 22171
diff changeset
1161 each of which is either '-', '.', '/', alphabetic, numeric, '_' or
99ef85ff1af4 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 22171
diff changeset
1162 '~'.
7477
05cf4cc72a9f commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents: 7384
diff changeset
1163 These items only work for 8-bit characters, except [:lower:] and
21991
bbca88cd13d5 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 21250
diff changeset
1164 [:upper:] also work for multibyte characters when using the new
8876
47f17f66da3d commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents: 7477
diff changeset
1165 regexp engine. See |two-engines|. In the future these items may
21991
bbca88cd13d5 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 21250
diff changeset
1166 work for multibyte characters. For now, to get all "alpha"
9041
34c45ee4210d commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents: 8951
diff changeset
1167 characters you can use: [[:lower:][:upper:]].
11267
588de97b40e7 patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1168
588de97b40e7 patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1169 The "Func" column shows what library function is used. The
588de97b40e7 patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1170 implementation depends on the system. Otherwise:
588de97b40e7 patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1171 (1) Uses islower() for ASCII and Vim builtin rules for other
15878
314694a2e74a Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 15709
diff changeset
1172 characters.
11267
588de97b40e7 patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1173 (2) Uses Vim builtin rules
588de97b40e7 patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents: 11160
diff changeset
1174 (3) As with (1) but using isupper()
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 140
diff changeset
1175 */[[=* *[==]*
4d9eabb1396e updated for version 7.0051
vimboss
parents: 140
diff changeset
1176 - An equivalence class. This means that characters are matched that
2974
59130cd78dfc updated for version 7.3.259
Bram Moolenaar <bram@vim.org>
parents: 2908
diff changeset
1177 have almost the same meaning, e.g., when ignoring accents. This
59130cd78dfc updated for version 7.3.259
Bram Moolenaar <bram@vim.org>
parents: 2908
diff changeset
1178 only works for Unicode, latin1 and latin9. The form is:
856
8cd729851562 updated for version 7.0g
vimboss
parents: 853
diff changeset
1179 [=a=]
168
4d9eabb1396e updated for version 7.0051
vimboss
parents: 140
diff changeset
1180 */[[.* *[..]*
4d9eabb1396e updated for version 7.0051
vimboss
parents: 140
diff changeset
1181 - A collation element. This currently simply accepts a single
4d9eabb1396e updated for version 7.0051
vimboss
parents: 140
diff changeset
1182 character in the form:
856
8cd729851562 updated for version 7.0g
vimboss
parents: 853
diff changeset
1183 [.a.]
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1184 */\]*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1185 - To include a literal ']', '^', '-' or '\' in the collection, put a
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1186 backslash before it: "[xyz\]]", "[\^xyz]", "[xy\-z]" and "[xyz\\]".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1187 (Note: POSIX does not support the use of a backslash this way). For
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1188 ']' you can also make it the first character (following a possible
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
1189 "^"): "[]xyz]" or "[^]xyz]".
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1190 For '-' you can also make it the first or last character: "[-xyz]",
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1191 "[^-xyz]" or "[xyz-]". For '\' you can also let it be followed by
2290
22529abcd646 Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
1192 any character that's not in "^]-\bdertnoUux". "[\xyz]" matches '\',
22529abcd646 Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
1193 'x', 'y' and 'z'. It's better to use "\\" though, future expansions
22529abcd646 Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents: 2154
diff changeset
1194 may use other characters after '\'.
4339
22fa3049e934 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4119
diff changeset
1195 - Omitting the trailing ] is not considered an error. "[]" works like
22fa3049e934 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4119
diff changeset
1196 "[]]", it matches the ']' character.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1197 - The following translations are accepted when the 'l' flag is not
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
1198 included in 'cpoptions':
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1199 \e <Esc>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1200 \t <Tab>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1201 \r <CR> (NOT end-of-line!)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1202 \b <BS>
1125
96cd8222a819 updated for version 7.1a
vimboss
parents: 874
diff changeset
1203 \n line break, see above |/[\n]|
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
1204 \d123 decimal number of character
23573
e2e2cc5d0856 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 23466
diff changeset
1205 \o40 octal number of character up to 0o377
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
1206 \x20 hexadecimal number of character up to 0xff
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
1207 \u20AC hex. number of multibyte character up to 0xffff
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
1208 \U1234 hex. number of multibyte character up to 0xffffffff
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1209 NOTE: The other backslash codes mentioned above do not work inside
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1210 []!
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1211 - Matching with a collection can be slow, because each character in
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1212 the text has to be compared with each character in the collection.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1213 Use one of the other atoms above when possible. Example: "\d" is
13482
9eebe457eb3c Update runtime files. Convert a couple of help files to utf-8.
Christian Brabandt <cb@256bit.org>
parents: 13231
diff changeset
1214 much faster than "[0-9]" and matches the same characters. However,
9eebe457eb3c Update runtime files. Convert a couple of help files to utf-8.
Christian Brabandt <cb@256bit.org>
parents: 13231
diff changeset
1215 the new |NFA| regexp engine deals with this better than the old one.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1216
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1217 */\%[]* *E69* *E70* *E369*
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
1218 \%[] A sequence of optionally matched atoms. This always matches.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1219 It matches as much of the list of atoms it contains as possible. Thus
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1220 it stops at the first atom that doesn't match. For example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1221 /r\%[ead]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1222 < matches "r", "re", "rea" or "read". The longest that matches is used.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1223 To match the Ex command "function", where "fu" is required and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1224 "nction" is optional, this would work: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1225 /\<fu\%[nction]\>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1226 < The end-of-word atom "\>" is used to avoid matching "fu" in "full".
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1227 It gets more complicated when the atoms are not ordinary characters.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1228 You don't often have to use it, but it is possible. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1229 /\<r\%[[eo]ad]\>
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1230 < Matches the words "r", "re", "ro", "rea", "roa", "read" and "road".
1125
96cd8222a819 updated for version 7.1a
vimboss
parents: 874
diff changeset
1231 There can be no \(\), \%(\) or \z(\) items inside the [] and \%[] does
96cd8222a819 updated for version 7.1a
vimboss
parents: 874
diff changeset
1232 not nest.
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
1233 To include a "[" use "[[]" and for "]" use []]", e.g.,: >
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
1234 /index\%[[[]0[]]]
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
1235 < matches "index" "index[", "index[0" and "index[0]".
2570
71b56b4e7785 Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents: 2561
diff changeset
1236 {not available when compiled without the |+syntax| feature}
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1237
140
8ecb0db93e9a updated for version 7.0045
vimboss
parents: 133
diff changeset
1238 */\%d* */\%x* */\%o* */\%u* */\%U* *E678*
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
1239
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
1240 \%d123 Matches the character specified with a decimal number. Must be
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
1241 followed by a non-digit.
24911
fd37be6dc258 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24636
diff changeset
1242 \%o40 Matches the character specified with an octal number up to 0o377.
23573
e2e2cc5d0856 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 23466
diff changeset
1243 Numbers below 0o40 must be followed by a non-octal digit or a
e2e2cc5d0856 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 23466
diff changeset
1244 non-digit.
24
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
1245 \%x2a Matches the character specified with up to two hexadecimal characters.
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
1246 \%u20AC Matches the character specified with up to four hexadecimal
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
1247 characters.
8ff7fd162d3c updated for version 7.0016
vimboss
parents: 20
diff changeset
1248 \%U1234abcd Matches the character specified with up to eight hexadecimal
15932
c3c1abe7aff2 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 15878
diff changeset
1249 characters, up to 0x7fffffff
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1250
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1251 ==============================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1252 7. Ignoring case in a pattern */ignorecase*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1253
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1254 If the 'ignorecase' option is on, the case of normal letters is ignored.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1255 'smartcase' can be set to ignore case when the pattern contains lowercase
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1256 letters only.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1257 */\c* */\C*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1258 When "\c" appears anywhere in the pattern, the whole pattern is handled like
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1259 'ignorecase' is on. The actual value of 'ignorecase' and 'smartcase' is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1260 ignored. "\C" does the opposite: Force matching case for the whole pattern.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1261 {only Vim supports \c and \C}
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1262 Note that 'ignorecase', "\c" and "\C" are not used for the character classes.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1263
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1264 Examples:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1265 pattern 'ignorecase' 'smartcase' matches ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1266 foo off - foo
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1267 foo on - foo Foo FOO
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1268 Foo on off foo Foo FOO
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1269 Foo on on Foo
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1270 \cfoo - - foo Foo FOO
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1271 foo\C - - foo
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1272
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1273 Technical detail: *NL-used-for-Nul*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1274 <Nul> characters in the file are stored as <NL> in memory. In the display
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1275 they are shown as "^@". The translation is done when reading and writing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1276 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
1277 "CTRL-V 000". This is probably just what you expect. Internally the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1278 character is replaced with a <NL> in the search pattern. What is unusual is
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1279 that typing CTRL-V CTRL-J also inserts a <NL>, thus also searches for a <Nul>
16553
0e473e9e70c2 patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents: 16533
diff changeset
1280 in the file.
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1281
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1282 *CR-used-for-NL*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1283 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
1284 characters internally. In the text they are shown as "^J". Otherwise this
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1285 works similar to the usage of <NL> for a <Nul>.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1286
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1287 When working with expression evaluation, a <NL> character in the pattern
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1288 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
1289 doesn't work there, it only works to match text in the buffer.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1290
21991
bbca88cd13d5 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 21250
diff changeset
1291 *pattern-multi-byte* *pattern-multibyte*
bbca88cd13d5 Update runtime files.
Bram Moolenaar <Bram@vim.org>
parents: 21250
diff changeset
1292 Patterns will also work with multibyte characters, mostly as you would
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1293 expect. But invalid bytes may cause trouble, a pattern with an invalid byte
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1294 will probably never match.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1295
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1296 ==============================================================================
714
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1297 8. Composing characters *patterns-composing*
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1298
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1299 */\Z*
5901
10fc95f48546 updated for version 7.4.293
Bram Moolenaar <bram@vim.org>
parents: 5663
diff changeset
1300 When "\Z" appears anywhere in the pattern, all composing characters are
10fc95f48546 updated for version 7.4.293
Bram Moolenaar <bram@vim.org>
parents: 5663
diff changeset
1301 ignored. Thus only the base characters need to match, the composing
10fc95f48546 updated for version 7.4.293
Bram Moolenaar <bram@vim.org>
parents: 5663
diff changeset
1302 characters may be different and the number of composing characters may differ.
10fc95f48546 updated for version 7.4.293
Bram Moolenaar <bram@vim.org>
parents: 5663
diff changeset
1303 Only relevant when 'encoding' is "utf-8".
4681
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
1304 Exception: If the pattern starts with one or more composing characters, these
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
1305 must match.
5901
10fc95f48546 updated for version 7.4.293
Bram Moolenaar <bram@vim.org>
parents: 5663
diff changeset
1306 */\%C*
10fc95f48546 updated for version 7.4.293
Bram Moolenaar <bram@vim.org>
parents: 5663
diff changeset
1307 Use "\%C" to skip any composing characters. For example, the pattern "a" does
10fc95f48546 updated for version 7.4.293
Bram Moolenaar <bram@vim.org>
parents: 5663
diff changeset
1308 not match in "càt" (where the a has the composing character 0x0300), but
10fc95f48546 updated for version 7.4.293
Bram Moolenaar <bram@vim.org>
parents: 5663
diff changeset
1309 "a\%C" does. Note that this does not match "cát" (where the á is character
10fc95f48546 updated for version 7.4.293
Bram Moolenaar <bram@vim.org>
parents: 5663
diff changeset
1310 0xe1, it does not have a compositing character). It does match "cat" (where
10fc95f48546 updated for version 7.4.293
Bram Moolenaar <bram@vim.org>
parents: 5663
diff changeset
1311 the a is just an a).
714
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1312
21250
21fb2a3ad3ca Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 18972
diff changeset
1313 When a composing character appears at the start of the pattern or after an
714
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1314 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
1315 character that includes this composing character.
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1316
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1317 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
1318 composing character by itself, except that it doesn't matter what comes before
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1319 this.
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1320
4681
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
1321 The order of composing characters does not matter. Also, the text may have
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
1322 more composing characters than the pattern, it still matches. But all
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
1323 composing characters in the pattern must be found in the text.
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
1324
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
1325 Suppose B is a base character and x and y are composing characters:
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
1326 pattern text match ~
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
1327 Bxy Bxy yes (perfect match)
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
1328 Bxy Byx yes (order ignored)
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
1329 Bxy By no (x missing)
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
1330 Bxy Bx no (y missing)
4780
2b11ac90d9e9 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 4681
diff changeset
1331 Bx Bx yes (perfect match)
4681
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
1332 Bx By no (x missing)
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
1333 Bx Bxy yes (extra y ignored)
2eb30f341e8d Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents: 4444
diff changeset
1334 Bx Byx yes (extra y ignored)
714
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1335
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1336 ==============================================================================
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1337 9. Compare with Perl patterns *perl-patterns*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1338
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1339 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
1340 difference between them is mostly just notation; here's a summary of where
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1341 they differ:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1342
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1343 Capability in Vimspeak in Perlspeak ~
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1344 ----------------------------------------------------------------
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1345 force case insensitivity \c (?i)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1346 force case sensitivity \C (?-i)
714
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1347 backref-less grouping \%(atom\) (?:atom)
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1348 conservative quantifiers \{-n,m} *?, +?, ??, {}?
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1349 0-width match atom\@= (?=atom)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1350 0-width non-match atom\@! (?!atom)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1351 0-width preceding match atom\@<= (?<=atom)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1352 0-width preceding non-match atom\@<! (?<!atom)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1353 match without retry atom\@> (?>atom)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1354
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1355 Vim and Perl handle newline characters inside a string a bit differently:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1356
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1357 In Perl, ^ and $ only match at the very beginning and end of the text,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1358 by default, but you can set the 'm' flag, which lets them match at
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1359 embedded newlines as well. You can also set the 's' flag, which causes
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1360 a . to match newlines as well. (Both these flags can be changed inside
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1361 a pattern using the same syntax used for the i flag above, BTW.)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1362
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1363 On the other hand, Vim's ^ and $ always match at embedded newlines, and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1364 you get two separate atoms, \%^ and \%$, which only match at the very
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1365 start and end of the text, respectively. Vim solves the second problem
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1366 by giving you the \_ "modifier": put it in front of a . or a character
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1367 class, and they will match newlines as well.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1368
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1369 Finally, these constructs are unique to Perl:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1370 - execution of arbitrary code in the regex: (?{perl code})
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1371 - conditional expressions: (?(condition)true-expr|false-expr)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1372
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1373 ...and these are unique to Vim:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1374 - changing the magic-ness of a pattern: \v \V \m \M
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1375 (very useful for avoiding backslashitis)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1376 - sequence of optionally matching atoms: \%[atoms]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1377 - \& (which is to \| what "and" is to "or"; it forces several branches
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1378 to match at one spot)
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1379 - matching lines/columns by number: \%5l \%5c \%5v
714
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1380 - setting the start and end of the match: \zs \ze
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1381
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1382 ==============================================================================
714
0f9f4761ad9c updated for version 7.0216
vimboss
parents: 699
diff changeset
1383 10. Highlighting matches *match-highlight*
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1384
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1385 *:mat* *:match*
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1386 :mat[ch] {group} /{pattern}/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1387 Define a pattern to highlight in the current window. It will
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1388 be highlighted with {group}. Example: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1389 :highlight MyGroup ctermbg=green guibg=green
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1390 :match MyGroup /TODO/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1391 < Instead of // any character can be used to mark the start and
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1392 end of the {pattern}. Watch out for using special characters,
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1393 such as '"' and '|'.
699
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1394
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1395 {group} must exist at the moment this command is executed.
699
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1396
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1397 The {group} highlighting still applies when a character is
1326
22886f3d882d updated for version 7.1-040
vimboss
parents: 1270
diff changeset
1398 to be highlighted for 'hlsearch', as the highlighting for
22886f3d882d updated for version 7.1-040
vimboss
parents: 1270
diff changeset
1399 matches is given higher priority than that of 'hlsearch'.
22886f3d882d updated for version 7.1-040
vimboss
parents: 1270
diff changeset
1400 Syntax highlighting (see 'syntax') is also overruled by
22886f3d882d updated for version 7.1-040
vimboss
parents: 1270
diff changeset
1401 matches.
699
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1402
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1403 Note that highlighting the last used search pattern with
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1404 'hlsearch' is used in all windows, while the pattern defined
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1405 with ":match" only exists in the current window. It is kept
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1406 when switching to another buffer.
699
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1407
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1408 'ignorecase' does not apply, use |/\c| in the pattern to
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1409 ignore case. Otherwise case is not ignored.
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1410
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
1411 'redrawtime' defines the maximum time searched for pattern
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
1412 matches.
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
1413
1125
96cd8222a819 updated for version 7.1a
vimboss
parents: 874
diff changeset
1414 When matching end-of-line and Vim redraws only part of the
96cd8222a819 updated for version 7.1a
vimboss
parents: 874
diff changeset
1415 display you may get unexpected results. That is because Vim
96cd8222a819 updated for version 7.1a
vimboss
parents: 874
diff changeset
1416 looks for a match in the line where redrawing starts.
96cd8222a819 updated for version 7.1a
vimboss
parents: 874
diff changeset
1417
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1326
diff changeset
1418 Also see |matcharg()| and |getmatches()|. The former returns
1326
22886f3d882d updated for version 7.1-040
vimboss
parents: 1270
diff changeset
1419 the highlight group and pattern of a previous |:match|
22886f3d882d updated for version 7.1-040
vimboss
parents: 1270
diff changeset
1420 command. The latter returns a list with highlight groups and
22886f3d882d updated for version 7.1-040
vimboss
parents: 1270
diff changeset
1421 patterns defined by both |matchadd()| and |:match|.
22886f3d882d updated for version 7.1-040
vimboss
parents: 1270
diff changeset
1422
22886f3d882d updated for version 7.1-040
vimboss
parents: 1270
diff changeset
1423 Highlighting matches using |:match| are limited to three
5968
92751673cc37 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5908
diff changeset
1424 matches (aside from |:match|, |:2match| and |:3match| are
1326
22886f3d882d updated for version 7.1-040
vimboss
parents: 1270
diff changeset
1425 available). |matchadd()| does not have this limitation and in
22886f3d882d updated for version 7.1-040
vimboss
parents: 1270
diff changeset
1426 addition makes it possible to prioritize matches.
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 810
diff changeset
1427
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1428 Another example, which highlights all characters in virtual
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1429 column 72 and more: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1430 :highlight rightMargin term=bold ctermfg=blue guifg=blue
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1431 :match rightMargin /.\%>72v/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1432 < To highlight all character that are in virtual column 7: >
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1433 :highlight col8 ctermbg=grey guibg=grey
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1434 :match col8 /\%<8v.\%>7v/
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1435 < Note the use of two items to also match a character that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1436 occupies more than one virtual column, such as a TAB.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1437
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1438 :mat[ch]
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1439 :mat[ch] none
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1440 Clear a previously defined match pattern.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1441
699
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1442
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 810
diff changeset
1443 :2mat[ch] {group} /{pattern}/ *:2match*
699
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1444 :2mat[ch]
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1445 :2mat[ch] none
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 810
diff changeset
1446 :3mat[ch] {group} /{pattern}/ *:3match*
699
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1447 :3mat[ch]
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1448 :3mat[ch] none
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1449 Just like |:match| above, but set a separate match. Thus
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1450 there can be three matches active at the same time. The match
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1451 with the lowest number has priority if several match at the
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1452 same position.
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1453 The ":3match" command is used by the |matchparen| plugin. You
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1454 are suggested to use ":match" for manual matching and
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1455 ":2match" for another plugin.
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1456
24636
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1457 ==============================================================================
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1458 11. Fuzzy matching *fuzzy-match*
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1459
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1460 Fuzzy matching refers to matching strings using a non-exact search string.
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1461 Fuzzy matching will match a string, if all the characters in the search string
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1462 are present anywhere in the string in the same order. Case is ignored. In a
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1463 matched string, other characters can be present between two consecutive
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1464 characters in the search string. If the search string has multiple words, then
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1465 each word is matched separately. So the words in the search string can be
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1466 present in any order in a string.
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1467
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1468 Fuzzy matching assigns a score for each matched string based on the following
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1469 criteria:
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1470 - The number of sequentially matching characters.
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1471 - The number of characters (distance) between two consecutive matching
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1472 characters.
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1473 - Matches at the beginning of a word
25402
bdda48f01a68 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 25147
diff changeset
1474 - Matches at a camel case character (e.g. Case in CamelCase)
bdda48f01a68 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 25147
diff changeset
1475 - Matches after a path separator or a hyphen.
24636
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1476 - The number of unmatched characters in a string.
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1477 The matching string with the highest score is returned first.
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1478
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1479 For example, when you search for the "get pat" string using fuzzy matching, it
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1480 will match the strings "GetPattern", "PatternGet", "getPattern", "patGetter",
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1481 "getSomePattern", "MatchpatternGet" etc.
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1482
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1483 The functions |matchfuzzy()| and |matchfuzzypos()| can be used to fuzzy search
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1484 a string in a List of strings. The matchfuzzy() function returns a List of
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1485 matching strings. The matchfuzzypos() functions returns the List of matches,
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1486 the matching positions and the fuzzy match scores.
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1487
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1488 The "f" flag of `:vimgrep` enables fuzzy matching.
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1489
840665e74421 Update runtime files
Bram Moolenaar <Bram@vim.org>
parents: 24024
diff changeset
1490
699
2af8de31a3a8 updated for version 7.0211
vimboss
parents: 667
diff changeset
1491
14421
2f7e67dd088c Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 14372
diff changeset
1492 vim:tw=78:ts=8:noet:ft=help:norl: