blob: d9f40f49b1af1ccc617966276e77b14e699a1f69 [file] [log] [blame]
Bram Moolenaarbf884932013-04-05 22:26:15 +02001*autocmd.txt* For Vim version 7.3. Last change: 2013 Mar 19
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Automatic commands *autocommand*
8
9For a basic explanation, see section |40.3| in the user manual.
10
111. Introduction |autocmd-intro|
122. Defining autocommands |autocmd-define|
133. Removing autocommands |autocmd-remove|
144. Listing autocommands |autocmd-list|
155. Events |autocmd-events|
166. Patterns |autocmd-patterns|
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000177. Buffer-local autocommands |autocmd-buflocal|
188. Groups |autocmd-groups|
199. Executing autocommands |autocmd-execute|
2010. Using autocommands |autocmd-use|
Bram Moolenaarb3480382005-12-11 21:33:32 +00002111. Disabling autocommands |autocmd-disable|
Bram Moolenaar071d4272004-06-13 20:20:40 +000022
23{Vi does not have any of these commands}
24{only when the |+autocmd| feature has not been disabled at compile time}
25
26==============================================================================
271. Introduction *autocmd-intro*
28
Bram Moolenaard4755bb2004-09-02 19:12:26 +000029You can specify commands to be executed automatically when reading or writing
30a file, when entering or leaving a buffer or window, and when exiting Vim.
31For example, you can create an autocommand to set the 'cindent' option for
32files matching *.c. You can also use autocommands to implement advanced
Bram Moolenaar071d4272004-06-13 20:20:40 +000033features, such as editing compressed files (see |gzip-example|). The usual
34place to put autocommands is in your .vimrc or .exrc file.
35
Bram Moolenaardb7207e2012-02-22 17:30:19 +010036 *E203* *E204* *E143* *E855*
Bram Moolenaar071d4272004-06-13 20:20:40 +000037WARNING: Using autocommands is very powerful, and may lead to unexpected side
38effects. 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==============================================================================
532. Defining autocommands *autocmd-define*
54
55Note: 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
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +010062 {pat} |autocmd-patterns|.
63 Vim always adds the {cmd} after existing autocommands,
64 so that the autocommands execute in the order in which
65 they were given. See |autocmd-nested| for [nested].
Bram Moolenaar071d4272004-06-13 20:20:40 +000066
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +000067The special pattern <buffer> or <buffer=N> defines a buffer-local autocommand.
68See |autocmd-buflocal|.
69
Bram Moolenaar071d4272004-06-13 20:20:40 +000070Note that special characters (e.g., "%", "<cword>") in the ":autocmd"
71arguments are not expanded when the autocommand is defined. These will be
72expanded when the Event is recognized, and the {cmd} is executed. The only
73exception is that "<sfile>" is expanded when the autocmd is defined. Example:
74>
75 :au BufNewFile,BufRead *.html so <sfile>:h/html.vim
76
77Here Vim expands <sfile> to the name of the file containing this line.
78
79When your .vimrc file is sourced twice, the autocommands will appear twice.
80To avoid this, put this command in your .vimrc file, before defining
81autocommands: >
82
83 :autocmd! " Remove ALL autocommands for the current group.
84
85If you don't want to remove all autocommands, you can instead use a variable
86to ensure that Vim includes the autocommands only once: >
87
88 :if !exists("autocommands_loaded")
89 : let autocommands_loaded = 1
90 : au ...
91 :endif
92
93When the [group] argument is not given, Vim uses the current group (as defined
94with ":augroup"); otherwise, Vim uses the group defined with [group]. Note
95that [group] must have been defined before. You cannot define a new group
96with ":au group ..."; use ":augroup" for that.
97
98While testing autocommands, you might find the 'verbose' option to be useful: >
99 :set verbose=9
100This setting makes Vim echo the autocommands as it executes them.
101
102When defining an autocommand in a script, it will be able to call functions
103local to the script and use mappings local to the script. When the event is
104triggered and the command executed, it will run in the context of the script
105it was defined in. This matters if |<SID>| is used in a command.
106
Bram Moolenaar446cb832008-06-24 21:56:24 +0000107When executing the commands, the message from one command overwrites a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000108previous message. This is different from when executing the commands
109manually. Mostly the screen will not scroll up, thus there is no hit-enter
110prompt. When one command outputs two messages this can happen anyway.
111
112==============================================================================
1133. 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
133When the [group] argument is not given, Vim uses the current group (as defined
134with ":augroup"); otherwise, Vim uses the group defined with [group].
135
136==============================================================================
1374. 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
152If you provide the [group] argument, Vim lists only the autocommands for
153[group]; otherwise, Vim lists the autocommands for ALL groups. Note that this
154argument behavior differs from that for defining and removing autocommands.
155
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000156In order to list buffer-local autocommands, use a pattern in the form <buffer>
157or <buffer=N>. See |autocmd-buflocal|.
158
Bram Moolenaarac6e65f2005-08-29 22:25:38 +0000159 *:autocmd-verbose*
160When 'verbose' is non-zero, listing an autocommand will also display where it
161was last defined. Example: >
162
163 :verbose autocmd BufEnter
164 FileExplorer BufEnter
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000165 * call s:LocalBrowse(expand("<amatch>"))
Bram Moolenaarac6e65f2005-08-29 22:25:38 +0000166 Last set from /usr/share/vim/vim-7.0/plugin/NetrwPlugin.vim
167<
168See |:verbose-cmd| for more information.
169
Bram Moolenaar071d4272004-06-13 20:20:40 +0000170==============================================================================
1715. Events *autocmd-events* *E215* *E216*
172
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000173You can specify a comma-separated list of event names. No white space can be
174used in this list. The command applies to all the events in the list.
175
176For 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
181Vim 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
184Note that the autocommands for the *ReadPre events and all the Filter events
185are not allowed to change the current buffer (you will get an error message if
186this happens). This is to prevent the file to be read into the wrong buffer.
187
188Note that the 'modified' flag is reset AFTER executing the BufReadPost
189and BufNewFile autocommands. But when the 'modified' option was set by the
190autocommands, this doesn't happen.
191
192You can use the 'eventignore' option to ignore a number of events or all
193events.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000194 *autocommand-events* *{event}*
195Vim recognizes the following events. Vim ignores the case of event names
196(e.g., you can use "BUFread" or "bufread" instead of "BufRead").
197
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000198First an overview by function with a short explanation. Then the list
Bram Moolenaar551dbcc2006-04-25 22:13:59 +0000199alphabetically with full explanations |autocmd-events-abc|.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000200
201Name 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
Bram Moolenaar551dbcc2006-04-25 22:13:59 +0000212|FileReadCmd| before reading a file with a ":read" command |Cmd-event|
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000213
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
262
263 Startup and exit
264|VimEnter| after doing all the startup stuff
265|GUIEnter| after starting the GUI successfully
Bram Moolenaard09acef2012-09-21 14:54:30 +0200266|GUIFailed| after starting the GUI failed
Bram Moolenaard7afed32007-05-06 13:26:41 +0000267|TermResponse| after the terminal response to |t_RV| is received
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000268
Bram Moolenaar00154502013-02-13 16:15:55 +0100269|QuitPre| when using `:quit`, before deciding whether to quit
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000270|VimLeavePre| before exiting Vim, before writing the viminfo file
271|VimLeave| before exiting Vim, after writing the viminfo file
272
273 Various
274|FileChangedShell| Vim notices that a file changed since editing started
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +0000275|FileChangedShellPost| After handling a file changed since editing started
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000276|FileChangedRO| before making the first change to a read-only file
277
Bram Moolenaara94bc432006-03-10 21:42:59 +0000278|ShellCmdPost| after executing a shell command
279|ShellFilterPost| after filtering with a shell command
280
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000281|FuncUndefined| a user function is used but it isn't defined
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000282|SpellFileMissing| a spell file is used but it can't be found
Bram Moolenaar1f35bf92006-03-07 22:38:47 +0000283|SourcePre| before sourcing a Vim script
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +0000284|SourceCmd| before sourcing a Vim script |Cmd-event|
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000285
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +0000286|VimResized| after the Vim window size changed
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000287|FocusGained| Vim got input focus
288|FocusLost| Vim lost input focus
289|CursorHold| the user doesn't press a key for a while
Bram Moolenaar754b5602006-02-09 23:53:20 +0000290|CursorHoldI| the user doesn't press a key for a while in Insert mode
291|CursorMoved| the cursor was moved in Normal mode
292|CursorMovedI| the cursor was moved in Insert mode
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000293
294|WinEnter| after entering another window
295|WinLeave| before leaving a window
Bram Moolenaarfaa959a2006-02-20 21:37:40 +0000296|TabEnter| after entering another tab page
297|TabLeave| before leaving a tab page
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000298|CmdwinEnter| after entering the command-line window
299|CmdwinLeave| before leaving the command-line window
300
301|InsertEnter| starting Insert mode
302|InsertChange| when typing <Insert> while in Insert or Replace mode
303|InsertLeave| when leaving Insert mode
Bram Moolenaare659c952011-05-19 17:25:41 +0200304|InsertCharPre| when a character was typed in Insert mode, before
305 inserting it
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000306
307|ColorScheme| after loading a color scheme
308
309|RemoteReply| a reply from a server Vim was received
310
311|QuickFixCmdPre| before a quickfix command is run
312|QuickFixCmdPost| after a quickfix command is run
313
314|SessionLoadPost| after loading a session file
315
316|MenuPopup| just before showing the popup menu
Bram Moolenaard09acef2012-09-21 14:54:30 +0200317|CompleteDone| after Insert mode completion is done
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000318
319|User| to be used in combination with ":doautocmd"
320
321
322The alphabetical list of autocommand events: *autocmd-events-abc*
323
324 *BufCreate* *BufAdd*
325BufAdd or BufCreate Just after creating a new buffer which is
326 added to the buffer list, or adding a buffer
327 to the buffer list.
328 Also used just after a buffer in the buffer
329 list has been renamed.
330 The BufCreate event is for historic reasons.
331 NOTE: When this autocommand is executed, the
332 current buffer "%" may be different from the
333 buffer being created "<afile>".
334 *BufDelete*
335BufDelete Before deleting a buffer from the buffer list.
336 The BufUnload may be called first (if the
337 buffer was loaded).
338 Also used just before a buffer in the buffer
339 list is renamed.
340 NOTE: When this autocommand is executed, the
341 current buffer "%" may be different from the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000342 buffer being deleted "<afile>" and "<abuf>".
Bram Moolenaarb849e712009-06-24 15:51:37 +0000343 Don't change to another buffer, it will cause
344 problems.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000345 *BufEnter*
346BufEnter After entering a buffer. Useful for setting
347 options for a file type. Also executed when
348 starting to edit a buffer, after the
349 BufReadPost autocommands.
350 *BufFilePost*
351BufFilePost After changing the name of the current buffer
352 with the ":file" or ":saveas" command.
Bram Moolenaar4770d092006-01-12 23:22:24 +0000353 *BufFilePre*
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000354BufFilePre Before changing the name of the current buffer
355 with the ":file" or ":saveas" command.
356 *BufHidden*
357BufHidden Just after a buffer has become hidden. That
358 is, when there are no longer windows that show
359 the buffer, but the buffer is not unloaded or
360 deleted. Not used for ":qa" or ":q" when
361 exiting Vim.
362 NOTE: When this autocommand is executed, the
363 current buffer "%" may be different from the
364 buffer being unloaded "<afile>".
365 *BufLeave*
366BufLeave Before leaving to another buffer. Also when
367 leaving or closing the current window and the
368 new current window is not for the same buffer.
369 Not used for ":qa" or ":q" when exiting Vim.
370 *BufNew*
371BufNew Just after creating a new buffer. Also used
372 just after a buffer has been renamed. When
373 the buffer is added to the buffer list BufAdd
374 will be triggered too.
375 NOTE: When this autocommand is executed, the
376 current buffer "%" may be different from the
377 buffer being created "<afile>".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000378 *BufNewFile*
379BufNewFile When starting to edit a file that doesn't
380 exist. Can be used to read in a skeleton
381 file.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000382 *BufRead* *BufReadPost*
383BufRead or BufReadPost When starting to edit a new buffer, after
384 reading the file into the buffer, before
385 executing the modelines. See |BufWinEnter|
386 for when you need to do something after
387 processing the modelines.
388 This does NOT work for ":r file". Not used
389 when the file doesn't exist. Also used after
390 successfully recovering a file.
Bram Moolenaar30b65812012-07-12 22:01:11 +0200391 Also triggered for the filetypedetect group
392 when executing ":filetype detect" and when
393 writing an unnamed buffer in a way that the
394 buffer gets a name.
Bram Moolenaar4770d092006-01-12 23:22:24 +0000395 *BufReadCmd*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000396BufReadCmd Before starting to edit a new buffer. Should
397 read the file into the buffer. |Cmd-event|
Bram Moolenaar4770d092006-01-12 23:22:24 +0000398 *BufReadPre* *E200* *E201*
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000399BufReadPre When starting to edit a new buffer, before
400 reading the file into the buffer. Not used
401 if the file doesn't exist.
402 *BufUnload*
403BufUnload Before unloading a buffer. This is when the
404 text in the buffer is going to be freed. This
405 may be after a BufWritePost and before a
406 BufDelete. Also used for all buffers that are
407 loaded when Vim is going to exit.
408 NOTE: When this autocommand is executed, the
409 current buffer "%" may be different from the
410 buffer being unloaded "<afile>".
Bram Moolenaarb849e712009-06-24 15:51:37 +0000411 Don't change to another buffer, it will cause
412 problems.
Bram Moolenaar0e1e25f2010-05-28 21:07:08 +0200413 When exiting and v:dying is 2 or more this
414 event is not triggered.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000415 *BufWinEnter*
416BufWinEnter After a buffer is displayed in a window. This
417 can be when the buffer is loaded (after
Bram Moolenaar446cb832008-06-24 21:56:24 +0000418 processing the modelines) or when a hidden
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000419 buffer is displayed in a window (and is no
Bram Moolenaar446cb832008-06-24 21:56:24 +0000420 longer hidden).
421 Does not happen for |:split| without
422 arguments, since you keep editing the same
423 buffer, or ":split" with a file that's already
Bram Moolenaarc236c162008-07-13 17:41:49 +0000424 open in a window, because it re-uses an
425 existing buffer. But it does happen for a
426 ":split" with the name of the current buffer,
427 since it reloads that buffer.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000428 *BufWinLeave*
429BufWinLeave Before a buffer is removed from a window.
430 Not when it's still visible in another window.
431 Also triggered when exiting. It's triggered
432 before BufUnload or BufHidden.
433 NOTE: When this autocommand is executed, the
434 current buffer "%" may be different from the
435 buffer being unloaded "<afile>".
Bram Moolenaar0e1e25f2010-05-28 21:07:08 +0200436 When exiting and v:dying is 2 or more this
437 event is not triggered.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000438 *BufWipeout*
439BufWipeout Before completely deleting a buffer. The
440 BufUnload and BufDelete events may be called
441 first (if the buffer was loaded and was in the
442 buffer list). Also used just before a buffer
443 is renamed (also when it's not in the buffer
444 list).
445 NOTE: When this autocommand is executed, the
446 current buffer "%" may be different from the
447 buffer being deleted "<afile>".
Bram Moolenaarb849e712009-06-24 15:51:37 +0000448 Don't change to another buffer, it will cause
449 problems.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000450 *BufWrite* *BufWritePre*
451BufWrite or BufWritePre Before writing the whole buffer to a file.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000452 *BufWriteCmd*
453BufWriteCmd Before writing the whole buffer to a file.
454 Should do the writing of the file and reset
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000455 'modified' if successful, unless '+' is in
456 'cpo' and writing to another file |cpo-+|.
457 The buffer contents should not be changed.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +0200458 When the command resets 'modified' the undo
459 information is adjusted to mark older undo
460 states as 'modified', like |:write| does.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000461 |Cmd-event|
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000462 *BufWritePost*
463BufWritePost After writing the whole buffer to a file
464 (should undo the commands for BufWritePre).
465 *CmdwinEnter*
466CmdwinEnter After entering the command-line window.
467 Useful for setting options specifically for
468 this special type of window. This is
469 triggered _instead_ of BufEnter and WinEnter.
470 <afile> is set to a single character,
471 indicating the type of command-line.
472 |cmdwin-char|
473 *CmdwinLeave*
474CmdwinLeave Before leaving the command-line window.
475 Useful to clean up any global setting done
476 with CmdwinEnter. This is triggered _instead_
477 of BufLeave and WinLeave.
478 <afile> is set to a single character,
479 indicating the type of command-line.
480 |cmdwin-char|
481 *ColorScheme*
482ColorScheme After loading a color scheme. |:colorscheme|
Bram Moolenaar754b5602006-02-09 23:53:20 +0000483
Bram Moolenaar30b65812012-07-12 22:01:11 +0200484 *CompleteDone*
485CompleteDone After Insert mode completion is done. Either
486 when something was completed or abandoning
487 completion. |ins-completion|
488
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000489 *CursorHold*
490CursorHold When the user doesn't press a key for the time
491 specified with 'updatetime'. Not re-triggered
492 until the user has pressed a key (i.e. doesn't
493 fire every 'updatetime' ms if you leave Vim to
494 make some coffee. :) See |CursorHold-example|
495 for previewing tags.
496 This event is only triggered in Normal mode.
Bram Moolenaard7afed32007-05-06 13:26:41 +0000497 It is not triggered when waiting for a command
498 argument to be typed, or a movement after an
499 operator.
Bram Moolenaare3226be2005-12-18 22:10:00 +0000500 While recording the CursorHold event is not
501 triggered. |q|
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000502 Note: Interactive commands cannot be used for
503 this event. There is no hit-enter prompt,
504 the screen is updated directly (when needed).
505 Note: In the future there will probably be
506 another option to set the time.
507 Hint: to force an update of the status lines
508 use: >
509 :let &ro = &ro
510< {only on Amiga, Unix, Win32, MSDOS and all GUI
511 versions}
Bram Moolenaar754b5602006-02-09 23:53:20 +0000512 *CursorHoldI*
513CursorHoldI Just like CursorHold, but in Insert mode.
514
515 *CursorMoved*
516CursorMoved After the cursor was moved in Normal mode.
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +0000517 Also when the text of the cursor line has been
518 changed, e.g., with "x", "rx" or "p".
Bram Moolenaar754b5602006-02-09 23:53:20 +0000519 Not triggered when there is typeahead or when
520 an operator is pending.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000521 For an example see |match-parens|.
Bram Moolenaarbf884932013-04-05 22:26:15 +0200522 Careful: This is triggered very often, don't
523 do anything that the user does not expect or
524 that is slow.
Bram Moolenaar754b5602006-02-09 23:53:20 +0000525 *CursorMovedI*
526CursorMovedI After the cursor was moved in Insert mode.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +0200527 Not triggered when the popup menu is visible.
Bram Moolenaar754b5602006-02-09 23:53:20 +0000528 Otherwise the same as CursorMoved.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000529 *EncodingChanged*
530EncodingChanged Fires off after the 'encoding' option has been
531 changed. Useful to set up fonts, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000532 *FileAppendCmd*
533FileAppendCmd Before appending to a file. Should do the
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +0000534 appending to the file. Use the '[ and ']
535 marks for the range of lines.|Cmd-event|
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000536 *FileAppendPost*
537FileAppendPost After appending to a file.
538 *FileAppendPre*
539FileAppendPre Before appending to a file. Use the '[ and ']
540 marks for the range of lines.
541 *FileChangedRO*
542FileChangedRO Before making the first change to a read-only
543 file. Can be used to check-out the file from
544 a source control system. Not triggered when
545 the change was caused by an autocommand.
546 This event is triggered when making the first
547 change in a buffer or the first change after
Bram Moolenaar61660ea2006-04-07 21:40:07 +0000548 'readonly' was set, just before the change is
549 applied to the text.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000550 WARNING: If the autocommand moves the cursor
551 the effect of the change is undefined.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000552 *E788*
553 It is not allowed to change to another buffer
554 here. You can reload the buffer but not edit
555 another one.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000556 *FileChangedShell*
557FileChangedShell When Vim notices that the modification time of
558 a file has changed since editing started.
559 Also when the file attributes of the file
560 change. |timestamp|
561 Mostly triggered after executing a shell
562 command, but also with a |:checktime| command
Bram Moolenaar19a09a12005-03-04 23:39:37 +0000563 or when Gvim regains input focus.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000564 This autocommand is triggered for each changed
565 file. It is not used when 'autoread' is set
566 and the buffer was not changed. If a
567 FileChangedShell autocommand is present the
568 warning message and prompt is not given.
Bram Moolenaar19a09a12005-03-04 23:39:37 +0000569 The |v:fcs_reason| variable is set to indicate
570 what happened and |v:fcs_choice| can be used
571 to tell Vim what to do next.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572 NOTE: When this autocommand is executed, the
573 current buffer "%" may be different from the
574 buffer that was changed "<afile>".
575 NOTE: The commands must not change the current
576 buffer, jump to another buffer or delete a
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100577 buffer. *E246* *E811*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000578 NOTE: This event never nests, to avoid an
579 endless loop. This means that while executing
580 commands for the FileChangedShell event no
581 other FileChangedShell event will be
582 triggered.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +0000583 *FileChangedShellPost*
584FileChangedShellPost After handling a file that was changed outside
585 of Vim. Can be used to update the statusline.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000586 *FileEncoding*
587FileEncoding Obsolete. It still works and is equivalent
588 to |EncodingChanged|.
589 *FileReadCmd*
590FileReadCmd Before reading a file with a ":read" command.
591 Should do the reading of the file. |Cmd-event|
592 *FileReadPost*
593FileReadPost After reading a file with a ":read" command.
594 Note that Vim sets the '[ and '] marks to the
595 first and last line of the read. This can be
596 used to operate on the lines just read.
597 *FileReadPre*
598FileReadPre Before reading a file with a ":read" command.
599 *FileType*
Bram Moolenaard7afed32007-05-06 13:26:41 +0000600FileType When the 'filetype' option has been set. The
601 pattern is matched against the filetype.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000602 <afile> can be used for the name of the file
603 where this option was set, and <amatch> for
604 the new value of 'filetype'.
605 See |filetypes|.
606 *FileWriteCmd*
607FileWriteCmd Before writing to a file, when not writing the
608 whole buffer. Should do the writing to the
609 file. Should not change the buffer. Use the
610 '[ and '] marks for the range of lines.
611 |Cmd-event|
612 *FileWritePost*
613FileWritePost After writing to a file, when not writing the
614 whole buffer.
615 *FileWritePre*
616FileWritePre Before writing to a file, when not writing the
617 whole buffer. Use the '[ and '] marks for the
618 range of lines.
619 *FilterReadPost*
620FilterReadPost After reading a file from a filter command.
621 Vim checks the pattern against the name of
622 the current buffer as with FilterReadPre.
623 Not triggered when 'shelltemp' is off.
624 *FilterReadPre* *E135*
625FilterReadPre Before reading a file from a filter command.
626 Vim checks the pattern against the name of
627 the current buffer, not the name of the
628 temporary file that is the output of the
629 filter command.
630 Not triggered when 'shelltemp' is off.
631 *FilterWritePost*
632FilterWritePost After writing a file for a filter command or
633 making a diff.
634 Vim checks the pattern against the name of
635 the current buffer as with FilterWritePre.
636 Not triggered when 'shelltemp' is off.
637 *FilterWritePre*
638FilterWritePre Before writing a file for a filter command or
639 making a diff.
640 Vim checks the pattern against the name of
641 the current buffer, not the name of the
642 temporary file that is the output of the
643 filter command.
644 Not triggered when 'shelltemp' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000645 *FocusGained*
646FocusGained When Vim got input focus. Only for the GUI
647 version and a few console versions where this
648 can be detected.
649 *FocusLost*
650FocusLost When Vim lost input focus. Only for the GUI
651 version and a few console versions where this
Bram Moolenaar843ee412004-06-30 16:16:41 +0000652 can be detected. May also happen when a
653 dialog pops up.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000654 *FuncUndefined*
655FuncUndefined When a user function is used but it isn't
656 defined. Useful for defining a function only
Bram Moolenaard7afed32007-05-06 13:26:41 +0000657 when it's used. The pattern is matched
658 against the function name. Both <amatch> and
659 <afile> are set to the name of the function.
Bram Moolenaar7c626922005-02-07 22:01:03 +0000660 See |autoload-functions|.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000661 *GUIEnter*
662GUIEnter After starting the GUI successfully, and after
663 opening the window. It is triggered before
664 VimEnter when using gvim. Can be used to
665 position the window from a .gvimrc file: >
666 :autocmd GUIEnter * winpos 100 50
Bram Moolenaard7afed32007-05-06 13:26:41 +0000667< *GUIFailed*
668GUIFailed After starting the GUI failed. Vim may
669 continue to run in the terminal, if possible
670 (only on Unix and alikes, when connecting the
671 X server fails). You may want to quit Vim: >
672 :autocmd GUIFailed * qall
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000673< *InsertChange*
674InsertChange When typing <Insert> while in Insert or
675 Replace mode. The |v:insertmode| variable
676 indicates the new mode.
677 Be careful not to move the cursor or do
678 anything else that the user does not expect.
Bram Moolenaare659c952011-05-19 17:25:41 +0200679 *InsertCharPre*
680InsertCharPre When a character is typed in Insert mode,
681 before inserting the char.
682 The |v:char| variable indicates the char typed
683 and can be changed during the event to insert
684 a different character. When |v:char| is set
685 to more than one character this text is
686 inserted literally.
687 It is not allowed to change the text |textlock|.
688 The event is not triggered when 'paste' is
689 set.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000690 *InsertEnter*
Bram Moolenaard7afed32007-05-06 13:26:41 +0000691InsertEnter Just before starting Insert mode. Also for
692 Replace mode and Virtual Replace mode. The
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000693 |v:insertmode| variable indicates the mode.
694 Be careful not to move the cursor or do
695 anything else that the user does not expect.
696 *InsertLeave*
697InsertLeave When leaving Insert mode. Also when using
698 CTRL-O |i_CTRL-O|. But not for |i_CTRL-C|.
699 *MenuPopup*
700MenuPopup Just before showing the popup menu (under the
701 right mouse button). Useful for adjusting the
702 menu for what is under the cursor or mouse
703 pointer.
704 The pattern is matched against a single
705 character representing the mode:
706 n Normal
707 v Visual
708 o Operator-pending
709 i Insert
Bram Moolenaar551dbcc2006-04-25 22:13:59 +0000710 c Command line
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000711 *QuickFixCmdPre*
712QuickFixCmdPre Before a quickfix command is run (|:make|,
Bram Moolenaara6557602006-02-04 22:43:20 +0000713 |:lmake|, |:grep|, |:lgrep|, |:grepadd|,
714 |:lgrepadd|, |:vimgrep|, |:lvimgrep|,
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100715 |:vimgrepadd|, |:lvimgrepadd|, |:cscope|,
Bram Moolenaar84f72352012-03-11 15:57:40 +0100716 |:cfile|, |:cgetfile|, |:caddfile|, |:lfile|,
717 |:lgetfile|, |:laddfile|, |:helpgrep|,
718 |:lhelpgrep|).
Bram Moolenaarf1eeae92010-05-14 23:14:42 +0200719 The pattern is matched against the command
720 being run. When |:grep| is used but 'grepprg'
721 is set to "internal" it still matches "grep".
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000722 This command cannot be used to set the
723 'makeprg' and 'grepprg' variables.
724 If this command causes an error, the quickfix
725 command is not executed.
726 *QuickFixCmdPost*
727QuickFixCmdPost Like QuickFixCmdPre, but after a quickfix
Bram Moolenaarf9393ef2006-04-24 19:47:27 +0000728 command is run, before jumping to the first
Bram Moolenaar8ec1f852012-03-07 20:13:49 +0100729 location. For |:cfile| and |:lfile| commands
730 it is run after error file is read and before
731 moving to the first error.
732 See |QuickFixCmdPost-example|.
Bram Moolenaar30b65812012-07-12 22:01:11 +0200733 *QuitPre*
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100734QuitPre When using `:quit`, `:wq` or `:qall`, before
735 deciding whether it closes the current window
736 or quits Vim. Can be used to close any
737 non-essential window if the current window is
738 the last ordinary window.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000739 *RemoteReply*
740RemoteReply When a reply from a Vim that functions as
Bram Moolenaard7afed32007-05-06 13:26:41 +0000741 server was received |server2client()|. The
742 pattern is matched against the {serverid}.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000743 <amatch> is equal to the {serverid} from which
744 the reply was sent, and <afile> is the actual
745 reply string.
746 Note that even if an autocommand is defined,
747 the reply should be read with |remote_read()|
748 to consume it.
749 *SessionLoadPost*
750SessionLoadPost After loading the session file created using
751 the |:mksession| command.
Bram Moolenaara94bc432006-03-10 21:42:59 +0000752 *ShellCmdPost*
753ShellCmdPost After executing a shell command with |:!cmd|,
754 |:shell|, |:make| and |:grep|. Can be used to
755 check for any changed files.
756 *ShellFilterPost*
757ShellFilterPost After executing a shell command with
758 ":{range}!cmd", ":w !cmd" or ":r !cmd".
759 Can be used to check for any changed files.
Bram Moolenaar1f35bf92006-03-07 22:38:47 +0000760 *SourcePre*
761SourcePre Before sourcing a Vim script. |:source|
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +0000762 <afile> is the name of the file being sourced.
763 *SourceCmd*
764SourceCmd When sourcing a Vim script. |:source|
765 <afile> is the name of the file being sourced.
766 The autocommand must source this file.
767 |Cmd-event|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000768 *SpellFileMissing*
769SpellFileMissing When trying to load a spell checking file and
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +0000770 it can't be found. The pattern is matched
771 against the language. <amatch> is the
772 language, 'encoding' also matters. See
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000773 |spell-SpellFileMissing|.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000774 *StdinReadPost*
775StdinReadPost After reading from the stdin into the buffer,
776 before executing the modelines. Only used
777 when the "-" argument was used when Vim was
778 started |--|.
779 *StdinReadPre*
780StdinReadPre Before reading from stdin into the buffer.
781 Only used when the "-" argument was used when
782 Vim was started |--|.
783 *SwapExists*
784SwapExists Detected an existing swap file when starting
785 to edit a file. Only when it is possible to
786 select a way to handle the situation, when Vim
787 would ask the user what to do.
788 The |v:swapname| variable holds the name of
Bram Moolenaarb3480382005-12-11 21:33:32 +0000789 the swap file found, <afile> the file being
790 edited. |v:swapcommand| may contain a command
791 to be executed in the opened file.
792 The commands should set the |v:swapchoice|
793 variable to a string with one character to
794 tell Vim what should be done next:
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000795 'o' open read-only
796 'e' edit the file anyway
797 'r' recover
798 'd' delete the swap file
799 'q' quit, don't edit the file
800 'a' abort, like hitting CTRL-C
801 When set to an empty string the user will be
802 asked, as if there was no SwapExists autocmd.
Bram Moolenaarb849e712009-06-24 15:51:37 +0000803 *E812*
804 It is not allowed to change to another buffer,
805 change a buffer name or change directory
806 here.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000807 *Syntax*
Bram Moolenaard7afed32007-05-06 13:26:41 +0000808Syntax When the 'syntax' option has been set. The
809 pattern is matched against the syntax name.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000810 <afile> can be used for the name of the file
811 where this option was set, and <amatch> for
812 the new value of 'syntax'.
813 See |:syn-on|.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +0000814 *TabEnter*
815TabEnter Just after entering a tab page. |tab-page|
Bram Moolenaar56a907a2006-05-06 21:44:30 +0000816 After triggering the WinEnter and before
817 triggering the BufEnter event.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +0000818 *TabLeave*
819TabLeave Just before leaving a tab page. |tab-page|
820 A WinLeave event will have been triggered
821 first.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000822 *TermChanged*
823TermChanged After the value of 'term' has changed. Useful
824 for re-loading the syntax file to update the
825 colors, fonts and other terminal-dependent
826 settings. Executed for all loaded buffers.
827 *TermResponse*
828TermResponse After the response to |t_RV| is received from
829 the terminal. The value of |v:termresponse|
830 can be used to do things depending on the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +0200831 terminal version. Note that this event may be
832 triggered halfway executing another event,
833 especially if file I/O, a shell command or
834 anything else that takes time is involved.
Bram Moolenaarbf884932013-04-05 22:26:15 +0200835 *TextChanged*
836TextChanged After a change was made to the text in the
837 current buffer in Normal mode. That is when
838 |b:changedtick| has changed.
839 Not triggered when there is typeahead or when
840 an operator is pending.
841 Careful: This is triggered very often, don't
842 do anything that the user does not expect or
843 that is slow.
844 *TextChangedI*
845TextChangedI After a change was made to the text in the
846 current buffer in Insert mode.
847 Not triggered when the popup menu is visible.
848 Otherwise the same as TextChanged.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000849 *User*
850User Never executed automatically. To be used for
851 autocommands that are only executed with
852 ":doautocmd".
853 *UserGettingBored*
Bram Moolenaarbf884932013-04-05 22:26:15 +0200854UserGettingBored When the user presses the same key 42 times.
855 Just kidding! :-)
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000856 *VimEnter*
857VimEnter After doing all the startup stuff, including
858 loading .vimrc files, executing the "-c cmd"
859 arguments, creating all windows and loading
860 the buffers in them.
861 *VimLeave*
862VimLeave Before exiting Vim, just after writing the
863 .viminfo file. Executed only once, like
864 VimLeavePre.
865 To detect an abnormal exit use |v:dying|.
Bram Moolenaar0e1e25f2010-05-28 21:07:08 +0200866 When v:dying is 2 or more this event is not
867 triggered.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000868 *VimLeavePre*
869VimLeavePre Before exiting Vim, just before writing the
870 .viminfo file. This is executed only once,
871 if there is a match with the name of what
872 happens to be the current buffer when exiting.
873 Mostly useful with a "*" pattern. >
874 :autocmd VimLeavePre * call CleanupStuff()
875< To detect an abnormal exit use |v:dying|.
Bram Moolenaar0e1e25f2010-05-28 21:07:08 +0200876 When v:dying is 2 or more this event is not
877 triggered.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +0000878 *VimResized*
879VimResized After the Vim window was resized, thus 'lines'
880 and/or 'columns' changed. Not when starting
881 up though.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000882 *WinEnter*
883WinEnter After entering another window. Not done for
884 the first window, when Vim has just started.
885 Useful for setting the window height.
886 If the window is for another buffer, Vim
887 executes the BufEnter autocommands after the
888 WinEnter autocommands.
889 Note: When using ":split fname" the WinEnter
890 event is triggered after the split but before
891 the file "fname" is loaded.
892 *WinLeave*
893WinLeave Before leaving a window. If the window to be
894 entered next is for a different buffer, Vim
895 executes the BufLeave autocommands before the
896 WinLeave autocommands (but not for ":new").
897 Not used for ":qa" or ":q" when exiting Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000898
899==============================================================================
9006. Patterns *autocmd-patterns* *{pat}*
901
902The file pattern {pat} is tested for a match against the file name in one of
903two ways:
9041. When there is no '/' in the pattern, Vim checks for a match against only
905 the tail part of the file name (without its leading directory path).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009062. When there is a '/' in the pattern, Vim checks for a match against both the
907 short file name (as you typed it) and the full file name (after expanding
908 it to a full path and resolving symbolic links).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000909
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000910The special pattern <buffer> or <buffer=N> is used for buffer-local
911autocommands |autocmd-buflocal|. This pattern is not matched against the name
912of a buffer.
913
Bram Moolenaar071d4272004-06-13 20:20:40 +0000914Examples: >
915 :autocmd BufRead *.txt set et
916Set the 'et' option for all text files. >
917
918 :autocmd BufRead /vim/src/*.c set cindent
919Set the 'cindent' option for C files in the /vim/src directory. >
920
921 :autocmd BufRead /tmp/*.c set ts=5
922If you have a link from "/tmp/test.c" to "/home/nobody/vim/src/test.c", and
923you start editing "/tmp/test.c", this autocommand will match.
924
925Note: To match part of a path, but not from the root directory, use a '*' as
926the first character. Example: >
927 :autocmd BufRead */doc/*.txt set tw=78
928This autocommand will for example be executed for "/tmp/doc/xx.txt" and
929"/usr/home/piet/doc/yy.txt". The number of directories does not matter here.
930
931
932The file name that the pattern is matched against is after expanding
Bram Moolenaar446cb832008-06-24 21:56:24 +0000933wildcards. Thus if you issue this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000934 :e $ROOTDIR/main.$EXT
935The argument is first expanded to: >
936 /usr/root/main.py
937Before it's matched with the pattern of the autocommand. Careful with this
938when using events like FileReadCmd, the value of <amatch> may not be what you
939expect.
940
941
942Environment variables can be used in a pattern: >
943 :autocmd BufRead $VIMRUNTIME/doc/*.txt set expandtab
944And ~ can be used for the home directory (if $HOME is defined): >
945 :autocmd BufWritePost ~/.vimrc so ~/.vimrc
946 :autocmd BufRead ~archive/* set readonly
947The environment variable is expanded when the autocommand is defined, not when
948the autocommand is executed. This is different from the command!
949
950 *file-pattern*
951The pattern is interpreted like mostly used in file names:
952 * matches any sequence of characters
953 ? matches any single character
954 \? matches a '?'
955 . matches a '.'
956 ~ matches a '~'
957 , separates patterns
958 \, matches a ','
959 { } like \( \) in a |pattern|
960 , inside { }: like \| in a |pattern|
961 \ special meaning like in a |pattern|
962 [ch] matches 'c' or 'h'
963 [^ch] match any character but 'c' and 'h'
964
965Note that for all systems the '/' character is used for path separator (even
966MS-DOS and OS/2). This was done because the backslash is difficult to use
967in a pattern and to make the autocommands portable across different systems.
968
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000969 *autocmd-changes*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000970Matching with the pattern is done when an event is triggered. Changing the
971buffer name in one of the autocommands, or even deleting the buffer, does not
972change which autocommands will be executed. Example: >
973
974 au BufEnter *.foo bdel
975 au BufEnter *.foo set modified
976
977This will delete the current buffer and then set 'modified' in what has become
978the current buffer instead. Vim doesn't take into account that "*.foo"
979doesn't match with that buffer name. It matches "*.foo" with the name of the
980buffer at the moment the event was triggered.
981
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000982However, buffer-local autocommands will not be executed for a buffer that has
983been wiped out with |:bwipe|. After deleting the buffer with |:bdel| the
984buffer actually still exists (it becomes unlisted), thus the autocommands are
985still executed.
986
Bram Moolenaar071d4272004-06-13 20:20:40 +0000987==============================================================================
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009887. Buffer-local autocommands *autocmd-buflocal* *autocmd-buffer-local*
989 *<buffer=N>* *<buffer=abuf>* *E680*
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000990
991Buffer-local autocommands are attached to a specific buffer. They are useful
992if the buffer does not have a name and when the name does not match a specific
993pattern. But it also means they must be explicitly added to each buffer.
994
995Instead of a pattern buffer-local autocommands use one of these forms:
996 <buffer> current buffer
997 <buffer=99> buffer number 99
998 <buffer=abuf> using <abuf> (only when executing autocommands)
999 |<abuf>|
1000
1001Examples: >
1002 :au CursorHold <buffer> echo 'hold'
1003 :au CursorHold <buffer=33> echo 'hold'
1004 :au CursorHold <buffer=abuf> echo 'hold'
1005
1006All the commands for autocommands also work with buffer-local autocommands,
1007simply use the special string instead of the pattern. Examples: >
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001008 :au! * <buffer> " remove buffer-local autocommands for
1009 " current buffer
1010 :au! * <buffer=33> " remove buffer-local autocommands for
1011 " buffer #33
Bram Moolenaar446cb832008-06-24 21:56:24 +00001012 :bufdo :au! CursorHold <buffer> " remove autocmd for given event for all
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001013 " buffers
1014 :au * <buffer> " list buffer-local autocommands for
1015 " current buffer
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00001016
1017Note that when an autocommand is defined for the current buffer, it is stored
1018with the buffer number. Thus it uses the form "<buffer=12>", where 12 is the
1019number of the current buffer. You will see this when listing autocommands,
1020for example.
1021
1022To test for presence of buffer-local autocommands use the |exists()| function
1023as follows: >
1024 :if exists("#CursorHold#<buffer=12>") | ... | endif
1025 :if exists("#CursorHold#<buffer>") | ... | endif " for current buffer
1026
1027When a buffer is wiped out its buffer-local autocommands are also gone, of
1028course. Note that when deleting a buffer, e.g., with ":bdel", it is only
1029unlisted, the autocommands are still present. In order to see the removal of
1030buffer-local autocommands: >
1031 :set verbose=6
1032
1033It is not possible to define buffer-local autocommands for a non-existent
1034buffer.
1035
1036==============================================================================
10378. Groups *autocmd-groups*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001038
1039Autocommands can be put together in a group. This is useful for removing or
1040executing a group of autocommands. For example, all the autocommands for
1041syntax highlighting are put in the "highlight" group, to be able to execute
1042":doautoall highlight BufRead" when the GUI starts.
1043
1044When no specific group is selected, Vim uses the default group. The default
1045group does not have a name. You cannot execute the autocommands from the
1046default group separately; you can execute them only by executing autocommands
1047for all groups.
1048
1049Normally, when executing autocommands automatically, Vim uses the autocommands
1050for all groups. The group only matters when executing autocommands with
1051":doautocmd" or ":doautoall", or when defining or deleting autocommands.
1052
1053The group name can contain any characters except white space. The group name
1054"end" is reserved (also in uppercase).
1055
1056The group name is case sensitive. Note that this is different from the event
1057name!
1058
1059 *:aug* *:augroup*
1060:aug[roup] {name} Define the autocmd group name for the
1061 following ":autocmd" commands. The name "end"
1062 or "END" selects the default group.
1063
1064 *:augroup-delete* *E367*
1065:aug[roup]! {name} Delete the autocmd group {name}. Don't use
1066 this if there is still an autocommand using
1067 this group! This is not checked.
1068
1069To enter autocommands for a specific group, use this method:
10701. Select the group with ":augroup {name}".
10712. Delete any old autocommands with ":au!".
10723. Define the autocommands.
10734. Go back to the default group with "augroup END".
1074
1075Example: >
1076 :augroup uncompress
1077 : au!
1078 : au BufEnter *.gz %!gunzip
1079 :augroup END
1080
1081This prevents having the autocommands defined twice (e.g., after sourcing the
1082.vimrc file again).
1083
1084==============================================================================
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +000010859. Executing autocommands *autocmd-execute*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001086
1087Vim can also execute Autocommands non-automatically. This is useful if you
1088have changed autocommands, or when Vim has executed the wrong autocommands
1089(e.g., the file pattern match was wrong).
1090
1091Note that the 'eventignore' option applies here too. Events listed in this
1092option will not cause any commands to be executed.
1093
1094 *:do* *:doau* *:doautocmd* *E217*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01001095:do[autocmd] [<nomodeline>] [group] {event} [fname]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001096 Apply the autocommands matching [fname] (default:
1097 current file name) for {event} to the current buffer.
1098 You can use this when the current file name does not
1099 match the right pattern, after changing settings, or
1100 to execute autocommands for a certain event.
1101 It's possible to use this inside an autocommand too,
1102 so you can base the autocommands for one extension on
1103 another extension. Example: >
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001104 :au BufEnter *.cpp so ~/.vimrc_cpp
1105 :au BufEnter *.cpp doau BufEnter x.c
Bram Moolenaar071d4272004-06-13 20:20:40 +00001106< Be careful to avoid endless loops. See
1107 |autocmd-nested|.
1108
1109 When the [group] argument is not given, Vim executes
1110 the autocommands for all groups. When the [group]
1111 argument is included, Vim executes only the matching
1112 autocommands for that group. Note: if you use an
1113 undefined group name, Vim gives you an error message.
Bram Moolenaar60542ac2012-02-12 20:14:01 +01001114 *<nomodeline>*
1115 After applying the autocommands the modelines are
1116 processed, so that their settings overrule the
1117 settings from autocommands, like what happens when
1118 editing a file. This is skipped when the <nomodeline>
1119 argument is present. You probably want to use
1120 <nomodeline> for events that are not used when loading
1121 a buffer, such as |User|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001122
1123 *:doautoa* *:doautoall*
Bram Moolenaara61d5fb2012-02-12 00:18:58 +01001124:doautoa[ll] [<nomodeline>] [group] {event} [fname]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001125 Like ":doautocmd", but apply the autocommands to each
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001126 loaded buffer. Note that [fname] is used to select
Bram Moolenaar071d4272004-06-13 20:20:40 +00001127 the autocommands, not the buffers to which they are
1128 applied.
1129 Careful: Don't use this for autocommands that delete a
1130 buffer, change to another buffer or change the
1131 contents of a buffer; the result is unpredictable.
1132 This command is intended for autocommands that set
1133 options, change highlighting, and things like that.
1134
1135==============================================================================
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000113610. Using autocommands *autocmd-use*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001137
1138For WRITING FILES there are four possible sets of events. Vim uses only one
1139of these sets for a write command:
1140
1141BufWriteCmd BufWritePre BufWritePost writing the whole buffer
1142 FilterWritePre FilterWritePost writing to filter temp file
1143FileAppendCmd FileAppendPre FileAppendPost appending to a file
1144FileWriteCmd FileWritePre FileWritePost any other file write
1145
1146When there is a matching "*Cmd" autocommand, it is assumed it will do the
1147writing. No further writing is done and the other events are not triggered.
1148|Cmd-event|
1149
1150Note that the *WritePost commands should undo any changes to the buffer that
1151were caused by the *WritePre commands; otherwise, writing the file will have
1152the side effect of changing the buffer.
1153
1154Before executing the autocommands, the buffer from which the lines are to be
1155written temporarily becomes the current buffer. Unless the autocommands
1156change the current buffer or delete the previously current buffer, the
1157previously current buffer is made the current buffer again.
1158
1159The *WritePre and *AppendPre autocommands must not delete the buffer from
1160which the lines are to be written.
1161
1162The '[ and '] marks have a special position:
1163- Before the *ReadPre event the '[ mark is set to the line just above where
1164 the new lines will be inserted.
1165- Before the *ReadPost event the '[ mark is set to the first line that was
1166 just read, the '] mark to the last line.
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001167- Before executing the *WriteCmd, *WritePre and *AppendPre autocommands the '[
1168 mark is set to the first line that will be written, the '] mark to the last
1169 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001170Careful: '[ and '] change when using commands that change the buffer.
1171
1172In commands which expect a file name, you can use "<afile>" for the file name
1173that is being read |:<afile>| (you can also use "%" for the current file
1174name). "<abuf>" can be used for the buffer number of the currently effective
1175buffer. This also works for buffers that doesn't have a name. But it doesn't
1176work for files without a buffer (e.g., with ":r file").
1177
1178 *gzip-example*
1179Examples for reading and writing compressed files: >
1180 :augroup gzip
1181 : autocmd!
1182 : autocmd BufReadPre,FileReadPre *.gz set bin
1183 : autocmd BufReadPost,FileReadPost *.gz '[,']!gunzip
1184 : autocmd BufReadPost,FileReadPost *.gz set nobin
1185 : autocmd BufReadPost,FileReadPost *.gz execute ":doautocmd BufReadPost " . expand("%:r")
1186 : autocmd BufWritePost,FileWritePost *.gz !mv <afile> <afile>:r
1187 : autocmd BufWritePost,FileWritePost *.gz !gzip <afile>:r
1188
1189 : autocmd FileAppendPre *.gz !gunzip <afile>
1190 : autocmd FileAppendPre *.gz !mv <afile>:r <afile>
1191 : autocmd FileAppendPost *.gz !mv <afile> <afile>:r
1192 : autocmd FileAppendPost *.gz !gzip <afile>:r
1193 :augroup END
1194
1195The "gzip" group is used to be able to delete any existing autocommands with
1196":autocmd!", for when the file is sourced twice.
1197
1198("<afile>:r" is the file name without the extension, see |:_%:|)
1199
1200The commands executed for the BufNewFile, BufRead/BufReadPost, BufWritePost,
1201FileAppendPost and VimLeave events do not set or reset the changed flag of the
1202buffer. When you decompress the buffer with the BufReadPost autocommands, you
1203can still exit with ":q". When you use ":undo" in BufWritePost to undo the
1204changes made by BufWritePre commands, you can still do ":q" (this also makes
1205"ZZ" work). If you do want the buffer to be marked as modified, set the
1206'modified' option.
1207
1208To execute Normal mode commands from an autocommand, use the ":normal"
1209command. Use with care! If the Normal mode command is not finished, the user
1210needs to type characters (e.g., after ":normal m" you need to type a mark
1211name).
1212
1213If you want the buffer to be unmodified after changing it, reset the
1214'modified' option. This makes it possible to exit the buffer with ":q"
1215instead of ":q!".
1216
1217 *autocmd-nested* *E218*
1218By default, autocommands do not nest. If you use ":e" or ":w" in an
1219autocommand, Vim does not execute the BufRead and BufWrite autocommands for
1220those commands. If you do want this, use the "nested" flag for those commands
1221in which you want nesting. For example: >
1222 :autocmd FileChangedShell *.c nested e!
1223The nesting is limited to 10 levels to get out of recursive loops.
1224
1225It's possible to use the ":au" command in an autocommand. This can be a
1226self-modifying command! This can be useful for an autocommand that should
1227execute only once.
1228
Bram Moolenaarb3480382005-12-11 21:33:32 +00001229If you want to skip autocommands for one command, use the |:noautocmd| command
1230modifier or the 'eventignore' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001231
1232Note: When reading a file (with ":read file" or with a filter command) and the
1233last line in the file does not have an <EOL>, Vim remembers this. At the next
1234write (with ":write file" or with a filter command), if the same line is
1235written again as the last line in a file AND 'binary' is set, Vim does not
1236supply an <EOL>. This makes a filter command on the just read lines write the
1237same file as was read, and makes a write command on just filtered lines write
1238the same file as was read from the filter. For example, another way to write
1239a compressed file: >
1240
1241 :autocmd FileWritePre *.gz set bin|'[,']!gzip
1242 :autocmd FileWritePost *.gz undo|set nobin
1243<
1244 *autocommand-pattern*
1245You can specify multiple patterns, separated by commas. Here are some
1246examples: >
1247
1248 :autocmd BufRead * set tw=79 nocin ic infercase fo=2croq
1249 :autocmd BufRead .letter set tw=72 fo=2tcrq
1250 :autocmd BufEnter .letter set dict=/usr/lib/dict/words
1251 :autocmd BufLeave .letter set dict=
1252 :autocmd BufRead,BufNewFile *.c,*.h set tw=0 cin noic
1253 :autocmd BufEnter *.c,*.h abbr FOR for (i = 0; i < 3; ++i)<CR>{<CR>}<Esc>O
1254 :autocmd BufLeave *.c,*.h unabbr FOR
1255
1256For makefiles (makefile, Makefile, imakefile, makefile.unix, etc.): >
1257
1258 :autocmd BufEnter ?akefile* set include=^s\=include
1259 :autocmd BufLeave ?akefile* set include&
1260
1261To always start editing C files at the first function: >
1262
1263 :autocmd BufRead *.c,*.h 1;/^{
1264
1265Without the "1;" above, the search would start from wherever the file was
1266entered, rather than from the start of the file.
1267
1268 *skeleton* *template*
1269To read a skeleton (template) file when opening a new file: >
1270
1271 :autocmd BufNewFile *.c 0r ~/vim/skeleton.c
1272 :autocmd BufNewFile *.h 0r ~/vim/skeleton.h
1273 :autocmd BufNewFile *.java 0r ~/vim/skeleton.java
1274
1275To insert the current date and time in a *.html file when writing it: >
1276
1277 :autocmd BufWritePre,FileWritePre *.html ks|call LastMod()|'s
1278 :fun LastMod()
1279 : if line("$") > 20
1280 : let l = 20
1281 : else
1282 : let l = line("$")
1283 : endif
1284 : exe "1," . l . "g/Last modified: /s/Last modified: .*/Last modified: " .
1285 : \ strftime("%Y %b %d")
1286 :endfun
1287
1288You need to have a line "Last modified: <date time>" in the first 20 lines
1289of the file for this to work. Vim replaces <date time> (and anything in the
1290same line after it) with the current date and time. Explanation:
1291 ks mark current position with mark 's'
1292 call LastMod() call the LastMod() function to do the work
1293 's return the cursor to the old position
1294The LastMod() function checks if the file is shorter than 20 lines, and then
1295uses the ":g" command to find lines that contain "Last modified: ". For those
1296lines the ":s" command is executed to replace the existing date with the
1297current one. The ":execute" command is used to be able to use an expression
1298for the ":g" and ":s" commands. The date is obtained with the strftime()
1299function. You can change its argument to get another date string.
1300
1301When entering :autocmd on the command-line, completion of events and command
1302names may be done (with <Tab>, CTRL-D, etc.) where appropriate.
1303
1304Vim executes all matching autocommands in the order that you specify them.
1305It is recommended that your first autocommand be used for all files by using
1306"*" as the file pattern. This means that you can define defaults you like
1307here for any settings, and if there is another matching autocommand it will
1308override these. But if there is no other matching autocommand, then at least
1309your default settings are recovered (if entering this file from another for
1310which autocommands did match). Note that "*" will also match files starting
1311with ".", unlike Unix shells.
1312
1313 *autocmd-searchpat*
1314Autocommands do not change the current search patterns. Vim saves the current
1315search patterns before executing autocommands then restores them after the
1316autocommands finish. This means that autocommands do not affect the strings
1317highlighted with the 'hlsearch' option. Within autocommands, you can still
1318use search patterns normally, e.g., with the "n" command.
1319If you want an autocommand to set the search pattern, such that it is used
1320after the autocommand finishes, use the ":let @/ =" command.
1321The search-highlighting cannot be switched off with ":nohlsearch" in an
1322autocommand. Use the 'h' flag in the 'viminfo' option to disable search-
1323highlighting when starting Vim.
1324
1325 *Cmd-event*
1326When using one of the "*Cmd" events, the matching autocommands are expected to
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00001327do the file reading, writing or sourcing. This can be used when working with
1328a special kind of file, for example on a remote system.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001329CAREFUL: If you use these events in a wrong way, it may have the effect of
1330making it impossible to read or write the matching files! Make sure you test
1331your autocommands properly. Best is to use a pattern that will never match a
1332normal file name, for example "ftp://*".
1333
1334When defining a BufReadCmd it will be difficult for Vim to recover a crashed
1335editing session. When recovering from the original file, Vim reads only those
1336parts of a file that are not found in the swap file. Since that is not
1337possible with a BufReadCmd, use the |:preserve| command to make sure the
1338original file isn't needed for recovery. You might want to do this only when
1339you expect the file to be modified.
1340
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00001341For file read and write commands the |v:cmdarg| variable holds the "++enc="
1342and "++ff=" argument that are effective. These should be used for the command
1343that reads/writes the file. The |v:cmdbang| variable is one when "!" was
1344used, zero otherwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001345
Bram Moolenaarc88ebf72010-07-22 22:30:23 +02001346See the $VIMRUNTIME/plugin/netrwPlugin.vim for examples.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001347
Bram Moolenaarb3480382005-12-11 21:33:32 +00001348==============================================================================
134911. Disabling autocommands *autocmd-disable*
1350
1351To disable autocommands for some time use the 'eventignore' option. Note that
1352this may cause unexpected behavior, make sure you restore 'eventignore'
1353afterwards, using a |:try| block with |:finally|.
1354
1355 *:noautocmd* *:noa*
1356To disable autocommands for just one command use the ":noautocmd" command
1357modifier. This will set 'eventignore' to "all" for the duration of the
1358following command. Example: >
1359
1360 :noautocmd w fname.gz
1361
1362This will write the file without triggering the autocommands defined by the
1363gzip plugin.
1364
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00001365
Bram Moolenaar071d4272004-06-13 20:20:40 +00001366 vim:tw=78:ts=8:ft=help:norl: