Mercurial > vim
annotate runtime/doc/autocmd.txt @ 9599:42a8a81decdf v7.4.2077
commit https://github.com/vim/vim/commit/12c11d553053f5a9eae9eb3c518279b12fa928c2
Author: Bram Moolenaar <Bram@vim.org>
Date: Tue Jul 19 23:13:03 2016 +0200
patch 7.4.2077
Problem: Cannot update 'tabline' when a tab was closed.
Solution: Add the TabClosed autocmd event. (partly by Felipe Morales)
author | Christian Brabandt <cb@256bit.org> |
---|---|
date | Tue, 19 Jul 2016 23:15:06 +0200 |
parents | 0190d5de215f |
children | 01c9630e80e0 |
rev | line source |
---|---|
9599
42a8a81decdf
commit https://github.com/vim/vim/commit/12c11d553053f5a9eae9eb3c518279b12fa928c2
Christian Brabandt <cb@256bit.org>
parents:
9595
diff
changeset
|
1 *autocmd.txt* For Vim version 7.4. Last change: 2016 Jul 19 |
7 | 2 |
3 | |
4 VIM REFERENCE MANUAL by Bram Moolenaar | |
5 | |
6 | |
7 Automatic commands *autocommand* | |
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 {Vi does not have any of these commands} | |
24 {only when the |+autocmd| feature has not been disabled at compile time} | |
25 | |
26 ============================================================================== | |
27 1. Introduction *autocmd-intro* | |
28 | |
22 | 29 You can specify commands to be executed automatically when reading or writing |
30 a file, when entering or leaving a buffer or window, and when exiting Vim. | |
31 For example, you can create an autocommand to set the 'cindent' option for | |
32 files matching *.c. You can also use autocommands to implement advanced | |
7 | 33 features, such as editing compressed files (see |gzip-example|). The usual |
34 place to put autocommands is in your .vimrc or .exrc file. | |
35 | |
3371 | 36 *E203* *E204* *E143* *E855* |
7 | 37 WARNING: Using autocommands is very powerful, and may lead to unexpected side |
38 effects. Be careful not to destroy your text. | |
39 - It's a good idea to do some testing on an expendable copy of a file first. | |
40 For example: If you use autocommands to decompress a file when starting to | |
41 edit it, make sure that the autocommands for compressing when writing work | |
42 correctly. | |
43 - Be prepared for an error halfway through (e.g., disk full). Vim will mostly | |
44 be able to undo the changes to the buffer, but you may have to clean up the | |
45 changes to other files by hand (e.g., compress a file that has been | |
46 decompressed). | |
47 - If the BufRead* events allow you to edit a compressed file, the FileRead* | |
48 events should do the same (this makes recovery possible in some rare cases). | |
49 It's a good idea to use the same autocommands for the File* and Buf* events | |
50 when possible. | |
51 | |
52 ============================================================================== | |
53 2. Defining autocommands *autocmd-define* | |
54 | |
55 Note: The ":autocmd" command cannot be followed by another command, since any | |
56 '|' is considered part of the command. | |
57 | |
58 *:au* *:autocmd* | |
59 :au[tocmd] [group] {event} {pat} [nested] {cmd} | |
60 Add {cmd} to the list of commands that Vim will | |
61 execute automatically on {event} for a file matching | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1919
diff
changeset
|
62 {pat} |autocmd-patterns|. |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1919
diff
changeset
|
63 Vim always adds the {cmd} after existing autocommands, |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1919
diff
changeset
|
64 so that the autocommands execute in the order in which |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1919
diff
changeset
|
65 they were given. See |autocmd-nested| for [nested]. |
7 | 66 |
40 | 67 The special pattern <buffer> or <buffer=N> defines a buffer-local autocommand. |
68 See |autocmd-buflocal|. | |
69 | |
7 | 70 Note that special characters (e.g., "%", "<cword>") in the ":autocmd" |
71 arguments are not expanded when the autocommand is defined. These will be | |
72 expanded when the Event is recognized, and the {cmd} is executed. The only | |
73 exception is that "<sfile>" is expanded when the autocmd is defined. Example: | |
74 > | |
75 :au BufNewFile,BufRead *.html so <sfile>:h/html.vim | |
76 | |
77 Here Vim expands <sfile> to the name of the file containing this line. | |
78 | |
79 When your .vimrc file is sourced twice, the autocommands will appear twice. | |
80 To avoid this, put this command in your .vimrc file, before defining | |
81 autocommands: > | |
82 | |
83 :autocmd! " Remove ALL autocommands for the current group. | |
84 | |
85 If you don't want to remove all autocommands, you can instead use a variable | |
86 to ensure that Vim includes the autocommands only once: > | |
87 | |
88 :if !exists("autocommands_loaded") | |
89 : let autocommands_loaded = 1 | |
90 : au ... | |
91 :endif | |
92 | |
93 When the [group] argument is not given, Vim uses the current group (as defined | |
94 with ":augroup"); otherwise, Vim uses the group defined with [group]. Note | |
95 that [group] must have been defined before. You cannot define a new group | |
96 with ":au group ..."; use ":augroup" for that. | |
97 | |
98 While testing autocommands, you might find the 'verbose' option to be useful: > | |
99 :set verbose=9 | |
100 This setting makes Vim echo the autocommands as it executes them. | |
101 | |
102 When defining an autocommand in a script, it will be able to call functions | |
103 local to the script and use mappings local to the script. When the event is | |
104 triggered and the command executed, it will run in the context of the script | |
105 it was defined in. This matters if |<SID>| is used in a command. | |
106 | |
1621 | 107 When executing the commands, the message from one command overwrites a |
7 | 108 previous message. This is different from when executing the commands |
109 manually. Mostly the screen will not scroll up, thus there is no hit-enter | |
110 prompt. When one command outputs two messages this can happen anyway. | |
111 | |
112 ============================================================================== | |
113 3. Removing autocommands *autocmd-remove* | |
114 | |
115 :au[tocmd]! [group] {event} {pat} [nested] {cmd} | |
116 Remove all autocommands associated with {event} and | |
117 {pat}, and add the command {cmd}. See | |
118 |autocmd-nested| for [nested]. | |
119 | |
120 :au[tocmd]! [group] {event} {pat} | |
121 Remove all autocommands associated with {event} and | |
122 {pat}. | |
123 | |
124 :au[tocmd]! [group] * {pat} | |
125 Remove all autocommands associated with {pat} for all | |
126 events. | |
127 | |
128 :au[tocmd]! [group] {event} | |
129 Remove ALL autocommands for {event}. | |
130 | |
131 :au[tocmd]! [group] Remove ALL autocommands. | |
132 | |
133 When the [group] argument is not given, Vim uses the current group (as defined | |
134 with ":augroup"); otherwise, Vim uses the group defined with [group]. | |
135 | |
136 ============================================================================== | |
137 4. Listing autocommands *autocmd-list* | |
138 | |
139 :au[tocmd] [group] {event} {pat} | |
140 Show the autocommands associated with {event} and | |
141 {pat}. | |
142 | |
143 :au[tocmd] [group] * {pat} | |
144 Show the autocommands associated with {pat} for all | |
145 events. | |
146 | |
147 :au[tocmd] [group] {event} | |
148 Show all autocommands for {event}. | |
149 | |
150 :au[tocmd] [group] Show all autocommands. | |
151 | |
152 If you provide the [group] argument, Vim lists only the autocommands for | |
153 [group]; otherwise, Vim lists the autocommands for ALL groups. Note that this | |
154 argument behavior differs from that for defining and removing autocommands. | |
155 | |
40 | 156 In order to list buffer-local autocommands, use a pattern in the form <buffer> |
157 or <buffer=N>. See |autocmd-buflocal|. | |
158 | |
500 | 159 *:autocmd-verbose* |
160 When 'verbose' is non-zero, listing an autocommand will also display where it | |
161 was last defined. Example: > | |
162 | |
163 :verbose autocmd BufEnter | |
164 FileExplorer BufEnter | |
856 | 165 * call s:LocalBrowse(expand("<amatch>")) |
500 | 166 Last set from /usr/share/vim/vim-7.0/plugin/NetrwPlugin.vim |
167 < | |
168 See |:verbose-cmd| for more information. | |
169 | |
7 | 170 ============================================================================== |
171 5. Events *autocmd-events* *E215* *E216* | |
172 | |
579 | 173 You can specify a comma-separated list of event names. No white space can be |
174 used in this list. The command applies to all the events in the list. | |
175 | |
176 For READING FILES there are four kinds of events possible: | |
177 BufNewFile starting to edit a non-existent file | |
178 BufReadPre BufReadPost starting to edit an existing file | |
179 FilterReadPre FilterReadPost read the temp file with filter output | |
180 FileReadPre FileReadPost any other file read | |
181 Vim uses only one of these four kinds when reading a file. The "Pre" and | |
182 "Post" events are both triggered, before and after reading the file. | |
183 | |
184 Note that the autocommands for the *ReadPre events and all the Filter events | |
185 are not allowed to change the current buffer (you will get an error message if | |
186 this happens). This is to prevent the file to be read into the wrong buffer. | |
187 | |
188 Note that the 'modified' flag is reset AFTER executing the BufReadPost | |
189 and BufNewFile autocommands. But when the 'modified' option was set by the | |
190 autocommands, this doesn't happen. | |
191 | |
192 You can use the 'eventignore' option to ignore a number of events or all | |
193 events. | |
7 | 194 *autocommand-events* *{event}* |
195 Vim recognizes the following events. Vim ignores the case of event names | |
196 (e.g., you can use "BUFread" or "bufread" instead of "BufRead"). | |
197 | |
579 | 198 First an overview by function with a short explanation. Then the list |
843 | 199 alphabetically with full explanations |autocmd-events-abc|. |
579 | 200 |
201 Name triggered by ~ | |
202 | |
203 Reading | |
204 |BufNewFile| starting to edit a file that doesn't exist | |
205 |BufReadPre| starting to edit a new buffer, before reading the file | |
206 |BufRead| starting to edit a new buffer, after reading the file | |
207 |BufReadPost| starting to edit a new buffer, after reading the file | |
208 |BufReadCmd| before starting to edit a new buffer |Cmd-event| | |
209 | |
210 |FileReadPre| before reading a file with a ":read" command | |
211 |FileReadPost| after reading a file with a ":read" command | |
843 | 212 |FileReadCmd| before reading a file with a ":read" command |Cmd-event| |
579 | 213 |
214 |FilterReadPre| before reading a file from a filter command | |
215 |FilterReadPost| after reading a file from a filter command | |
216 | |
217 |StdinReadPre| before reading from stdin into the buffer | |
218 |StdinReadPost| After reading from the stdin into the buffer | |
219 | |
220 Writing | |
221 |BufWrite| starting to write the whole buffer to a file | |
222 |BufWritePre| starting to write the whole buffer to a file | |
223 |BufWritePost| after writing the whole buffer to a file | |
224 |BufWriteCmd| before writing the whole buffer to a file |Cmd-event| | |
225 | |
226 |FileWritePre| starting to write part of a buffer to a file | |
227 |FileWritePost| after writing part of a buffer to a file | |
228 |FileWriteCmd| before writing part of a buffer to a file |Cmd-event| | |
229 | |
230 |FileAppendPre| starting to append to a file | |
231 |FileAppendPost| after appending to a file | |
232 |FileAppendCmd| before appending to a file |Cmd-event| | |
233 | |
234 |FilterWritePre| starting to write a file for a filter command or diff | |
235 |FilterWritePost| after writing a file for a filter command or diff | |
236 | |
237 Buffers | |
238 |BufAdd| just after adding a buffer to the buffer list | |
239 |BufCreate| just after adding a buffer to the buffer list | |
240 |BufDelete| before deleting a buffer from the buffer list | |
241 |BufWipeout| before completely deleting a buffer | |
242 | |
243 |BufFilePre| before changing the name of the current buffer | |
244 |BufFilePost| after changing the name of the current buffer | |
245 | |
246 |BufEnter| after entering a buffer | |
247 |BufLeave| before leaving to another buffer | |
248 |BufWinEnter| after a buffer is displayed in a window | |
249 |BufWinLeave| before a buffer is removed from a window | |
250 | |
251 |BufUnload| before unloading a buffer | |
252 |BufHidden| just after a buffer has become hidden | |
253 |BufNew| just after creating a new buffer | |
254 | |
255 |SwapExists| detected an existing swap file | |
256 | |
257 Options | |
258 |FileType| when the 'filetype' option has been set | |
259 |Syntax| when the 'syntax' option has been set | |
260 |EncodingChanged| after the 'encoding' option has been changed | |
261 |TermChanged| after the value of 'term' has changed | |
6935 | 262 |OptionSet| after setting any option |
579 | 263 |
264 Startup and exit | |
265 |VimEnter| after doing all the startup stuff | |
266 |GUIEnter| after starting the GUI successfully | |
3830 | 267 |GUIFailed| after starting the GUI failed |
1154 | 268 |TermResponse| after the terminal response to |t_RV| is received |
579 | 269 |
4119 | 270 |QuitPre| when using `:quit`, before deciding whether to quit |
579 | 271 |VimLeavePre| before exiting Vim, before writing the viminfo file |
272 |VimLeave| before exiting Vim, after writing the viminfo file | |
273 | |
274 Various | |
275 |FileChangedShell| Vim notices that a file changed since editing started | |
766 | 276 |FileChangedShellPost| After handling a file changed since editing started |
579 | 277 |FileChangedRO| before making the first change to a read-only file |
278 | |
724 | 279 |ShellCmdPost| after executing a shell command |
280 |ShellFilterPost| after filtering with a shell command | |
281 | |
6154 | 282 |CmdUndefined| a user command is used but it isn't defined |
579 | 283 |FuncUndefined| a user function is used but it isn't defined |
650 | 284 |SpellFileMissing| a spell file is used but it can't be found |
716 | 285 |SourcePre| before sourcing a Vim script |
1061 | 286 |SourceCmd| before sourcing a Vim script |Cmd-event| |
579 | 287 |
766 | 288 |VimResized| after the Vim window size changed |
579 | 289 |FocusGained| Vim got input focus |
290 |FocusLost| Vim lost input focus | |
291 |CursorHold| the user doesn't press a key for a while | |
661 | 292 |CursorHoldI| the user doesn't press a key for a while in Insert mode |
293 |CursorMoved| the cursor was moved in Normal mode | |
294 |CursorMovedI| the cursor was moved in Insert mode | |
579 | 295 |
9595
0190d5de215f
commit https://github.com/vim/vim/commit/c917da4b3e8801a255dbefea8e4ed19c1c716dd8
Christian Brabandt <cb@256bit.org>
parents:
9286
diff
changeset
|
296 |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
|
297 |TabNew| after creating a new tab page |
42a8a81decdf
commit https://github.com/vim/vim/commit/12c11d553053f5a9eae9eb3c518279b12fa928c2
Christian Brabandt <cb@256bit.org>
parents:
9595
diff
changeset
|
298 |TabClosed| after closing a tab page |
579 | 299 |WinEnter| after entering another window |
300 |WinLeave| before leaving a window | |
677 | 301 |TabEnter| after entering another tab page |
302 |TabLeave| before leaving a tab page | |
579 | 303 |CmdwinEnter| after entering the command-line window |
304 |CmdwinLeave| before leaving the command-line window | |
305 | |
306 |InsertEnter| starting Insert mode | |
307 |InsertChange| when typing <Insert> while in Insert or Replace mode | |
308 |InsertLeave| when leaving Insert mode | |
2845 | 309 |InsertCharPre| when a character was typed in Insert mode, before |
310 inserting it | |
579 | 311 |
5555 | 312 |TextChanged| after a change was made to the text in Normal mode |
313 |TextChangedI| after a change was made to the text in Insert mode | |
314 | |
579 | 315 |ColorScheme| after loading a color scheme |
316 | |
317 |RemoteReply| a reply from a server Vim was received | |
318 | |
319 |QuickFixCmdPre| before a quickfix command is run | |
320 |QuickFixCmdPost| after a quickfix command is run | |
321 | |
322 |SessionLoadPost| after loading a session file | |
323 | |
324 |MenuPopup| just before showing the popup menu | |
3830 | 325 |CompleteDone| after Insert mode completion is done |
579 | 326 |
327 |User| to be used in combination with ":doautocmd" | |
328 | |
329 | |
330 The alphabetical list of autocommand events: *autocmd-events-abc* | |
331 | |
332 *BufCreate* *BufAdd* | |
333 BufAdd or BufCreate Just after creating a new buffer which is | |
334 added to the buffer list, or adding a buffer | |
335 to the buffer list. | |
336 Also used just after a buffer in the buffer | |
337 list has been renamed. | |
338 The BufCreate event is for historic reasons. | |
339 NOTE: When this autocommand is executed, the | |
340 current buffer "%" may be different from the | |
341 buffer being created "<afile>". | |
342 *BufDelete* | |
343 BufDelete Before deleting a buffer from the buffer list. | |
344 The BufUnload may be called first (if the | |
345 buffer was loaded). | |
346 Also used just before a buffer in the buffer | |
347 list is renamed. | |
348 NOTE: When this autocommand is executed, the | |
349 current buffer "%" may be different from the | |
1621 | 350 buffer being deleted "<afile>" and "<abuf>". |
1919 | 351 Don't change to another buffer, it will cause |
352 problems. | |
579 | 353 *BufEnter* |
354 BufEnter After entering a buffer. Useful for setting | |
355 options for a file type. Also executed when | |
356 starting to edit a buffer, after the | |
357 BufReadPost autocommands. | |
358 *BufFilePost* | |
359 BufFilePost After changing the name of the current buffer | |
360 with the ":file" or ":saveas" command. | |
625 | 361 *BufFilePre* |
579 | 362 BufFilePre Before changing the name of the current buffer |
363 with the ":file" or ":saveas" command. | |
364 *BufHidden* | |
365 BufHidden Just after a buffer has become hidden. That | |
366 is, when there are no longer windows that show | |
367 the buffer, but the buffer is not unloaded or | |
368 deleted. Not used for ":qa" or ":q" when | |
369 exiting Vim. | |
370 NOTE: When this autocommand is executed, the | |
371 current buffer "%" may be different from the | |
372 buffer being unloaded "<afile>". | |
373 *BufLeave* | |
374 BufLeave Before leaving to another buffer. Also when | |
375 leaving or closing the current window and the | |
376 new current window is not for the same buffer. | |
377 Not used for ":qa" or ":q" when exiting Vim. | |
378 *BufNew* | |
379 BufNew Just after creating a new buffer. Also used | |
380 just after a buffer has been renamed. When | |
381 the buffer is added to the buffer list BufAdd | |
382 will be triggered too. | |
383 NOTE: When this autocommand is executed, the | |
384 current buffer "%" may be different from the | |
385 buffer being created "<afile>". | |
7 | 386 *BufNewFile* |
387 BufNewFile When starting to edit a file that doesn't | |
388 exist. Can be used to read in a skeleton | |
389 file. | |
390 *BufRead* *BufReadPost* | |
391 BufRead or BufReadPost When starting to edit a new buffer, after | |
392 reading the file into the buffer, before | |
393 executing the modelines. See |BufWinEnter| | |
394 for when you need to do something after | |
395 processing the modelines. | |
396 This does NOT work for ":r file". Not used | |
397 when the file doesn't exist. Also used after | |
398 successfully recovering a file. | |
3682 | 399 Also triggered for the filetypedetect group |
400 when executing ":filetype detect" and when | |
401 writing an unnamed buffer in a way that the | |
402 buffer gets a name. | |
625 | 403 *BufReadCmd* |
7 | 404 BufReadCmd Before starting to edit a new buffer. Should |
405 read the file into the buffer. |Cmd-event| | |
625 | 406 *BufReadPre* *E200* *E201* |
579 | 407 BufReadPre When starting to edit a new buffer, before |
408 reading the file into the buffer. Not used | |
409 if the file doesn't exist. | |
410 *BufUnload* | |
411 BufUnload Before unloading a buffer. This is when the | |
412 text in the buffer is going to be freed. This | |
413 may be after a BufWritePost and before a | |
414 BufDelete. Also used for all buffers that are | |
415 loaded when Vim is going to exit. | |
416 NOTE: When this autocommand is executed, the | |
417 current buffer "%" may be different from the | |
418 buffer being unloaded "<afile>". | |
1919 | 419 Don't change to another buffer, it will cause |
420 problems. | |
2226
36a9ac99e1ca
Don't execute some autocommands when v:dying is 2 or more.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
421 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
|
422 event is not triggered. |
579 | 423 *BufWinEnter* |
424 BufWinEnter After a buffer is displayed in a window. This | |
425 can be when the buffer is loaded (after | |
1621 | 426 processing the modelines) or when a hidden |
579 | 427 buffer is displayed in a window (and is no |
1621 | 428 longer hidden). |
429 Does not happen for |:split| without | |
430 arguments, since you keep editing the same | |
431 buffer, or ":split" with a file that's already | |
1668 | 432 open in a window, because it re-uses an |
433 existing buffer. But it does happen for a | |
434 ":split" with the name of the current buffer, | |
435 since it reloads that buffer. | |
579 | 436 *BufWinLeave* |
437 BufWinLeave Before a buffer is removed from a window. | |
438 Not when it's still visible in another window. | |
439 Also triggered when exiting. It's triggered | |
440 before BufUnload or BufHidden. | |
441 NOTE: When this autocommand is executed, the | |
442 current buffer "%" may be different from the | |
443 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
|
444 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
|
445 event is not triggered. |
579 | 446 *BufWipeout* |
447 BufWipeout Before completely deleting a buffer. The | |
448 BufUnload and BufDelete events may be called | |
449 first (if the buffer was loaded and was in the | |
450 buffer list). Also used just before a buffer | |
451 is renamed (also when it's not in the buffer | |
452 list). | |
453 NOTE: When this autocommand is executed, the | |
454 current buffer "%" may be different from the | |
455 buffer being deleted "<afile>". | |
1919 | 456 Don't change to another buffer, it will cause |
457 problems. | |
7 | 458 *BufWrite* *BufWritePre* |
459 BufWrite or BufWritePre Before writing the whole buffer to a file. | |
460 *BufWriteCmd* | |
461 BufWriteCmd Before writing the whole buffer to a file. | |
462 Should do the writing of the file and reset | |
39 | 463 'modified' if successful, unless '+' is in |
464 'cpo' and writing to another file |cpo-+|. | |
465 The buffer contents should not be changed. | |
3082 | 466 When the command resets 'modified' the undo |
467 information is adjusted to mark older undo | |
468 states as 'modified', like |:write| does. | |
39 | 469 |Cmd-event| |
579 | 470 *BufWritePost* |
471 BufWritePost After writing the whole buffer to a file | |
472 (should undo the commands for BufWritePre). | |
6154 | 473 *CmdUndefined* |
474 CmdUndefined When a user command is used but it isn't | |
475 defined. Useful for defining a command only | |
476 when it's used. The pattern is matched | |
477 against the command name. Both <amatch> and | |
478 <afile> are set to the name of the command. | |
479 NOTE: Autocompletion won't work until the | |
480 command is defined. An alternative is to | |
481 always define the user command and have it | |
482 invoke an autoloaded function. See |autoload|. | |
579 | 483 *CmdwinEnter* |
484 CmdwinEnter After entering the command-line window. | |
485 Useful for setting options specifically for | |
486 this special type of window. This is | |
487 triggered _instead_ of BufEnter and WinEnter. | |
488 <afile> is set to a single character, | |
489 indicating the type of command-line. | |
490 |cmdwin-char| | |
491 *CmdwinLeave* | |
492 CmdwinLeave Before leaving the command-line window. | |
493 Useful to clean up any global setting done | |
494 with CmdwinEnter. This is triggered _instead_ | |
495 of BufLeave and WinLeave. | |
496 <afile> is set to a single character, | |
497 indicating the type of command-line. | |
498 |cmdwin-char| | |
499 *ColorScheme* | |
500 ColorScheme After loading a color scheme. |:colorscheme| | |
5521 | 501 The pattern is matched against the |
502 colorscheme name. <afile> can be used for the | |
503 name of the actual file where this option was | |
504 set, and <amatch> for the new colorscheme | |
505 name. | |
506 | |
661 | 507 |
3682 | 508 *CompleteDone* |
509 CompleteDone After Insert mode completion is done. Either | |
510 when something was completed or abandoning | |
511 completion. |ins-completion| | |
6909 | 512 The |v:completed_item| variable contains |
513 information about the completed item. | |
3682 | 514 |
579 | 515 *CursorHold* |
516 CursorHold When the user doesn't press a key for the time | |
517 specified with 'updatetime'. Not re-triggered | |
518 until the user has pressed a key (i.e. doesn't | |
519 fire every 'updatetime' ms if you leave Vim to | |
520 make some coffee. :) See |CursorHold-example| | |
521 for previewing tags. | |
522 This event is only triggered in Normal mode. | |
1154 | 523 It is not triggered when waiting for a command |
524 argument to be typed, or a movement after an | |
525 operator. | |
610 | 526 While recording the CursorHold event is not |
527 triggered. |q| | |
6259 | 528 *<CursorHold>* |
529 Internally the autocommand is triggered by the | |
530 <CursorHold> key. In an expression mapping | |
531 |getchar()| may see this character. | |
532 | |
579 | 533 Note: Interactive commands cannot be used for |
534 this event. There is no hit-enter prompt, | |
535 the screen is updated directly (when needed). | |
536 Note: In the future there will probably be | |
537 another option to set the time. | |
538 Hint: to force an update of the status lines | |
539 use: > | |
540 :let &ro = &ro | |
541 < {only on Amiga, Unix, Win32, MSDOS and all GUI | |
542 versions} | |
661 | 543 *CursorHoldI* |
544 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
|
545 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
|
546 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
|
547 |insert_expand|. |
661 | 548 |
549 *CursorMoved* | |
4911 | 550 CursorMoved After the cursor was moved in Normal or Visual |
551 mode. Also when the text of the cursor line | |
552 has been changed, e.g., with "x", "rx" or "p". | |
661 | 553 Not triggered when there is typeahead or when |
554 an operator is pending. | |
667 | 555 For an example see |match-parens|. |
4264 | 556 Careful: This is triggered very often, don't |
557 do anything that the user does not expect or | |
558 that is slow. | |
661 | 559 *CursorMovedI* |
560 CursorMovedI After the cursor was moved in Insert mode. | |
3082 | 561 Not triggered when the popup menu is visible. |
661 | 562 Otherwise the same as CursorMoved. |
579 | 563 *EncodingChanged* |
564 EncodingChanged Fires off after the 'encoding' option has been | |
565 changed. Useful to set up fonts, for example. | |
7 | 566 *FileAppendCmd* |
567 FileAppendCmd Before appending to a file. Should do the | |
26 | 568 appending to the file. Use the '[ and '] |
569 marks for the range of lines.|Cmd-event| | |
579 | 570 *FileAppendPost* |
571 FileAppendPost After appending to a file. | |
572 *FileAppendPre* | |
573 FileAppendPre Before appending to a file. Use the '[ and '] | |
574 marks for the range of lines. | |
575 *FileChangedRO* | |
576 FileChangedRO Before making the first change to a read-only | |
577 file. Can be used to check-out the file from | |
578 a source control system. Not triggered when | |
579 the change was caused by an autocommand. | |
580 This event is triggered when making the first | |
581 change in a buffer or the first change after | |
823 | 582 'readonly' was set, just before the change is |
583 applied to the text. | |
579 | 584 WARNING: If the autocommand moves the cursor |
585 the effect of the change is undefined. | |
819 | 586 *E788* |
587 It is not allowed to change to another buffer | |
588 here. You can reload the buffer but not edit | |
589 another one. | |
5663
1dea14d4c738
Update runtime files. Add support for systemverilog.
Bram Moolenaar <bram@vim.org>
parents:
5555
diff
changeset
|
590 *E881* |
1dea14d4c738
Update runtime files. Add support for systemverilog.
Bram Moolenaar <bram@vim.org>
parents:
5555
diff
changeset
|
591 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
|
592 may fail and the change will be aborted. |
7 | 593 *FileChangedShell* |
594 FileChangedShell When Vim notices that the modification time of | |
595 a file has changed since editing started. | |
596 Also when the file attributes of the file | |
5908 | 597 change or when the size of the file changes. |
598 |timestamp| | |
7 | 599 Mostly triggered after executing a shell |
600 command, but also with a |:checktime| command | |
179 | 601 or when Gvim regains input focus. |
7 | 602 This autocommand is triggered for each changed |
603 file. It is not used when 'autoread' is set | |
604 and the buffer was not changed. If a | |
605 FileChangedShell autocommand is present the | |
606 warning message and prompt is not given. | |
179 | 607 The |v:fcs_reason| variable is set to indicate |
608 what happened and |v:fcs_choice| can be used | |
609 to tell Vim what to do next. | |
7 | 610 NOTE: When this autocommand is executed, the |
611 current buffer "%" may be different from the | |
612 buffer that was changed "<afile>". | |
613 NOTE: The commands must not change the current | |
614 buffer, jump to another buffer or delete a | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1919
diff
changeset
|
615 buffer. *E246* *E811* |
7 | 616 NOTE: This event never nests, to avoid an |
617 endless loop. This means that while executing | |
618 commands for the FileChangedShell event no | |
619 other FileChangedShell event will be | |
620 triggered. | |
766 | 621 *FileChangedShellPost* |
622 FileChangedShellPost After handling a file that was changed outside | |
623 of Vim. Can be used to update the statusline. | |
579 | 624 *FileEncoding* |
625 FileEncoding Obsolete. It still works and is equivalent | |
626 to |EncodingChanged|. | |
627 *FileReadCmd* | |
628 FileReadCmd Before reading a file with a ":read" command. | |
629 Should do the reading of the file. |Cmd-event| | |
630 *FileReadPost* | |
631 FileReadPost After reading a file with a ":read" command. | |
632 Note that Vim sets the '[ and '] marks to the | |
633 first and last line of the read. This can be | |
634 used to operate on the lines just read. | |
635 *FileReadPre* | |
636 FileReadPre Before reading a file with a ":read" command. | |
637 *FileType* | |
1154 | 638 FileType When the 'filetype' option has been set. The |
639 pattern is matched against the filetype. | |
579 | 640 <afile> can be used for the name of the file |
641 where this option was set, and <amatch> for | |
642 the new value of 'filetype'. | |
643 See |filetypes|. | |
644 *FileWriteCmd* | |
645 FileWriteCmd Before writing to a file, when not writing the | |
646 whole buffer. Should do the writing to the | |
647 file. Should not change the buffer. Use the | |
648 '[ and '] marks for the range of lines. | |
649 |Cmd-event| | |
650 *FileWritePost* | |
651 FileWritePost After writing to a file, when not writing the | |
652 whole buffer. | |
653 *FileWritePre* | |
654 FileWritePre Before writing to a file, when not writing the | |
655 whole buffer. Use the '[ and '] marks for the | |
656 range of lines. | |
657 *FilterReadPost* | |
658 FilterReadPost After reading a file from a filter command. | |
659 Vim checks the pattern against the name of | |
660 the current buffer as with FilterReadPre. | |
661 Not triggered when 'shelltemp' is off. | |
662 *FilterReadPre* *E135* | |
663 FilterReadPre Before reading a file from a filter command. | |
664 Vim checks the pattern against the name of | |
665 the current buffer, not the name of the | |
666 temporary file that is the output of the | |
667 filter command. | |
668 Not triggered when 'shelltemp' is off. | |
669 *FilterWritePost* | |
670 FilterWritePost After writing a file for a filter command or | |
671 making a diff. | |
672 Vim checks the pattern against the name of | |
673 the current buffer as with FilterWritePre. | |
674 Not triggered when 'shelltemp' is off. | |
675 *FilterWritePre* | |
676 FilterWritePre Before writing a file for a filter command or | |
677 making a diff. | |
678 Vim checks the pattern against the name of | |
679 the current buffer, not the name of the | |
680 temporary file that is the output of the | |
681 filter command. | |
682 Not triggered when 'shelltemp' is off. | |
7 | 683 *FocusGained* |
684 FocusGained When Vim got input focus. Only for the GUI | |
685 version and a few console versions where this | |
686 can be detected. | |
687 *FocusLost* | |
688 FocusLost When Vim lost input focus. Only for the GUI | |
689 version and a few console versions where this | |
11 | 690 can be detected. May also happen when a |
691 dialog pops up. | |
7 | 692 *FuncUndefined* |
693 FuncUndefined When a user function is used but it isn't | |
694 defined. Useful for defining a function only | |
1154 | 695 when it's used. The pattern is matched |
696 against the function name. Both <amatch> and | |
697 <afile> are set to the name of the function. | |
6154 | 698 NOTE: When writing Vim scripts a better |
699 alternative is to use an autoloaded function. | |
161 | 700 See |autoload-functions|. |
579 | 701 *GUIEnter* |
702 GUIEnter After starting the GUI successfully, and after | |
703 opening the window. It is triggered before | |
704 VimEnter when using gvim. Can be used to | |
705 position the window from a .gvimrc file: > | |
706 :autocmd GUIEnter * winpos 100 50 | |
1154 | 707 < *GUIFailed* |
708 GUIFailed After starting the GUI failed. Vim may | |
709 continue to run in the terminal, if possible | |
710 (only on Unix and alikes, when connecting the | |
711 X server fails). You may want to quit Vim: > | |
712 :autocmd GUIFailed * qall | |
579 | 713 < *InsertChange* |
714 InsertChange When typing <Insert> while in Insert or | |
715 Replace mode. The |v:insertmode| variable | |
716 indicates the new mode. | |
717 Be careful not to move the cursor or do | |
718 anything else that the user does not expect. | |
2845 | 719 *InsertCharPre* |
720 InsertCharPre When a character is typed in Insert mode, | |
721 before inserting the char. | |
722 The |v:char| variable indicates the char typed | |
723 and can be changed during the event to insert | |
724 a different character. When |v:char| is set | |
725 to more than one character this text is | |
726 inserted literally. | |
727 It is not allowed to change the text |textlock|. | |
728 The event is not triggered when 'paste' is | |
729 set. | |
579 | 730 *InsertEnter* |
1154 | 731 InsertEnter Just before starting Insert mode. Also for |
732 Replace mode and Virtual Replace mode. The | |
579 | 733 |v:insertmode| variable indicates the mode. |
4448 | 734 Be careful not to do anything else that the |
735 user does not expect. | |
736 The cursor is restored afterwards. If you do | |
737 not want that set |v:char| to a non-empty | |
738 string. | |
579 | 739 *InsertLeave* |
740 InsertLeave When leaving Insert mode. Also when using | |
741 CTRL-O |i_CTRL-O|. But not for |i_CTRL-C|. | |
742 *MenuPopup* | |
743 MenuPopup Just before showing the popup menu (under the | |
744 right mouse button). Useful for adjusting the | |
745 menu for what is under the cursor or mouse | |
746 pointer. | |
747 The pattern is matched against a single | |
748 character representing the mode: | |
749 n Normal | |
750 v Visual | |
751 o Operator-pending | |
752 i Insert | |
843 | 753 c Command line |
6935 | 754 *OptionSet* |
755 OptionSet After setting an option. The pattern is | |
756 matched against the long option name. | |
757 The |v:option_old| variable indicates the | |
758 old option value, |v:option_new| variable | |
759 indicates the newly set value, the | |
760 |v:option_type| variable indicates whether | |
761 it's global or local scoped and |<amatch>| | |
762 indicates what option has been set. | |
763 | |
764 Is not triggered on startup and for the 'key' | |
765 option for obvious reasons. | |
766 | |
6951
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6935
diff
changeset
|
767 Usage example: Check for the existence of the |
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6935
diff
changeset
|
768 directory in the 'backupdir' and 'undodir' |
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6935
diff
changeset
|
769 options, create the directory if it doesn't |
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6935
diff
changeset
|
770 exist yet. |
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6935
diff
changeset
|
771 |
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6935
diff
changeset
|
772 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
|
773 during this autocommand, this may break a |
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6935
diff
changeset
|
774 plugin. You can always use `:noa` to prevent |
b2673982c625
Updated and new runtime files.
Bram Moolenaar <bram@vim.org>
parents:
6935
diff
changeset
|
775 triggering this autocommand. |
6935 | 776 |
579 | 777 *QuickFixCmdPre* |
778 QuickFixCmdPre Before a quickfix command is run (|:make|, | |
657 | 779 |:lmake|, |:grep|, |:lgrep|, |:grepadd|, |
780 |:lgrepadd|, |:vimgrep|, |:lvimgrep|, | |
3281 | 781 |:vimgrepadd|, |:lvimgrepadd|, |:cscope|, |
3410
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3404
diff
changeset
|
782 |:cfile|, |:cgetfile|, |:caddfile|, |:lfile|, |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3404
diff
changeset
|
783 |:lgetfile|, |:laddfile|, |:helpgrep|, |
94601b379f38
Updated runtime files. Add Dutch translations.
Bram Moolenaar <bram@vim.org>
parents:
3404
diff
changeset
|
784 |:lhelpgrep|). |
2151
ae22c450546c
updated for version 7.2.433
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
785 The pattern is matched against the command |
ae22c450546c
updated for version 7.2.433
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
786 being run. When |:grep| is used but 'grepprg' |
ae22c450546c
updated for version 7.2.433
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
787 is set to "internal" it still matches "grep". |
579 | 788 This command cannot be used to set the |
789 'makeprg' and 'grepprg' variables. | |
790 If this command causes an error, the quickfix | |
791 command is not executed. | |
792 *QuickFixCmdPost* | |
793 QuickFixCmdPost Like QuickFixCmdPre, but after a quickfix | |
842 | 794 command is run, before jumping to the first |
3404 | 795 location. For |:cfile| and |:lfile| commands |
796 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
|
797 moving to the first error. |
3404 | 798 See |QuickFixCmdPost-example|. |
3682 | 799 *QuitPre* |
4229 | 800 QuitPre When using `:quit`, `:wq` or `:qall`, before |
801 deciding whether it closes the current window | |
802 or quits Vim. Can be used to close any | |
803 non-essential window if the current window is | |
804 the last ordinary window. | |
579 | 805 *RemoteReply* |
806 RemoteReply When a reply from a Vim that functions as | |
1154 | 807 server was received |server2client()|. The |
808 pattern is matched against the {serverid}. | |
579 | 809 <amatch> is equal to the {serverid} from which |
810 the reply was sent, and <afile> is the actual | |
811 reply string. | |
812 Note that even if an autocommand is defined, | |
813 the reply should be read with |remote_read()| | |
814 to consume it. | |
815 *SessionLoadPost* | |
816 SessionLoadPost After loading the session file created using | |
817 the |:mksession| command. | |
724 | 818 *ShellCmdPost* |
819 ShellCmdPost After executing a shell command with |:!cmd|, | |
820 |:shell|, |:make| and |:grep|. Can be used to | |
821 check for any changed files. | |
822 *ShellFilterPost* | |
823 ShellFilterPost After executing a shell command with | |
824 ":{range}!cmd", ":w !cmd" or ":r !cmd". | |
825 Can be used to check for any changed files. | |
716 | 826 *SourcePre* |
827 SourcePre Before sourcing a Vim script. |:source| | |
1061 | 828 <afile> is the name of the file being sourced. |
829 *SourceCmd* | |
830 SourceCmd When sourcing a Vim script. |:source| | |
831 <afile> is the name of the file being sourced. | |
832 The autocommand must source this file. | |
833 |Cmd-event| | |
650 | 834 *SpellFileMissing* |
835 SpellFileMissing When trying to load a spell checking file and | |
1061 | 836 it can't be found. The pattern is matched |
837 against the language. <amatch> is the | |
838 language, 'encoding' also matters. See | |
650 | 839 |spell-SpellFileMissing|. |
579 | 840 *StdinReadPost* |
841 StdinReadPost After reading from the stdin into the buffer, | |
842 before executing the modelines. Only used | |
843 when the "-" argument was used when Vim was | |
844 started |--|. | |
845 *StdinReadPre* | |
846 StdinReadPre Before reading from stdin into the buffer. | |
847 Only used when the "-" argument was used when | |
848 Vim was started |--|. | |
849 *SwapExists* | |
850 SwapExists Detected an existing swap file when starting | |
851 to edit a file. Only when it is possible to | |
852 select a way to handle the situation, when Vim | |
853 would ask the user what to do. | |
854 The |v:swapname| variable holds the name of | |
590 | 855 the swap file found, <afile> the file being |
856 edited. |v:swapcommand| may contain a command | |
857 to be executed in the opened file. | |
858 The commands should set the |v:swapchoice| | |
859 variable to a string with one character to | |
860 tell Vim what should be done next: | |
579 | 861 'o' open read-only |
862 'e' edit the file anyway | |
863 'r' recover | |
864 'd' delete the swap file | |
865 'q' quit, don't edit the file | |
866 'a' abort, like hitting CTRL-C | |
867 When set to an empty string the user will be | |
868 asked, as if there was no SwapExists autocmd. | |
1919 | 869 *E812* |
870 It is not allowed to change to another buffer, | |
871 change a buffer name or change directory | |
872 here. | |
579 | 873 *Syntax* |
1154 | 874 Syntax When the 'syntax' option has been set. The |
875 pattern is matched against the syntax name. | |
579 | 876 <afile> can be used for the name of the file |
877 where this option was set, and <amatch> for | |
878 the new value of 'syntax'. | |
879 See |:syn-on|. | |
9599
42a8a81decdf
commit https://github.com/vim/vim/commit/12c11d553053f5a9eae9eb3c518279b12fa928c2
Christian Brabandt <cb@256bit.org>
parents:
9595
diff
changeset
|
880 *TabClosed* |
42a8a81decdf
commit https://github.com/vim/vim/commit/12c11d553053f5a9eae9eb3c518279b12fa928c2
Christian Brabandt <cb@256bit.org>
parents:
9595
diff
changeset
|
881 TabClosed After closing a tab page. |
677 | 882 *TabEnter* |
883 TabEnter Just after entering a tab page. |tab-page| | |
872 | 884 After triggering the WinEnter and before |
885 triggering the BufEnter event. | |
677 | 886 *TabLeave* |
887 TabLeave Just before leaving a tab page. |tab-page| | |
888 A WinLeave event will have been triggered | |
889 first. | |
9595
0190d5de215f
commit https://github.com/vim/vim/commit/c917da4b3e8801a255dbefea8e4ed19c1c716dd8
Christian Brabandt <cb@256bit.org>
parents:
9286
diff
changeset
|
890 *TabNew* |
0190d5de215f
commit https://github.com/vim/vim/commit/c917da4b3e8801a255dbefea8e4ed19c1c716dd8
Christian Brabandt <cb@256bit.org>
parents:
9286
diff
changeset
|
891 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
|
892 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
|
893 first, TabEnter follows. |
579 | 894 *TermChanged* |
895 TermChanged After the value of 'term' has changed. Useful | |
896 for re-loading the syntax file to update the | |
897 colors, fonts and other terminal-dependent | |
898 settings. Executed for all loaded buffers. | |
899 *TermResponse* | |
900 TermResponse After the response to |t_RV| is received from | |
901 the terminal. The value of |v:termresponse| | |
902 can be used to do things depending on the | |
2788 | 903 terminal version. Note that this event may be |
904 triggered halfway executing another event, | |
905 especially if file I/O, a shell command or | |
906 anything else that takes time is involved. | |
4264 | 907 *TextChanged* |
908 TextChanged After a change was made to the text in the | |
909 current buffer in Normal mode. That is when | |
910 |b:changedtick| has changed. | |
911 Not triggered when there is typeahead or when | |
912 an operator is pending. | |
913 Careful: This is triggered very often, don't | |
914 do anything that the user does not expect or | |
915 that is slow. | |
916 *TextChangedI* | |
917 TextChangedI After a change was made to the text in the | |
918 current buffer in Insert mode. | |
919 Not triggered when the popup menu is visible. | |
920 Otherwise the same as TextChanged. | |
579 | 921 *User* |
922 User Never executed automatically. To be used for | |
923 autocommands that are only executed with | |
924 ":doautocmd". | |
925 *UserGettingBored* | |
4264 | 926 UserGettingBored When the user presses the same key 42 times. |
927 Just kidding! :-) | |
579 | 928 *VimEnter* |
929 VimEnter After doing all the startup stuff, including | |
930 loading .vimrc files, executing the "-c cmd" | |
931 arguments, creating all windows and loading | |
932 the buffers in them. | |
8738
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
933 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
|
934 |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
|
935 can do: > |
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
936 if v:vim_did_enter |
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
937 call s:init() |
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
938 else |
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
939 au VimEnter * call s:init() |
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
940 endif |
e770986c855a
commit https://github.com/vim/vim/commit/1473551a4457d4920b235eeeb9f279e196ee7225
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
941 < *VimLeave* |
579 | 942 VimLeave Before exiting Vim, just after writing the |
943 .viminfo file. Executed only once, like | |
944 VimLeavePre. | |
945 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
|
946 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
|
947 triggered. |
579 | 948 *VimLeavePre* |
949 VimLeavePre Before exiting Vim, just before writing the | |
950 .viminfo file. This is executed only once, | |
951 if there is a match with the name of what | |
952 happens to be the current buffer when exiting. | |
953 Mostly useful with a "*" pattern. > | |
954 :autocmd VimLeavePre * call CleanupStuff() | |
955 < 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
|
956 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
|
957 triggered. |
766 | 958 *VimResized* |
959 VimResized After the Vim window was resized, thus 'lines' | |
960 and/or 'columns' changed. Not when starting | |
961 up though. | |
7 | 962 *WinEnter* |
963 WinEnter After entering another window. Not done for | |
964 the first window, when Vim has just started. | |
965 Useful for setting the window height. | |
966 If the window is for another buffer, Vim | |
967 executes the BufEnter autocommands after the | |
968 WinEnter autocommands. | |
969 Note: When using ":split fname" the WinEnter | |
970 event is triggered after the split but before | |
971 the file "fname" is loaded. | |
972 *WinLeave* | |
973 WinLeave Before leaving a window. If the window to be | |
974 entered next is for a different buffer, Vim | |
975 executes the BufLeave autocommands before the | |
976 WinLeave autocommands (but not for ":new"). | |
977 Not used for ":qa" or ":q" when exiting Vim. | |
978 | |
9599
42a8a81decdf
commit https://github.com/vim/vim/commit/12c11d553053f5a9eae9eb3c518279b12fa928c2
Christian Brabandt <cb@256bit.org>
parents:
9595
diff
changeset
|
979 *WinNew* |
42a8a81decdf
commit https://github.com/vim/vim/commit/12c11d553053f5a9eae9eb3c518279b12fa928c2
Christian Brabandt <cb@256bit.org>
parents:
9595
diff
changeset
|
980 WinNew When a new window was created. Not done for |
42a8a81decdf
commit https://github.com/vim/vim/commit/12c11d553053f5a9eae9eb3c518279b12fa928c2
Christian Brabandt <cb@256bit.org>
parents:
9595
diff
changeset
|
981 the fist window, when Vim has just started. |
42a8a81decdf
commit https://github.com/vim/vim/commit/12c11d553053f5a9eae9eb3c518279b12fa928c2
Christian Brabandt <cb@256bit.org>
parents:
9595
diff
changeset
|
982 Before a WinEnter event. |
42a8a81decdf
commit https://github.com/vim/vim/commit/12c11d553053f5a9eae9eb3c518279b12fa928c2
Christian Brabandt <cb@256bit.org>
parents:
9595
diff
changeset
|
983 |
7 | 984 ============================================================================== |
985 6. Patterns *autocmd-patterns* *{pat}* | |
986 | |
6741 | 987 The {pat} argument can be a comma separated list. This works as if the |
988 command was given with each pattern separately. Thus this command: > | |
989 :autocmd BufRead *.txt,*.info set et | |
990 Is equivalent to: > | |
991 :autocmd BufRead *.txt set et | |
992 :autocmd BufRead *.info set et | |
993 | |
7 | 994 The file pattern {pat} is tested for a match against the file name in one of |
995 two ways: | |
996 1. When there is no '/' in the pattern, Vim checks for a match against only | |
997 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
|
998 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
|
999 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
|
1000 it to a full path and resolving symbolic links). |
7 | 1001 |
40 | 1002 The special pattern <buffer> or <buffer=N> is used for buffer-local |
1003 autocommands |autocmd-buflocal|. This pattern is not matched against the name | |
1004 of a buffer. | |
1005 | |
7 | 1006 Examples: > |
1007 :autocmd BufRead *.txt set et | |
1008 Set the 'et' option for all text files. > | |
1009 | |
1010 :autocmd BufRead /vim/src/*.c set cindent | |
1011 Set the 'cindent' option for C files in the /vim/src directory. > | |
1012 | |
1013 :autocmd BufRead /tmp/*.c set ts=5 | |
1014 If you have a link from "/tmp/test.c" to "/home/nobody/vim/src/test.c", and | |
1015 you start editing "/tmp/test.c", this autocommand will match. | |
1016 | |
1017 Note: To match part of a path, but not from the root directory, use a '*' as | |
1018 the first character. Example: > | |
1019 :autocmd BufRead */doc/*.txt set tw=78 | |
1020 This autocommand will for example be executed for "/tmp/doc/xx.txt" and | |
1021 "/usr/home/piet/doc/yy.txt". The number of directories does not matter here. | |
1022 | |
1023 | |
1024 The file name that the pattern is matched against is after expanding | |
1621 | 1025 wildcards. Thus if you issue this command: > |
7 | 1026 :e $ROOTDIR/main.$EXT |
1027 The argument is first expanded to: > | |
1028 /usr/root/main.py | |
1029 Before it's matched with the pattern of the autocommand. Careful with this | |
1030 when using events like FileReadCmd, the value of <amatch> may not be what you | |
1031 expect. | |
1032 | |
1033 | |
1034 Environment variables can be used in a pattern: > | |
1035 :autocmd BufRead $VIMRUNTIME/doc/*.txt set expandtab | |
1036 And ~ can be used for the home directory (if $HOME is defined): > | |
1037 :autocmd BufWritePost ~/.vimrc so ~/.vimrc | |
1038 :autocmd BufRead ~archive/* set readonly | |
1039 The environment variable is expanded when the autocommand is defined, not when | |
1040 the autocommand is executed. This is different from the command! | |
1041 | |
1042 *file-pattern* | |
1043 The pattern is interpreted like mostly used in file names: | |
5294 | 1044 * matches any sequence of characters; Unusual: includes path |
5277 | 1045 separators |
7 | 1046 ? matches any single character |
1047 \? matches a '?' | |
1048 . matches a '.' | |
1049 ~ matches a '~' | |
1050 , separates patterns | |
1051 \, matches a ',' | |
1052 { } like \( \) in a |pattern| | |
1053 , inside { }: like \| in a |pattern| | |
5259
6b7ab6a4f31a
updated for version 7.4b.006
Bram Moolenaar <bram@vim.org>
parents:
5247
diff
changeset
|
1054 \} literal } |
6b7ab6a4f31a
updated for version 7.4b.006
Bram Moolenaar <bram@vim.org>
parents:
5247
diff
changeset
|
1055 \{ literal { |
6b7ab6a4f31a
updated for version 7.4b.006
Bram Moolenaar <bram@vim.org>
parents:
5247
diff
changeset
|
1056 \\\{n,m\} like \{n,m} in a |pattern| |
7 | 1057 \ special meaning like in a |pattern| |
1058 [ch] matches 'c' or 'h' | |
1059 [^ch] match any character but 'c' and 'h' | |
1060 | |
1061 Note that for all systems the '/' character is used for path separator (even | |
1062 MS-DOS and OS/2). This was done because the backslash is difficult to use | |
1063 in a pattern and to make the autocommands portable across different systems. | |
1064 | |
40 | 1065 *autocmd-changes* |
7 | 1066 Matching with the pattern is done when an event is triggered. Changing the |
1067 buffer name in one of the autocommands, or even deleting the buffer, does not | |
1068 change which autocommands will be executed. Example: > | |
1069 | |
1070 au BufEnter *.foo bdel | |
1071 au BufEnter *.foo set modified | |
1072 | |
1073 This will delete the current buffer and then set 'modified' in what has become | |
1074 the current buffer instead. Vim doesn't take into account that "*.foo" | |
1075 doesn't match with that buffer name. It matches "*.foo" with the name of the | |
1076 buffer at the moment the event was triggered. | |
1077 | |
40 | 1078 However, buffer-local autocommands will not be executed for a buffer that has |
1079 been wiped out with |:bwipe|. After deleting the buffer with |:bdel| the | |
1080 buffer actually still exists (it becomes unlisted), thus the autocommands are | |
1081 still executed. | |
1082 | |
7 | 1083 ============================================================================== |
856 | 1084 7. Buffer-local autocommands *autocmd-buflocal* *autocmd-buffer-local* |
1085 *<buffer=N>* *<buffer=abuf>* *E680* | |
40 | 1086 |
1087 Buffer-local autocommands are attached to a specific buffer. They are useful | |
1088 if the buffer does not have a name and when the name does not match a specific | |
1089 pattern. But it also means they must be explicitly added to each buffer. | |
1090 | |
1091 Instead of a pattern buffer-local autocommands use one of these forms: | |
1092 <buffer> current buffer | |
1093 <buffer=99> buffer number 99 | |
1094 <buffer=abuf> using <abuf> (only when executing autocommands) | |
1095 |<abuf>| | |
1096 | |
1097 Examples: > | |
1098 :au CursorHold <buffer> echo 'hold' | |
1099 :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
|
1100 :au BufNewFile * au CursorHold <buffer=abuf> echo 'hold' |
40 | 1101 |
1102 All the commands for autocommands also work with buffer-local autocommands, | |
1103 simply use the special string instead of the pattern. Examples: > | |
856 | 1104 :au! * <buffer> " remove buffer-local autocommands for |
1105 " current buffer | |
1106 :au! * <buffer=33> " remove buffer-local autocommands for | |
1107 " buffer #33 | |
1621 | 1108 :bufdo :au! CursorHold <buffer> " remove autocmd for given event for all |
856 | 1109 " buffers |
1110 :au * <buffer> " list buffer-local autocommands for | |
1111 " current buffer | |
40 | 1112 |
1113 Note that when an autocommand is defined for the current buffer, it is stored | |
1114 with the buffer number. Thus it uses the form "<buffer=12>", where 12 is the | |
1115 number of the current buffer. You will see this when listing autocommands, | |
1116 for example. | |
1117 | |
1118 To test for presence of buffer-local autocommands use the |exists()| function | |
1119 as follows: > | |
1120 :if exists("#CursorHold#<buffer=12>") | ... | endif | |
1121 :if exists("#CursorHold#<buffer>") | ... | endif " for current buffer | |
1122 | |
1123 When a buffer is wiped out its buffer-local autocommands are also gone, of | |
1124 course. Note that when deleting a buffer, e.g., with ":bdel", it is only | |
1125 unlisted, the autocommands are still present. In order to see the removal of | |
1126 buffer-local autocommands: > | |
1127 :set verbose=6 | |
1128 | |
1129 It is not possible to define buffer-local autocommands for a non-existent | |
1130 buffer. | |
1131 | |
1132 ============================================================================== | |
1133 8. Groups *autocmd-groups* | |
7 | 1134 |
1135 Autocommands can be put together in a group. This is useful for removing or | |
1136 executing a group of autocommands. For example, all the autocommands for | |
1137 syntax highlighting are put in the "highlight" group, to be able to execute | |
1138 ":doautoall highlight BufRead" when the GUI starts. | |
1139 | |
1140 When no specific group is selected, Vim uses the default group. The default | |
1141 group does not have a name. You cannot execute the autocommands from the | |
1142 default group separately; you can execute them only by executing autocommands | |
1143 for all groups. | |
1144 | |
1145 Normally, when executing autocommands automatically, Vim uses the autocommands | |
1146 for all groups. The group only matters when executing autocommands with | |
1147 ":doautocmd" or ":doautoall", or when defining or deleting autocommands. | |
1148 | |
1149 The group name can contain any characters except white space. The group name | |
1150 "end" is reserved (also in uppercase). | |
1151 | |
1152 The group name is case sensitive. Note that this is different from the event | |
1153 name! | |
1154 | |
1155 *:aug* *:augroup* | |
1156 :aug[roup] {name} Define the autocmd group name for the | |
1157 following ":autocmd" commands. The name "end" | |
1158 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
|
1159 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
|
1160 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
|
1161 most likely will not do what you intended. |
7 | 1162 |
1163 *:augroup-delete* *E367* | |
1164 :aug[roup]! {name} Delete the autocmd group {name}. Don't use | |
1165 this if there is still an autocommand using | |
1166 this group! This is not checked. | |
1167 | |
1168 To enter autocommands for a specific group, use this method: | |
1169 1. Select the group with ":augroup {name}". | |
1170 2. Delete any old autocommands with ":au!". | |
1171 3. Define the autocommands. | |
1172 4. Go back to the default group with "augroup END". | |
1173 | |
1174 Example: > | |
1175 :augroup uncompress | |
1176 : au! | |
1177 : au BufEnter *.gz %!gunzip | |
1178 :augroup END | |
1179 | |
1180 This prevents having the autocommands defined twice (e.g., after sourcing the | |
1181 .vimrc file again). | |
1182 | |
1183 ============================================================================== | |
40 | 1184 9. Executing autocommands *autocmd-execute* |
7 | 1185 |
1186 Vim can also execute Autocommands non-automatically. This is useful if you | |
1187 have changed autocommands, or when Vim has executed the wrong autocommands | |
1188 (e.g., the file pattern match was wrong). | |
1189 | |
1190 Note that the 'eventignore' option applies here too. Events listed in this | |
1191 option will not cause any commands to be executed. | |
1192 | |
1193 *:do* *:doau* *:doautocmd* *E217* | |
3356 | 1194 :do[autocmd] [<nomodeline>] [group] {event} [fname] |
7 | 1195 Apply the autocommands matching [fname] (default: |
1196 current file name) for {event} to the current buffer. | |
1197 You can use this when the current file name does not | |
1198 match the right pattern, after changing settings, or | |
1199 to execute autocommands for a certain event. | |
1200 It's possible to use this inside an autocommand too, | |
1201 so you can base the autocommands for one extension on | |
1202 another extension. Example: > | |
3224 | 1203 :au BufEnter *.cpp so ~/.vimrc_cpp |
1204 :au BufEnter *.cpp doau BufEnter x.c | |
7 | 1205 < Be careful to avoid endless loops. See |
1206 |autocmd-nested|. | |
1207 | |
1208 When the [group] argument is not given, Vim executes | |
1209 the autocommands for all groups. When the [group] | |
1210 argument is included, Vim executes only the matching | |
1211 autocommands for that group. Note: if you use an | |
1212 undefined group name, Vim gives you an error message. | |
3350 | 1213 *<nomodeline>* |
1214 After applying the autocommands the modelines are | |
1215 processed, so that their settings overrule the | |
1216 settings from autocommands, like what happens when | |
1217 editing a file. This is skipped when the <nomodeline> | |
1218 argument is present. You probably want to use | |
1219 <nomodeline> for events that are not used when loading | |
1220 a buffer, such as |User|. | |
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
1221 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
|
1222 matching autocommands were executed. |
7 | 1223 |
1224 *:doautoa* *:doautoall* | |
3342 | 1225 :doautoa[ll] [<nomodeline>] [group] {event} [fname] |
7 | 1226 Like ":doautocmd", but apply the autocommands to each |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1919
diff
changeset
|
1227 loaded buffer. Note that [fname] is used to select |
7 | 1228 the autocommands, not the buffers to which they are |
1229 applied. | |
1230 Careful: Don't use this for autocommands that delete a | |
1231 buffer, change to another buffer or change the | |
1232 contents of a buffer; the result is unpredictable. | |
1233 This command is intended for autocommands that set | |
1234 options, change highlighting, and things like that. | |
1235 | |
1236 ============================================================================== | |
40 | 1237 10. Using autocommands *autocmd-use* |
7 | 1238 |
1239 For WRITING FILES there are four possible sets of events. Vim uses only one | |
1240 of these sets for a write command: | |
1241 | |
1242 BufWriteCmd BufWritePre BufWritePost writing the whole buffer | |
1243 FilterWritePre FilterWritePost writing to filter temp file | |
1244 FileAppendCmd FileAppendPre FileAppendPost appending to a file | |
1245 FileWriteCmd FileWritePre FileWritePost any other file write | |
1246 | |
1247 When there is a matching "*Cmd" autocommand, it is assumed it will do the | |
1248 writing. No further writing is done and the other events are not triggered. | |
1249 |Cmd-event| | |
1250 | |
1251 Note that the *WritePost commands should undo any changes to the buffer that | |
1252 were caused by the *WritePre commands; otherwise, writing the file will have | |
1253 the side effect of changing the buffer. | |
1254 | |
1255 Before executing the autocommands, the buffer from which the lines are to be | |
1256 written temporarily becomes the current buffer. Unless the autocommands | |
1257 change the current buffer or delete the previously current buffer, the | |
1258 previously current buffer is made the current buffer again. | |
1259 | |
1260 The *WritePre and *AppendPre autocommands must not delete the buffer from | |
1261 which the lines are to be written. | |
1262 | |
1263 The '[ and '] marks have a special position: | |
1264 - Before the *ReadPre event the '[ mark is set to the line just above where | |
1265 the new lines will be inserted. | |
1266 - Before the *ReadPost event the '[ mark is set to the first line that was | |
1267 just read, the '] mark to the last line. | |
26 | 1268 - Before executing the *WriteCmd, *WritePre and *AppendPre autocommands the '[ |
1269 mark is set to the first line that will be written, the '] mark to the last | |
1270 line. | |
7 | 1271 Careful: '[ and '] change when using commands that change the buffer. |
1272 | |
1273 In commands which expect a file name, you can use "<afile>" for the file name | |
1274 that is being read |:<afile>| (you can also use "%" for the current file | |
1275 name). "<abuf>" can be used for the buffer number of the currently effective | |
1276 buffer. This also works for buffers that doesn't have a name. But it doesn't | |
1277 work for files without a buffer (e.g., with ":r file"). | |
1278 | |
1279 *gzip-example* | |
1280 Examples for reading and writing compressed files: > | |
1281 :augroup gzip | |
1282 : autocmd! | |
1283 : autocmd BufReadPre,FileReadPre *.gz set bin | |
1284 : autocmd BufReadPost,FileReadPost *.gz '[,']!gunzip | |
1285 : autocmd BufReadPost,FileReadPost *.gz set nobin | |
1286 : autocmd BufReadPost,FileReadPost *.gz execute ":doautocmd BufReadPost " . expand("%:r") | |
1287 : autocmd BufWritePost,FileWritePost *.gz !mv <afile> <afile>:r | |
1288 : autocmd BufWritePost,FileWritePost *.gz !gzip <afile>:r | |
1289 | |
1290 : autocmd FileAppendPre *.gz !gunzip <afile> | |
1291 : autocmd FileAppendPre *.gz !mv <afile>:r <afile> | |
1292 : autocmd FileAppendPost *.gz !mv <afile> <afile>:r | |
1293 : autocmd FileAppendPost *.gz !gzip <afile>:r | |
1294 :augroup END | |
1295 | |
1296 The "gzip" group is used to be able to delete any existing autocommands with | |
1297 ":autocmd!", for when the file is sourced twice. | |
1298 | |
1299 ("<afile>:r" is the file name without the extension, see |:_%:|) | |
1300 | |
1301 The commands executed for the BufNewFile, BufRead/BufReadPost, BufWritePost, | |
1302 FileAppendPost and VimLeave events do not set or reset the changed flag of the | |
1303 buffer. When you decompress the buffer with the BufReadPost autocommands, you | |
1304 can still exit with ":q". When you use ":undo" in BufWritePost to undo the | |
1305 changes made by BufWritePre commands, you can still do ":q" (this also makes | |
1306 "ZZ" work). If you do want the buffer to be marked as modified, set the | |
1307 'modified' option. | |
1308 | |
1309 To execute Normal mode commands from an autocommand, use the ":normal" | |
1310 command. Use with care! If the Normal mode command is not finished, the user | |
1311 needs to type characters (e.g., after ":normal m" you need to type a mark | |
1312 name). | |
1313 | |
1314 If you want the buffer to be unmodified after changing it, reset the | |
1315 'modified' option. This makes it possible to exit the buffer with ":q" | |
1316 instead of ":q!". | |
1317 | |
1318 *autocmd-nested* *E218* | |
1319 By default, autocommands do not nest. If you use ":e" or ":w" in an | |
1320 autocommand, Vim does not execute the BufRead and BufWrite autocommands for | |
1321 those commands. If you do want this, use the "nested" flag for those commands | |
1322 in which you want nesting. For example: > | |
1323 :autocmd FileChangedShell *.c nested e! | |
1324 The nesting is limited to 10 levels to get out of recursive loops. | |
1325 | |
1326 It's possible to use the ":au" command in an autocommand. This can be a | |
1327 self-modifying command! This can be useful for an autocommand that should | |
1328 execute only once. | |
1329 | |
590 | 1330 If you want to skip autocommands for one command, use the |:noautocmd| command |
1331 modifier or the 'eventignore' option. | |
7 | 1332 |
1333 Note: When reading a file (with ":read file" or with a filter command) and the | |
1334 last line in the file does not have an <EOL>, Vim remembers this. At the next | |
1335 write (with ":write file" or with a filter command), if the same line is | |
1336 written again as the last line in a file AND 'binary' is set, Vim does not | |
1337 supply an <EOL>. This makes a filter command on the just read lines write the | |
1338 same file as was read, and makes a write command on just filtered lines write | |
1339 the same file as was read from the filter. For example, another way to write | |
1340 a compressed file: > | |
1341 | |
1342 :autocmd FileWritePre *.gz set bin|'[,']!gzip | |
1343 :autocmd FileWritePost *.gz undo|set nobin | |
1344 < | |
1345 *autocommand-pattern* | |
1346 You can specify multiple patterns, separated by commas. Here are some | |
1347 examples: > | |
1348 | |
1349 :autocmd BufRead * set tw=79 nocin ic infercase fo=2croq | |
1350 :autocmd BufRead .letter set tw=72 fo=2tcrq | |
1351 :autocmd BufEnter .letter set dict=/usr/lib/dict/words | |
1352 :autocmd BufLeave .letter set dict= | |
1353 :autocmd BufRead,BufNewFile *.c,*.h set tw=0 cin noic | |
1354 :autocmd BufEnter *.c,*.h abbr FOR for (i = 0; i < 3; ++i)<CR>{<CR>}<Esc>O | |
1355 :autocmd BufLeave *.c,*.h unabbr FOR | |
1356 | |
1357 For makefiles (makefile, Makefile, imakefile, makefile.unix, etc.): > | |
1358 | |
1359 :autocmd BufEnter ?akefile* set include=^s\=include | |
1360 :autocmd BufLeave ?akefile* set include& | |
1361 | |
1362 To always start editing C files at the first function: > | |
1363 | |
1364 :autocmd BufRead *.c,*.h 1;/^{ | |
1365 | |
1366 Without the "1;" above, the search would start from wherever the file was | |
1367 entered, rather than from the start of the file. | |
1368 | |
1369 *skeleton* *template* | |
1370 To read a skeleton (template) file when opening a new file: > | |
1371 | |
1372 :autocmd BufNewFile *.c 0r ~/vim/skeleton.c | |
1373 :autocmd BufNewFile *.h 0r ~/vim/skeleton.h | |
1374 :autocmd BufNewFile *.java 0r ~/vim/skeleton.java | |
1375 | |
1376 To insert the current date and time in a *.html file when writing it: > | |
1377 | |
1378 :autocmd BufWritePre,FileWritePre *.html ks|call LastMod()|'s | |
1379 :fun LastMod() | |
1380 : if line("$") > 20 | |
1381 : let l = 20 | |
1382 : else | |
1383 : let l = line("$") | |
1384 : endif | |
1385 : exe "1," . l . "g/Last modified: /s/Last modified: .*/Last modified: " . | |
1386 : \ strftime("%Y %b %d") | |
1387 :endfun | |
1388 | |
1389 You need to have a line "Last modified: <date time>" in the first 20 lines | |
1390 of the file for this to work. Vim replaces <date time> (and anything in the | |
1391 same line after it) with the current date and time. Explanation: | |
1392 ks mark current position with mark 's' | |
1393 call LastMod() call the LastMod() function to do the work | |
1394 's return the cursor to the old position | |
1395 The LastMod() function checks if the file is shorter than 20 lines, and then | |
1396 uses the ":g" command to find lines that contain "Last modified: ". For those | |
1397 lines the ":s" command is executed to replace the existing date with the | |
1398 current one. The ":execute" command is used to be able to use an expression | |
1399 for the ":g" and ":s" commands. The date is obtained with the strftime() | |
1400 function. You can change its argument to get another date string. | |
1401 | |
1402 When entering :autocmd on the command-line, completion of events and command | |
1403 names may be done (with <Tab>, CTRL-D, etc.) where appropriate. | |
1404 | |
1405 Vim executes all matching autocommands in the order that you specify them. | |
1406 It is recommended that your first autocommand be used for all files by using | |
1407 "*" as the file pattern. This means that you can define defaults you like | |
1408 here for any settings, and if there is another matching autocommand it will | |
1409 override these. But if there is no other matching autocommand, then at least | |
1410 your default settings are recovered (if entering this file from another for | |
1411 which autocommands did match). Note that "*" will also match files starting | |
1412 with ".", unlike Unix shells. | |
1413 | |
1414 *autocmd-searchpat* | |
1415 Autocommands do not change the current search patterns. Vim saves the current | |
1416 search patterns before executing autocommands then restores them after the | |
1417 autocommands finish. This means that autocommands do not affect the strings | |
1418 highlighted with the 'hlsearch' option. Within autocommands, you can still | |
1419 use search patterns normally, e.g., with the "n" command. | |
1420 If you want an autocommand to set the search pattern, such that it is used | |
1421 after the autocommand finishes, use the ":let @/ =" command. | |
1422 The search-highlighting cannot be switched off with ":nohlsearch" in an | |
1423 autocommand. Use the 'h' flag in the 'viminfo' option to disable search- | |
1424 highlighting when starting Vim. | |
1425 | |
1426 *Cmd-event* | |
1427 When using one of the "*Cmd" events, the matching autocommands are expected to | |
1061 | 1428 do the file reading, writing or sourcing. This can be used when working with |
1429 a special kind of file, for example on a remote system. | |
7 | 1430 CAREFUL: If you use these events in a wrong way, it may have the effect of |
1431 making it impossible to read or write the matching files! Make sure you test | |
1432 your autocommands properly. Best is to use a pattern that will never match a | |
1433 normal file name, for example "ftp://*". | |
1434 | |
1435 When defining a BufReadCmd it will be difficult for Vim to recover a crashed | |
1436 editing session. When recovering from the original file, Vim reads only those | |
1437 parts of a file that are not found in the swap file. Since that is not | |
1438 possible with a BufReadCmd, use the |:preserve| command to make sure the | |
1439 original file isn't needed for recovery. You might want to do this only when | |
1440 you expect the file to be modified. | |
1441 | |
1061 | 1442 For file read and write commands the |v:cmdarg| variable holds the "++enc=" |
1443 and "++ff=" argument that are effective. These should be used for the command | |
1444 that reads/writes the file. The |v:cmdbang| variable is one when "!" was | |
1445 used, zero otherwise. | |
7 | 1446 |
2377
878562053ba3
Update Fortran indent and syntax file. (Ajit Thakkar)
Bram Moolenaar <bram@vim.org>
parents:
2345
diff
changeset
|
1447 See the $VIMRUNTIME/plugin/netrwPlugin.vim for examples. |
7 | 1448 |
590 | 1449 ============================================================================== |
1450 11. Disabling autocommands *autocmd-disable* | |
1451 | |
1452 To disable autocommands for some time use the 'eventignore' option. Note that | |
1453 this may cause unexpected behavior, make sure you restore 'eventignore' | |
1454 afterwards, using a |:try| block with |:finally|. | |
1455 | |
1456 *:noautocmd* *:noa* | |
1457 To disable autocommands for just one command use the ":noautocmd" command | |
1458 modifier. This will set 'eventignore' to "all" for the duration of the | |
1459 following command. Example: > | |
1460 | |
1461 :noautocmd w fname.gz | |
1462 | |
1463 This will write the file without triggering the autocommands defined by the | |
1464 gzip plugin. | |
1465 | |
40 | 1466 |
7 | 1467 vim:tw=78:ts=8:ft=help:norl: |