blob: 3384051e2ffd6cd65c58d8e46c67d388195df956 [file] [log] [blame]
Bram Moolenaar3b1db362013-08-10 15:00:24 +02001*autocmd.txt* For Vim version 7.4. Last change: 2013 Aug 04
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*
Bram Moolenaar52b91d82013-06-15 21:39:51 +0200516CursorMoved After the cursor was moved in Normal or Visual
517 mode. Also when the text of the cursor line
518 has been 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.
Bram Moolenaar097c9922013-05-19 21:15:15 +0200694 Be careful not to do anything else that the
695 user does not expect.
696 The cursor is restored afterwards. If you do
697 not want that set |v:char| to a non-empty
698 string.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000699 *InsertLeave*
700InsertLeave When leaving Insert mode. Also when using
701 CTRL-O |i_CTRL-O|. But not for |i_CTRL-C|.
702 *MenuPopup*
703MenuPopup Just before showing the popup menu (under the
704 right mouse button). Useful for adjusting the
705 menu for what is under the cursor or mouse
706 pointer.
707 The pattern is matched against a single
708 character representing the mode:
709 n Normal
710 v Visual
711 o Operator-pending
712 i Insert
Bram Moolenaar551dbcc2006-04-25 22:13:59 +0000713 c Command line
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000714 *QuickFixCmdPre*
715QuickFixCmdPre Before a quickfix command is run (|:make|,
Bram Moolenaara6557602006-02-04 22:43:20 +0000716 |:lmake|, |:grep|, |:lgrep|, |:grepadd|,
717 |:lgrepadd|, |:vimgrep|, |:lvimgrep|,
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100718 |:vimgrepadd|, |:lvimgrepadd|, |:cscope|,
Bram Moolenaar84f72352012-03-11 15:57:40 +0100719 |:cfile|, |:cgetfile|, |:caddfile|, |:lfile|,
720 |:lgetfile|, |:laddfile|, |:helpgrep|,
721 |:lhelpgrep|).
Bram Moolenaarf1eeae92010-05-14 23:14:42 +0200722 The pattern is matched against the command
723 being run. When |:grep| is used but 'grepprg'
724 is set to "internal" it still matches "grep".
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000725 This command cannot be used to set the
726 'makeprg' and 'grepprg' variables.
727 If this command causes an error, the quickfix
728 command is not executed.
729 *QuickFixCmdPost*
730QuickFixCmdPost Like QuickFixCmdPre, but after a quickfix
Bram Moolenaarf9393ef2006-04-24 19:47:27 +0000731 command is run, before jumping to the first
Bram Moolenaar8ec1f852012-03-07 20:13:49 +0100732 location. For |:cfile| and |:lfile| commands
733 it is run after error file is read and before
734 moving to the first error.
735 See |QuickFixCmdPost-example|.
Bram Moolenaar30b65812012-07-12 22:01:11 +0200736 *QuitPre*
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100737QuitPre When using `:quit`, `:wq` or `:qall`, before
738 deciding whether it closes the current window
739 or quits Vim. Can be used to close any
740 non-essential window if the current window is
741 the last ordinary window.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000742 *RemoteReply*
743RemoteReply When a reply from a Vim that functions as
Bram Moolenaard7afed32007-05-06 13:26:41 +0000744 server was received |server2client()|. The
745 pattern is matched against the {serverid}.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000746 <amatch> is equal to the {serverid} from which
747 the reply was sent, and <afile> is the actual
748 reply string.
749 Note that even if an autocommand is defined,
750 the reply should be read with |remote_read()|
751 to consume it.
752 *SessionLoadPost*
753SessionLoadPost After loading the session file created using
754 the |:mksession| command.
Bram Moolenaara94bc432006-03-10 21:42:59 +0000755 *ShellCmdPost*
756ShellCmdPost After executing a shell command with |:!cmd|,
757 |:shell|, |:make| and |:grep|. Can be used to
758 check for any changed files.
759 *ShellFilterPost*
760ShellFilterPost After executing a shell command with
761 ":{range}!cmd", ":w !cmd" or ":r !cmd".
762 Can be used to check for any changed files.
Bram Moolenaar1f35bf92006-03-07 22:38:47 +0000763 *SourcePre*
764SourcePre Before sourcing a Vim script. |:source|
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +0000765 <afile> is the name of the file being sourced.
766 *SourceCmd*
767SourceCmd When sourcing a Vim script. |:source|
768 <afile> is the name of the file being sourced.
769 The autocommand must source this file.
770 |Cmd-event|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000771 *SpellFileMissing*
772SpellFileMissing When trying to load a spell checking file and
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +0000773 it can't be found. The pattern is matched
774 against the language. <amatch> is the
775 language, 'encoding' also matters. See
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000776 |spell-SpellFileMissing|.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000777 *StdinReadPost*
778StdinReadPost After reading from the stdin into the buffer,
779 before executing the modelines. Only used
780 when the "-" argument was used when Vim was
781 started |--|.
782 *StdinReadPre*
783StdinReadPre Before reading from stdin into the buffer.
784 Only used when the "-" argument was used when
785 Vim was started |--|.
786 *SwapExists*
787SwapExists Detected an existing swap file when starting
788 to edit a file. Only when it is possible to
789 select a way to handle the situation, when Vim
790 would ask the user what to do.
791 The |v:swapname| variable holds the name of
Bram Moolenaarb3480382005-12-11 21:33:32 +0000792 the swap file found, <afile> the file being
793 edited. |v:swapcommand| may contain a command
794 to be executed in the opened file.
795 The commands should set the |v:swapchoice|
796 variable to a string with one character to
797 tell Vim what should be done next:
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000798 'o' open read-only
799 'e' edit the file anyway
800 'r' recover
801 'd' delete the swap file
802 'q' quit, don't edit the file
803 'a' abort, like hitting CTRL-C
804 When set to an empty string the user will be
805 asked, as if there was no SwapExists autocmd.
Bram Moolenaarb849e712009-06-24 15:51:37 +0000806 *E812*
807 It is not allowed to change to another buffer,
808 change a buffer name or change directory
809 here.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000810 *Syntax*
Bram Moolenaard7afed32007-05-06 13:26:41 +0000811Syntax When the 'syntax' option has been set. The
812 pattern is matched against the syntax name.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000813 <afile> can be used for the name of the file
814 where this option was set, and <amatch> for
815 the new value of 'syntax'.
816 See |:syn-on|.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +0000817 *TabEnter*
818TabEnter Just after entering a tab page. |tab-page|
Bram Moolenaar56a907a2006-05-06 21:44:30 +0000819 After triggering the WinEnter and before
820 triggering the BufEnter event.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +0000821 *TabLeave*
822TabLeave Just before leaving a tab page. |tab-page|
823 A WinLeave event will have been triggered
824 first.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000825 *TermChanged*
826TermChanged After the value of 'term' has changed. Useful
827 for re-loading the syntax file to update the
828 colors, fonts and other terminal-dependent
829 settings. Executed for all loaded buffers.
830 *TermResponse*
831TermResponse After the response to |t_RV| is received from
832 the terminal. The value of |v:termresponse|
833 can be used to do things depending on the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +0200834 terminal version. Note that this event may be
835 triggered halfway executing another event,
836 especially if file I/O, a shell command or
837 anything else that takes time is involved.
Bram Moolenaarbf884932013-04-05 22:26:15 +0200838 *TextChanged*
839TextChanged After a change was made to the text in the
840 current buffer in Normal mode. That is when
841 |b:changedtick| has changed.
842 Not triggered when there is typeahead or when
843 an operator is pending.
844 Careful: This is triggered very often, don't
845 do anything that the user does not expect or
846 that is slow.
847 *TextChangedI*
848TextChangedI After a change was made to the text in the
849 current buffer in Insert mode.
850 Not triggered when the popup menu is visible.
851 Otherwise the same as TextChanged.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000852 *User*
853User Never executed automatically. To be used for
854 autocommands that are only executed with
855 ":doautocmd".
856 *UserGettingBored*
Bram Moolenaarbf884932013-04-05 22:26:15 +0200857UserGettingBored When the user presses the same key 42 times.
858 Just kidding! :-)
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000859 *VimEnter*
860VimEnter After doing all the startup stuff, including
861 loading .vimrc files, executing the "-c cmd"
862 arguments, creating all windows and loading
863 the buffers in them.
864 *VimLeave*
865VimLeave Before exiting Vim, just after writing the
866 .viminfo file. Executed only once, like
867 VimLeavePre.
868 To detect an abnormal exit use |v:dying|.
Bram Moolenaar0e1e25f2010-05-28 21:07:08 +0200869 When v:dying is 2 or more this event is not
870 triggered.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000871 *VimLeavePre*
872VimLeavePre Before exiting Vim, just before writing the
873 .viminfo file. This is executed only once,
874 if there is a match with the name of what
875 happens to be the current buffer when exiting.
876 Mostly useful with a "*" pattern. >
877 :autocmd VimLeavePre * call CleanupStuff()
878< To detect an abnormal exit use |v:dying|.
Bram Moolenaar0e1e25f2010-05-28 21:07:08 +0200879 When v:dying is 2 or more this event is not
880 triggered.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +0000881 *VimResized*
882VimResized After the Vim window was resized, thus 'lines'
883 and/or 'columns' changed. Not when starting
884 up though.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000885 *WinEnter*
886WinEnter After entering another window. Not done for
887 the first window, when Vim has just started.
888 Useful for setting the window height.
889 If the window is for another buffer, Vim
890 executes the BufEnter autocommands after the
891 WinEnter autocommands.
892 Note: When using ":split fname" the WinEnter
893 event is triggered after the split but before
894 the file "fname" is loaded.
895 *WinLeave*
896WinLeave Before leaving a window. If the window to be
897 entered next is for a different buffer, Vim
898 executes the BufLeave autocommands before the
899 WinLeave autocommands (but not for ":new").
900 Not used for ":qa" or ":q" when exiting Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000901
902==============================================================================
9036. Patterns *autocmd-patterns* *{pat}*
904
905The file pattern {pat} is tested for a match against the file name in one of
906two ways:
9071. When there is no '/' in the pattern, Vim checks for a match against only
908 the tail part of the file name (without its leading directory path).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009092. When there is a '/' in the pattern, Vim checks for a match against both the
910 short file name (as you typed it) and the full file name (after expanding
911 it to a full path and resolving symbolic links).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000912
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000913The special pattern <buffer> or <buffer=N> is used for buffer-local
914autocommands |autocmd-buflocal|. This pattern is not matched against the name
915of a buffer.
916
Bram Moolenaar071d4272004-06-13 20:20:40 +0000917Examples: >
918 :autocmd BufRead *.txt set et
919Set the 'et' option for all text files. >
920
921 :autocmd BufRead /vim/src/*.c set cindent
922Set the 'cindent' option for C files in the /vim/src directory. >
923
924 :autocmd BufRead /tmp/*.c set ts=5
925If you have a link from "/tmp/test.c" to "/home/nobody/vim/src/test.c", and
926you start editing "/tmp/test.c", this autocommand will match.
927
928Note: To match part of a path, but not from the root directory, use a '*' as
929the first character. Example: >
930 :autocmd BufRead */doc/*.txt set tw=78
931This autocommand will for example be executed for "/tmp/doc/xx.txt" and
932"/usr/home/piet/doc/yy.txt". The number of directories does not matter here.
933
934
935The file name that the pattern is matched against is after expanding
Bram Moolenaar446cb832008-06-24 21:56:24 +0000936wildcards. Thus if you issue this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000937 :e $ROOTDIR/main.$EXT
938The argument is first expanded to: >
939 /usr/root/main.py
940Before it's matched with the pattern of the autocommand. Careful with this
941when using events like FileReadCmd, the value of <amatch> may not be what you
942expect.
943
944
945Environment variables can be used in a pattern: >
946 :autocmd BufRead $VIMRUNTIME/doc/*.txt set expandtab
947And ~ can be used for the home directory (if $HOME is defined): >
948 :autocmd BufWritePost ~/.vimrc so ~/.vimrc
949 :autocmd BufRead ~archive/* set readonly
950The environment variable is expanded when the autocommand is defined, not when
951the autocommand is executed. This is different from the command!
952
953 *file-pattern*
954The pattern is interpreted like mostly used in file names:
Bram Moolenaar3b1db362013-08-10 15:00:24 +0200955 * matches any sequence of characters; Unusual: includes path
Bram Moolenaar9d98fe92013-08-03 18:35:36 +0200956 separators
Bram Moolenaar071d4272004-06-13 20:20:40 +0000957 ? matches any single character
958 \? matches a '?'
959 . matches a '.'
960 ~ matches a '~'
961 , separates patterns
962 \, matches a ','
963 { } like \( \) in a |pattern|
964 , inside { }: like \| in a |pattern|
Bram Moolenaara946afe2013-08-02 15:22:39 +0200965 \} literal }
966 \{ literal {
967 \\\{n,m\} like \{n,m} in a |pattern|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000968 \ special meaning like in a |pattern|
969 [ch] matches 'c' or 'h'
970 [^ch] match any character but 'c' and 'h'
971
972Note that for all systems the '/' character is used for path separator (even
973MS-DOS and OS/2). This was done because the backslash is difficult to use
974in a pattern and to make the autocommands portable across different systems.
975
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000976 *autocmd-changes*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000977Matching with the pattern is done when an event is triggered. Changing the
978buffer name in one of the autocommands, or even deleting the buffer, does not
979change which autocommands will be executed. Example: >
980
981 au BufEnter *.foo bdel
982 au BufEnter *.foo set modified
983
984This will delete the current buffer and then set 'modified' in what has become
985the current buffer instead. Vim doesn't take into account that "*.foo"
986doesn't match with that buffer name. It matches "*.foo" with the name of the
987buffer at the moment the event was triggered.
988
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000989However, buffer-local autocommands will not be executed for a buffer that has
990been wiped out with |:bwipe|. After deleting the buffer with |:bdel| the
991buffer actually still exists (it becomes unlisted), thus the autocommands are
992still executed.
993
Bram Moolenaar071d4272004-06-13 20:20:40 +0000994==============================================================================
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009957. Buffer-local autocommands *autocmd-buflocal* *autocmd-buffer-local*
996 *<buffer=N>* *<buffer=abuf>* *E680*
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000997
998Buffer-local autocommands are attached to a specific buffer. They are useful
999if the buffer does not have a name and when the name does not match a specific
1000pattern. But it also means they must be explicitly added to each buffer.
1001
1002Instead of a pattern buffer-local autocommands use one of these forms:
1003 <buffer> current buffer
1004 <buffer=99> buffer number 99
1005 <buffer=abuf> using <abuf> (only when executing autocommands)
1006 |<abuf>|
1007
1008Examples: >
1009 :au CursorHold <buffer> echo 'hold'
1010 :au CursorHold <buffer=33> echo 'hold'
1011 :au CursorHold <buffer=abuf> echo 'hold'
1012
1013All the commands for autocommands also work with buffer-local autocommands,
1014simply use the special string instead of the pattern. Examples: >
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001015 :au! * <buffer> " remove buffer-local autocommands for
1016 " current buffer
1017 :au! * <buffer=33> " remove buffer-local autocommands for
1018 " buffer #33
Bram Moolenaar446cb832008-06-24 21:56:24 +00001019 :bufdo :au! CursorHold <buffer> " remove autocmd for given event for all
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001020 " buffers
1021 :au * <buffer> " list buffer-local autocommands for
1022 " current buffer
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00001023
1024Note that when an autocommand is defined for the current buffer, it is stored
1025with the buffer number. Thus it uses the form "<buffer=12>", where 12 is the
1026number of the current buffer. You will see this when listing autocommands,
1027for example.
1028
1029To test for presence of buffer-local autocommands use the |exists()| function
1030as follows: >
1031 :if exists("#CursorHold#<buffer=12>") | ... | endif
1032 :if exists("#CursorHold#<buffer>") | ... | endif " for current buffer
1033
1034When a buffer is wiped out its buffer-local autocommands are also gone, of
1035course. Note that when deleting a buffer, e.g., with ":bdel", it is only
1036unlisted, the autocommands are still present. In order to see the removal of
1037buffer-local autocommands: >
1038 :set verbose=6
1039
1040It is not possible to define buffer-local autocommands for a non-existent
1041buffer.
1042
1043==============================================================================
10448. Groups *autocmd-groups*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001045
1046Autocommands can be put together in a group. This is useful for removing or
1047executing a group of autocommands. For example, all the autocommands for
1048syntax highlighting are put in the "highlight" group, to be able to execute
1049":doautoall highlight BufRead" when the GUI starts.
1050
1051When no specific group is selected, Vim uses the default group. The default
1052group does not have a name. You cannot execute the autocommands from the
1053default group separately; you can execute them only by executing autocommands
1054for all groups.
1055
1056Normally, when executing autocommands automatically, Vim uses the autocommands
1057for all groups. The group only matters when executing autocommands with
1058":doautocmd" or ":doautoall", or when defining or deleting autocommands.
1059
1060The group name can contain any characters except white space. The group name
1061"end" is reserved (also in uppercase).
1062
1063The group name is case sensitive. Note that this is different from the event
1064name!
1065
1066 *:aug* *:augroup*
1067:aug[roup] {name} Define the autocmd group name for the
1068 following ":autocmd" commands. The name "end"
1069 or "END" selects the default group.
1070
1071 *:augroup-delete* *E367*
1072:aug[roup]! {name} Delete the autocmd group {name}. Don't use
1073 this if there is still an autocommand using
1074 this group! This is not checked.
1075
1076To enter autocommands for a specific group, use this method:
10771. Select the group with ":augroup {name}".
10782. Delete any old autocommands with ":au!".
10793. Define the autocommands.
10804. Go back to the default group with "augroup END".
1081
1082Example: >
1083 :augroup uncompress
1084 : au!
1085 : au BufEnter *.gz %!gunzip
1086 :augroup END
1087
1088This prevents having the autocommands defined twice (e.g., after sourcing the
1089.vimrc file again).
1090
1091==============================================================================
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +000010929. Executing autocommands *autocmd-execute*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001093
1094Vim can also execute Autocommands non-automatically. This is useful if you
1095have changed autocommands, or when Vim has executed the wrong autocommands
1096(e.g., the file pattern match was wrong).
1097
1098Note that the 'eventignore' option applies here too. Events listed in this
1099option will not cause any commands to be executed.
1100
1101 *:do* *:doau* *:doautocmd* *E217*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01001102:do[autocmd] [<nomodeline>] [group] {event} [fname]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001103 Apply the autocommands matching [fname] (default:
1104 current file name) for {event} to the current buffer.
1105 You can use this when the current file name does not
1106 match the right pattern, after changing settings, or
1107 to execute autocommands for a certain event.
1108 It's possible to use this inside an autocommand too,
1109 so you can base the autocommands for one extension on
1110 another extension. Example: >
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001111 :au BufEnter *.cpp so ~/.vimrc_cpp
1112 :au BufEnter *.cpp doau BufEnter x.c
Bram Moolenaar071d4272004-06-13 20:20:40 +00001113< Be careful to avoid endless loops. See
1114 |autocmd-nested|.
1115
1116 When the [group] argument is not given, Vim executes
1117 the autocommands for all groups. When the [group]
1118 argument is included, Vim executes only the matching
1119 autocommands for that group. Note: if you use an
1120 undefined group name, Vim gives you an error message.
Bram Moolenaar60542ac2012-02-12 20:14:01 +01001121 *<nomodeline>*
1122 After applying the autocommands the modelines are
1123 processed, so that their settings overrule the
1124 settings from autocommands, like what happens when
1125 editing a file. This is skipped when the <nomodeline>
1126 argument is present. You probably want to use
1127 <nomodeline> for events that are not used when loading
1128 a buffer, such as |User|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001129
1130 *:doautoa* *:doautoall*
Bram Moolenaara61d5fb2012-02-12 00:18:58 +01001131:doautoa[ll] [<nomodeline>] [group] {event} [fname]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001132 Like ":doautocmd", but apply the autocommands to each
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001133 loaded buffer. Note that [fname] is used to select
Bram Moolenaar071d4272004-06-13 20:20:40 +00001134 the autocommands, not the buffers to which they are
1135 applied.
1136 Careful: Don't use this for autocommands that delete a
1137 buffer, change to another buffer or change the
1138 contents of a buffer; the result is unpredictable.
1139 This command is intended for autocommands that set
1140 options, change highlighting, and things like that.
1141
1142==============================================================================
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000114310. Using autocommands *autocmd-use*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001144
1145For WRITING FILES there are four possible sets of events. Vim uses only one
1146of these sets for a write command:
1147
1148BufWriteCmd BufWritePre BufWritePost writing the whole buffer
1149 FilterWritePre FilterWritePost writing to filter temp file
1150FileAppendCmd FileAppendPre FileAppendPost appending to a file
1151FileWriteCmd FileWritePre FileWritePost any other file write
1152
1153When there is a matching "*Cmd" autocommand, it is assumed it will do the
1154writing. No further writing is done and the other events are not triggered.
1155|Cmd-event|
1156
1157Note that the *WritePost commands should undo any changes to the buffer that
1158were caused by the *WritePre commands; otherwise, writing the file will have
1159the side effect of changing the buffer.
1160
1161Before executing the autocommands, the buffer from which the lines are to be
1162written temporarily becomes the current buffer. Unless the autocommands
1163change the current buffer or delete the previously current buffer, the
1164previously current buffer is made the current buffer again.
1165
1166The *WritePre and *AppendPre autocommands must not delete the buffer from
1167which the lines are to be written.
1168
1169The '[ and '] marks have a special position:
1170- Before the *ReadPre event the '[ mark is set to the line just above where
1171 the new lines will be inserted.
1172- Before the *ReadPost event the '[ mark is set to the first line that was
1173 just read, the '] mark to the last line.
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001174- Before executing the *WriteCmd, *WritePre and *AppendPre autocommands the '[
1175 mark is set to the first line that will be written, the '] mark to the last
1176 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001177Careful: '[ and '] change when using commands that change the buffer.
1178
1179In commands which expect a file name, you can use "<afile>" for the file name
1180that is being read |:<afile>| (you can also use "%" for the current file
1181name). "<abuf>" can be used for the buffer number of the currently effective
1182buffer. This also works for buffers that doesn't have a name. But it doesn't
1183work for files without a buffer (e.g., with ":r file").
1184
1185 *gzip-example*
1186Examples for reading and writing compressed files: >
1187 :augroup gzip
1188 : autocmd!
1189 : autocmd BufReadPre,FileReadPre *.gz set bin
1190 : autocmd BufReadPost,FileReadPost *.gz '[,']!gunzip
1191 : autocmd BufReadPost,FileReadPost *.gz set nobin
1192 : autocmd BufReadPost,FileReadPost *.gz execute ":doautocmd BufReadPost " . expand("%:r")
1193 : autocmd BufWritePost,FileWritePost *.gz !mv <afile> <afile>:r
1194 : autocmd BufWritePost,FileWritePost *.gz !gzip <afile>:r
1195
1196 : autocmd FileAppendPre *.gz !gunzip <afile>
1197 : autocmd FileAppendPre *.gz !mv <afile>:r <afile>
1198 : autocmd FileAppendPost *.gz !mv <afile> <afile>:r
1199 : autocmd FileAppendPost *.gz !gzip <afile>:r
1200 :augroup END
1201
1202The "gzip" group is used to be able to delete any existing autocommands with
1203":autocmd!", for when the file is sourced twice.
1204
1205("<afile>:r" is the file name without the extension, see |:_%:|)
1206
1207The commands executed for the BufNewFile, BufRead/BufReadPost, BufWritePost,
1208FileAppendPost and VimLeave events do not set or reset the changed flag of the
1209buffer. When you decompress the buffer with the BufReadPost autocommands, you
1210can still exit with ":q". When you use ":undo" in BufWritePost to undo the
1211changes made by BufWritePre commands, you can still do ":q" (this also makes
1212"ZZ" work). If you do want the buffer to be marked as modified, set the
1213'modified' option.
1214
1215To execute Normal mode commands from an autocommand, use the ":normal"
1216command. Use with care! If the Normal mode command is not finished, the user
1217needs to type characters (e.g., after ":normal m" you need to type a mark
1218name).
1219
1220If you want the buffer to be unmodified after changing it, reset the
1221'modified' option. This makes it possible to exit the buffer with ":q"
1222instead of ":q!".
1223
1224 *autocmd-nested* *E218*
1225By default, autocommands do not nest. If you use ":e" or ":w" in an
1226autocommand, Vim does not execute the BufRead and BufWrite autocommands for
1227those commands. If you do want this, use the "nested" flag for those commands
1228in which you want nesting. For example: >
1229 :autocmd FileChangedShell *.c nested e!
1230The nesting is limited to 10 levels to get out of recursive loops.
1231
1232It's possible to use the ":au" command in an autocommand. This can be a
1233self-modifying command! This can be useful for an autocommand that should
1234execute only once.
1235
Bram Moolenaarb3480382005-12-11 21:33:32 +00001236If you want to skip autocommands for one command, use the |:noautocmd| command
1237modifier or the 'eventignore' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001238
1239Note: When reading a file (with ":read file" or with a filter command) and the
1240last line in the file does not have an <EOL>, Vim remembers this. At the next
1241write (with ":write file" or with a filter command), if the same line is
1242written again as the last line in a file AND 'binary' is set, Vim does not
1243supply an <EOL>. This makes a filter command on the just read lines write the
1244same file as was read, and makes a write command on just filtered lines write
1245the same file as was read from the filter. For example, another way to write
1246a compressed file: >
1247
1248 :autocmd FileWritePre *.gz set bin|'[,']!gzip
1249 :autocmd FileWritePost *.gz undo|set nobin
1250<
1251 *autocommand-pattern*
1252You can specify multiple patterns, separated by commas. Here are some
1253examples: >
1254
1255 :autocmd BufRead * set tw=79 nocin ic infercase fo=2croq
1256 :autocmd BufRead .letter set tw=72 fo=2tcrq
1257 :autocmd BufEnter .letter set dict=/usr/lib/dict/words
1258 :autocmd BufLeave .letter set dict=
1259 :autocmd BufRead,BufNewFile *.c,*.h set tw=0 cin noic
1260 :autocmd BufEnter *.c,*.h abbr FOR for (i = 0; i < 3; ++i)<CR>{<CR>}<Esc>O
1261 :autocmd BufLeave *.c,*.h unabbr FOR
1262
1263For makefiles (makefile, Makefile, imakefile, makefile.unix, etc.): >
1264
1265 :autocmd BufEnter ?akefile* set include=^s\=include
1266 :autocmd BufLeave ?akefile* set include&
1267
1268To always start editing C files at the first function: >
1269
1270 :autocmd BufRead *.c,*.h 1;/^{
1271
1272Without the "1;" above, the search would start from wherever the file was
1273entered, rather than from the start of the file.
1274
1275 *skeleton* *template*
1276To read a skeleton (template) file when opening a new file: >
1277
1278 :autocmd BufNewFile *.c 0r ~/vim/skeleton.c
1279 :autocmd BufNewFile *.h 0r ~/vim/skeleton.h
1280 :autocmd BufNewFile *.java 0r ~/vim/skeleton.java
1281
1282To insert the current date and time in a *.html file when writing it: >
1283
1284 :autocmd BufWritePre,FileWritePre *.html ks|call LastMod()|'s
1285 :fun LastMod()
1286 : if line("$") > 20
1287 : let l = 20
1288 : else
1289 : let l = line("$")
1290 : endif
1291 : exe "1," . l . "g/Last modified: /s/Last modified: .*/Last modified: " .
1292 : \ strftime("%Y %b %d")
1293 :endfun
1294
1295You need to have a line "Last modified: <date time>" in the first 20 lines
1296of the file for this to work. Vim replaces <date time> (and anything in the
1297same line after it) with the current date and time. Explanation:
1298 ks mark current position with mark 's'
1299 call LastMod() call the LastMod() function to do the work
1300 's return the cursor to the old position
1301The LastMod() function checks if the file is shorter than 20 lines, and then
1302uses the ":g" command to find lines that contain "Last modified: ". For those
1303lines the ":s" command is executed to replace the existing date with the
1304current one. The ":execute" command is used to be able to use an expression
1305for the ":g" and ":s" commands. The date is obtained with the strftime()
1306function. You can change its argument to get another date string.
1307
1308When entering :autocmd on the command-line, completion of events and command
1309names may be done (with <Tab>, CTRL-D, etc.) where appropriate.
1310
1311Vim executes all matching autocommands in the order that you specify them.
1312It is recommended that your first autocommand be used for all files by using
1313"*" as the file pattern. This means that you can define defaults you like
1314here for any settings, and if there is another matching autocommand it will
1315override these. But if there is no other matching autocommand, then at least
1316your default settings are recovered (if entering this file from another for
1317which autocommands did match). Note that "*" will also match files starting
1318with ".", unlike Unix shells.
1319
1320 *autocmd-searchpat*
1321Autocommands do not change the current search patterns. Vim saves the current
1322search patterns before executing autocommands then restores them after the
1323autocommands finish. This means that autocommands do not affect the strings
1324highlighted with the 'hlsearch' option. Within autocommands, you can still
1325use search patterns normally, e.g., with the "n" command.
1326If you want an autocommand to set the search pattern, such that it is used
1327after the autocommand finishes, use the ":let @/ =" command.
1328The search-highlighting cannot be switched off with ":nohlsearch" in an
1329autocommand. Use the 'h' flag in the 'viminfo' option to disable search-
1330highlighting when starting Vim.
1331
1332 *Cmd-event*
1333When using one of the "*Cmd" events, the matching autocommands are expected to
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00001334do the file reading, writing or sourcing. This can be used when working with
1335a special kind of file, for example on a remote system.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001336CAREFUL: If you use these events in a wrong way, it may have the effect of
1337making it impossible to read or write the matching files! Make sure you test
1338your autocommands properly. Best is to use a pattern that will never match a
1339normal file name, for example "ftp://*".
1340
1341When defining a BufReadCmd it will be difficult for Vim to recover a crashed
1342editing session. When recovering from the original file, Vim reads only those
1343parts of a file that are not found in the swap file. Since that is not
1344possible with a BufReadCmd, use the |:preserve| command to make sure the
1345original file isn't needed for recovery. You might want to do this only when
1346you expect the file to be modified.
1347
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00001348For file read and write commands the |v:cmdarg| variable holds the "++enc="
1349and "++ff=" argument that are effective. These should be used for the command
1350that reads/writes the file. The |v:cmdbang| variable is one when "!" was
1351used, zero otherwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001352
Bram Moolenaarc88ebf72010-07-22 22:30:23 +02001353See the $VIMRUNTIME/plugin/netrwPlugin.vim for examples.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001354
Bram Moolenaarb3480382005-12-11 21:33:32 +00001355==============================================================================
135611. Disabling autocommands *autocmd-disable*
1357
1358To disable autocommands for some time use the 'eventignore' option. Note that
1359this may cause unexpected behavior, make sure you restore 'eventignore'
1360afterwards, using a |:try| block with |:finally|.
1361
1362 *:noautocmd* *:noa*
1363To disable autocommands for just one command use the ":noautocmd" command
1364modifier. This will set 'eventignore' to "all" for the duration of the
1365following command. Example: >
1366
1367 :noautocmd w fname.gz
1368
1369This will write the file without triggering the autocommands defined by the
1370gzip plugin.
1371
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00001372
Bram Moolenaar071d4272004-06-13 20:20:40 +00001373 vim:tw=78:ts=8:ft=help:norl: