Mercurial > vim
annotate runtime/doc/autocmd.txt @ 28588:a1de4ee8c40d v8.2.4818
patch 8.2.4818: no test for what 8.2.4806 fixes
Commit: https://github.com/vim/vim/commit/ac92ab771952b2a9ee39ea6fa5e70e4c072942d5
Author: zeertzjq <zeertzjq@outlook.com>
Date: Sun Apr 24 15:58:30 2022 +0100
patch 8.2.4818: no test for what 8.2.4806 fixes
Problem: No test for what 8.2.4806 fixes.
Solution: Add a test. (closes https://github.com/vim/vim/issues/10727)
author | Bram Moolenaar <Bram@vim.org> |
---|---|
date | Sun, 24 Apr 2022 17:00:04 +0200 |
parents | f73a9bdff3a3 |
children | c5862dfaf0bd |
rev | line source |
---|---|
28517 | 1 *autocmd.txt* For Vim version 8.2. Last change: 2022 Apr 17 |
7 | 2 |
3 | |
4 VIM REFERENCE MANUAL by Bram Moolenaar | |
5 | |
6 | |
14193 | 7 Automatic commands *autocommand* *autocommands* |
7 | 8 |
9 For a basic explanation, see section |40.3| in the user manual. | |
10 | |
11 1. Introduction |autocmd-intro| | |
12 2. Defining autocommands |autocmd-define| | |
13 3. Removing autocommands |autocmd-remove| | |
14 4. Listing autocommands |autocmd-list| | |
15 5. Events |autocmd-events| | |
16 6. Patterns |autocmd-patterns| | |
40 | 17 7. Buffer-local autocommands |autocmd-buflocal| |
18 8. Groups |autocmd-groups| | |
19 9. Executing autocommands |autocmd-execute| | |
20 10. Using autocommands |autocmd-use| | |
590 | 21 11. Disabling autocommands |autocmd-disable| |
7 | 22 |
23 | |
24 ============================================================================== | |
25 1. Introduction *autocmd-intro* | |
26 | |
22 | 27 You can specify commands to be executed automatically when reading or writing |
28 a file, when entering or leaving a buffer or window, and when exiting Vim. | |
29 For example, you can create an autocommand to set the 'cindent' option for | |
30 files matching *.c. You can also use autocommands to implement advanced | |
7 | 31 features, such as editing compressed files (see |gzip-example|). The usual |
32 place to put autocommands is in your .vimrc or .exrc file. | |
33 | |
13231 | 34 *E203* *E204* *E143* *E855* *E937* *E952* |
7 | 35 WARNING: Using autocommands is very powerful, and may lead to unexpected side |
36 effects. Be careful not to destroy your text. | |
37 - It's a good idea to do some testing on an expendable copy of a file first. | |
38 For example: If you use autocommands to decompress a file when starting to | |
39 edit it, make sure that the autocommands for compressing when writing work | |
40 correctly. | |
41 - Be prepared for an error halfway through (e.g., disk full). Vim will mostly | |
42 be able to undo the changes to the buffer, but you may have to clean up the | |
43 changes to other files by hand (e.g., compress a file that has been | |
44 decompressed). | |
45 - If the BufRead* events allow you to edit a compressed file, the FileRead* | |
46 events should do the same (this makes recovery possible in some rare cases). | |
47 It's a good idea to use the same autocommands for the File* and Buf* events | |
48 when possible. | |
49 | |
50 ============================================================================== | |
51 2. Defining autocommands *autocmd-define* | |
52 | |
53 *:au* *:autocmd* | |
27162 | 54 :au[tocmd] [group] {event} {aupat} [++once] [++nested] {cmd} |
7 | 55 Add {cmd} to the list of commands that Vim will |
56 execute automatically on {event} for a file matching | |
27162 | 57 {aupat} |autocmd-patterns|. |
23798
59efd230b373
patch 8.2.2440: documentation based on patches is outdated
Bram Moolenaar <Bram@vim.org>
parents:
23305
diff
changeset
|
58 Here {event} cannot be "*". *E1155* |
13482
9eebe457eb3c
Update runtime files. Convert a couple of help files to utf-8.
Christian Brabandt <cb@256bit.org>
parents:
13444
diff
changeset
|
59 Note: A quote character is seen as argument to the |
9eebe457eb3c
Update runtime files. Convert a couple of help files to utf-8.
Christian Brabandt <cb@256bit.org>
parents:
13444
diff
changeset
|
60 :autocmd and won't start a comment. |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1919
diff
changeset
|
61 Vim always adds the {cmd} after existing autocommands, |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1919
diff
changeset
|
62 so that the autocommands execute in the order in which |
16217
81e6940504e8
patch 8.1.1113: making an autocommand trigger once is not so easy
Bram Moolenaar <Bram@vim.org>
parents:
16023
diff
changeset
|
63 they were given. |
81e6940504e8
patch 8.1.1113: making an autocommand trigger once is not so easy
Bram Moolenaar <Bram@vim.org>
parents:
16023
diff
changeset
|
64 See |autocmd-nested| for [++nested]. "nested" |
81e6940504e8
patch 8.1.1113: making an autocommand trigger once is not so easy
Bram Moolenaar <Bram@vim.org>
parents:
16023
diff
changeset
|
65 (without the ++) can also be used, for backwards |
28010 | 66 compatibility, but not in |Vim9| script. *E1078* |
16217
81e6940504e8
patch 8.1.1113: making an autocommand trigger once is not so easy
Bram Moolenaar <Bram@vim.org>
parents:
16023
diff
changeset
|
67 *autocmd-once* |
81e6940504e8
patch 8.1.1113: making an autocommand trigger once is not so easy
Bram Moolenaar <Bram@vim.org>
parents:
16023
diff
changeset
|
68 If [++once] is supplied the command is executed once, |
81e6940504e8
patch 8.1.1113: making an autocommand trigger once is not so easy
Bram Moolenaar <Bram@vim.org>
parents:
16023
diff
changeset
|
69 then removed ("one shot"). |
7 | 70 |
40 | 71 The special pattern <buffer> or <buffer=N> defines a buffer-local autocommand. |
72 See |autocmd-buflocal|. | |
73 | |
23164 | 74 If the `:autocmd` is in Vim9 script (a script that starts with `:vim9script` |
75 and in a `:def` function) then {cmd} will be executed as in Vim9 | |
22958 | 76 script. Thus this depends on where the autocmd is defined, not where it is |
77 triggered. | |
78 | |
25619 | 79 {cmd} can be a block, like with `:command`, see |:command-repl|. Example: > |
25463
05f9e8f2016c
patch 8.2.3268: cannot use a block with :autocmd like with :command
Bram Moolenaar <Bram@vim.org>
parents:
25402
diff
changeset
|
80 au BufReadPost *.xml { |
05f9e8f2016c
patch 8.2.3268: cannot use a block with :autocmd like with :command
Bram Moolenaar <Bram@vim.org>
parents:
25402
diff
changeset
|
81 setlocal matchpairs+=<:> |
05f9e8f2016c
patch 8.2.3268: cannot use a block with :autocmd like with :command
Bram Moolenaar <Bram@vim.org>
parents:
25402
diff
changeset
|
82 /<start |
05f9e8f2016c
patch 8.2.3268: cannot use a block with :autocmd like with :command
Bram Moolenaar <Bram@vim.org>
parents:
25402
diff
changeset
|
83 } |
05f9e8f2016c
patch 8.2.3268: cannot use a block with :autocmd like with :command
Bram Moolenaar <Bram@vim.org>
parents:
25402
diff
changeset
|
84 |
9653
01c9630e80e0
commit https://github.com/vim/vim/commit/e99e84497b89e5f91df519790802770920ecf4fe
Christian Brabandt <cb@256bit.org>
parents:
9599
diff
changeset
|
85 Note: The ":autocmd" command can only be followed by another command when the |
26219 | 86 '|' appears where the pattern is expected. This works: > |
9653
01c9630e80e0
commit https://github.com/vim/vim/commit/e99e84497b89e5f91df519790802770920ecf4fe
Christian Brabandt <cb@256bit.org>
parents:
9599
diff
changeset
|
87 :augroup mine | au! BufRead | augroup END |
01c9630e80e0
commit https://github.com/vim/vim/commit/e99e84497b89e5f91df519790802770920ecf4fe
Christian Brabandt <cb@256bit.org>
parents:
9599
diff
changeset
|
88 But this sees "augroup" as part of the defined command: > |
12785 | 89 :augroup mine | au! BufRead * | augroup END |
9653
01c9630e80e0
commit https://github.com/vim/vim/commit/e99e84497b89e5f91df519790802770920ecf4fe
Christian Brabandt <cb@256bit.org>
parents:
9599
diff
changeset
|
90 :augroup mine | au BufRead * set tw=70 | augroup END |
12785 | 91 Instead you can put the group name into the command: > |
92 :au! mine BufRead * | |
93 :au mine BufRead * set tw=70 | |
94 Or use `:execute`: > | |
95 :augroup mine | exe "au! BufRead *" | augroup END | |
96 :augroup mine | exe "au BufRead * set tw=70" | augroup END | |
9653
01c9630e80e0
commit https://github.com/vim/vim/commit/e99e84497b89e5f91df519790802770920ecf4fe
Christian Brabandt <cb@256bit.org>
parents:
9599
diff
changeset
|
97 |
28517 | 98 < *autocmd-expand* |
7 | 99 Note that special characters (e.g., "%", "<cword>") in the ":autocmd" |
100 arguments are not expanded when the autocommand is defined. These will be | |
101 expanded when the Event is recognized, and the {cmd} is executed. The only | |
102 exception is that "<sfile>" is expanded when the autocmd is defined. Example: | |
103 > | |
104 :au BufNewFile,BufRead *.html so <sfile>:h/html.vim | |
105 | |
106 Here Vim expands <sfile> to the name of the file containing this line. | |
107 | |
10244
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10218
diff
changeset
|
108 `:autocmd` adds to the list of autocommands regardless of whether they are |
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10218
diff
changeset
|
109 already present. When your .vimrc file is sourced twice, the autocommands |
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10218
diff
changeset
|
110 will appear twice. To avoid this, define your autocommands in a group, so |
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10218
diff
changeset
|
111 that you can easily clear them: > |
7 | 112 |
10244
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10218
diff
changeset
|
113 augroup vimrc |
13482
9eebe457eb3c
Update runtime files. Convert a couple of help files to utf-8.
Christian Brabandt <cb@256bit.org>
parents:
13444
diff
changeset
|
114 " Remove all vimrc autocommands |
9eebe457eb3c
Update runtime files. Convert a couple of help files to utf-8.
Christian Brabandt <cb@256bit.org>
parents:
13444
diff
changeset
|
115 autocmd! |
10244
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10218
diff
changeset
|
116 au BufNewFile,BufRead *.html so <sfile>:h/html.vim |
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10218
diff
changeset
|
117 augroup END |
7 | 118 |
119 If you don't want to remove all autocommands, you can instead use a variable | |
120 to ensure that Vim includes the autocommands only once: > | |
121 | |
122 :if !exists("autocommands_loaded") | |
123 : let autocommands_loaded = 1 | |
124 : au ... | |
125 :endif | |
126 | |
127 When the [group] argument is not given, Vim uses the current group (as defined | |
128 with ":augroup"); otherwise, Vim uses the group defined with [group]. Note | |
129 that [group] must have been defined before. You cannot define a new group | |
130 with ":au group ..."; use ":augroup" for that. | |
131 | |
132 While testing autocommands, you might find the 'verbose' option to be useful: > | |
133 :set verbose=9 | |
134 This setting makes Vim echo the autocommands as it executes them. | |
135 | |
136 When defining an autocommand in a script, it will be able to call functions | |
137 local to the script and use mappings local to the script. When the event is | |
138 triggered and the command executed, it will run in the context of the script | |
139 it was defined in. This matters if |<SID>| is used in a command. | |
140 | |
1621 | 141 When executing the commands, the message from one command overwrites a |
7 | 142 previous message. This is different from when executing the commands |
143 manually. Mostly the screen will not scroll up, thus there is no hit-enter | |
144 prompt. When one command outputs two messages this can happen anyway. | |
145 | |
146 ============================================================================== | |
147 3. Removing autocommands *autocmd-remove* | |
148 | |
27162 | 149 :au[tocmd]! [group] {event} {aupat} [++once] [++nested] {cmd} |
7 | 150 Remove all autocommands associated with {event} and |
27162 | 151 {aupat}, and add the command {cmd}. |
16217
81e6940504e8
patch 8.1.1113: making an autocommand trigger once is not so easy
Bram Moolenaar <Bram@vim.org>
parents:
16023
diff
changeset
|
152 See |autocmd-once| for [++once]. |
81e6940504e8
patch 8.1.1113: making an autocommand trigger once is not so easy
Bram Moolenaar <Bram@vim.org>
parents:
16023
diff
changeset
|
153 See |autocmd-nested| for [++nested]. |
7 | 154 |
27162 | 155 :au[tocmd]! [group] {event} {aupat} |
7 | 156 Remove all autocommands associated with {event} and |
27162 | 157 {aupat}. |
7 | 158 |
27162 | 159 :au[tocmd]! [group] * {aupat} |
160 Remove all autocommands associated with {aupat} for | |
161 all events. | |
7 | 162 |
163 :au[tocmd]! [group] {event} | |
164 Remove ALL autocommands for {event}. | |
10244
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10218
diff
changeset
|
165 Warning: You should not do this without a group for |
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10218
diff
changeset
|
166 |BufRead| and other common events, it can break |
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10218
diff
changeset
|
167 plugins, syntax highlighting, etc. |
7 | 168 |
169 :au[tocmd]! [group] Remove ALL autocommands. | |
13482
9eebe457eb3c
Update runtime files. Convert a couple of help files to utf-8.
Christian Brabandt <cb@256bit.org>
parents:
13444
diff
changeset
|
170 Note: a quote will be seen as argument to the :autocmd |
9eebe457eb3c
Update runtime files. Convert a couple of help files to utf-8.
Christian Brabandt <cb@256bit.org>
parents:
13444
diff
changeset
|
171 and won't start a comment. |
10244
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10218
diff
changeset
|
172 Warning: You should normally not do this without a |
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10218
diff
changeset
|
173 group, it breaks plugins, syntax highlighting, etc. |
7 | 174 |
175 When the [group] argument is not given, Vim uses the current group (as defined | |
176 with ":augroup"); otherwise, Vim uses the group defined with [group]. | |
177 | |
178 ============================================================================== | |
179 4. Listing autocommands *autocmd-list* | |
180 | |
27162 | 181 :au[tocmd] [group] {event} {aupat} |
7 | 182 Show the autocommands associated with {event} and |
27162 | 183 {aupat}. |
7 | 184 |
27162 | 185 :au[tocmd] [group] * {aupat} |
186 Show the autocommands associated with {aupat} for all | |
7 | 187 events. |
188 | |
189 :au[tocmd] [group] {event} | |
190 Show all autocommands for {event}. | |
191 | |
192 :au[tocmd] [group] Show all autocommands. | |
193 | |
194 If you provide the [group] argument, Vim lists only the autocommands for | |
195 [group]; otherwise, Vim lists the autocommands for ALL groups. Note that this | |
196 argument behavior differs from that for defining and removing autocommands. | |
197 | |
40 | 198 In order to list buffer-local autocommands, use a pattern in the form <buffer> |
199 or <buffer=N>. See |autocmd-buflocal|. | |
200 | |
500 | 201 *:autocmd-verbose* |
202 When 'verbose' is non-zero, listing an autocommand will also display where it | |
203 was last defined. Example: > | |
204 | |
205 :verbose autocmd BufEnter | |
206 FileExplorer BufEnter | |
856 | 207 * call s:LocalBrowse(expand("<amatch>")) |
500 | 208 Last set from /usr/share/vim/vim-7.0/plugin/NetrwPlugin.vim |
209 < | |
210 See |:verbose-cmd| for more information. | |
211 | |
7 | 212 ============================================================================== |
213 5. Events *autocmd-events* *E215* *E216* | |
214 | |
579 | 215 You can specify a comma-separated list of event names. No white space can be |
216 used in this list. The command applies to all the events in the list. | |
217 | |
218 For READING FILES there are four kinds of events possible: | |
219 BufNewFile starting to edit a non-existent file | |
220 BufReadPre BufReadPost starting to edit an existing file | |
221 FilterReadPre FilterReadPost read the temp file with filter output | |
222 FileReadPre FileReadPost any other file read | |
223 Vim uses only one of these four kinds when reading a file. The "Pre" and | |
224 "Post" events are both triggered, before and after reading the file. | |
225 | |
226 Note that the autocommands for the *ReadPre events and all the Filter events | |
227 are not allowed to change the current buffer (you will get an error message if | |
228 this happens). This is to prevent the file to be read into the wrong buffer. | |
229 | |
230 Note that the 'modified' flag is reset AFTER executing the BufReadPost | |
231 and BufNewFile autocommands. But when the 'modified' option was set by the | |
232 autocommands, this doesn't happen. | |
233 | |
234 You can use the 'eventignore' option to ignore a number of events or all | |
235 events. | |
7 | 236 *autocommand-events* *{event}* |
237 Vim recognizes the following events. Vim ignores the case of event names | |
238 (e.g., you can use "BUFread" or "bufread" instead of "BufRead"). | |
239 | |
579 | 240 First an overview by function with a short explanation. Then the list |
843 | 241 alphabetically with full explanations |autocmd-events-abc|. |
579 | 242 |
243 Name triggered by ~ | |
244 | |
245 Reading | |
246 |BufNewFile| starting to edit a file that doesn't exist | |
247 |BufReadPre| starting to edit a new buffer, before reading the file | |
248 |BufRead| starting to edit a new buffer, after reading the file | |
249 |BufReadPost| starting to edit a new buffer, after reading the file | |
250 |BufReadCmd| before starting to edit a new buffer |Cmd-event| | |
251 | |
252 |FileReadPre| before reading a file with a ":read" command | |
253 |FileReadPost| after reading a file with a ":read" command | |
843 | 254 |FileReadCmd| before reading a file with a ":read" command |Cmd-event| |
579 | 255 |
256 |FilterReadPre| before reading a file from a filter command | |
257 |FilterReadPost| after reading a file from a filter command | |
258 | |
259 |StdinReadPre| before reading from stdin into the buffer | |
260 |StdinReadPost| After reading from the stdin into the buffer | |
261 | |
262 Writing | |
263 |BufWrite| starting to write the whole buffer to a file | |
264 |BufWritePre| starting to write the whole buffer to a file | |
265 |BufWritePost| after writing the whole buffer to a file | |
266 |BufWriteCmd| before writing the whole buffer to a file |Cmd-event| | |
267 | |
268 |FileWritePre| starting to write part of a buffer to a file | |
269 |FileWritePost| after writing part of a buffer to a file | |
270 |FileWriteCmd| before writing part of a buffer to a file |Cmd-event| | |
271 | |
272 |FileAppendPre| starting to append to a file | |
273 |FileAppendPost| after appending to a file | |
274 |FileAppendCmd| before appending to a file |Cmd-event| | |
275 | |
276 |FilterWritePre| starting to write a file for a filter command or diff | |
277 |FilterWritePost| after writing a file for a filter command or diff | |
278 | |
279 Buffers | |
280 |BufAdd| just after adding a buffer to the buffer list | |
281 |BufCreate| just after adding a buffer to the buffer list | |
282 |BufDelete| before deleting a buffer from the buffer list | |
283 |BufWipeout| before completely deleting a buffer | |
284 | |
285 |BufFilePre| before changing the name of the current buffer | |
286 |BufFilePost| after changing the name of the current buffer | |
287 | |
288 |BufEnter| after entering a buffer | |
289 |BufLeave| before leaving to another buffer | |
290 |BufWinEnter| after a buffer is displayed in a window | |
291 |BufWinLeave| before a buffer is removed from a window | |
292 | |
293 |BufUnload| before unloading a buffer | |
22723 | 294 |BufHidden| just before a buffer becomes hidden |
579 | 295 |BufNew| just after creating a new buffer |
296 | |
297 |SwapExists| detected an existing swap file | |
298 | |
299 Options | |
300 |FileType| when the 'filetype' option has been set | |
301 |Syntax| when the 'syntax' option has been set | |
302 |EncodingChanged| after the 'encoding' option has been changed | |
303 |TermChanged| after the value of 'term' has changed | |
6935 | 304 |OptionSet| after setting any option |
579 | 305 |
306 Startup and exit | |
307 |VimEnter| after doing all the startup stuff | |
308 |GUIEnter| after starting the GUI successfully | |
3830 | 309 |GUIFailed| after starting the GUI failed |
1154 | 310 |TermResponse| after the terminal response to |t_RV| is received |
579 | 311 |
13442
94e638936d3e
patch 8.0.1595: no autocommand triggered before exiting
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
312 |QuitPre| when using `:quit`, before deciding whether to exit |
94e638936d3e
patch 8.0.1595: no autocommand triggered before exiting
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
313 |ExitPre| when using a command that may make Vim exit |
579 | 314 |VimLeavePre| before exiting Vim, before writing the viminfo file |
315 |VimLeave| before exiting Vim, after writing the viminfo file | |
316 | |
23165
a916fca16d4b
patch 8.2.2128: there is no way to do something on CTRL-Z
Bram Moolenaar <Bram@vim.org>
parents:
23164
diff
changeset
|
317 |VimSuspend| when suspending Vim |
a916fca16d4b
patch 8.2.2128: there is no way to do something on CTRL-Z
Bram Moolenaar <Bram@vim.org>
parents:
23164
diff
changeset
|
318 |VimResume| when Vim is resumed after being suspended |
a916fca16d4b
patch 8.2.2128: there is no way to do something on CTRL-Z
Bram Moolenaar <Bram@vim.org>
parents:
23164
diff
changeset
|
319 |
18450
507348b211b4
patch 8.1.2219: no autocommand for open window with terminal
Bram Moolenaar <Bram@vim.org>
parents:
18130
diff
changeset
|
320 Terminal |
507348b211b4
patch 8.1.2219: no autocommand for open window with terminal
Bram Moolenaar <Bram@vim.org>
parents:
18130
diff
changeset
|
321 |TerminalOpen| after a terminal buffer was created |
507348b211b4
patch 8.1.2219: no autocommand for open window with terminal
Bram Moolenaar <Bram@vim.org>
parents:
18130
diff
changeset
|
322 |TerminalWinOpen| after a terminal buffer was created in a new window |
507348b211b4
patch 8.1.2219: no autocommand for open window with terminal
Bram Moolenaar <Bram@vim.org>
parents:
18130
diff
changeset
|
323 |
579 | 324 Various |
325 |FileChangedShell| Vim notices that a file changed since editing started | |
766 | 326 |FileChangedShellPost| After handling a file changed since editing started |
579 | 327 |FileChangedRO| before making the first change to a read-only file |
328 | |
14945 | 329 |DiffUpdated| after diffs have been updated |
27617
269f89efb06a
patch 8.2.4335: no autocommand event triggered before changing directory
Bram Moolenaar <Bram@vim.org>
parents:
27321
diff
changeset
|
330 |DirChangedPre| before the working directory will change |
13170
6559e98f3e74
patch 8.0.1459: cannot handle change of directory
Christian Brabandt <cb@256bit.org>
parents:
13142
diff
changeset
|
331 |DirChanged| after the working directory has changed |
6559e98f3e74
patch 8.0.1459: cannot handle change of directory
Christian Brabandt <cb@256bit.org>
parents:
13142
diff
changeset
|
332 |
724 | 333 |ShellCmdPost| after executing a shell command |
334 |ShellFilterPost| after filtering with a shell command | |
335 | |
6154 | 336 |CmdUndefined| a user command is used but it isn't defined |
579 | 337 |FuncUndefined| a user function is used but it isn't defined |
650 | 338 |SpellFileMissing| a spell file is used but it can't be found |
716 | 339 |SourcePre| before sourcing a Vim script |
15640 | 340 |SourcePost| after sourcing a Vim script |
1061 | 341 |SourceCmd| before sourcing a Vim script |Cmd-event| |
579 | 342 |
766 | 343 |VimResized| after the Vim window size changed |
579 | 344 |FocusGained| Vim got input focus |
345 |FocusLost| Vim lost input focus | |
346 |CursorHold| the user doesn't press a key for a while | |
661 | 347 |CursorHoldI| the user doesn't press a key for a while in Insert mode |
348 |CursorMoved| the cursor was moved in Normal mode | |
349 |CursorMovedI| the cursor was moved in Insert mode | |
579 | 350 |
9595
0190d5de215f
commit https://github.com/vim/vim/commit/c917da4b3e8801a255dbefea8e4ed19c1c716dd8
Christian Brabandt <cb@256bit.org>
parents:
9286
diff
changeset
|
351 |WinNew| after creating a new window |
9599
42a8a81decdf
commit https://github.com/vim/vim/commit/12c11d553053f5a9eae9eb3c518279b12fa928c2
Christian Brabandt <cb@256bit.org>
parents:
9595
diff
changeset
|
352 |TabNew| after creating a new tab page |
26117
d4d9c7c55a5f
patch 8.2.3591: no event is triggered when closing a window
Bram Moolenaar <Bram@vim.org>
parents:
26042
diff
changeset
|
353 |WinClosed| after closing a window |
9599
42a8a81decdf
commit https://github.com/vim/vim/commit/12c11d553053f5a9eae9eb3c518279b12fa928c2
Christian Brabandt <cb@256bit.org>
parents:
9595
diff
changeset
|
354 |TabClosed| after closing a tab page |
579 | 355 |WinEnter| after entering another window |
356 |WinLeave| before leaving a window | |
677 | 357 |TabEnter| after entering another tab page |
358 |TabLeave| before leaving a tab page | |
579 | 359 |CmdwinEnter| after entering the command-line window |
360 |CmdwinLeave| before leaving the command-line window | |
361 | |
13437 | 362 |CmdlineChanged| after a change was made to the command-line text |
363 |CmdlineEnter| after the cursor moves to the command line | |
364 |CmdlineLeave| before the cursor leaves the command line | |
365 | |
579 | 366 |InsertEnter| starting Insert mode |
367 |InsertChange| when typing <Insert> while in Insert or Replace mode | |
368 |InsertLeave| when leaving Insert mode | |
28010 | 369 |InsertLeavePre| just before leaving Insert mode |
2845 | 370 |InsertCharPre| when a character was typed in Insert mode, before |
371 inserting it | |
579 | 372 |
25790
16a7d1154be8
patch 8.2.3430: no generic way to trigger an autocommand on mode change
Bram Moolenaar <Bram@vim.org>
parents:
25619
diff
changeset
|
373 |ModeChanged| after changing the mode |
16a7d1154be8
patch 8.2.3430: no generic way to trigger an autocommand on mode change
Bram Moolenaar <Bram@vim.org>
parents:
25619
diff
changeset
|
374 |
5555 | 375 |TextChanged| after a change was made to the text in Normal mode |
376 |TextChangedI| after a change was made to the text in Insert mode | |
13240
5ed6e4a25925
patch 8.0.1494: no autocmd triggered in Insert mode with visible popup menu
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
377 when popup menu is not visible |
5ed6e4a25925
patch 8.0.1494: no autocmd triggered in Insert mode with visible popup menu
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
378 |TextChangedP| after a change was made to the text in Insert mode |
5ed6e4a25925
patch 8.0.1494: no autocmd triggered in Insert mode with visible popup menu
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
379 when popup menu visible |
14347 | 380 |TextYankPost| after text has been yanked or deleted |
5555 | 381 |
18098
a2870e6f5b45
patch 8.1.2044: no easy way to process postponed work
Bram Moolenaar <Bram@vim.org>
parents:
18043
diff
changeset
|
382 |SafeState| nothing pending, going to wait for the user to type a |
a2870e6f5b45
patch 8.1.2044: no easy way to process postponed work
Bram Moolenaar <Bram@vim.org>
parents:
18043
diff
changeset
|
383 character |
18102
0d9ec3a2821f
patch 8.1.2046: SafeState may be triggered at the wrong moment
Bram Moolenaar <Bram@vim.org>
parents:
18098
diff
changeset
|
384 |SafeStateAgain| repeated SafeState |
18098
a2870e6f5b45
patch 8.1.2044: no easy way to process postponed work
Bram Moolenaar <Bram@vim.org>
parents:
18043
diff
changeset
|
385 |
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13735
diff
changeset
|
386 |ColorSchemePre| before loading a color scheme |
579 | 387 |ColorScheme| after loading a color scheme |
388 | |
389 |RemoteReply| a reply from a server Vim was received | |
390 | |
391 |QuickFixCmdPre| before a quickfix command is run | |
392 |QuickFixCmdPost| after a quickfix command is run | |
393 | |
394 |SessionLoadPost| after loading a session file | |
395 | |
396 |MenuPopup| just before showing the popup menu | |
16268
0f65f2808470
patch 8.1.1138: plugins don't get notified when the popup menu changes
Bram Moolenaar <Bram@vim.org>
parents:
16217
diff
changeset
|
397 |CompleteChanged| after Insert mode completion menu changed |
19199
8cbadf7fb9d4
patch 8.2.0158: triggering CompleteDone earlier is not backwards compatible
Bram Moolenaar <Bram@vim.org>
parents:
19127
diff
changeset
|
398 |CompleteDonePre| after Insert mode completion is done, before clearing |
8cbadf7fb9d4
patch 8.2.0158: triggering CompleteDone earlier is not backwards compatible
Bram Moolenaar <Bram@vim.org>
parents:
19127
diff
changeset
|
399 info |
8cbadf7fb9d4
patch 8.2.0158: triggering CompleteDone earlier is not backwards compatible
Bram Moolenaar <Bram@vim.org>
parents:
19127
diff
changeset
|
400 |CompleteDone| after Insert mode completion is done, after clearing |
8cbadf7fb9d4
patch 8.2.0158: triggering CompleteDone earlier is not backwards compatible
Bram Moolenaar <Bram@vim.org>
parents:
19127
diff
changeset
|
401 info |
579 | 402 |
403 |User| to be used in combination with ":doautocmd" | |
20800
e76b83c07bd8
patch 8.2.0952: no simple way to interrupt Vim
Bram Moolenaar <Bram@vim.org>
parents:
19303
diff
changeset
|
404 |SigUSR1| after the SIGUSR1 signal has been detected |
579 | 405 |
28375
e466fdbe0699
patch 8.2.4713: plugins cannot track text scrolling
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
406 |WinScrolled| after scrolling or resizing a window |
e466fdbe0699
patch 8.2.4713: plugins cannot track text scrolling
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
407 |
579 | 408 |
409 The alphabetical list of autocommand events: *autocmd-events-abc* | |
410 | |
411 *BufCreate* *BufAdd* | |
412 BufAdd or BufCreate Just after creating a new buffer which is | |
413 added to the buffer list, or adding a buffer | |
414 to the buffer list. | |
415 Also used just after a buffer in the buffer | |
416 list has been renamed. | |
18878
ef90e5bbb971
Minor runtime file updates.
Bram Moolenaar <Bram@vim.org>
parents:
18450
diff
changeset
|
417 Not triggered for the initial buffers created |
ef90e5bbb971
Minor runtime file updates.
Bram Moolenaar <Bram@vim.org>
parents:
18450
diff
changeset
|
418 during startup. |
579 | 419 The BufCreate event is for historic reasons. |
420 NOTE: When this autocommand is executed, the | |
421 current buffer "%" may be different from the | |
422 buffer being created "<afile>". | |
423 *BufDelete* | |
424 BufDelete Before deleting a buffer from the buffer list. | |
425 The BufUnload may be called first (if the | |
426 buffer was loaded). | |
427 Also used just before a buffer in the buffer | |
428 list is renamed. | |
429 NOTE: When this autocommand is executed, the | |
430 current buffer "%" may be different from the | |
1621 | 431 buffer being deleted "<afile>" and "<abuf>". |
1919 | 432 Don't change to another buffer, it will cause |
433 problems. | |
579 | 434 *BufEnter* |
435 BufEnter After entering a buffer. Useful for setting | |
436 options for a file type. Also executed when | |
437 starting to edit a buffer, after the | |
438 BufReadPost autocommands. | |
439 *BufFilePost* | |
440 BufFilePost After changing the name of the current buffer | |
441 with the ":file" or ":saveas" command. | |
625 | 442 *BufFilePre* |
579 | 443 BufFilePre Before changing the name of the current buffer |
444 with the ":file" or ":saveas" command. | |
445 *BufHidden* | |
17261 | 446 BufHidden Just before a buffer becomes hidden. That is, |
447 when there are no longer windows that show | |
579 | 448 the buffer, but the buffer is not unloaded or |
449 deleted. Not used for ":qa" or ":q" when | |
450 exiting Vim. | |
451 NOTE: When this autocommand is executed, the | |
452 current buffer "%" may be different from the | |
453 buffer being unloaded "<afile>". | |
454 *BufLeave* | |
455 BufLeave Before leaving to another buffer. Also when | |
456 leaving or closing the current window and the | |
457 new current window is not for the same buffer. | |
458 Not used for ":qa" or ":q" when exiting Vim. | |
459 *BufNew* | |
460 BufNew Just after creating a new buffer. Also used | |
461 just after a buffer has been renamed. When | |
462 the buffer is added to the buffer list BufAdd | |
463 will be triggered too. | |
464 NOTE: When this autocommand is executed, the | |
465 current buffer "%" may be different from the | |
466 buffer being created "<afile>". | |
7 | 467 *BufNewFile* |
468 BufNewFile When starting to edit a file that doesn't | |
469 exist. Can be used to read in a skeleton | |
470 file. | |
471 *BufRead* *BufReadPost* | |
472 BufRead or BufReadPost When starting to edit a new buffer, after | |
473 reading the file into the buffer, before | |
474 executing the modelines. See |BufWinEnter| | |
475 for when you need to do something after | |
476 processing the modelines. | |
28517 | 477 Also triggered: |
478 - when writing an unnamed buffer in a way that | |
479 the buffer gets a name | |
480 - after successfully recovering a file | |
481 - for the filetypedetect group when executing | |
482 ":filetype detect" | |
483 Not triggered: | |
484 - for the `:read file` command | |
485 - when the file doesn't exist | |
625 | 486 *BufReadCmd* |
7 | 487 BufReadCmd Before starting to edit a new buffer. Should |
488 read the file into the buffer. |Cmd-event| | |
625 | 489 *BufReadPre* *E200* *E201* |
579 | 490 BufReadPre When starting to edit a new buffer, before |
491 reading the file into the buffer. Not used | |
492 if the file doesn't exist. | |
493 *BufUnload* | |
494 BufUnload Before unloading a buffer. This is when the | |
495 text in the buffer is going to be freed. This | |
496 may be after a BufWritePost and before a | |
497 BufDelete. Also used for all buffers that are | |
498 loaded when Vim is going to exit. | |
499 NOTE: When this autocommand is executed, the | |
500 current buffer "%" may be different from the | |
501 buffer being unloaded "<afile>". | |
10140
b11ceef7116e
commit https://github.com/vim/vim/commit/64d8e25bf6efe5f18b032563521c3ce278c316ab
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
502 Don't change to another buffer or window, it |
b11ceef7116e
commit https://github.com/vim/vim/commit/64d8e25bf6efe5f18b032563521c3ce278c316ab
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
503 will cause problems! |
2226
36a9ac99e1ca
Don't execute some autocommands when v:dying is 2 or more.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
504 When exiting and v:dying is 2 or more this |
36a9ac99e1ca
Don't execute some autocommands when v:dying is 2 or more.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
505 event is not triggered. |
579 | 506 *BufWinEnter* |
507 BufWinEnter After a buffer is displayed in a window. This | |
508 can be when the buffer is loaded (after | |
1621 | 509 processing the modelines) or when a hidden |
579 | 510 buffer is displayed in a window (and is no |
1621 | 511 longer hidden). |
512 Does not happen for |:split| without | |
513 arguments, since you keep editing the same | |
514 buffer, or ":split" with a file that's already | |
1668 | 515 open in a window, because it re-uses an |
516 existing buffer. But it does happen for a | |
517 ":split" with the name of the current buffer, | |
518 since it reloads that buffer. | |
13835
8e583c52eb44
patch 8.0.1789: BufWinEnter does not work well for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13818
diff
changeset
|
519 Does not happen for a terminal window, because |
8e583c52eb44
patch 8.0.1789: BufWinEnter does not work well for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13818
diff
changeset
|
520 it starts in Terminal-Job mode and Normal mode |
8e583c52eb44
patch 8.0.1789: BufWinEnter does not work well for a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13818
diff
changeset
|
521 commands won't work. Use |TerminalOpen| instead. |
579 | 522 *BufWinLeave* |
523 BufWinLeave Before a buffer is removed from a window. | |
524 Not when it's still visible in another window. | |
525 Also triggered when exiting. It's triggered | |
526 before BufUnload or BufHidden. | |
527 NOTE: When this autocommand is executed, the | |
528 current buffer "%" may be different from the | |
529 buffer being unloaded "<afile>". | |
2226
36a9ac99e1ca
Don't execute some autocommands when v:dying is 2 or more.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
530 When exiting and v:dying is 2 or more this |
36a9ac99e1ca
Don't execute some autocommands when v:dying is 2 or more.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
531 event is not triggered. |
579 | 532 *BufWipeout* |
533 BufWipeout Before completely deleting a buffer. The | |
534 BufUnload and BufDelete events may be called | |
535 first (if the buffer was loaded and was in the | |
536 buffer list). Also used just before a buffer | |
537 is renamed (also when it's not in the buffer | |
538 list). | |
539 NOTE: When this autocommand is executed, the | |
540 current buffer "%" may be different from the | |
541 buffer being deleted "<afile>". | |
1919 | 542 Don't change to another buffer, it will cause |
543 problems. | |
7 | 544 *BufWrite* *BufWritePre* |
545 BufWrite or BufWritePre Before writing the whole buffer to a file. | |
546 *BufWriteCmd* | |
547 BufWriteCmd Before writing the whole buffer to a file. | |
548 Should do the writing of the file and reset | |
39 | 549 'modified' if successful, unless '+' is in |
550 'cpo' and writing to another file |cpo-+|. | |
551 The buffer contents should not be changed. | |
3082 | 552 When the command resets 'modified' the undo |
553 information is adjusted to mark older undo | |
554 states as 'modified', like |:write| does. | |
39 | 555 |Cmd-event| |
579 | 556 *BufWritePost* |
557 BufWritePost After writing the whole buffer to a file | |
558 (should undo the commands for BufWritePre). | |
6154 | 559 *CmdUndefined* |
560 CmdUndefined When a user command is used but it isn't | |
561 defined. Useful for defining a command only | |
562 when it's used. The pattern is matched | |
563 against the command name. Both <amatch> and | |
564 <afile> are set to the name of the command. | |
565 NOTE: Autocompletion won't work until the | |
566 command is defined. An alternative is to | |
567 always define the user command and have it | |
568 invoke an autoloaded function. See |autoload|. | |
13142
59a16624400a
patch 8.0.1445: cannot act on edits in the command line
Christian Brabandt <cb@256bit.org>
parents:
13051
diff
changeset
|
569 *CmdlineChanged* |
13437 | 570 CmdlineChanged After a change was made to the text in the |
571 command line. Be careful not to mess up | |
572 the command line, it may cause Vim to lock up. | |
13142
59a16624400a
patch 8.0.1445: cannot act on edits in the command line
Christian Brabandt <cb@256bit.org>
parents:
13051
diff
changeset
|
573 <afile> is set to a single character, |
59a16624400a
patch 8.0.1445: cannot act on edits in the command line
Christian Brabandt <cb@256bit.org>
parents:
13051
diff
changeset
|
574 indicating the type of command-line. |
59a16624400a
patch 8.0.1445: cannot act on edits in the command line
Christian Brabandt <cb@256bit.org>
parents:
13051
diff
changeset
|
575 |cmdwin-char| |
12656
0a9dacb8826a
patch 8.0.1206: no autocmd for entering or leaving the command line
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
576 *CmdlineEnter* |
0a9dacb8826a
patch 8.0.1206: no autocmd for entering or leaving the command line
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
577 CmdlineEnter After moving the cursor to the command line, |
0a9dacb8826a
patch 8.0.1206: no autocmd for entering or leaving the command line
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
578 where the user can type a command or search |
22862
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22723
diff
changeset
|
579 string; including non-interactive use of ":" |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22723
diff
changeset
|
580 in a mapping, but not when using |<Cmd>|. |
12656
0a9dacb8826a
patch 8.0.1206: no autocmd for entering or leaving the command line
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
581 <afile> is set to a single character, |
0a9dacb8826a
patch 8.0.1206: no autocmd for entering or leaving the command line
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
582 indicating the type of command-line. |
0a9dacb8826a
patch 8.0.1206: no autocmd for entering or leaving the command line
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
583 |cmdwin-char| |
0a9dacb8826a
patch 8.0.1206: no autocmd for entering or leaving the command line
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
584 *CmdlineLeave* |
22862
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22723
diff
changeset
|
585 CmdlineLeave Before leaving the command line; including |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22723
diff
changeset
|
586 non-interactive use of ":" in a mapping, but |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22723
diff
changeset
|
587 not when using |<Cmd>|. |
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12656
diff
changeset
|
588 Also when abandoning the command line, after |
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12656
diff
changeset
|
589 typing CTRL-C or <Esc>. |
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12656
diff
changeset
|
590 When the commands result in an error the |
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
12656
diff
changeset
|
591 command line is still executed. |
12656
0a9dacb8826a
patch 8.0.1206: no autocmd for entering or leaving the command line
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
592 <afile> is set to a single character, |
0a9dacb8826a
patch 8.0.1206: no autocmd for entering or leaving the command line
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
593 indicating the type of command-line. |
0a9dacb8826a
patch 8.0.1206: no autocmd for entering or leaving the command line
Christian Brabandt <cb@256bit.org>
parents:
11659
diff
changeset
|
594 |cmdwin-char| |
579 | 595 *CmdwinEnter* |
596 CmdwinEnter After entering the command-line window. | |
597 Useful for setting options specifically for | |
18043
5a0d5f8e1778
patch 8.1.2017: cannot execute commands after closing the cmdline window
Bram Moolenaar <Bram@vim.org>
parents:
17756
diff
changeset
|
598 this special type of window. |
579 | 599 <afile> is set to a single character, |
600 indicating the type of command-line. | |
601 |cmdwin-char| | |
602 *CmdwinLeave* | |
603 CmdwinLeave Before leaving the command-line window. | |
604 Useful to clean up any global setting done | |
18043
5a0d5f8e1778
patch 8.1.2017: cannot execute commands after closing the cmdline window
Bram Moolenaar <Bram@vim.org>
parents:
17756
diff
changeset
|
605 with CmdwinEnter. |
579 | 606 <afile> is set to a single character, |
607 indicating the type of command-line. | |
608 |cmdwin-char| | |
609 *ColorScheme* | |
610 ColorScheme After loading a color scheme. |:colorscheme| | |
5521 | 611 The pattern is matched against the |
612 colorscheme name. <afile> can be used for the | |
613 name of the actual file where this option was | |
614 set, and <amatch> for the new colorscheme | |
615 name. | |
616 | |
13818
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13735
diff
changeset
|
617 *ColorSchemePre* |
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13735
diff
changeset
|
618 ColorSchemePre Before loading a color scheme. |:colorscheme| |
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13735
diff
changeset
|
619 Useful to setup removing things added by a |
28ac7914b2b6
Update runtime files and translations
Christian Brabandt <cb@256bit.org>
parents:
13735
diff
changeset
|
620 color scheme, before another one is loaded. |
18130 | 621 CompleteChanged *CompleteChanged* |
16268
0f65f2808470
patch 8.1.1138: plugins don't get notified when the popup menu changes
Bram Moolenaar <Bram@vim.org>
parents:
16217
diff
changeset
|
622 After each time the Insert mode completion |
0f65f2808470
patch 8.1.1138: plugins don't get notified when the popup menu changes
Bram Moolenaar <Bram@vim.org>
parents:
16217
diff
changeset
|
623 menu changed. Not fired on popup menu hide, |
19199
8cbadf7fb9d4
patch 8.2.0158: triggering CompleteDone earlier is not backwards compatible
Bram Moolenaar <Bram@vim.org>
parents:
19127
diff
changeset
|
624 use |CompleteDonePre| or |CompleteDone| for |
8cbadf7fb9d4
patch 8.2.0158: triggering CompleteDone earlier is not backwards compatible
Bram Moolenaar <Bram@vim.org>
parents:
19127
diff
changeset
|
625 that. Never triggered recursively. |
661 | 626 |
16268
0f65f2808470
patch 8.1.1138: plugins don't get notified when the popup menu changes
Bram Moolenaar <Bram@vim.org>
parents:
16217
diff
changeset
|
627 Sets these |v:event| keys: |
16380 | 628 completed_item See |complete-items|. |
16268
0f65f2808470
patch 8.1.1138: plugins don't get notified when the popup menu changes
Bram Moolenaar <Bram@vim.org>
parents:
16217
diff
changeset
|
629 height nr of items visible |
0f65f2808470
patch 8.1.1138: plugins don't get notified when the popup menu changes
Bram Moolenaar <Bram@vim.org>
parents:
16217
diff
changeset
|
630 width screen cells |
0f65f2808470
patch 8.1.1138: plugins don't get notified when the popup menu changes
Bram Moolenaar <Bram@vim.org>
parents:
16217
diff
changeset
|
631 row top screen row |
0f65f2808470
patch 8.1.1138: plugins don't get notified when the popup menu changes
Bram Moolenaar <Bram@vim.org>
parents:
16217
diff
changeset
|
632 col leftmost screen column |
0f65f2808470
patch 8.1.1138: plugins don't get notified when the popup menu changes
Bram Moolenaar <Bram@vim.org>
parents:
16217
diff
changeset
|
633 size total nr of items |
0f65f2808470
patch 8.1.1138: plugins don't get notified when the popup menu changes
Bram Moolenaar <Bram@vim.org>
parents:
16217
diff
changeset
|
634 scrollbar TRUE if visible |
0f65f2808470
patch 8.1.1138: plugins don't get notified when the popup menu changes
Bram Moolenaar <Bram@vim.org>
parents:
16217
diff
changeset
|
635 |
0f65f2808470
patch 8.1.1138: plugins don't get notified when the popup menu changes
Bram Moolenaar <Bram@vim.org>
parents:
16217
diff
changeset
|
636 It is not allowed to change the text |textlock|. |
17756
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17261
diff
changeset
|
637 |
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17261
diff
changeset
|
638 The size and position of the popup are also |
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17261
diff
changeset
|
639 available by calling |pum_getpos()|. |
a7afcea6f40a
patch 8.1.1875: cannot get size and position of the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17261
diff
changeset
|
640 |
19199
8cbadf7fb9d4
patch 8.2.0158: triggering CompleteDone earlier is not backwards compatible
Bram Moolenaar <Bram@vim.org>
parents:
19127
diff
changeset
|
641 *CompleteDonePre* |
8cbadf7fb9d4
patch 8.2.0158: triggering CompleteDone earlier is not backwards compatible
Bram Moolenaar <Bram@vim.org>
parents:
19127
diff
changeset
|
642 CompleteDonePre After Insert mode completion is done. Either |
8cbadf7fb9d4
patch 8.2.0158: triggering CompleteDone earlier is not backwards compatible
Bram Moolenaar <Bram@vim.org>
parents:
19127
diff
changeset
|
643 when something was completed or abandoning |
8cbadf7fb9d4
patch 8.2.0158: triggering CompleteDone earlier is not backwards compatible
Bram Moolenaar <Bram@vim.org>
parents:
19127
diff
changeset
|
644 completion. |ins-completion| |
8cbadf7fb9d4
patch 8.2.0158: triggering CompleteDone earlier is not backwards compatible
Bram Moolenaar <Bram@vim.org>
parents:
19127
diff
changeset
|
645 |complete_info()| can be used, the info is |
8cbadf7fb9d4
patch 8.2.0158: triggering CompleteDone earlier is not backwards compatible
Bram Moolenaar <Bram@vim.org>
parents:
19127
diff
changeset
|
646 cleared after triggering CompleteDonePre. |
8cbadf7fb9d4
patch 8.2.0158: triggering CompleteDone earlier is not backwards compatible
Bram Moolenaar <Bram@vim.org>
parents:
19127
diff
changeset
|
647 The |v:completed_item| variable contains |
8cbadf7fb9d4
patch 8.2.0158: triggering CompleteDone earlier is not backwards compatible
Bram Moolenaar <Bram@vim.org>
parents:
19127
diff
changeset
|
648 information about the completed item. |
8cbadf7fb9d4
patch 8.2.0158: triggering CompleteDone earlier is not backwards compatible
Bram Moolenaar <Bram@vim.org>
parents:
19127
diff
changeset
|
649 |
3682 | 650 *CompleteDone* |
651 CompleteDone After Insert mode completion is done. Either | |
652 when something was completed or abandoning | |
653 completion. |ins-completion| | |
19199
8cbadf7fb9d4
patch 8.2.0158: triggering CompleteDone earlier is not backwards compatible
Bram Moolenaar <Bram@vim.org>
parents:
19127
diff
changeset
|
654 |complete_info()| cannot be used, the info is |
8cbadf7fb9d4
patch 8.2.0158: triggering CompleteDone earlier is not backwards compatible
Bram Moolenaar <Bram@vim.org>
parents:
19127
diff
changeset
|
655 cleared before triggering CompleteDone. Use |
8cbadf7fb9d4
patch 8.2.0158: triggering CompleteDone earlier is not backwards compatible
Bram Moolenaar <Bram@vim.org>
parents:
19127
diff
changeset
|
656 CompleteDonePre if you need it. |
6909 | 657 The |v:completed_item| variable contains |
658 information about the completed item. | |
3682 | 659 |
579 | 660 *CursorHold* |
661 CursorHold When the user doesn't press a key for the time | |
22441 | 662 specified with 'updatetime'. Not triggered |
579 | 663 until the user has pressed a key (i.e. doesn't |
664 fire every 'updatetime' ms if you leave Vim to | |
665 make some coffee. :) See |CursorHold-example| | |
666 for previewing tags. | |
667 This event is only triggered in Normal mode. | |
1154 | 668 It is not triggered when waiting for a command |
669 argument to be typed, or a movement after an | |
670 operator. | |
610 | 671 While recording the CursorHold event is not |
672 triggered. |q| | |
6259 | 673 *<CursorHold>* |
674 Internally the autocommand is triggered by the | |
675 <CursorHold> key. In an expression mapping | |
676 |getchar()| may see this character. | |
677 | |
579 | 678 Note: Interactive commands cannot be used for |
679 this event. There is no hit-enter prompt, | |
680 the screen is updated directly (when needed). | |
681 Note: In the future there will probably be | |
682 another option to set the time. | |
683 Hint: to force an update of the status lines | |
684 use: > | |
685 :let &ro = &ro | |
18972 | 686 < {only on Amiga, Unix, Win32 and all GUI |
579 | 687 versions} |
661 | 688 *CursorHoldI* |
689 CursorHoldI Just like CursorHold, but in Insert mode. | |
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
690 Not triggered when waiting for another key, |
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
691 e.g. after CTRL-V, and not when in CTRL-X mode |
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
692 |insert_expand|. |
661 | 693 |
694 *CursorMoved* | |
4911 | 695 CursorMoved After the cursor was moved in Normal or Visual |
696 mode. Also when the text of the cursor line | |
697 has been changed, e.g., with "x", "rx" or "p". | |
28246 | 698 Not always triggered when there is typeahead, |
699 while executing commands in a script file, | |
700 when an operator is pending or when moving to | |
25161 | 701 another window while remaining at the same |
702 cursor position. | |
667 | 703 For an example see |match-parens|. |
16023 | 704 Note: This can not be skipped with |
705 `:noautocmd`. | |
4264 | 706 Careful: This is triggered very often, don't |
707 do anything that the user does not expect or | |
708 that is slow. | |
661 | 709 *CursorMovedI* |
710 CursorMovedI After the cursor was moved in Insert mode. | |
3082 | 711 Not triggered when the popup menu is visible. |
661 | 712 Otherwise the same as CursorMoved. |
28517 | 713 *DiffUpdated* |
714 DiffUpdated After diffs have been updated. Depending on | |
715 what kind of diff is being used (internal or | |
716 external) this can be triggered on every | |
717 change or when doing |:diffupdate|. | |
718 *DirChangedPre* | |
719 DirChangedPre The working directory is going to be changed, | |
720 as with |DirChanged|. The pattern is like | |
721 with |DirChanged|. The new directory can be | |
722 found in v:event.directory. | |
723 *DirChanged* | |
724 DirChanged The working directory has changed in response | |
725 to the |:cd| or |:tcd| or |:lcd| commands, or | |
726 as a result of the 'autochdir' option. | |
727 The pattern can be: | |
728 "window" to trigger on `:lcd` | |
729 "tabpage" to trigger on `:tcd` | |
730 "global" to trigger on `:cd` | |
731 "auto" to trigger on 'autochdir'. | |
732 "drop" to trigger on editing a file | |
733 <afile> is set to the new directory name. | |
579 | 734 *EncodingChanged* |
735 EncodingChanged Fires off after the 'encoding' option has been | |
736 changed. Useful to set up fonts, for example. | |
28517 | 737 *ExitPre* |
738 ExitPre When using `:quit`, `:wq` in a way it makes | |
739 Vim exit, or using `:qall`, just after | |
740 |QuitPre|. Can be used to close any | |
741 non-essential window. Exiting may still be | |
742 cancelled if there is a modified buffer that | |
743 isn't automatically saved, use |VimLeavePre| | |
744 for really exiting. | |
7 | 745 *FileAppendCmd* |
746 FileAppendCmd Before appending to a file. Should do the | |
26 | 747 appending to the file. Use the '[ and '] |
25973 | 748 marks for the range of lines. |Cmd-event| |
579 | 749 *FileAppendPost* |
750 FileAppendPost After appending to a file. | |
751 *FileAppendPre* | |
752 FileAppendPre Before appending to a file. Use the '[ and '] | |
753 marks for the range of lines. | |
754 *FileChangedRO* | |
755 FileChangedRO Before making the first change to a read-only | |
756 file. Can be used to check-out the file from | |
757 a source control system. Not triggered when | |
758 the change was caused by an autocommand. | |
759 This event is triggered when making the first | |
760 change in a buffer or the first change after | |
823 | 761 'readonly' was set, just before the change is |
762 applied to the text. | |
579 | 763 WARNING: If the autocommand moves the cursor |
764 the effect of the change is undefined. | |
819 | 765 *E788* |
766 It is not allowed to change to another buffer | |
767 here. You can reload the buffer but not edit | |
768 another one. | |
5663
1dea14d4c738
Update runtime files. Add support for systemverilog.
Bram Moolenaar <bram@vim.org>
parents:
5555
diff
changeset
|
769 *E881* |
1dea14d4c738
Update runtime files. Add support for systemverilog.
Bram Moolenaar <bram@vim.org>
parents:
5555
diff
changeset
|
770 If the number of lines changes saving for undo |
1dea14d4c738
Update runtime files. Add support for systemverilog.
Bram Moolenaar <bram@vim.org>
parents:
5555
diff
changeset
|
771 may fail and the change will be aborted. |
7 | 772 *FileChangedShell* |
773 FileChangedShell When Vim notices that the modification time of | |
774 a file has changed since editing started. | |
775 Also when the file attributes of the file | |
5908 | 776 change or when the size of the file changes. |
777 |timestamp| | |
7 | 778 Mostly triggered after executing a shell |
779 command, but also with a |:checktime| command | |
11473 | 780 or when gvim regains input focus. |
7 | 781 This autocommand is triggered for each changed |
782 file. It is not used when 'autoread' is set | |
783 and the buffer was not changed. If a | |
784 FileChangedShell autocommand is present the | |
785 warning message and prompt is not given. | |
179 | 786 The |v:fcs_reason| variable is set to indicate |
787 what happened and |v:fcs_choice| can be used | |
788 to tell Vim what to do next. | |
7 | 789 NOTE: When this autocommand is executed, the |
790 current buffer "%" may be different from the | |
11347 | 791 buffer that was changed, which is in "<afile>". |
7 | 792 NOTE: The commands must not change the current |
793 buffer, jump to another buffer or delete a | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1919
diff
changeset
|
794 buffer. *E246* *E811* |
7 | 795 NOTE: This event never nests, to avoid an |
796 endless loop. This means that while executing | |
797 commands for the FileChangedShell event no | |
798 other FileChangedShell event will be | |
799 triggered. | |
766 | 800 *FileChangedShellPost* |
801 FileChangedShellPost After handling a file that was changed outside | |
802 of Vim. Can be used to update the statusline. | |
579 | 803 *FileEncoding* |
804 FileEncoding Obsolete. It still works and is equivalent | |
805 to |EncodingChanged|. | |
806 *FileReadCmd* | |
807 FileReadCmd Before reading a file with a ":read" command. | |
808 Should do the reading of the file. |Cmd-event| | |
809 *FileReadPost* | |
810 FileReadPost After reading a file with a ":read" command. | |
811 Note that Vim sets the '[ and '] marks to the | |
812 first and last line of the read. This can be | |
813 used to operate on the lines just read. | |
814 *FileReadPre* | |
815 FileReadPre Before reading a file with a ":read" command. | |
816 *FileType* | |
1154 | 817 FileType When the 'filetype' option has been set. The |
818 pattern is matched against the filetype. | |
579 | 819 <afile> can be used for the name of the file |
820 where this option was set, and <amatch> for | |
11659
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11473
diff
changeset
|
821 the new value of 'filetype'. Navigating to |
49c12c93abf3
Updated runtime files and translations.
Christian Brabandt <cb@256bit.org>
parents:
11473
diff
changeset
|
822 another window or buffer is not allowed. |
579 | 823 See |filetypes|. |
824 *FileWriteCmd* | |
825 FileWriteCmd Before writing to a file, when not writing the | |
826 whole buffer. Should do the writing to the | |
827 file. Should not change the buffer. Use the | |
828 '[ and '] marks for the range of lines. | |
829 |Cmd-event| | |
830 *FileWritePost* | |
831 FileWritePost After writing to a file, when not writing the | |
832 whole buffer. | |
833 *FileWritePre* | |
834 FileWritePre Before writing to a file, when not writing the | |
835 whole buffer. Use the '[ and '] marks for the | |
836 range of lines. | |
837 *FilterReadPost* | |
838 FilterReadPost After reading a file from a filter command. | |
839 Vim checks the pattern against the name of | |
840 the current buffer as with FilterReadPre. | |
841 Not triggered when 'shelltemp' is off. | |
842 *FilterReadPre* *E135* | |
843 FilterReadPre Before reading a file from a filter command. | |
844 Vim checks the pattern against the name of | |
845 the current buffer, not the name of the | |
846 temporary file that is the output of the | |
847 filter command. | |
848 Not triggered when 'shelltemp' is off. | |
849 *FilterWritePost* | |
850 FilterWritePost After writing a file for a filter command or | |
15334 | 851 making a diff with an external diff (see |
25973 | 852 |DiffUpdated| for internal diff). |
579 | 853 Vim checks the pattern against the name of |
854 the current buffer as with FilterWritePre. | |
855 Not triggered when 'shelltemp' is off. | |
856 *FilterWritePre* | |
857 FilterWritePre Before writing a file for a filter command or | |
15334 | 858 making a diff with an external diff. |
579 | 859 Vim checks the pattern against the name of |
860 the current buffer, not the name of the | |
861 temporary file that is the output of the | |
862 filter command. | |
863 Not triggered when 'shelltemp' is off. | |
7 | 864 *FocusGained* |
865 FocusGained When Vim got input focus. Only for the GUI | |
866 version and a few console versions where this | |
867 can be detected. | |
868 *FocusLost* | |
869 FocusLost When Vim lost input focus. Only for the GUI | |
870 version and a few console versions where this | |
11 | 871 can be detected. May also happen when a |
872 dialog pops up. | |
7 | 873 *FuncUndefined* |
874 FuncUndefined When a user function is used but it isn't | |
875 defined. Useful for defining a function only | |
1154 | 876 when it's used. The pattern is matched |
877 against the function name. Both <amatch> and | |
878 <afile> are set to the name of the function. | |
23305 | 879 Not triggered when compiling a |Vim9| |
880 function. | |
6154 | 881 NOTE: When writing Vim scripts a better |
882 alternative is to use an autoloaded function. | |
161 | 883 See |autoload-functions|. |
579 | 884 *GUIEnter* |
885 GUIEnter After starting the GUI successfully, and after | |
886 opening the window. It is triggered before | |
887 VimEnter when using gvim. Can be used to | |
888 position the window from a .gvimrc file: > | |
889 :autocmd GUIEnter * winpos 100 50 | |
1154 | 890 < *GUIFailed* |
891 GUIFailed After starting the GUI failed. Vim may | |
892 continue to run in the terminal, if possible | |
893 (only on Unix and alikes, when connecting the | |
894 X server fails). You may want to quit Vim: > | |
895 :autocmd GUIFailed * qall | |
579 | 896 < *InsertChange* |
897 InsertChange When typing <Insert> while in Insert or | |
898 Replace mode. The |v:insertmode| variable | |
899 indicates the new mode. | |
900 Be careful not to move the cursor or do | |
901 anything else that the user does not expect. | |
2845 | 902 *InsertCharPre* |
903 InsertCharPre When a character is typed in Insert mode, | |
904 before inserting the char. | |
905 The |v:char| variable indicates the char typed | |
906 and can be changed during the event to insert | |
907 a different character. When |v:char| is set | |
908 to more than one character this text is | |
909 inserted literally. | |
910 It is not allowed to change the text |textlock|. | |
911 The event is not triggered when 'paste' is | |
13437 | 912 set. {only with the +eval feature} |
579 | 913 *InsertEnter* |
1154 | 914 InsertEnter Just before starting Insert mode. Also for |
915 Replace mode and Virtual Replace mode. The | |
579 | 916 |v:insertmode| variable indicates the mode. |
4448 | 917 Be careful not to do anything else that the |
918 user does not expect. | |
919 The cursor is restored afterwards. If you do | |
920 not want that set |v:char| to a non-empty | |
921 string. | |
22651
fba5ccf33794
patch 8.2.1874: can't do something just before leaving Insert mode
Bram Moolenaar <Bram@vim.org>
parents:
22441
diff
changeset
|
922 *InsertLeavePre* |
fba5ccf33794
patch 8.2.1874: can't do something just before leaving Insert mode
Bram Moolenaar <Bram@vim.org>
parents:
22441
diff
changeset
|
923 InsertLeavePre Just before leaving Insert mode. Also when |
22723 | 924 using CTRL-O |i_CTRL-O|. Be careful not to |
22651
fba5ccf33794
patch 8.2.1874: can't do something just before leaving Insert mode
Bram Moolenaar <Bram@vim.org>
parents:
22441
diff
changeset
|
925 change mode or use `:normal`, it will likely |
fba5ccf33794
patch 8.2.1874: can't do something just before leaving Insert mode
Bram Moolenaar <Bram@vim.org>
parents:
22441
diff
changeset
|
926 cause trouble. |
579 | 927 *InsertLeave* |
22651
fba5ccf33794
patch 8.2.1874: can't do something just before leaving Insert mode
Bram Moolenaar <Bram@vim.org>
parents:
22441
diff
changeset
|
928 InsertLeave Just after leaving Insert mode. Also when |
fba5ccf33794
patch 8.2.1874: can't do something just before leaving Insert mode
Bram Moolenaar <Bram@vim.org>
parents:
22441
diff
changeset
|
929 using CTRL-O |i_CTRL-O|. But not for |i_CTRL-C|. |
579 | 930 *MenuPopup* |
931 MenuPopup Just before showing the popup menu (under the | |
932 right mouse button). Useful for adjusting the | |
933 menu for what is under the cursor or mouse | |
934 pointer. | |
14952
405309f9dd13
patch 8.1.0487: no menus specifically for the terminal window
Bram Moolenaar <Bram@vim.org>
parents:
14945
diff
changeset
|
935 The pattern is matched against one or two |
405309f9dd13
patch 8.1.0487: no menus specifically for the terminal window
Bram Moolenaar <Bram@vim.org>
parents:
14945
diff
changeset
|
936 characters representing the mode: |
579 | 937 n Normal |
938 v Visual | |
939 o Operator-pending | |
940 i Insert | |
843 | 941 c Command line |
14952
405309f9dd13
patch 8.1.0487: no menus specifically for the terminal window
Bram Moolenaar <Bram@vim.org>
parents:
14945
diff
changeset
|
942 tl Terminal |
25790
16a7d1154be8
patch 8.2.3430: no generic way to trigger an autocommand on mode change
Bram Moolenaar <Bram@vim.org>
parents:
25619
diff
changeset
|
943 *ModeChanged* |
16a7d1154be8
patch 8.2.3430: no generic way to trigger an autocommand on mode change
Bram Moolenaar <Bram@vim.org>
parents:
25619
diff
changeset
|
944 ModeChanged After changing the mode. The pattern is |
16a7d1154be8
patch 8.2.3430: no generic way to trigger an autocommand on mode change
Bram Moolenaar <Bram@vim.org>
parents:
25619
diff
changeset
|
945 matched against `'old_mode:new_mode'`, for |
26042
6b39ab99e367
patch 8.2.3555: ModeChanged is not triggered on every mode change
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
946 example match against `*:c*` to simulate |
6b39ab99e367
patch 8.2.3555: ModeChanged is not triggered on every mode change
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
947 |CmdlineEnter|. |
25790
16a7d1154be8
patch 8.2.3430: no generic way to trigger an autocommand on mode change
Bram Moolenaar <Bram@vim.org>
parents:
25619
diff
changeset
|
948 The following values of |v:event| are set: |
16a7d1154be8
patch 8.2.3430: no generic way to trigger an autocommand on mode change
Bram Moolenaar <Bram@vim.org>
parents:
25619
diff
changeset
|
949 old_mode The mode before it changed. |
16a7d1154be8
patch 8.2.3430: no generic way to trigger an autocommand on mode change
Bram Moolenaar <Bram@vim.org>
parents:
25619
diff
changeset
|
950 new_mode The new mode as also returned |
26042
6b39ab99e367
patch 8.2.3555: ModeChanged is not triggered on every mode change
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
951 by |mode()| called with a |
6b39ab99e367
patch 8.2.3555: ModeChanged is not triggered on every mode change
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
952 non-zero argument. |
25790
16a7d1154be8
patch 8.2.3430: no generic way to trigger an autocommand on mode change
Bram Moolenaar <Bram@vim.org>
parents:
25619
diff
changeset
|
953 When ModeChanged is triggered, old_mode will |
16a7d1154be8
patch 8.2.3430: no generic way to trigger an autocommand on mode change
Bram Moolenaar <Bram@vim.org>
parents:
25619
diff
changeset
|
954 have the value of new_mode when the event was |
16a7d1154be8
patch 8.2.3430: no generic way to trigger an autocommand on mode change
Bram Moolenaar <Bram@vim.org>
parents:
25619
diff
changeset
|
955 last triggered. |
26042
6b39ab99e367
patch 8.2.3555: ModeChanged is not triggered on every mode change
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
956 This will be triggered on every minor mode |
6b39ab99e367
patch 8.2.3555: ModeChanged is not triggered on every mode change
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
957 change. |
25790
16a7d1154be8
patch 8.2.3430: no generic way to trigger an autocommand on mode change
Bram Moolenaar <Bram@vim.org>
parents:
25619
diff
changeset
|
958 Usage example to use relative line numbers |
25880 | 959 when entering Visual mode: > |
26042
6b39ab99e367
patch 8.2.3555: ModeChanged is not triggered on every mode change
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
960 :au ModeChanged [vV\x16]*:* let &l:rnu = mode() =~# '^[vV\x16]' |
6b39ab99e367
patch 8.2.3555: ModeChanged is not triggered on every mode change
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
961 :au ModeChanged *:[vV\x16]* let &l:rnu = mode() =~# '^[vV\x16]' |
6b39ab99e367
patch 8.2.3555: ModeChanged is not triggered on every mode change
Bram Moolenaar <Bram@vim.org>
parents:
25973
diff
changeset
|
962 :au WinEnter,WinLeave * let &l:rnu = mode() =~# '^[vV\x16]' |
25790
16a7d1154be8
patch 8.2.3430: no generic way to trigger an autocommand on mode change
Bram Moolenaar <Bram@vim.org>
parents:
25619
diff
changeset
|
963 < *OptionSet* |
6935 | 964 OptionSet After setting an option. The pattern is |
965 matched against the long option name. | |
17085
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
966 |<amatch>| indicates what option has been set. |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
967 |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
968 |v:option_type| indicates whether it's global |
17161 | 969 or local scoped. |
17085
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
970 |v:option_command| indicates what type of |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
971 set/let command was used (follow the tag to |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
972 see the table). |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
973 |v:option_new| indicates the newly set value. |
17161 | 974 |v:option_oldlocal| has the old local value. |
975 |v:option_oldglobal| has the old global value. | |
17085
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
976 |v:option_old| indicates the old option value. |
6935 | 977 |
17085
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
978 |v:option_oldlocal| is only set when |:set| |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
979 or |:setlocal| or a |modeline| was used to set |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
980 the option. Similarly |v:option_oldglobal| is |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
981 only set when |:set| or |:setglobal| was used. |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
982 |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
983 Note that when setting a |global-local| string |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
984 option with |:set|, then |v:option_old| is the |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
985 old global value. However, for all other kinds |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
986 of options (local string options, global-local |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
987 number options, ...) it is the old local |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
988 value. |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
989 |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
990 OptionSet is not triggered on startup and for |
620e9011b685
patch 8.1.1542: an OptionSet autocommand does not get enough info
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
991 the 'key' option for obvious reasons. |
6935 | 992 |
6951
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6935
diff
changeset
|
993 Usage example: Check for the existence of the |
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6935
diff
changeset
|
994 directory in the 'backupdir' and 'undodir' |
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6935
diff
changeset
|
995 options, create the directory if it doesn't |
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6935
diff
changeset
|
996 exist yet. |
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6935
diff
changeset
|
997 |
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6935
diff
changeset
|
998 Note: It's a bad idea to reset an option |
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6935
diff
changeset
|
999 during this autocommand, this may break a |
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6935
diff
changeset
|
1000 plugin. You can always use `:noa` to prevent |
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6935
diff
changeset
|
1001 triggering this autocommand. |
6935 | 1002 |
14864 | 1003 When using |:set| in the autocommand the event |
1004 is not triggered again. | |
579 | 1005 *QuickFixCmdPre* |
1006 QuickFixCmdPre Before a quickfix command is run (|:make|, | |
657 | 1007 |:lmake|, |:grep|, |:lgrep|, |:grepadd|, |
1008 |:lgrepadd|, |:vimgrep|, |:lvimgrep|, | |
3281 | 1009 |:vimgrepadd|, |:lvimgrepadd|, |:cscope|, |
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3404
diff
changeset
|
1010 |:cfile|, |:cgetfile|, |:caddfile|, |:lfile|, |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3404
diff
changeset
|
1011 |:lgetfile|, |:laddfile|, |:helpgrep|, |
10140
b11ceef7116e
commit https://github.com/vim/vim/commit/64d8e25bf6efe5f18b032563521c3ce278c316ab
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
1012 |:lhelpgrep|, |:cexpr|, |:cgetexpr|, |
b11ceef7116e
commit https://github.com/vim/vim/commit/64d8e25bf6efe5f18b032563521c3ce278c316ab
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
1013 |:caddexpr|, |:cbuffer|, |:cgetbuffer|, |
b11ceef7116e
commit https://github.com/vim/vim/commit/64d8e25bf6efe5f18b032563521c3ce278c316ab
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
1014 |:caddbuffer|). |
2151
ae22c450546c
updated for version 7.2.433
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
1015 The pattern is matched against the command |
ae22c450546c
updated for version 7.2.433
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
1016 being run. When |:grep| is used but 'grepprg' |
ae22c450546c
updated for version 7.2.433
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
1017 is set to "internal" it still matches "grep". |
579 | 1018 This command cannot be used to set the |
1019 'makeprg' and 'grepprg' variables. | |
1020 If this command causes an error, the quickfix | |
1021 command is not executed. | |
1022 *QuickFixCmdPost* | |
1023 QuickFixCmdPost Like QuickFixCmdPre, but after a quickfix | |
842 | 1024 command is run, before jumping to the first |
3404 | 1025 location. For |:cfile| and |:lfile| commands |
1026 it is run after error file is read and before | |
5663
1dea14d4c738
Update runtime files. Add support for systemverilog.
Bram Moolenaar <bram@vim.org>
parents:
5555
diff
changeset
|
1027 moving to the first error. |
3404 | 1028 See |QuickFixCmdPost-example|. |
3682 | 1029 *QuitPre* |
4229 | 1030 QuitPre When using `:quit`, `:wq` or `:qall`, before |
1031 deciding whether it closes the current window | |
24751 | 1032 or quits Vim. For `:wq` the buffer is written |
1033 before QuitPre is triggered. Can be used to | |
1034 close any non-essential window if the current | |
1035 window is the last ordinary window. | |
13442
94e638936d3e
patch 8.0.1595: no autocommand triggered before exiting
Christian Brabandt <cb@256bit.org>
parents:
13437
diff
changeset
|
1036 Also see |ExitPre|. |
579 | 1037 *RemoteReply* |
1038 RemoteReply When a reply from a Vim that functions as | |
1154 | 1039 server was received |server2client()|. The |
1040 pattern is matched against the {serverid}. | |
579 | 1041 <amatch> is equal to the {serverid} from which |
1042 the reply was sent, and <afile> is the actual | |
1043 reply string. | |
1044 Note that even if an autocommand is defined, | |
1045 the reply should be read with |remote_read()| | |
1046 to consume it. | |
18098
a2870e6f5b45
patch 8.1.2044: no easy way to process postponed work
Bram Moolenaar <Bram@vim.org>
parents:
18043
diff
changeset
|
1047 *SafeState* |
a2870e6f5b45
patch 8.1.2044: no easy way to process postponed work
Bram Moolenaar <Bram@vim.org>
parents:
18043
diff
changeset
|
1048 SafeState When nothing is pending, going to wait for the |
a2870e6f5b45
patch 8.1.2044: no easy way to process postponed work
Bram Moolenaar <Bram@vim.org>
parents:
18043
diff
changeset
|
1049 user to type a character. |
a2870e6f5b45
patch 8.1.2044: no easy way to process postponed work
Bram Moolenaar <Bram@vim.org>
parents:
18043
diff
changeset
|
1050 This will not be triggered when: |
a2870e6f5b45
patch 8.1.2044: no easy way to process postponed work
Bram Moolenaar <Bram@vim.org>
parents:
18043
diff
changeset
|
1051 - an operator is pending |
a2870e6f5b45
patch 8.1.2044: no easy way to process postponed work
Bram Moolenaar <Bram@vim.org>
parents:
18043
diff
changeset
|
1052 - a register was entered with "r |
a2870e6f5b45
patch 8.1.2044: no easy way to process postponed work
Bram Moolenaar <Bram@vim.org>
parents:
18043
diff
changeset
|
1053 - halfway executing a command |
a2870e6f5b45
patch 8.1.2044: no easy way to process postponed work
Bram Moolenaar <Bram@vim.org>
parents:
18043
diff
changeset
|
1054 - executing a mapping |
a2870e6f5b45
patch 8.1.2044: no easy way to process postponed work
Bram Moolenaar <Bram@vim.org>
parents:
18043
diff
changeset
|
1055 - there is typeahead |
a2870e6f5b45
patch 8.1.2044: no easy way to process postponed work
Bram Moolenaar <Bram@vim.org>
parents:
18043
diff
changeset
|
1056 - Insert mode completion is active |
a2870e6f5b45
patch 8.1.2044: no easy way to process postponed work
Bram Moolenaar <Bram@vim.org>
parents:
18043
diff
changeset
|
1057 - Command line completion is active |
a2870e6f5b45
patch 8.1.2044: no easy way to process postponed work
Bram Moolenaar <Bram@vim.org>
parents:
18043
diff
changeset
|
1058 You can use `mode()` to find out what state |
a2870e6f5b45
patch 8.1.2044: no easy way to process postponed work
Bram Moolenaar <Bram@vim.org>
parents:
18043
diff
changeset
|
1059 Vim is in. That may be: |
a2870e6f5b45
patch 8.1.2044: no easy way to process postponed work
Bram Moolenaar <Bram@vim.org>
parents:
18043
diff
changeset
|
1060 - VIsual mode |
a2870e6f5b45
patch 8.1.2044: no easy way to process postponed work
Bram Moolenaar <Bram@vim.org>
parents:
18043
diff
changeset
|
1061 - Normal mode |
a2870e6f5b45
patch 8.1.2044: no easy way to process postponed work
Bram Moolenaar <Bram@vim.org>
parents:
18043
diff
changeset
|
1062 - Insert mode |
a2870e6f5b45
patch 8.1.2044: no easy way to process postponed work
Bram Moolenaar <Bram@vim.org>
parents:
18043
diff
changeset
|
1063 - Command-line mode |
a2870e6f5b45
patch 8.1.2044: no easy way to process postponed work
Bram Moolenaar <Bram@vim.org>
parents:
18043
diff
changeset
|
1064 Depending on what you want to do, you may also |
a2870e6f5b45
patch 8.1.2044: no easy way to process postponed work
Bram Moolenaar <Bram@vim.org>
parents:
18043
diff
changeset
|
1065 check more with `state()`, e.g. whether the |
a2870e6f5b45
patch 8.1.2044: no easy way to process postponed work
Bram Moolenaar <Bram@vim.org>
parents:
18043
diff
changeset
|
1066 screen was scrolled for messages. |
18102
0d9ec3a2821f
patch 8.1.2046: SafeState may be triggered at the wrong moment
Bram Moolenaar <Bram@vim.org>
parents:
18098
diff
changeset
|
1067 *SafeStateAgain* |
0d9ec3a2821f
patch 8.1.2046: SafeState may be triggered at the wrong moment
Bram Moolenaar <Bram@vim.org>
parents:
18098
diff
changeset
|
1068 SafeStateAgain Like SafeState but after processing any |
0d9ec3a2821f
patch 8.1.2046: SafeState may be triggered at the wrong moment
Bram Moolenaar <Bram@vim.org>
parents:
18098
diff
changeset
|
1069 messages and invoking callbacks. This may be |
0d9ec3a2821f
patch 8.1.2046: SafeState may be triggered at the wrong moment
Bram Moolenaar <Bram@vim.org>
parents:
18098
diff
changeset
|
1070 triggered often, don't do something that takes |
0d9ec3a2821f
patch 8.1.2046: SafeState may be triggered at the wrong moment
Bram Moolenaar <Bram@vim.org>
parents:
18098
diff
changeset
|
1071 time. |
18098
a2870e6f5b45
patch 8.1.2044: no easy way to process postponed work
Bram Moolenaar <Bram@vim.org>
parents:
18043
diff
changeset
|
1072 |
579 | 1073 *SessionLoadPost* |
1074 SessionLoadPost After loading the session file created using | |
1075 the |:mksession| command. | |
724 | 1076 *ShellCmdPost* |
1077 ShellCmdPost After executing a shell command with |:!cmd|, | |
1078 |:shell|, |:make| and |:grep|. Can be used to | |
1079 check for any changed files. | |
1080 *ShellFilterPost* | |
1081 ShellFilterPost After executing a shell command with | |
1082 ":{range}!cmd", ":w !cmd" or ":r !cmd". | |
1083 Can be used to check for any changed files. | |
716 | 1084 *SourcePre* |
1085 SourcePre Before sourcing a Vim script. |:source| | |
1061 | 1086 <afile> is the name of the file being sourced. |
15442
3e2e1608efa4
patch 8.1.0729: there is a SourcePre autocommand event but not a SourcePost
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
1087 *SourcePost* |
3e2e1608efa4
patch 8.1.0729: there is a SourcePre autocommand event but not a SourcePost
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
1088 SourcePost After sourcing a Vim script. |:source| |
3e2e1608efa4
patch 8.1.0729: there is a SourcePre autocommand event but not a SourcePost
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
1089 <afile> is the name of the file being sourced. |
3e2e1608efa4
patch 8.1.0729: there is a SourcePre autocommand event but not a SourcePost
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
1090 Not triggered when sourcing was interrupted. |
3e2e1608efa4
patch 8.1.0729: there is a SourcePre autocommand event but not a SourcePost
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
1091 Also triggered after a SourceCmd autocommand |
3e2e1608efa4
patch 8.1.0729: there is a SourcePre autocommand event but not a SourcePost
Bram Moolenaar <Bram@vim.org>
parents:
15334
diff
changeset
|
1092 was triggered. |
1061 | 1093 *SourceCmd* |
1094 SourceCmd When sourcing a Vim script. |:source| | |
1095 <afile> is the name of the file being sourced. | |
1096 The autocommand must source this file. | |
1097 |Cmd-event| | |
650 | 1098 *SpellFileMissing* |
1099 SpellFileMissing When trying to load a spell checking file and | |
1061 | 1100 it can't be found. The pattern is matched |
1101 against the language. <amatch> is the | |
1102 language, 'encoding' also matters. See | |
650 | 1103 |spell-SpellFileMissing|. |
579 | 1104 *StdinReadPost* |
1105 StdinReadPost After reading from the stdin into the buffer, | |
1106 before executing the modelines. Only used | |
1107 when the "-" argument was used when Vim was | |
1108 started |--|. | |
1109 *StdinReadPre* | |
1110 StdinReadPre Before reading from stdin into the buffer. | |
1111 Only used when the "-" argument was used when | |
1112 Vim was started |--|. | |
1113 *SwapExists* | |
1114 SwapExists Detected an existing swap file when starting | |
1115 to edit a file. Only when it is possible to | |
1116 select a way to handle the situation, when Vim | |
1117 would ask the user what to do. | |
1118 The |v:swapname| variable holds the name of | |
590 | 1119 the swap file found, <afile> the file being |
1120 edited. |v:swapcommand| may contain a command | |
1121 to be executed in the opened file. | |
1122 The commands should set the |v:swapchoice| | |
1123 variable to a string with one character to | |
1124 tell Vim what should be done next: | |
579 | 1125 'o' open read-only |
1126 'e' edit the file anyway | |
1127 'r' recover | |
1128 'd' delete the swap file | |
1129 'q' quit, don't edit the file | |
1130 'a' abort, like hitting CTRL-C | |
1131 When set to an empty string the user will be | |
1132 asked, as if there was no SwapExists autocmd. | |
1919 | 1133 *E812* |
1134 It is not allowed to change to another buffer, | |
1135 change a buffer name or change directory | |
1136 here. | |
13437 | 1137 {only available with the +eval feature} |
579 | 1138 *Syntax* |
1154 | 1139 Syntax When the 'syntax' option has been set. The |
1140 pattern is matched against the syntax name. | |
579 | 1141 <afile> can be used for the name of the file |
1142 where this option was set, and <amatch> for | |
1143 the new value of 'syntax'. | |
1144 See |:syn-on|. | |
9599
42a8a81decdf
commit https://github.com/vim/vim/commit/12c11d553053f5a9eae9eb3c518279b12fa928c2
Christian Brabandt <cb@256bit.org>
parents:
9595
diff
changeset
|
1145 *TabClosed* |
42a8a81decdf
commit https://github.com/vim/vim/commit/12c11d553053f5a9eae9eb3c518279b12fa928c2
Christian Brabandt <cb@256bit.org>
parents:
9595
diff
changeset
|
1146 TabClosed After closing a tab page. |
677 | 1147 *TabEnter* |
1148 TabEnter Just after entering a tab page. |tab-page| | |
872 | 1149 After triggering the WinEnter and before |
1150 triggering the BufEnter event. | |
677 | 1151 *TabLeave* |
1152 TabLeave Just before leaving a tab page. |tab-page| | |
1153 A WinLeave event will have been triggered | |
1154 first. | |
9595
0190d5de215f
commit https://github.com/vim/vim/commit/c917da4b3e8801a255dbefea8e4ed19c1c716dd8
Christian Brabandt <cb@256bit.org>
parents:
9286
diff
changeset
|
1155 *TabNew* |
0190d5de215f
commit https://github.com/vim/vim/commit/c917da4b3e8801a255dbefea8e4ed19c1c716dd8
Christian Brabandt <cb@256bit.org>
parents:
9286
diff
changeset
|
1156 TabNew When a tab page was created. |tab-page| |
0190d5de215f
commit https://github.com/vim/vim/commit/c917da4b3e8801a255dbefea8e4ed19c1c716dd8
Christian Brabandt <cb@256bit.org>
parents:
9286
diff
changeset
|
1157 A WinEnter event will have been triggered |
0190d5de215f
commit https://github.com/vim/vim/commit/c917da4b3e8801a255dbefea8e4ed19c1c716dd8
Christian Brabandt <cb@256bit.org>
parents:
9286
diff
changeset
|
1158 first, TabEnter follows. |
579 | 1159 *TermChanged* |
1160 TermChanged After the value of 'term' has changed. Useful | |
1161 for re-loading the syntax file to update the | |
1162 colors, fonts and other terminal-dependent | |
1163 settings. Executed for all loaded buffers. | |
13444
9f06f7aca74c
patch 8.0.1596: no autocommand specifically for opening a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13442
diff
changeset
|
1164 *TerminalOpen* |
9f06f7aca74c
patch 8.0.1596: no autocommand specifically for opening a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13442
diff
changeset
|
1165 TerminalOpen Just after a terminal buffer was created, with |
9f06f7aca74c
patch 8.0.1596: no autocommand specifically for opening a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13442
diff
changeset
|
1166 `:terminal` or |term_start()|. This event is |
9f06f7aca74c
patch 8.0.1596: no autocommand specifically for opening a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13442
diff
changeset
|
1167 triggered even if the buffer is created |
9f06f7aca74c
patch 8.0.1596: no autocommand specifically for opening a terminal window
Christian Brabandt <cb@256bit.org>
parents:
13442
diff
changeset
|
1168 without a window, with the ++hidden option. |
18450
507348b211b4
patch 8.1.2219: no autocommand for open window with terminal
Bram Moolenaar <Bram@vim.org>
parents:
18130
diff
changeset
|
1169 *TerminalWinOpen* |
507348b211b4
patch 8.1.2219: no autocommand for open window with terminal
Bram Moolenaar <Bram@vim.org>
parents:
18130
diff
changeset
|
1170 TerminalWinOpen Just after a terminal buffer was created, with |
507348b211b4
patch 8.1.2219: no autocommand for open window with terminal
Bram Moolenaar <Bram@vim.org>
parents:
18130
diff
changeset
|
1171 `:terminal` or |term_start()|. This event is |
507348b211b4
patch 8.1.2219: no autocommand for open window with terminal
Bram Moolenaar <Bram@vim.org>
parents:
18130
diff
changeset
|
1172 triggered only if the buffer is created |
507348b211b4
patch 8.1.2219: no autocommand for open window with terminal
Bram Moolenaar <Bram@vim.org>
parents:
18130
diff
changeset
|
1173 with a window. Can be used to set window |
507348b211b4
patch 8.1.2219: no autocommand for open window with terminal
Bram Moolenaar <Bram@vim.org>
parents:
18130
diff
changeset
|
1174 local options for the terminal window. |
579 | 1175 *TermResponse* |
1176 TermResponse After the response to |t_RV| is received from | |
1177 the terminal. The value of |v:termresponse| | |
1178 can be used to do things depending on the | |
2788 | 1179 terminal version. Note that this event may be |
1180 triggered halfway executing another event, | |
1181 especially if file I/O, a shell command or | |
1182 anything else that takes time is involved. | |
4264 | 1183 *TextChanged* |
1184 TextChanged After a change was made to the text in the | |
15512 | 1185 current buffer in Normal mode. That is after |
1186 |b:changedtick| has changed (also when that | |
1187 happened before the TextChanged autocommand | |
1188 was defined). | |
4264 | 1189 Not triggered when there is typeahead or when |
1190 an operator is pending. | |
16023 | 1191 Note: This can not be skipped with |
1192 `:noautocmd`. | |
4264 | 1193 Careful: This is triggered very often, don't |
1194 do anything that the user does not expect or | |
1195 that is slow. | |
1196 *TextChangedI* | |
1197 TextChangedI After a change was made to the text in the | |
1198 current buffer in Insert mode. | |
1199 Not triggered when the popup menu is visible. | |
1200 Otherwise the same as TextChanged. | |
13240
5ed6e4a25925
patch 8.0.1494: no autocmd triggered in Insert mode with visible popup menu
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
1201 *TextChangedP* |
5ed6e4a25925
patch 8.0.1494: no autocmd triggered in Insert mode with visible popup menu
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
1202 TextChangedP After a change was made to the text in the |
5ed6e4a25925
patch 8.0.1494: no autocmd triggered in Insert mode with visible popup menu
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
1203 current buffer in Insert mode, only when the |
5ed6e4a25925
patch 8.0.1494: no autocmd triggered in Insert mode with visible popup menu
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
1204 popup menu is visible. Otherwise the same as |
5ed6e4a25925
patch 8.0.1494: no autocmd triggered in Insert mode with visible popup menu
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
1205 TextChanged. |
13051 | 1206 *TextYankPost* |
13037
6e81a68d63a1
patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
1207 TextYankPost After text has been yanked or deleted in the |
6e81a68d63a1
patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
1208 current buffer. The following values of |
6e81a68d63a1
patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
1209 |v:event| can be used to determine the operation |
6e81a68d63a1
patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
1210 that triggered this autocmd: |
28384
21e96d9b66c0
patch 8.2.4717: for TextYankPost v:event does not contain all information
Bram Moolenaar <Bram@vim.org>
parents:
28379
diff
changeset
|
1211 inclusive TRUE if the motion is |
21e96d9b66c0
patch 8.2.4717: for TextYankPost v:event does not contain all information
Bram Moolenaar <Bram@vim.org>
parents:
28379
diff
changeset
|
1212 |inclusive| else the motion is |
21e96d9b66c0
patch 8.2.4717: for TextYankPost v:event does not contain all information
Bram Moolenaar <Bram@vim.org>
parents:
28379
diff
changeset
|
1213 |exclusive|. |
18130 | 1214 operator The operation performed. |
1215 regcontents Text that was stored in the | |
13037
6e81a68d63a1
patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
1216 register, as a list of lines, |
6e81a68d63a1
patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
1217 like with: > |
6e81a68d63a1
patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
1218 getreg(r, 1, 1) |
25973 | 1219 < regname Name of the register or empty |
1220 string for the unnamed | |
1221 register, see |registers|. | |
13037
6e81a68d63a1
patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
1222 regtype Type of the register, see |
6e81a68d63a1
patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
1223 |getregtype()|. |
20824
b8ca32dcfabb
patch 8.2.0964: TextYankPost does not provide info about Visual selection
Bram Moolenaar <Bram@vim.org>
parents:
20800
diff
changeset
|
1224 visual True if the operation is |
b8ca32dcfabb
patch 8.2.0964: TextYankPost does not provide info about Visual selection
Bram Moolenaar <Bram@vim.org>
parents:
20800
diff
changeset
|
1225 performed on a |Visual| area. |
13037
6e81a68d63a1
patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
1226 Not triggered when |quote_| is used nor when |
6e81a68d63a1
patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
1227 called recursively. |
6e81a68d63a1
patch 8.0.1394: cannot intercept a yank command
Christian Brabandt <cb@256bit.org>
parents:
12785
diff
changeset
|
1228 It is not allowed to change the buffer text, |
27321 | 1229 see |textlock|. *E1064* |
13437 | 1230 {only when compiled with the +eval feature} |
20800
e76b83c07bd8
patch 8.2.0952: no simple way to interrupt Vim
Bram Moolenaar <Bram@vim.org>
parents:
19303
diff
changeset
|
1231 |
579 | 1232 *User* |
1233 User Never executed automatically. To be used for | |
1234 autocommands that are only executed with | |
1235 ":doautocmd". | |
13735 | 1236 Note that when `:doautocmd User MyEvent` is |
1237 used while there are no matching autocommands, | |
1238 you will get an error. If you don't want | |
28375
e466fdbe0699
patch 8.2.4713: plugins cannot track text scrolling
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
1239 that, either check whether an autocommand is |
e466fdbe0699
patch 8.2.4713: plugins cannot track text scrolling
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
1240 defined using `exists('#User#MyEvent')` or |
e466fdbe0699
patch 8.2.4713: plugins cannot track text scrolling
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
1241 define a dummy autocommand yourself. |
e466fdbe0699
patch 8.2.4713: plugins cannot track text scrolling
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
1242 Example: > |
e466fdbe0699
patch 8.2.4713: plugins cannot track text scrolling
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
1243 if exists('#User#MyEvent') |
e466fdbe0699
patch 8.2.4713: plugins cannot track text scrolling
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
1244 doautocmd User MyEvent |
e466fdbe0699
patch 8.2.4713: plugins cannot track text scrolling
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
1245 endif |
20800
e76b83c07bd8
patch 8.2.0952: no simple way to interrupt Vim
Bram Moolenaar <Bram@vim.org>
parents:
19303
diff
changeset
|
1246 |
e76b83c07bd8
patch 8.2.0952: no simple way to interrupt Vim
Bram Moolenaar <Bram@vim.org>
parents:
19303
diff
changeset
|
1247 *SigUSR1* |
e76b83c07bd8
patch 8.2.0952: no simple way to interrupt Vim
Bram Moolenaar <Bram@vim.org>
parents:
19303
diff
changeset
|
1248 SigUSR1 After the SIGUSR1 signal has been detected. |
e76b83c07bd8
patch 8.2.0952: no simple way to interrupt Vim
Bram Moolenaar <Bram@vim.org>
parents:
19303
diff
changeset
|
1249 Could be used if other ways of notifying Vim |
e76b83c07bd8
patch 8.2.0952: no simple way to interrupt Vim
Bram Moolenaar <Bram@vim.org>
parents:
19303
diff
changeset
|
1250 are not feasible. E.g. to check for the |
e76b83c07bd8
patch 8.2.0952: no simple way to interrupt Vim
Bram Moolenaar <Bram@vim.org>
parents:
19303
diff
changeset
|
1251 result of a build that takes a long time, or |
e76b83c07bd8
patch 8.2.0952: no simple way to interrupt Vim
Bram Moolenaar <Bram@vim.org>
parents:
19303
diff
changeset
|
1252 when a motion sensor is triggered. |
e76b83c07bd8
patch 8.2.0952: no simple way to interrupt Vim
Bram Moolenaar <Bram@vim.org>
parents:
19303
diff
changeset
|
1253 {only on Unix} |
e76b83c07bd8
patch 8.2.0952: no simple way to interrupt Vim
Bram Moolenaar <Bram@vim.org>
parents:
19303
diff
changeset
|
1254 |
579 | 1255 *UserGettingBored* |
4264 | 1256 UserGettingBored When the user presses the same key 42 times. |
1257 Just kidding! :-) | |
579 | 1258 *VimEnter* |
1259 VimEnter After doing all the startup stuff, including | |
1260 loading .vimrc files, executing the "-c cmd" | |
1261 arguments, creating all windows and loading | |
1262 the buffers in them. | |
8738
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
1263 Just before this event is triggered the |
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
1264 |v:vim_did_enter| variable is set, so that you |
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
1265 can do: > |
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
1266 if v:vim_did_enter |
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
1267 call s:init() |
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
1268 else |
18130 | 1269 au VimEnter * call s:init() |
8738
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
1270 endif |
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
1271 < *VimLeave* |
579 | 1272 VimLeave Before exiting Vim, just after writing the |
1273 .viminfo file. Executed only once, like | |
1274 VimLeavePre. | |
1275 To detect an abnormal exit use |v:dying|. | |
2226
36a9ac99e1ca
Don't execute some autocommands when v:dying is 2 or more.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1276 When v:dying is 2 or more this event is not |
36a9ac99e1ca
Don't execute some autocommands when v:dying is 2 or more.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1277 triggered. |
23048
ad674a98058a
patch 8.2.2070: can't get the exit value in VimLeave(Pre) autocommands
Bram Moolenaar <Bram@vim.org>
parents:
22958
diff
changeset
|
1278 To get the exit code use |v:exiting|. |
579 | 1279 *VimLeavePre* |
1280 VimLeavePre Before exiting Vim, just before writing the | |
1281 .viminfo file. This is executed only once, | |
1282 if there is a match with the name of what | |
1283 happens to be the current buffer when exiting. | |
1284 Mostly useful with a "*" pattern. > | |
1285 :autocmd VimLeavePre * call CleanupStuff() | |
1286 < To detect an abnormal exit use |v:dying|. | |
2226
36a9ac99e1ca
Don't execute some autocommands when v:dying is 2 or more.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1287 When v:dying is 2 or more this event is not |
36a9ac99e1ca
Don't execute some autocommands when v:dying is 2 or more.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1288 triggered. |
23048
ad674a98058a
patch 8.2.2070: can't get the exit value in VimLeave(Pre) autocommands
Bram Moolenaar <Bram@vim.org>
parents:
22958
diff
changeset
|
1289 To get the exit code use |v:exiting|. |
766 | 1290 *VimResized* |
1291 VimResized After the Vim window was resized, thus 'lines' | |
1292 and/or 'columns' changed. Not when starting | |
1293 up though. | |
23165
a916fca16d4b
patch 8.2.2128: there is no way to do something on CTRL-Z
Bram Moolenaar <Bram@vim.org>
parents:
23164
diff
changeset
|
1294 *VimResume* |
a916fca16d4b
patch 8.2.2128: there is no way to do something on CTRL-Z
Bram Moolenaar <Bram@vim.org>
parents:
23164
diff
changeset
|
1295 VimResume When the Vim instance is resumed after being |
a916fca16d4b
patch 8.2.2128: there is no way to do something on CTRL-Z
Bram Moolenaar <Bram@vim.org>
parents:
23164
diff
changeset
|
1296 suspended and |VimSuspend| was triggered. |
a916fca16d4b
patch 8.2.2128: there is no way to do something on CTRL-Z
Bram Moolenaar <Bram@vim.org>
parents:
23164
diff
changeset
|
1297 Useful for triggering |:checktime| and ensure |
a916fca16d4b
patch 8.2.2128: there is no way to do something on CTRL-Z
Bram Moolenaar <Bram@vim.org>
parents:
23164
diff
changeset
|
1298 the buffers content did not change while Vim |
a916fca16d4b
patch 8.2.2128: there is no way to do something on CTRL-Z
Bram Moolenaar <Bram@vim.org>
parents:
23164
diff
changeset
|
1299 was suspended: > |
a916fca16d4b
patch 8.2.2128: there is no way to do something on CTRL-Z
Bram Moolenaar <Bram@vim.org>
parents:
23164
diff
changeset
|
1300 :autocmd VimResume * checktime |
a916fca16d4b
patch 8.2.2128: there is no way to do something on CTRL-Z
Bram Moolenaar <Bram@vim.org>
parents:
23164
diff
changeset
|
1301 < *VimSuspend* |
a916fca16d4b
patch 8.2.2128: there is no way to do something on CTRL-Z
Bram Moolenaar <Bram@vim.org>
parents:
23164
diff
changeset
|
1302 VimSuspend When the Vim instance is suspended. Only when |
26825
3c1dcb63f579
patch 8.2.3941: SIGTSTP is not handled
Bram Moolenaar <Bram@vim.org>
parents:
26219
diff
changeset
|
1303 CTRL-Z was typed inside Vim, or when the SIGTSTP |
3c1dcb63f579
patch 8.2.3941: SIGTSTP is not handled
Bram Moolenaar <Bram@vim.org>
parents:
26219
diff
changeset
|
1304 signal was sent to Vim, but not for SIGSTOP. |
26117
d4d9c7c55a5f
patch 8.2.3591: no event is triggered when closing a window
Bram Moolenaar <Bram@vim.org>
parents:
26042
diff
changeset
|
1305 *WinClosed* |
d4d9c7c55a5f
patch 8.2.3591: no event is triggered when closing a window
Bram Moolenaar <Bram@vim.org>
parents:
26042
diff
changeset
|
1306 WinClosed After closing a window. The pattern is |
d4d9c7c55a5f
patch 8.2.3591: no event is triggered when closing a window
Bram Moolenaar <Bram@vim.org>
parents:
26042
diff
changeset
|
1307 matched against the |window-ID|. Both |
d4d9c7c55a5f
patch 8.2.3591: no event is triggered when closing a window
Bram Moolenaar <Bram@vim.org>
parents:
26042
diff
changeset
|
1308 <amatch> and <afile> are set to the |
d4d9c7c55a5f
patch 8.2.3591: no event is triggered when closing a window
Bram Moolenaar <Bram@vim.org>
parents:
26042
diff
changeset
|
1309 |window-ID|. Non-recursive (event cannot |
d4d9c7c55a5f
patch 8.2.3591: no event is triggered when closing a window
Bram Moolenaar <Bram@vim.org>
parents:
26042
diff
changeset
|
1310 trigger itself). |
7 | 1311 *WinEnter* |
1312 WinEnter After entering another window. Not done for | |
1313 the first window, when Vim has just started. | |
1314 Useful for setting the window height. | |
1315 If the window is for another buffer, Vim | |
1316 executes the BufEnter autocommands after the | |
1317 WinEnter autocommands. | |
13735 | 1318 Note: For split and tabpage commands the |
1319 WinEnter event is triggered after the split | |
1320 or tab command but before the file is loaded. | |
1321 | |
7 | 1322 *WinLeave* |
1323 WinLeave Before leaving a window. If the window to be | |
1324 entered next is for a different buffer, Vim | |
1325 executes the BufLeave autocommands before the | |
1326 WinLeave autocommands (but not for ":new"). | |
1327 Not used for ":qa" or ":q" when exiting Vim. | |
1328 | |
9599
42a8a81decdf
commit https://github.com/vim/vim/commit/12c11d553053f5a9eae9eb3c518279b12fa928c2
Christian Brabandt <cb@256bit.org>
parents:
9595
diff
changeset
|
1329 *WinNew* |
42a8a81decdf
commit https://github.com/vim/vim/commit/12c11d553053f5a9eae9eb3c518279b12fa928c2
Christian Brabandt <cb@256bit.org>
parents:
9595
diff
changeset
|
1330 WinNew When a new window was created. Not done for |
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
1331 the first window, when Vim has just started. |
9599
42a8a81decdf
commit https://github.com/vim/vim/commit/12c11d553053f5a9eae9eb3c518279b12fa928c2
Christian Brabandt <cb@256bit.org>
parents:
9595
diff
changeset
|
1332 Before a WinEnter event. |
42a8a81decdf
commit https://github.com/vim/vim/commit/12c11d553053f5a9eae9eb3c518279b12fa928c2
Christian Brabandt <cb@256bit.org>
parents:
9595
diff
changeset
|
1333 |
28375
e466fdbe0699
patch 8.2.4713: plugins cannot track text scrolling
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
1334 *WinScrolled* |
e466fdbe0699
patch 8.2.4713: plugins cannot track text scrolling
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
1335 WinScrolled After scrolling the content of a window or |
e466fdbe0699
patch 8.2.4713: plugins cannot track text scrolling
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
1336 resizing a window. |
e466fdbe0699
patch 8.2.4713: plugins cannot track text scrolling
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
1337 The pattern is matched against the |
e466fdbe0699
patch 8.2.4713: plugins cannot track text scrolling
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
1338 |window-ID|. Both <amatch> and <afile> are |
e466fdbe0699
patch 8.2.4713: plugins cannot track text scrolling
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
1339 set to the |window-ID|. |
e466fdbe0699
patch 8.2.4713: plugins cannot track text scrolling
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
1340 Non-recursive (the event cannot trigger |
e466fdbe0699
patch 8.2.4713: plugins cannot track text scrolling
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
1341 itself). However, if the command causes the |
e466fdbe0699
patch 8.2.4713: plugins cannot track text scrolling
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
1342 window to scroll or change size another |
e466fdbe0699
patch 8.2.4713: plugins cannot track text scrolling
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
1343 WinScrolled event will be triggered later. |
e466fdbe0699
patch 8.2.4713: plugins cannot track text scrolling
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
1344 Does not trigger when the command is added, |
e466fdbe0699
patch 8.2.4713: plugins cannot track text scrolling
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
1345 only after the first scroll or resize. |
e466fdbe0699
patch 8.2.4713: plugins cannot track text scrolling
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
1346 |
7 | 1347 ============================================================================== |
27162 | 1348 6. Patterns *autocmd-patterns* *{aupat}* |
7 | 1349 |
28375
e466fdbe0699
patch 8.2.4713: plugins cannot track text scrolling
Bram Moolenaar <Bram@vim.org>
parents:
28246
diff
changeset
|
1350 The {aupat} argument of `:autocmd` can be a comma-separated list. This works as |
27162 | 1351 if the command was given with each pattern separately. Thus this command: > |
6741 | 1352 :autocmd BufRead *.txt,*.info set et |
1353 Is equivalent to: > | |
1354 :autocmd BufRead *.txt set et | |
1355 :autocmd BufRead *.info set et | |
1356 | |
27162 | 1357 The file pattern {aupat} is tested for a match against the file name in one of |
7 | 1358 two ways: |
1359 1. When there is no '/' in the pattern, Vim checks for a match against only | |
1360 the tail part of the file name (without its leading directory path). | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1919
diff
changeset
|
1361 2. When there is a '/' in the pattern, Vim checks for a match against both the |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1919
diff
changeset
|
1362 short file name (as you typed it) and the full file name (after expanding |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1919
diff
changeset
|
1363 it to a full path and resolving symbolic links). |
7 | 1364 |
40 | 1365 The special pattern <buffer> or <buffer=N> is used for buffer-local |
1366 autocommands |autocmd-buflocal|. This pattern is not matched against the name | |
1367 of a buffer. | |
1368 | |
7 | 1369 Examples: > |
1370 :autocmd BufRead *.txt set et | |
1371 Set the 'et' option for all text files. > | |
1372 | |
1373 :autocmd BufRead /vim/src/*.c set cindent | |
1374 Set the 'cindent' option for C files in the /vim/src directory. > | |
1375 | |
1376 :autocmd BufRead /tmp/*.c set ts=5 | |
1377 If you have a link from "/tmp/test.c" to "/home/nobody/vim/src/test.c", and | |
1378 you start editing "/tmp/test.c", this autocommand will match. | |
1379 | |
1380 Note: To match part of a path, but not from the root directory, use a '*' as | |
1381 the first character. Example: > | |
1382 :autocmd BufRead */doc/*.txt set tw=78 | |
1383 This autocommand will for example be executed for "/tmp/doc/xx.txt" and | |
1384 "/usr/home/piet/doc/yy.txt". The number of directories does not matter here. | |
1385 | |
1386 | |
1387 The file name that the pattern is matched against is after expanding | |
1621 | 1388 wildcards. Thus if you issue this command: > |
7 | 1389 :e $ROOTDIR/main.$EXT |
1390 The argument is first expanded to: > | |
1391 /usr/root/main.py | |
1392 Before it's matched with the pattern of the autocommand. Careful with this | |
1393 when using events like FileReadCmd, the value of <amatch> may not be what you | |
1394 expect. | |
1395 | |
1396 | |
1397 Environment variables can be used in a pattern: > | |
1398 :autocmd BufRead $VIMRUNTIME/doc/*.txt set expandtab | |
1399 And ~ can be used for the home directory (if $HOME is defined): > | |
1400 :autocmd BufWritePost ~/.vimrc so ~/.vimrc | |
1401 :autocmd BufRead ~archive/* set readonly | |
1402 The environment variable is expanded when the autocommand is defined, not when | |
1403 the autocommand is executed. This is different from the command! | |
1404 | |
1405 *file-pattern* | |
1406 The pattern is interpreted like mostly used in file names: | |
5294 | 1407 * matches any sequence of characters; Unusual: includes path |
5277 | 1408 separators |
7 | 1409 ? matches any single character |
1410 \? matches a '?' | |
1411 . matches a '.' | |
1412 ~ matches a '~' | |
1413 , separates patterns | |
1414 \, matches a ',' | |
1415 { } like \( \) in a |pattern| | |
1416 , inside { }: like \| in a |pattern| | |
5259
6b7ab6a4f31a
updated for version 7.4b.006
Bram Moolenaar <bram@vim.org>
parents:
5247
diff
changeset
|
1417 \} literal } |
6b7ab6a4f31a
updated for version 7.4b.006
Bram Moolenaar <bram@vim.org>
parents:
5247
diff
changeset
|
1418 \{ literal { |
6b7ab6a4f31a
updated for version 7.4b.006
Bram Moolenaar <bram@vim.org>
parents:
5247
diff
changeset
|
1419 \\\{n,m\} like \{n,m} in a |pattern| |
7 | 1420 \ special meaning like in a |pattern| |
1421 [ch] matches 'c' or 'h' | |
1422 [^ch] match any character but 'c' and 'h' | |
1423 | |
1424 Note that for all systems the '/' character is used for path separator (even | |
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
1425 for MS-Windows). This was done because the backslash is difficult to use in a |
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
1426 pattern and to make the autocommands portable across different systems. |
7 | 1427 |
10140
b11ceef7116e
commit https://github.com/vim/vim/commit/64d8e25bf6efe5f18b032563521c3ce278c316ab
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
1428 It is possible to use |pattern| items, but they may not work as expected, |
b11ceef7116e
commit https://github.com/vim/vim/commit/64d8e25bf6efe5f18b032563521c3ce278c316ab
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
1429 because of the translation done for the above. |
b11ceef7116e
commit https://github.com/vim/vim/commit/64d8e25bf6efe5f18b032563521c3ce278c316ab
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
1430 |
40 | 1431 *autocmd-changes* |
7 | 1432 Matching with the pattern is done when an event is triggered. Changing the |
1433 buffer name in one of the autocommands, or even deleting the buffer, does not | |
1434 change which autocommands will be executed. Example: > | |
1435 | |
1436 au BufEnter *.foo bdel | |
1437 au BufEnter *.foo set modified | |
1438 | |
1439 This will delete the current buffer and then set 'modified' in what has become | |
1440 the current buffer instead. Vim doesn't take into account that "*.foo" | |
1441 doesn't match with that buffer name. It matches "*.foo" with the name of the | |
1442 buffer at the moment the event was triggered. | |
1443 | |
40 | 1444 However, buffer-local autocommands will not be executed for a buffer that has |
1445 been wiped out with |:bwipe|. After deleting the buffer with |:bdel| the | |
1446 buffer actually still exists (it becomes unlisted), thus the autocommands are | |
1447 still executed. | |
1448 | |
7 | 1449 ============================================================================== |
856 | 1450 7. Buffer-local autocommands *autocmd-buflocal* *autocmd-buffer-local* |
1451 *<buffer=N>* *<buffer=abuf>* *E680* | |
40 | 1452 |
1453 Buffer-local autocommands are attached to a specific buffer. They are useful | |
1454 if the buffer does not have a name and when the name does not match a specific | |
1455 pattern. But it also means they must be explicitly added to each buffer. | |
1456 | |
1457 Instead of a pattern buffer-local autocommands use one of these forms: | |
1458 <buffer> current buffer | |
1459 <buffer=99> buffer number 99 | |
1460 <buffer=abuf> using <abuf> (only when executing autocommands) | |
1461 |<abuf>| | |
1462 | |
1463 Examples: > | |
1464 :au CursorHold <buffer> echo 'hold' | |
1465 :au CursorHold <buffer=33> echo 'hold' | |
7051
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
7013
diff
changeset
|
1466 :au BufNewFile * au CursorHold <buffer=abuf> echo 'hold' |
40 | 1467 |
1468 All the commands for autocommands also work with buffer-local autocommands, | |
1469 simply use the special string instead of the pattern. Examples: > | |
856 | 1470 :au! * <buffer> " remove buffer-local autocommands for |
1471 " current buffer | |
1472 :au! * <buffer=33> " remove buffer-local autocommands for | |
1473 " buffer #33 | |
1621 | 1474 :bufdo :au! CursorHold <buffer> " remove autocmd for given event for all |
856 | 1475 " buffers |
1476 :au * <buffer> " list buffer-local autocommands for | |
1477 " current buffer | |
40 | 1478 |
1479 Note that when an autocommand is defined for the current buffer, it is stored | |
1480 with the buffer number. Thus it uses the form "<buffer=12>", where 12 is the | |
1481 number of the current buffer. You will see this when listing autocommands, | |
1482 for example. | |
1483 | |
1484 To test for presence of buffer-local autocommands use the |exists()| function | |
1485 as follows: > | |
1486 :if exists("#CursorHold#<buffer=12>") | ... | endif | |
1487 :if exists("#CursorHold#<buffer>") | ... | endif " for current buffer | |
1488 | |
1489 When a buffer is wiped out its buffer-local autocommands are also gone, of | |
1490 course. Note that when deleting a buffer, e.g., with ":bdel", it is only | |
1491 unlisted, the autocommands are still present. In order to see the removal of | |
1492 buffer-local autocommands: > | |
1493 :set verbose=6 | |
1494 | |
1495 It is not possible to define buffer-local autocommands for a non-existent | |
1496 buffer. | |
1497 | |
1498 ============================================================================== | |
1499 8. Groups *autocmd-groups* | |
7 | 1500 |
1501 Autocommands can be put together in a group. This is useful for removing or | |
1502 executing a group of autocommands. For example, all the autocommands for | |
1503 syntax highlighting are put in the "highlight" group, to be able to execute | |
1504 ":doautoall highlight BufRead" when the GUI starts. | |
1505 | |
1506 When no specific group is selected, Vim uses the default group. The default | |
1507 group does not have a name. You cannot execute the autocommands from the | |
1508 default group separately; you can execute them only by executing autocommands | |
1509 for all groups. | |
1510 | |
1511 Normally, when executing autocommands automatically, Vim uses the autocommands | |
1512 for all groups. The group only matters when executing autocommands with | |
1513 ":doautocmd" or ":doautoall", or when defining or deleting autocommands. | |
1514 | |
1515 The group name can contain any characters except white space. The group name | |
1516 "end" is reserved (also in uppercase). | |
1517 | |
1518 The group name is case sensitive. Note that this is different from the event | |
1519 name! | |
1520 | |
1521 *:aug* *:augroup* | |
1522 :aug[roup] {name} Define the autocmd group name for the | |
1523 following ":autocmd" commands. The name "end" | |
1524 or "END" selects the default group. | |
7384
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
1525 To avoid confusion, the name should be |
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
1526 different from existing {event} names, as this |
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
1527 most likely will not do what you intended. |
7 | 1528 |
10140
b11ceef7116e
commit https://github.com/vim/vim/commit/64d8e25bf6efe5f18b032563521c3ce278c316ab
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
1529 *:augroup-delete* *E367* *W19* *E936* |
7 | 1530 :aug[roup]! {name} Delete the autocmd group {name}. Don't use |
1531 this if there is still an autocommand using | |
9737
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9653
diff
changeset
|
1532 this group! You will get a warning if doing |
21676 | 1533 it anyway. When the group is the current |
1534 group you will get error E936. | |
7 | 1535 |
1536 To enter autocommands for a specific group, use this method: | |
1537 1. Select the group with ":augroup {name}". | |
1538 2. Delete any old autocommands with ":au!". | |
1539 3. Define the autocommands. | |
1540 4. Go back to the default group with "augroup END". | |
1541 | |
1542 Example: > | |
1543 :augroup uncompress | |
1544 : au! | |
1545 : au BufEnter *.gz %!gunzip | |
1546 :augroup END | |
1547 | |
1548 This prevents having the autocommands defined twice (e.g., after sourcing the | |
1549 .vimrc file again). | |
1550 | |
25880 | 1551 *FileExplorer* |
1552 There is one group that is recognized by Vim: FileExplorer. If this group | |
1553 exists Vim assumes that editing a directory is possible and will trigger a | |
1554 plugin that lists the files in that directory. This is used by the |netrw| | |
1555 plugin. This allows you to do: > | |
1556 browse edit | |
1557 | |
7 | 1558 ============================================================================== |
40 | 1559 9. Executing autocommands *autocmd-execute* |
7 | 1560 |
1561 Vim can also execute Autocommands non-automatically. This is useful if you | |
1562 have changed autocommands, or when Vim has executed the wrong autocommands | |
1563 (e.g., the file pattern match was wrong). | |
1564 | |
1565 Note that the 'eventignore' option applies here too. Events listed in this | |
1566 option will not cause any commands to be executed. | |
1567 | |
16944 | 1568 *:do* *:doau* *:doaut* *:doautocmd* *E217* |
3356 | 1569 :do[autocmd] [<nomodeline>] [group] {event} [fname] |
7 | 1570 Apply the autocommands matching [fname] (default: |
1571 current file name) for {event} to the current buffer. | |
1572 You can use this when the current file name does not | |
1573 match the right pattern, after changing settings, or | |
1574 to execute autocommands for a certain event. | |
1575 It's possible to use this inside an autocommand too, | |
1576 so you can base the autocommands for one extension on | |
1577 another extension. Example: > | |
3224 | 1578 :au BufEnter *.cpp so ~/.vimrc_cpp |
1579 :au BufEnter *.cpp doau BufEnter x.c | |
7 | 1580 < Be careful to avoid endless loops. See |
1581 |autocmd-nested|. | |
1582 | |
1583 When the [group] argument is not given, Vim executes | |
1584 the autocommands for all groups. When the [group] | |
1585 argument is included, Vim executes only the matching | |
1586 autocommands for that group. Note: if you use an | |
1587 undefined group name, Vim gives you an error message. | |
3350 | 1588 *<nomodeline>* |
1589 After applying the autocommands the modelines are | |
1590 processed, so that their settings overrule the | |
1591 settings from autocommands, like what happens when | |
1592 editing a file. This is skipped when the <nomodeline> | |
1593 argument is present. You probably want to use | |
1594 <nomodeline> for events that are not used when loading | |
1595 a buffer, such as |User|. | |
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
1596 Processing modelines is also skipped when no |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
1597 matching autocommands were executed. |
7 | 1598 |
1599 *:doautoa* *:doautoall* | |
3342 | 1600 :doautoa[ll] [<nomodeline>] [group] {event} [fname] |
7 | 1601 Like ":doautocmd", but apply the autocommands to each |
24278 | 1602 loaded buffer. The current buffer is done last. |
1603 | |
1604 Note that [fname] is used to select the autocommands, | |
24569 | 1605 not the buffers to which they are applied. Example: > |
1606 augroup mine | |
1607 autocmd! | |
1608 autocmd FileType * echo expand('<amatch>') | |
1609 augroup END | |
1610 doautoall mine FileType Loaded-Buffer | |
1611 < Sourcing this script, you'll see as many | |
1612 "Loaded-Buffer" echoed as there are loaded buffers. | |
24278 | 1613 |
7 | 1614 Careful: Don't use this for autocommands that delete a |
1615 buffer, change to another buffer or change the | |
1616 contents of a buffer; the result is unpredictable. | |
1617 This command is intended for autocommands that set | |
1618 options, change highlighting, and things like that. | |
1619 | |
1620 ============================================================================== | |
40 | 1621 10. Using autocommands *autocmd-use* |
7 | 1622 |
1623 For WRITING FILES there are four possible sets of events. Vim uses only one | |
1624 of these sets for a write command: | |
1625 | |
1626 BufWriteCmd BufWritePre BufWritePost writing the whole buffer | |
1627 FilterWritePre FilterWritePost writing to filter temp file | |
1628 FileAppendCmd FileAppendPre FileAppendPost appending to a file | |
1629 FileWriteCmd FileWritePre FileWritePost any other file write | |
1630 | |
1631 When there is a matching "*Cmd" autocommand, it is assumed it will do the | |
1632 writing. No further writing is done and the other events are not triggered. | |
1633 |Cmd-event| | |
1634 | |
1635 Note that the *WritePost commands should undo any changes to the buffer that | |
1636 were caused by the *WritePre commands; otherwise, writing the file will have | |
1637 the side effect of changing the buffer. | |
1638 | |
1639 Before executing the autocommands, the buffer from which the lines are to be | |
1640 written temporarily becomes the current buffer. Unless the autocommands | |
1641 change the current buffer or delete the previously current buffer, the | |
1642 previously current buffer is made the current buffer again. | |
1643 | |
1644 The *WritePre and *AppendPre autocommands must not delete the buffer from | |
1645 which the lines are to be written. | |
1646 | |
1647 The '[ and '] marks have a special position: | |
1648 - Before the *ReadPre event the '[ mark is set to the line just above where | |
1649 the new lines will be inserted. | |
1650 - Before the *ReadPost event the '[ mark is set to the first line that was | |
1651 just read, the '] mark to the last line. | |
26 | 1652 - Before executing the *WriteCmd, *WritePre and *AppendPre autocommands the '[ |
1653 mark is set to the first line that will be written, the '] mark to the last | |
1654 line. | |
7 | 1655 Careful: '[ and '] change when using commands that change the buffer. |
1656 | |
1657 In commands which expect a file name, you can use "<afile>" for the file name | |
1658 that is being read |:<afile>| (you can also use "%" for the current file | |
1659 name). "<abuf>" can be used for the buffer number of the currently effective | |
14123 | 1660 buffer. This also works for buffers that don't have a name. But it doesn't |
7 | 1661 work for files without a buffer (e.g., with ":r file"). |
1662 | |
1663 *gzip-example* | |
1664 Examples for reading and writing compressed files: > | |
1665 :augroup gzip | |
1666 : autocmd! | |
1667 : autocmd BufReadPre,FileReadPre *.gz set bin | |
1668 : autocmd BufReadPost,FileReadPost *.gz '[,']!gunzip | |
1669 : autocmd BufReadPost,FileReadPost *.gz set nobin | |
27903 | 1670 : autocmd BufReadPost,FileReadPost *.gz execute ":doautocmd BufReadPost " .. expand("%:r") |
7 | 1671 : autocmd BufWritePost,FileWritePost *.gz !mv <afile> <afile>:r |
1672 : autocmd BufWritePost,FileWritePost *.gz !gzip <afile>:r | |
1673 | |
1674 : autocmd FileAppendPre *.gz !gunzip <afile> | |
1675 : autocmd FileAppendPre *.gz !mv <afile>:r <afile> | |
1676 : autocmd FileAppendPost *.gz !mv <afile> <afile>:r | |
1677 : autocmd FileAppendPost *.gz !gzip <afile>:r | |
1678 :augroup END | |
1679 | |
1680 The "gzip" group is used to be able to delete any existing autocommands with | |
1681 ":autocmd!", for when the file is sourced twice. | |
1682 | |
1683 ("<afile>:r" is the file name without the extension, see |:_%:|) | |
1684 | |
1685 The commands executed for the BufNewFile, BufRead/BufReadPost, BufWritePost, | |
1686 FileAppendPost and VimLeave events do not set or reset the changed flag of the | |
1687 buffer. When you decompress the buffer with the BufReadPost autocommands, you | |
1688 can still exit with ":q". When you use ":undo" in BufWritePost to undo the | |
1689 changes made by BufWritePre commands, you can still do ":q" (this also makes | |
1690 "ZZ" work). If you do want the buffer to be marked as modified, set the | |
1691 'modified' option. | |
1692 | |
1693 To execute Normal mode commands from an autocommand, use the ":normal" | |
1694 command. Use with care! If the Normal mode command is not finished, the user | |
1695 needs to type characters (e.g., after ":normal m" you need to type a mark | |
1696 name). | |
1697 | |
1698 If you want the buffer to be unmodified after changing it, reset the | |
1699 'modified' option. This makes it possible to exit the buffer with ":q" | |
1700 instead of ":q!". | |
1701 | |
1702 *autocmd-nested* *E218* | |
16023 | 1703 By default, autocommands do not nest. For example, if you use ":e" or ":w" in |
1704 an autocommand, Vim does not execute the BufRead and BufWrite autocommands for | |
7 | 1705 those commands. If you do want this, use the "nested" flag for those commands |
1706 in which you want nesting. For example: > | |
16217
81e6940504e8
patch 8.1.1113: making an autocommand trigger once is not so easy
Bram Moolenaar <Bram@vim.org>
parents:
16023
diff
changeset
|
1707 :autocmd FileChangedShell *.c ++nested e! |
7 | 1708 The nesting is limited to 10 levels to get out of recursive loops. |
1709 | |
1710 It's possible to use the ":au" command in an autocommand. This can be a | |
1711 self-modifying command! This can be useful for an autocommand that should | |
1712 execute only once. | |
1713 | |
590 | 1714 If you want to skip autocommands for one command, use the |:noautocmd| command |
1715 modifier or the 'eventignore' option. | |
7 | 1716 |
1717 Note: When reading a file (with ":read file" or with a filter command) and the | |
1718 last line in the file does not have an <EOL>, Vim remembers this. At the next | |
1719 write (with ":write file" or with a filter command), if the same line is | |
1720 written again as the last line in a file AND 'binary' is set, Vim does not | |
1721 supply an <EOL>. This makes a filter command on the just read lines write the | |
1722 same file as was read, and makes a write command on just filtered lines write | |
1723 the same file as was read from the filter. For example, another way to write | |
1724 a compressed file: > | |
1725 | |
1726 :autocmd FileWritePre *.gz set bin|'[,']!gzip | |
1727 :autocmd FileWritePost *.gz undo|set nobin | |
1728 < | |
1729 *autocommand-pattern* | |
1730 You can specify multiple patterns, separated by commas. Here are some | |
1731 examples: > | |
1732 | |
1733 :autocmd BufRead * set tw=79 nocin ic infercase fo=2croq | |
1734 :autocmd BufRead .letter set tw=72 fo=2tcrq | |
1735 :autocmd BufEnter .letter set dict=/usr/lib/dict/words | |
1736 :autocmd BufLeave .letter set dict= | |
1737 :autocmd BufRead,BufNewFile *.c,*.h set tw=0 cin noic | |
1738 :autocmd BufEnter *.c,*.h abbr FOR for (i = 0; i < 3; ++i)<CR>{<CR>}<Esc>O | |
1739 :autocmd BufLeave *.c,*.h unabbr FOR | |
1740 | |
1741 For makefiles (makefile, Makefile, imakefile, makefile.unix, etc.): > | |
1742 | |
1743 :autocmd BufEnter ?akefile* set include=^s\=include | |
1744 :autocmd BufLeave ?akefile* set include& | |
1745 | |
1746 To always start editing C files at the first function: > | |
1747 | |
1748 :autocmd BufRead *.c,*.h 1;/^{ | |
1749 | |
1750 Without the "1;" above, the search would start from wherever the file was | |
1751 entered, rather than from the start of the file. | |
1752 | |
1753 *skeleton* *template* | |
1754 To read a skeleton (template) file when opening a new file: > | |
1755 | |
1756 :autocmd BufNewFile *.c 0r ~/vim/skeleton.c | |
1757 :autocmd BufNewFile *.h 0r ~/vim/skeleton.h | |
1758 :autocmd BufNewFile *.java 0r ~/vim/skeleton.java | |
1759 | |
1760 To insert the current date and time in a *.html file when writing it: > | |
1761 | |
1762 :autocmd BufWritePre,FileWritePre *.html ks|call LastMod()|'s | |
1763 :fun LastMod() | |
1764 : if line("$") > 20 | |
1765 : let l = 20 | |
1766 : else | |
1767 : let l = line("$") | |
1768 : endif | |
27903 | 1769 : exe "1," .. l .. "g/Last modified: /s/Last modified: .*/Last modified: " .. |
7 | 1770 : \ strftime("%Y %b %d") |
1771 :endfun | |
1772 | |
1773 You need to have a line "Last modified: <date time>" in the first 20 lines | |
1774 of the file for this to work. Vim replaces <date time> (and anything in the | |
1775 same line after it) with the current date and time. Explanation: | |
1776 ks mark current position with mark 's' | |
1777 call LastMod() call the LastMod() function to do the work | |
1778 's return the cursor to the old position | |
1779 The LastMod() function checks if the file is shorter than 20 lines, and then | |
1780 uses the ":g" command to find lines that contain "Last modified: ". For those | |
1781 lines the ":s" command is executed to replace the existing date with the | |
1782 current one. The ":execute" command is used to be able to use an expression | |
1783 for the ":g" and ":s" commands. The date is obtained with the strftime() | |
1784 function. You can change its argument to get another date string. | |
1785 | |
1786 When entering :autocmd on the command-line, completion of events and command | |
1787 names may be done (with <Tab>, CTRL-D, etc.) where appropriate. | |
1788 | |
1789 Vim executes all matching autocommands in the order that you specify them. | |
1790 It is recommended that your first autocommand be used for all files by using | |
1791 "*" as the file pattern. This means that you can define defaults you like | |
1792 here for any settings, and if there is another matching autocommand it will | |
1793 override these. But if there is no other matching autocommand, then at least | |
1794 your default settings are recovered (if entering this file from another for | |
1795 which autocommands did match). Note that "*" will also match files starting | |
1796 with ".", unlike Unix shells. | |
1797 | |
1798 *autocmd-searchpat* | |
1799 Autocommands do not change the current search patterns. Vim saves the current | |
1800 search patterns before executing autocommands then restores them after the | |
1801 autocommands finish. This means that autocommands do not affect the strings | |
1802 highlighted with the 'hlsearch' option. Within autocommands, you can still | |
1803 use search patterns normally, e.g., with the "n" command. | |
1804 If you want an autocommand to set the search pattern, such that it is used | |
1805 after the autocommand finishes, use the ":let @/ =" command. | |
1806 The search-highlighting cannot be switched off with ":nohlsearch" in an | |
1807 autocommand. Use the 'h' flag in the 'viminfo' option to disable search- | |
1808 highlighting when starting Vim. | |
1809 | |
1810 *Cmd-event* | |
1811 When using one of the "*Cmd" events, the matching autocommands are expected to | |
1061 | 1812 do the file reading, writing or sourcing. This can be used when working with |
1813 a special kind of file, for example on a remote system. | |
7 | 1814 CAREFUL: If you use these events in a wrong way, it may have the effect of |
1815 making it impossible to read or write the matching files! Make sure you test | |
1816 your autocommands properly. Best is to use a pattern that will never match a | |
1817 normal file name, for example "ftp://*". | |
1818 | |
1819 When defining a BufReadCmd it will be difficult for Vim to recover a crashed | |
1820 editing session. When recovering from the original file, Vim reads only those | |
1821 parts of a file that are not found in the swap file. Since that is not | |
1822 possible with a BufReadCmd, use the |:preserve| command to make sure the | |
1823 original file isn't needed for recovery. You might want to do this only when | |
1824 you expect the file to be modified. | |
1825 | |
1061 | 1826 For file read and write commands the |v:cmdarg| variable holds the "++enc=" |
1827 and "++ff=" argument that are effective. These should be used for the command | |
1828 that reads/writes the file. The |v:cmdbang| variable is one when "!" was | |
1829 used, zero otherwise. | |
7 | 1830 |
2377
878562053ba3
Update Fortran indent and syntax file. (Ajit Thakkar)
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
1831 See the $VIMRUNTIME/plugin/netrwPlugin.vim for examples. |
7 | 1832 |
590 | 1833 ============================================================================== |
1834 11. Disabling autocommands *autocmd-disable* | |
1835 | |
1836 To disable autocommands for some time use the 'eventignore' option. Note that | |
1837 this may cause unexpected behavior, make sure you restore 'eventignore' | |
1838 afterwards, using a |:try| block with |:finally|. | |
1839 | |
1840 *:noautocmd* *:noa* | |
1841 To disable autocommands for just one command use the ":noautocmd" command | |
1842 modifier. This will set 'eventignore' to "all" for the duration of the | |
1843 following command. Example: > | |
1844 | |
1845 :noautocmd w fname.gz | |
1846 | |
1847 This will write the file without triggering the autocommands defined by the | |
1848 gzip plugin. | |
1849 | |
16023 | 1850 Note that some autocommands are not triggered right away, but only later. |
1851 This specifically applies to |CursorMoved| and |TextChanged|. | |
1852 | |
40 | 1853 |
14421 | 1854 vim:tw=78:ts=8:noet:ft=help:norl: |