blob: ecb5b963d206ee103941cd381822ca1399bc00ad [file] [log] [blame]
Bram Moolenaar92dff182014-02-11 19:15:50 +01001*autocmd.txt* For Vim version 7.4. Last change: 2014 Jan 23
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
Bram Moolenaardfb18412013-12-11 18:53:29 +0100307|TextChanged| after a change was made to the text in Normal mode
308|TextChangedI| after a change was made to the text in Insert mode
309
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000310|ColorScheme| after loading a color scheme
311
312|RemoteReply| a reply from a server Vim was received
313
314|QuickFixCmdPre| before a quickfix command is run
315|QuickFixCmdPost| after a quickfix command is run
316
317|SessionLoadPost| after loading a session file
318
319|MenuPopup| just before showing the popup menu
Bram Moolenaard09acef2012-09-21 14:54:30 +0200320|CompleteDone| after Insert mode completion is done
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000321
322|User| to be used in combination with ":doautocmd"
323
324
325The alphabetical list of autocommand events: *autocmd-events-abc*
326
327 *BufCreate* *BufAdd*
328BufAdd or BufCreate Just after creating a new buffer which is
329 added to the buffer list, or adding a buffer
330 to the buffer list.
331 Also used just after a buffer in the buffer
332 list has been renamed.
333 The BufCreate event is for historic reasons.
334 NOTE: When this autocommand is executed, the
335 current buffer "%" may be different from the
336 buffer being created "<afile>".
337 *BufDelete*
338BufDelete Before deleting a buffer from the buffer list.
339 The BufUnload may be called first (if the
340 buffer was loaded).
341 Also used just before a buffer in the buffer
342 list is renamed.
343 NOTE: When this autocommand is executed, the
344 current buffer "%" may be different from the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000345 buffer being deleted "<afile>" and "<abuf>".
Bram Moolenaarb849e712009-06-24 15:51:37 +0000346 Don't change to another buffer, it will cause
347 problems.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000348 *BufEnter*
349BufEnter After entering a buffer. Useful for setting
350 options for a file type. Also executed when
351 starting to edit a buffer, after the
352 BufReadPost autocommands.
353 *BufFilePost*
354BufFilePost After changing the name of the current buffer
355 with the ":file" or ":saveas" command.
Bram Moolenaar4770d092006-01-12 23:22:24 +0000356 *BufFilePre*
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000357BufFilePre Before changing the name of the current buffer
358 with the ":file" or ":saveas" command.
359 *BufHidden*
360BufHidden Just after a buffer has become hidden. That
361 is, when there are no longer windows that show
362 the buffer, but the buffer is not unloaded or
363 deleted. Not used for ":qa" or ":q" when
364 exiting Vim.
365 NOTE: When this autocommand is executed, the
366 current buffer "%" may be different from the
367 buffer being unloaded "<afile>".
368 *BufLeave*
369BufLeave Before leaving to another buffer. Also when
370 leaving or closing the current window and the
371 new current window is not for the same buffer.
372 Not used for ":qa" or ":q" when exiting Vim.
373 *BufNew*
374BufNew Just after creating a new buffer. Also used
375 just after a buffer has been renamed. When
376 the buffer is added to the buffer list BufAdd
377 will be triggered too.
378 NOTE: When this autocommand is executed, the
379 current buffer "%" may be different from the
380 buffer being created "<afile>".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000381 *BufNewFile*
382BufNewFile When starting to edit a file that doesn't
383 exist. Can be used to read in a skeleton
384 file.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000385 *BufRead* *BufReadPost*
386BufRead or BufReadPost When starting to edit a new buffer, after
387 reading the file into the buffer, before
388 executing the modelines. See |BufWinEnter|
389 for when you need to do something after
390 processing the modelines.
391 This does NOT work for ":r file". Not used
392 when the file doesn't exist. Also used after
393 successfully recovering a file.
Bram Moolenaar30b65812012-07-12 22:01:11 +0200394 Also triggered for the filetypedetect group
395 when executing ":filetype detect" and when
396 writing an unnamed buffer in a way that the
397 buffer gets a name.
Bram Moolenaar4770d092006-01-12 23:22:24 +0000398 *BufReadCmd*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000399BufReadCmd Before starting to edit a new buffer. Should
400 read the file into the buffer. |Cmd-event|
Bram Moolenaar4770d092006-01-12 23:22:24 +0000401 *BufReadPre* *E200* *E201*
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000402BufReadPre When starting to edit a new buffer, before
403 reading the file into the buffer. Not used
404 if the file doesn't exist.
405 *BufUnload*
406BufUnload Before unloading a buffer. This is when the
407 text in the buffer is going to be freed. This
408 may be after a BufWritePost and before a
409 BufDelete. Also used for all buffers that are
410 loaded when Vim is going to exit.
411 NOTE: When this autocommand is executed, the
412 current buffer "%" may be different from the
413 buffer being unloaded "<afile>".
Bram Moolenaarb849e712009-06-24 15:51:37 +0000414 Don't change to another buffer, it will cause
415 problems.
Bram Moolenaar0e1e25f2010-05-28 21:07:08 +0200416 When exiting and v:dying is 2 or more this
417 event is not triggered.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000418 *BufWinEnter*
419BufWinEnter After a buffer is displayed in a window. This
420 can be when the buffer is loaded (after
Bram Moolenaar446cb832008-06-24 21:56:24 +0000421 processing the modelines) or when a hidden
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000422 buffer is displayed in a window (and is no
Bram Moolenaar446cb832008-06-24 21:56:24 +0000423 longer hidden).
424 Does not happen for |:split| without
425 arguments, since you keep editing the same
426 buffer, or ":split" with a file that's already
Bram Moolenaarc236c162008-07-13 17:41:49 +0000427 open in a window, because it re-uses an
428 existing buffer. But it does happen for a
429 ":split" with the name of the current buffer,
430 since it reloads that buffer.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000431 *BufWinLeave*
432BufWinLeave Before a buffer is removed from a window.
433 Not when it's still visible in another window.
434 Also triggered when exiting. It's triggered
435 before BufUnload or BufHidden.
436 NOTE: When this autocommand is executed, the
437 current buffer "%" may be different from the
438 buffer being unloaded "<afile>".
Bram Moolenaar0e1e25f2010-05-28 21:07:08 +0200439 When exiting and v:dying is 2 or more this
440 event is not triggered.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000441 *BufWipeout*
442BufWipeout Before completely deleting a buffer. The
443 BufUnload and BufDelete events may be called
444 first (if the buffer was loaded and was in the
445 buffer list). Also used just before a buffer
446 is renamed (also when it's not in the buffer
447 list).
448 NOTE: When this autocommand is executed, the
449 current buffer "%" may be different from the
450 buffer being deleted "<afile>".
Bram Moolenaarb849e712009-06-24 15:51:37 +0000451 Don't change to another buffer, it will cause
452 problems.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000453 *BufWrite* *BufWritePre*
454BufWrite or BufWritePre Before writing the whole buffer to a file.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000455 *BufWriteCmd*
456BufWriteCmd Before writing the whole buffer to a file.
457 Should do the writing of the file and reset
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000458 'modified' if successful, unless '+' is in
459 'cpo' and writing to another file |cpo-+|.
460 The buffer contents should not be changed.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +0200461 When the command resets 'modified' the undo
462 information is adjusted to mark older undo
463 states as 'modified', like |:write| does.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000464 |Cmd-event|
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000465 *BufWritePost*
466BufWritePost After writing the whole buffer to a file
467 (should undo the commands for BufWritePre).
468 *CmdwinEnter*
469CmdwinEnter After entering the command-line window.
470 Useful for setting options specifically for
471 this special type of window. This is
472 triggered _instead_ of BufEnter and WinEnter.
473 <afile> is set to a single character,
474 indicating the type of command-line.
475 |cmdwin-char|
476 *CmdwinLeave*
477CmdwinLeave Before leaving the command-line window.
478 Useful to clean up any global setting done
479 with CmdwinEnter. This is triggered _instead_
480 of BufLeave and WinLeave.
481 <afile> is set to a single character,
482 indicating the type of command-line.
483 |cmdwin-char|
484 *ColorScheme*
485ColorScheme After loading a color scheme. |:colorscheme|
Bram Moolenaarb95186f2013-11-28 18:53:52 +0100486 The pattern is matched against the
487 colorscheme name. <afile> can be used for the
488 name of the actual file where this option was
489 set, and <amatch> for the new colorscheme
490 name.
491
Bram Moolenaar754b5602006-02-09 23:53:20 +0000492
Bram Moolenaar30b65812012-07-12 22:01:11 +0200493 *CompleteDone*
494CompleteDone After Insert mode completion is done. Either
495 when something was completed or abandoning
496 completion. |ins-completion|
497
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000498 *CursorHold*
499CursorHold When the user doesn't press a key for the time
500 specified with 'updatetime'. Not re-triggered
501 until the user has pressed a key (i.e. doesn't
502 fire every 'updatetime' ms if you leave Vim to
503 make some coffee. :) See |CursorHold-example|
504 for previewing tags.
505 This event is only triggered in Normal mode.
Bram Moolenaard7afed32007-05-06 13:26:41 +0000506 It is not triggered when waiting for a command
507 argument to be typed, or a movement after an
508 operator.
Bram Moolenaare3226be2005-12-18 22:10:00 +0000509 While recording the CursorHold event is not
510 triggered. |q|
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000511 Note: Interactive commands cannot be used for
512 this event. There is no hit-enter prompt,
513 the screen is updated directly (when needed).
514 Note: In the future there will probably be
515 another option to set the time.
516 Hint: to force an update of the status lines
517 use: >
518 :let &ro = &ro
519< {only on Amiga, Unix, Win32, MSDOS and all GUI
520 versions}
Bram Moolenaar754b5602006-02-09 23:53:20 +0000521 *CursorHoldI*
522CursorHoldI Just like CursorHold, but in Insert mode.
523
524 *CursorMoved*
Bram Moolenaar52b91d82013-06-15 21:39:51 +0200525CursorMoved After the cursor was moved in Normal or Visual
526 mode. Also when the text of the cursor line
527 has been changed, e.g., with "x", "rx" or "p".
Bram Moolenaar754b5602006-02-09 23:53:20 +0000528 Not triggered when there is typeahead or when
529 an operator is pending.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000530 For an example see |match-parens|.
Bram Moolenaarbf884932013-04-05 22:26:15 +0200531 Careful: This is triggered very often, don't
532 do anything that the user does not expect or
533 that is slow.
Bram Moolenaar754b5602006-02-09 23:53:20 +0000534 *CursorMovedI*
535CursorMovedI After the cursor was moved in Insert mode.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +0200536 Not triggered when the popup menu is visible.
Bram Moolenaar754b5602006-02-09 23:53:20 +0000537 Otherwise the same as CursorMoved.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000538 *EncodingChanged*
539EncodingChanged Fires off after the 'encoding' option has been
540 changed. Useful to set up fonts, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000541 *FileAppendCmd*
542FileAppendCmd Before appending to a file. Should do the
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +0000543 appending to the file. Use the '[ and ']
544 marks for the range of lines.|Cmd-event|
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000545 *FileAppendPost*
546FileAppendPost After appending to a file.
547 *FileAppendPre*
548FileAppendPre Before appending to a file. Use the '[ and ']
549 marks for the range of lines.
550 *FileChangedRO*
551FileChangedRO Before making the first change to a read-only
552 file. Can be used to check-out the file from
553 a source control system. Not triggered when
554 the change was caused by an autocommand.
555 This event is triggered when making the first
556 change in a buffer or the first change after
Bram Moolenaar61660ea2006-04-07 21:40:07 +0000557 'readonly' was set, just before the change is
558 applied to the text.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000559 WARNING: If the autocommand moves the cursor
560 the effect of the change is undefined.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000561 *E788*
562 It is not allowed to change to another buffer
563 here. You can reload the buffer but not edit
564 another one.
Bram Moolenaar92dff182014-02-11 19:15:50 +0100565 *E881*
566 If the number of lines changes saving for undo
567 may fail and the change will be aborted.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000568 *FileChangedShell*
569FileChangedShell When Vim notices that the modification time of
570 a file has changed since editing started.
571 Also when the file attributes of the file
572 change. |timestamp|
573 Mostly triggered after executing a shell
574 command, but also with a |:checktime| command
Bram Moolenaar19a09a12005-03-04 23:39:37 +0000575 or when Gvim regains input focus.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000576 This autocommand is triggered for each changed
577 file. It is not used when 'autoread' is set
578 and the buffer was not changed. If a
579 FileChangedShell autocommand is present the
580 warning message and prompt is not given.
Bram Moolenaar19a09a12005-03-04 23:39:37 +0000581 The |v:fcs_reason| variable is set to indicate
582 what happened and |v:fcs_choice| can be used
583 to tell Vim what to do next.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000584 NOTE: When this autocommand is executed, the
585 current buffer "%" may be different from the
586 buffer that was changed "<afile>".
587 NOTE: The commands must not change the current
588 buffer, jump to another buffer or delete a
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100589 buffer. *E246* *E811*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000590 NOTE: This event never nests, to avoid an
591 endless loop. This means that while executing
592 commands for the FileChangedShell event no
593 other FileChangedShell event will be
594 triggered.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +0000595 *FileChangedShellPost*
596FileChangedShellPost After handling a file that was changed outside
597 of Vim. Can be used to update the statusline.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000598 *FileEncoding*
599FileEncoding Obsolete. It still works and is equivalent
600 to |EncodingChanged|.
601 *FileReadCmd*
602FileReadCmd Before reading a file with a ":read" command.
603 Should do the reading of the file. |Cmd-event|
604 *FileReadPost*
605FileReadPost After reading a file with a ":read" command.
606 Note that Vim sets the '[ and '] marks to the
607 first and last line of the read. This can be
608 used to operate on the lines just read.
609 *FileReadPre*
610FileReadPre Before reading a file with a ":read" command.
611 *FileType*
Bram Moolenaard7afed32007-05-06 13:26:41 +0000612FileType When the 'filetype' option has been set. The
613 pattern is matched against the filetype.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000614 <afile> can be used for the name of the file
615 where this option was set, and <amatch> for
616 the new value of 'filetype'.
617 See |filetypes|.
618 *FileWriteCmd*
619FileWriteCmd Before writing to a file, when not writing the
620 whole buffer. Should do the writing to the
621 file. Should not change the buffer. Use the
622 '[ and '] marks for the range of lines.
623 |Cmd-event|
624 *FileWritePost*
625FileWritePost After writing to a file, when not writing the
626 whole buffer.
627 *FileWritePre*
628FileWritePre Before writing to a file, when not writing the
629 whole buffer. Use the '[ and '] marks for the
630 range of lines.
631 *FilterReadPost*
632FilterReadPost After reading a file from a filter command.
633 Vim checks the pattern against the name of
634 the current buffer as with FilterReadPre.
635 Not triggered when 'shelltemp' is off.
636 *FilterReadPre* *E135*
637FilterReadPre Before reading a file from a filter command.
638 Vim checks the pattern against the name of
639 the current buffer, not the name of the
640 temporary file that is the output of the
641 filter command.
642 Not triggered when 'shelltemp' is off.
643 *FilterWritePost*
644FilterWritePost After writing a file for a filter command or
645 making a diff.
646 Vim checks the pattern against the name of
647 the current buffer as with FilterWritePre.
648 Not triggered when 'shelltemp' is off.
649 *FilterWritePre*
650FilterWritePre Before writing a file for a filter command or
651 making a diff.
652 Vim checks the pattern against the name of
653 the current buffer, not the name of the
654 temporary file that is the output of the
655 filter command.
656 Not triggered when 'shelltemp' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000657 *FocusGained*
658FocusGained When Vim got input focus. Only for the GUI
659 version and a few console versions where this
660 can be detected.
661 *FocusLost*
662FocusLost When Vim lost input focus. Only for the GUI
663 version and a few console versions where this
Bram Moolenaar843ee412004-06-30 16:16:41 +0000664 can be detected. May also happen when a
665 dialog pops up.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000666 *FuncUndefined*
667FuncUndefined When a user function is used but it isn't
668 defined. Useful for defining a function only
Bram Moolenaard7afed32007-05-06 13:26:41 +0000669 when it's used. The pattern is matched
670 against the function name. Both <amatch> and
671 <afile> are set to the name of the function.
Bram Moolenaar7c626922005-02-07 22:01:03 +0000672 See |autoload-functions|.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000673 *GUIEnter*
674GUIEnter After starting the GUI successfully, and after
675 opening the window. It is triggered before
676 VimEnter when using gvim. Can be used to
677 position the window from a .gvimrc file: >
678 :autocmd GUIEnter * winpos 100 50
Bram Moolenaard7afed32007-05-06 13:26:41 +0000679< *GUIFailed*
680GUIFailed After starting the GUI failed. Vim may
681 continue to run in the terminal, if possible
682 (only on Unix and alikes, when connecting the
683 X server fails). You may want to quit Vim: >
684 :autocmd GUIFailed * qall
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000685< *InsertChange*
686InsertChange When typing <Insert> while in Insert or
687 Replace mode. The |v:insertmode| variable
688 indicates the new mode.
689 Be careful not to move the cursor or do
690 anything else that the user does not expect.
Bram Moolenaare659c952011-05-19 17:25:41 +0200691 *InsertCharPre*
692InsertCharPre When a character is typed in Insert mode,
693 before inserting the char.
694 The |v:char| variable indicates the char typed
695 and can be changed during the event to insert
696 a different character. When |v:char| is set
697 to more than one character this text is
698 inserted literally.
699 It is not allowed to change the text |textlock|.
700 The event is not triggered when 'paste' is
701 set.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000702 *InsertEnter*
Bram Moolenaard7afed32007-05-06 13:26:41 +0000703InsertEnter Just before starting Insert mode. Also for
704 Replace mode and Virtual Replace mode. The
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000705 |v:insertmode| variable indicates the mode.
Bram Moolenaar097c9922013-05-19 21:15:15 +0200706 Be careful not to do anything else that the
707 user does not expect.
708 The cursor is restored afterwards. If you do
709 not want that set |v:char| to a non-empty
710 string.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000711 *InsertLeave*
712InsertLeave When leaving Insert mode. Also when using
713 CTRL-O |i_CTRL-O|. But not for |i_CTRL-C|.
714 *MenuPopup*
715MenuPopup Just before showing the popup menu (under the
716 right mouse button). Useful for adjusting the
717 menu for what is under the cursor or mouse
718 pointer.
719 The pattern is matched against a single
720 character representing the mode:
721 n Normal
722 v Visual
723 o Operator-pending
724 i Insert
Bram Moolenaar551dbcc2006-04-25 22:13:59 +0000725 c Command line
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000726 *QuickFixCmdPre*
727QuickFixCmdPre Before a quickfix command is run (|:make|,
Bram Moolenaara6557602006-02-04 22:43:20 +0000728 |:lmake|, |:grep|, |:lgrep|, |:grepadd|,
729 |:lgrepadd|, |:vimgrep|, |:lvimgrep|,
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100730 |:vimgrepadd|, |:lvimgrepadd|, |:cscope|,
Bram Moolenaar84f72352012-03-11 15:57:40 +0100731 |:cfile|, |:cgetfile|, |:caddfile|, |:lfile|,
732 |:lgetfile|, |:laddfile|, |:helpgrep|,
733 |:lhelpgrep|).
Bram Moolenaarf1eeae92010-05-14 23:14:42 +0200734 The pattern is matched against the command
735 being run. When |:grep| is used but 'grepprg'
736 is set to "internal" it still matches "grep".
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000737 This command cannot be used to set the
738 'makeprg' and 'grepprg' variables.
739 If this command causes an error, the quickfix
740 command is not executed.
741 *QuickFixCmdPost*
742QuickFixCmdPost Like QuickFixCmdPre, but after a quickfix
Bram Moolenaarf9393ef2006-04-24 19:47:27 +0000743 command is run, before jumping to the first
Bram Moolenaar8ec1f852012-03-07 20:13:49 +0100744 location. For |:cfile| and |:lfile| commands
745 it is run after error file is read and before
Bram Moolenaar92dff182014-02-11 19:15:50 +0100746 moving to the first error.
Bram Moolenaar8ec1f852012-03-07 20:13:49 +0100747 See |QuickFixCmdPost-example|.
Bram Moolenaar30b65812012-07-12 22:01:11 +0200748 *QuitPre*
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100749QuitPre When using `:quit`, `:wq` or `:qall`, before
750 deciding whether it closes the current window
751 or quits Vim. Can be used to close any
752 non-essential window if the current window is
753 the last ordinary window.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000754 *RemoteReply*
755RemoteReply When a reply from a Vim that functions as
Bram Moolenaard7afed32007-05-06 13:26:41 +0000756 server was received |server2client()|. The
757 pattern is matched against the {serverid}.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000758 <amatch> is equal to the {serverid} from which
759 the reply was sent, and <afile> is the actual
760 reply string.
761 Note that even if an autocommand is defined,
762 the reply should be read with |remote_read()|
763 to consume it.
764 *SessionLoadPost*
765SessionLoadPost After loading the session file created using
766 the |:mksession| command.
Bram Moolenaara94bc432006-03-10 21:42:59 +0000767 *ShellCmdPost*
768ShellCmdPost After executing a shell command with |:!cmd|,
769 |:shell|, |:make| and |:grep|. Can be used to
770 check for any changed files.
771 *ShellFilterPost*
772ShellFilterPost After executing a shell command with
773 ":{range}!cmd", ":w !cmd" or ":r !cmd".
774 Can be used to check for any changed files.
Bram Moolenaar1f35bf92006-03-07 22:38:47 +0000775 *SourcePre*
776SourcePre Before sourcing a Vim script. |:source|
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +0000777 <afile> is the name of the file being sourced.
778 *SourceCmd*
779SourceCmd When sourcing a Vim script. |:source|
780 <afile> is the name of the file being sourced.
781 The autocommand must source this file.
782 |Cmd-event|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000783 *SpellFileMissing*
784SpellFileMissing When trying to load a spell checking file and
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +0000785 it can't be found. The pattern is matched
786 against the language. <amatch> is the
787 language, 'encoding' also matters. See
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000788 |spell-SpellFileMissing|.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000789 *StdinReadPost*
790StdinReadPost After reading from the stdin into the buffer,
791 before executing the modelines. Only used
792 when the "-" argument was used when Vim was
793 started |--|.
794 *StdinReadPre*
795StdinReadPre Before reading from stdin into the buffer.
796 Only used when the "-" argument was used when
797 Vim was started |--|.
798 *SwapExists*
799SwapExists Detected an existing swap file when starting
800 to edit a file. Only when it is possible to
801 select a way to handle the situation, when Vim
802 would ask the user what to do.
803 The |v:swapname| variable holds the name of
Bram Moolenaarb3480382005-12-11 21:33:32 +0000804 the swap file found, <afile> the file being
805 edited. |v:swapcommand| may contain a command
806 to be executed in the opened file.
807 The commands should set the |v:swapchoice|
808 variable to a string with one character to
809 tell Vim what should be done next:
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000810 'o' open read-only
811 'e' edit the file anyway
812 'r' recover
813 'd' delete the swap file
814 'q' quit, don't edit the file
815 'a' abort, like hitting CTRL-C
816 When set to an empty string the user will be
817 asked, as if there was no SwapExists autocmd.
Bram Moolenaarb849e712009-06-24 15:51:37 +0000818 *E812*
819 It is not allowed to change to another buffer,
820 change a buffer name or change directory
821 here.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000822 *Syntax*
Bram Moolenaard7afed32007-05-06 13:26:41 +0000823Syntax When the 'syntax' option has been set. The
824 pattern is matched against the syntax name.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000825 <afile> can be used for the name of the file
826 where this option was set, and <amatch> for
827 the new value of 'syntax'.
828 See |:syn-on|.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +0000829 *TabEnter*
830TabEnter Just after entering a tab page. |tab-page|
Bram Moolenaar56a907a2006-05-06 21:44:30 +0000831 After triggering the WinEnter and before
832 triggering the BufEnter event.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +0000833 *TabLeave*
834TabLeave Just before leaving a tab page. |tab-page|
835 A WinLeave event will have been triggered
836 first.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000837 *TermChanged*
838TermChanged After the value of 'term' has changed. Useful
839 for re-loading the syntax file to update the
840 colors, fonts and other terminal-dependent
841 settings. Executed for all loaded buffers.
842 *TermResponse*
843TermResponse After the response to |t_RV| is received from
844 the terminal. The value of |v:termresponse|
845 can be used to do things depending on the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +0200846 terminal version. Note that this event may be
847 triggered halfway executing another event,
848 especially if file I/O, a shell command or
849 anything else that takes time is involved.
Bram Moolenaarbf884932013-04-05 22:26:15 +0200850 *TextChanged*
851TextChanged After a change was made to the text in the
852 current buffer in Normal mode. That is when
853 |b:changedtick| has changed.
854 Not triggered when there is typeahead or when
855 an operator is pending.
856 Careful: This is triggered very often, don't
857 do anything that the user does not expect or
858 that is slow.
859 *TextChangedI*
860TextChangedI After a change was made to the text in the
861 current buffer in Insert mode.
862 Not triggered when the popup menu is visible.
863 Otherwise the same as TextChanged.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000864 *User*
865User Never executed automatically. To be used for
866 autocommands that are only executed with
867 ":doautocmd".
868 *UserGettingBored*
Bram Moolenaarbf884932013-04-05 22:26:15 +0200869UserGettingBored When the user presses the same key 42 times.
870 Just kidding! :-)
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000871 *VimEnter*
872VimEnter After doing all the startup stuff, including
873 loading .vimrc files, executing the "-c cmd"
874 arguments, creating all windows and loading
875 the buffers in them.
876 *VimLeave*
877VimLeave Before exiting Vim, just after writing the
878 .viminfo file. Executed only once, like
879 VimLeavePre.
880 To detect an abnormal exit use |v:dying|.
Bram Moolenaar0e1e25f2010-05-28 21:07:08 +0200881 When v:dying is 2 or more this event is not
882 triggered.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000883 *VimLeavePre*
884VimLeavePre Before exiting Vim, just before writing the
885 .viminfo file. This is executed only once,
886 if there is a match with the name of what
887 happens to be the current buffer when exiting.
888 Mostly useful with a "*" pattern. >
889 :autocmd VimLeavePre * call CleanupStuff()
890< To detect an abnormal exit use |v:dying|.
Bram Moolenaar0e1e25f2010-05-28 21:07:08 +0200891 When v:dying is 2 or more this event is not
892 triggered.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +0000893 *VimResized*
894VimResized After the Vim window was resized, thus 'lines'
895 and/or 'columns' changed. Not when starting
896 up though.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000897 *WinEnter*
898WinEnter After entering another window. Not done for
899 the first window, when Vim has just started.
900 Useful for setting the window height.
901 If the window is for another buffer, Vim
902 executes the BufEnter autocommands after the
903 WinEnter autocommands.
904 Note: When using ":split fname" the WinEnter
905 event is triggered after the split but before
906 the file "fname" is loaded.
907 *WinLeave*
908WinLeave Before leaving a window. If the window to be
909 entered next is for a different buffer, Vim
910 executes the BufLeave autocommands before the
911 WinLeave autocommands (but not for ":new").
912 Not used for ":qa" or ":q" when exiting Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000913
914==============================================================================
9156. Patterns *autocmd-patterns* *{pat}*
916
917The file pattern {pat} is tested for a match against the file name in one of
918two ways:
9191. When there is no '/' in the pattern, Vim checks for a match against only
920 the tail part of the file name (without its leading directory path).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009212. When there is a '/' in the pattern, Vim checks for a match against both the
922 short file name (as you typed it) and the full file name (after expanding
923 it to a full path and resolving symbolic links).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000924
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000925The special pattern <buffer> or <buffer=N> is used for buffer-local
926autocommands |autocmd-buflocal|. This pattern is not matched against the name
927of a buffer.
928
Bram Moolenaar071d4272004-06-13 20:20:40 +0000929Examples: >
930 :autocmd BufRead *.txt set et
931Set the 'et' option for all text files. >
932
933 :autocmd BufRead /vim/src/*.c set cindent
934Set the 'cindent' option for C files in the /vim/src directory. >
935
936 :autocmd BufRead /tmp/*.c set ts=5
937If you have a link from "/tmp/test.c" to "/home/nobody/vim/src/test.c", and
938you start editing "/tmp/test.c", this autocommand will match.
939
940Note: To match part of a path, but not from the root directory, use a '*' as
941the first character. Example: >
942 :autocmd BufRead */doc/*.txt set tw=78
943This autocommand will for example be executed for "/tmp/doc/xx.txt" and
944"/usr/home/piet/doc/yy.txt". The number of directories does not matter here.
945
946
947The file name that the pattern is matched against is after expanding
Bram Moolenaar446cb832008-06-24 21:56:24 +0000948wildcards. Thus if you issue this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000949 :e $ROOTDIR/main.$EXT
950The argument is first expanded to: >
951 /usr/root/main.py
952Before it's matched with the pattern of the autocommand. Careful with this
953when using events like FileReadCmd, the value of <amatch> may not be what you
954expect.
955
956
957Environment variables can be used in a pattern: >
958 :autocmd BufRead $VIMRUNTIME/doc/*.txt set expandtab
959And ~ can be used for the home directory (if $HOME is defined): >
960 :autocmd BufWritePost ~/.vimrc so ~/.vimrc
961 :autocmd BufRead ~archive/* set readonly
962The environment variable is expanded when the autocommand is defined, not when
963the autocommand is executed. This is different from the command!
964
965 *file-pattern*
966The pattern is interpreted like mostly used in file names:
Bram Moolenaar3b1db362013-08-10 15:00:24 +0200967 * matches any sequence of characters; Unusual: includes path
Bram Moolenaar9d98fe92013-08-03 18:35:36 +0200968 separators
Bram Moolenaar071d4272004-06-13 20:20:40 +0000969 ? matches any single character
970 \? matches a '?'
971 . matches a '.'
972 ~ matches a '~'
973 , separates patterns
974 \, matches a ','
975 { } like \( \) in a |pattern|
976 , inside { }: like \| in a |pattern|
Bram Moolenaara946afe2013-08-02 15:22:39 +0200977 \} literal }
978 \{ literal {
979 \\\{n,m\} like \{n,m} in a |pattern|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000980 \ special meaning like in a |pattern|
981 [ch] matches 'c' or 'h'
982 [^ch] match any character but 'c' and 'h'
983
984Note that for all systems the '/' character is used for path separator (even
985MS-DOS and OS/2). This was done because the backslash is difficult to use
986in a pattern and to make the autocommands portable across different systems.
987
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000988 *autocmd-changes*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000989Matching with the pattern is done when an event is triggered. Changing the
990buffer name in one of the autocommands, or even deleting the buffer, does not
991change which autocommands will be executed. Example: >
992
993 au BufEnter *.foo bdel
994 au BufEnter *.foo set modified
995
996This will delete the current buffer and then set 'modified' in what has become
997the current buffer instead. Vim doesn't take into account that "*.foo"
998doesn't match with that buffer name. It matches "*.foo" with the name of the
999buffer at the moment the event was triggered.
1000
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00001001However, buffer-local autocommands will not be executed for a buffer that has
1002been wiped out with |:bwipe|. After deleting the buffer with |:bdel| the
1003buffer actually still exists (it becomes unlisted), thus the autocommands are
1004still executed.
1005
Bram Moolenaar071d4272004-06-13 20:20:40 +00001006==============================================================================
Bram Moolenaarc9b4b052006-04-30 18:54:39 +000010077. Buffer-local autocommands *autocmd-buflocal* *autocmd-buffer-local*
1008 *<buffer=N>* *<buffer=abuf>* *E680*
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00001009
1010Buffer-local autocommands are attached to a specific buffer. They are useful
1011if the buffer does not have a name and when the name does not match a specific
1012pattern. But it also means they must be explicitly added to each buffer.
1013
1014Instead of a pattern buffer-local autocommands use one of these forms:
1015 <buffer> current buffer
1016 <buffer=99> buffer number 99
1017 <buffer=abuf> using <abuf> (only when executing autocommands)
1018 |<abuf>|
1019
1020Examples: >
1021 :au CursorHold <buffer> echo 'hold'
1022 :au CursorHold <buffer=33> echo 'hold'
1023 :au CursorHold <buffer=abuf> echo 'hold'
1024
1025All the commands for autocommands also work with buffer-local autocommands,
1026simply use the special string instead of the pattern. Examples: >
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001027 :au! * <buffer> " remove buffer-local autocommands for
1028 " current buffer
1029 :au! * <buffer=33> " remove buffer-local autocommands for
1030 " buffer #33
Bram Moolenaar446cb832008-06-24 21:56:24 +00001031 :bufdo :au! CursorHold <buffer> " remove autocmd for given event for all
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001032 " buffers
1033 :au * <buffer> " list buffer-local autocommands for
1034 " current buffer
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00001035
1036Note that when an autocommand is defined for the current buffer, it is stored
1037with the buffer number. Thus it uses the form "<buffer=12>", where 12 is the
1038number of the current buffer. You will see this when listing autocommands,
1039for example.
1040
1041To test for presence of buffer-local autocommands use the |exists()| function
1042as follows: >
1043 :if exists("#CursorHold#<buffer=12>") | ... | endif
1044 :if exists("#CursorHold#<buffer>") | ... | endif " for current buffer
1045
1046When a buffer is wiped out its buffer-local autocommands are also gone, of
1047course. Note that when deleting a buffer, e.g., with ":bdel", it is only
1048unlisted, the autocommands are still present. In order to see the removal of
1049buffer-local autocommands: >
1050 :set verbose=6
1051
1052It is not possible to define buffer-local autocommands for a non-existent
1053buffer.
1054
1055==============================================================================
10568. Groups *autocmd-groups*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001057
1058Autocommands can be put together in a group. This is useful for removing or
1059executing a group of autocommands. For example, all the autocommands for
1060syntax highlighting are put in the "highlight" group, to be able to execute
1061":doautoall highlight BufRead" when the GUI starts.
1062
1063When no specific group is selected, Vim uses the default group. The default
1064group does not have a name. You cannot execute the autocommands from the
1065default group separately; you can execute them only by executing autocommands
1066for all groups.
1067
1068Normally, when executing autocommands automatically, Vim uses the autocommands
1069for all groups. The group only matters when executing autocommands with
1070":doautocmd" or ":doautoall", or when defining or deleting autocommands.
1071
1072The group name can contain any characters except white space. The group name
1073"end" is reserved (also in uppercase).
1074
1075The group name is case sensitive. Note that this is different from the event
1076name!
1077
1078 *:aug* *:augroup*
1079:aug[roup] {name} Define the autocmd group name for the
1080 following ":autocmd" commands. The name "end"
1081 or "END" selects the default group.
1082
1083 *:augroup-delete* *E367*
1084:aug[roup]! {name} Delete the autocmd group {name}. Don't use
1085 this if there is still an autocommand using
1086 this group! This is not checked.
1087
1088To enter autocommands for a specific group, use this method:
10891. Select the group with ":augroup {name}".
10902. Delete any old autocommands with ":au!".
10913. Define the autocommands.
10924. Go back to the default group with "augroup END".
1093
1094Example: >
1095 :augroup uncompress
1096 : au!
1097 : au BufEnter *.gz %!gunzip
1098 :augroup END
1099
1100This prevents having the autocommands defined twice (e.g., after sourcing the
1101.vimrc file again).
1102
1103==============================================================================
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +000011049. Executing autocommands *autocmd-execute*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001105
1106Vim can also execute Autocommands non-automatically. This is useful if you
1107have changed autocommands, or when Vim has executed the wrong autocommands
1108(e.g., the file pattern match was wrong).
1109
1110Note that the 'eventignore' option applies here too. Events listed in this
1111option will not cause any commands to be executed.
1112
1113 *:do* *:doau* *:doautocmd* *E217*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01001114:do[autocmd] [<nomodeline>] [group] {event} [fname]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001115 Apply the autocommands matching [fname] (default:
1116 current file name) for {event} to the current buffer.
1117 You can use this when the current file name does not
1118 match the right pattern, after changing settings, or
1119 to execute autocommands for a certain event.
1120 It's possible to use this inside an autocommand too,
1121 so you can base the autocommands for one extension on
1122 another extension. Example: >
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001123 :au BufEnter *.cpp so ~/.vimrc_cpp
1124 :au BufEnter *.cpp doau BufEnter x.c
Bram Moolenaar071d4272004-06-13 20:20:40 +00001125< Be careful to avoid endless loops. See
1126 |autocmd-nested|.
1127
1128 When the [group] argument is not given, Vim executes
1129 the autocommands for all groups. When the [group]
1130 argument is included, Vim executes only the matching
1131 autocommands for that group. Note: if you use an
1132 undefined group name, Vim gives you an error message.
Bram Moolenaar60542ac2012-02-12 20:14:01 +01001133 *<nomodeline>*
1134 After applying the autocommands the modelines are
1135 processed, so that their settings overrule the
1136 settings from autocommands, like what happens when
1137 editing a file. This is skipped when the <nomodeline>
1138 argument is present. You probably want to use
1139 <nomodeline> for events that are not used when loading
1140 a buffer, such as |User|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001141
1142 *:doautoa* *:doautoall*
Bram Moolenaara61d5fb2012-02-12 00:18:58 +01001143:doautoa[ll] [<nomodeline>] [group] {event} [fname]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001144 Like ":doautocmd", but apply the autocommands to each
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001145 loaded buffer. Note that [fname] is used to select
Bram Moolenaar071d4272004-06-13 20:20:40 +00001146 the autocommands, not the buffers to which they are
1147 applied.
1148 Careful: Don't use this for autocommands that delete a
1149 buffer, change to another buffer or change the
1150 contents of a buffer; the result is unpredictable.
1151 This command is intended for autocommands that set
1152 options, change highlighting, and things like that.
1153
1154==============================================================================
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000115510. Using autocommands *autocmd-use*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001156
1157For WRITING FILES there are four possible sets of events. Vim uses only one
1158of these sets for a write command:
1159
1160BufWriteCmd BufWritePre BufWritePost writing the whole buffer
1161 FilterWritePre FilterWritePost writing to filter temp file
1162FileAppendCmd FileAppendPre FileAppendPost appending to a file
1163FileWriteCmd FileWritePre FileWritePost any other file write
1164
1165When there is a matching "*Cmd" autocommand, it is assumed it will do the
1166writing. No further writing is done and the other events are not triggered.
1167|Cmd-event|
1168
1169Note that the *WritePost commands should undo any changes to the buffer that
1170were caused by the *WritePre commands; otherwise, writing the file will have
1171the side effect of changing the buffer.
1172
1173Before executing the autocommands, the buffer from which the lines are to be
1174written temporarily becomes the current buffer. Unless the autocommands
1175change the current buffer or delete the previously current buffer, the
1176previously current buffer is made the current buffer again.
1177
1178The *WritePre and *AppendPre autocommands must not delete the buffer from
1179which the lines are to be written.
1180
1181The '[ and '] marks have a special position:
1182- Before the *ReadPre event the '[ mark is set to the line just above where
1183 the new lines will be inserted.
1184- Before the *ReadPost event the '[ mark is set to the first line that was
1185 just read, the '] mark to the last line.
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001186- Before executing the *WriteCmd, *WritePre and *AppendPre autocommands the '[
1187 mark is set to the first line that will be written, the '] mark to the last
1188 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001189Careful: '[ and '] change when using commands that change the buffer.
1190
1191In commands which expect a file name, you can use "<afile>" for the file name
1192that is being read |:<afile>| (you can also use "%" for the current file
1193name). "<abuf>" can be used for the buffer number of the currently effective
1194buffer. This also works for buffers that doesn't have a name. But it doesn't
1195work for files without a buffer (e.g., with ":r file").
1196
1197 *gzip-example*
1198Examples for reading and writing compressed files: >
1199 :augroup gzip
1200 : autocmd!
1201 : autocmd BufReadPre,FileReadPre *.gz set bin
1202 : autocmd BufReadPost,FileReadPost *.gz '[,']!gunzip
1203 : autocmd BufReadPost,FileReadPost *.gz set nobin
1204 : autocmd BufReadPost,FileReadPost *.gz execute ":doautocmd BufReadPost " . expand("%:r")
1205 : autocmd BufWritePost,FileWritePost *.gz !mv <afile> <afile>:r
1206 : autocmd BufWritePost,FileWritePost *.gz !gzip <afile>:r
1207
1208 : autocmd FileAppendPre *.gz !gunzip <afile>
1209 : autocmd FileAppendPre *.gz !mv <afile>:r <afile>
1210 : autocmd FileAppendPost *.gz !mv <afile> <afile>:r
1211 : autocmd FileAppendPost *.gz !gzip <afile>:r
1212 :augroup END
1213
1214The "gzip" group is used to be able to delete any existing autocommands with
1215":autocmd!", for when the file is sourced twice.
1216
1217("<afile>:r" is the file name without the extension, see |:_%:|)
1218
1219The commands executed for the BufNewFile, BufRead/BufReadPost, BufWritePost,
1220FileAppendPost and VimLeave events do not set or reset the changed flag of the
1221buffer. When you decompress the buffer with the BufReadPost autocommands, you
1222can still exit with ":q". When you use ":undo" in BufWritePost to undo the
1223changes made by BufWritePre commands, you can still do ":q" (this also makes
1224"ZZ" work). If you do want the buffer to be marked as modified, set the
1225'modified' option.
1226
1227To execute Normal mode commands from an autocommand, use the ":normal"
1228command. Use with care! If the Normal mode command is not finished, the user
1229needs to type characters (e.g., after ":normal m" you need to type a mark
1230name).
1231
1232If you want the buffer to be unmodified after changing it, reset the
1233'modified' option. This makes it possible to exit the buffer with ":q"
1234instead of ":q!".
1235
1236 *autocmd-nested* *E218*
1237By default, autocommands do not nest. If you use ":e" or ":w" in an
1238autocommand, Vim does not execute the BufRead and BufWrite autocommands for
1239those commands. If you do want this, use the "nested" flag for those commands
1240in which you want nesting. For example: >
1241 :autocmd FileChangedShell *.c nested e!
1242The nesting is limited to 10 levels to get out of recursive loops.
1243
1244It's possible to use the ":au" command in an autocommand. This can be a
1245self-modifying command! This can be useful for an autocommand that should
1246execute only once.
1247
Bram Moolenaarb3480382005-12-11 21:33:32 +00001248If you want to skip autocommands for one command, use the |:noautocmd| command
1249modifier or the 'eventignore' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001250
1251Note: When reading a file (with ":read file" or with a filter command) and the
1252last line in the file does not have an <EOL>, Vim remembers this. At the next
1253write (with ":write file" or with a filter command), if the same line is
1254written again as the last line in a file AND 'binary' is set, Vim does not
1255supply an <EOL>. This makes a filter command on the just read lines write the
1256same file as was read, and makes a write command on just filtered lines write
1257the same file as was read from the filter. For example, another way to write
1258a compressed file: >
1259
1260 :autocmd FileWritePre *.gz set bin|'[,']!gzip
1261 :autocmd FileWritePost *.gz undo|set nobin
1262<
1263 *autocommand-pattern*
1264You can specify multiple patterns, separated by commas. Here are some
1265examples: >
1266
1267 :autocmd BufRead * set tw=79 nocin ic infercase fo=2croq
1268 :autocmd BufRead .letter set tw=72 fo=2tcrq
1269 :autocmd BufEnter .letter set dict=/usr/lib/dict/words
1270 :autocmd BufLeave .letter set dict=
1271 :autocmd BufRead,BufNewFile *.c,*.h set tw=0 cin noic
1272 :autocmd BufEnter *.c,*.h abbr FOR for (i = 0; i < 3; ++i)<CR>{<CR>}<Esc>O
1273 :autocmd BufLeave *.c,*.h unabbr FOR
1274
1275For makefiles (makefile, Makefile, imakefile, makefile.unix, etc.): >
1276
1277 :autocmd BufEnter ?akefile* set include=^s\=include
1278 :autocmd BufLeave ?akefile* set include&
1279
1280To always start editing C files at the first function: >
1281
1282 :autocmd BufRead *.c,*.h 1;/^{
1283
1284Without the "1;" above, the search would start from wherever the file was
1285entered, rather than from the start of the file.
1286
1287 *skeleton* *template*
1288To read a skeleton (template) file when opening a new file: >
1289
1290 :autocmd BufNewFile *.c 0r ~/vim/skeleton.c
1291 :autocmd BufNewFile *.h 0r ~/vim/skeleton.h
1292 :autocmd BufNewFile *.java 0r ~/vim/skeleton.java
1293
1294To insert the current date and time in a *.html file when writing it: >
1295
1296 :autocmd BufWritePre,FileWritePre *.html ks|call LastMod()|'s
1297 :fun LastMod()
1298 : if line("$") > 20
1299 : let l = 20
1300 : else
1301 : let l = line("$")
1302 : endif
1303 : exe "1," . l . "g/Last modified: /s/Last modified: .*/Last modified: " .
1304 : \ strftime("%Y %b %d")
1305 :endfun
1306
1307You need to have a line "Last modified: <date time>" in the first 20 lines
1308of the file for this to work. Vim replaces <date time> (and anything in the
1309same line after it) with the current date and time. Explanation:
1310 ks mark current position with mark 's'
1311 call LastMod() call the LastMod() function to do the work
1312 's return the cursor to the old position
1313The LastMod() function checks if the file is shorter than 20 lines, and then
1314uses the ":g" command to find lines that contain "Last modified: ". For those
1315lines the ":s" command is executed to replace the existing date with the
1316current one. The ":execute" command is used to be able to use an expression
1317for the ":g" and ":s" commands. The date is obtained with the strftime()
1318function. You can change its argument to get another date string.
1319
1320When entering :autocmd on the command-line, completion of events and command
1321names may be done (with <Tab>, CTRL-D, etc.) where appropriate.
1322
1323Vim executes all matching autocommands in the order that you specify them.
1324It is recommended that your first autocommand be used for all files by using
1325"*" as the file pattern. This means that you can define defaults you like
1326here for any settings, and if there is another matching autocommand it will
1327override these. But if there is no other matching autocommand, then at least
1328your default settings are recovered (if entering this file from another for
1329which autocommands did match). Note that "*" will also match files starting
1330with ".", unlike Unix shells.
1331
1332 *autocmd-searchpat*
1333Autocommands do not change the current search patterns. Vim saves the current
1334search patterns before executing autocommands then restores them after the
1335autocommands finish. This means that autocommands do not affect the strings
1336highlighted with the 'hlsearch' option. Within autocommands, you can still
1337use search patterns normally, e.g., with the "n" command.
1338If you want an autocommand to set the search pattern, such that it is used
1339after the autocommand finishes, use the ":let @/ =" command.
1340The search-highlighting cannot be switched off with ":nohlsearch" in an
1341autocommand. Use the 'h' flag in the 'viminfo' option to disable search-
1342highlighting when starting Vim.
1343
1344 *Cmd-event*
1345When using one of the "*Cmd" events, the matching autocommands are expected to
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00001346do the file reading, writing or sourcing. This can be used when working with
1347a special kind of file, for example on a remote system.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001348CAREFUL: If you use these events in a wrong way, it may have the effect of
1349making it impossible to read or write the matching files! Make sure you test
1350your autocommands properly. Best is to use a pattern that will never match a
1351normal file name, for example "ftp://*".
1352
1353When defining a BufReadCmd it will be difficult for Vim to recover a crashed
1354editing session. When recovering from the original file, Vim reads only those
1355parts of a file that are not found in the swap file. Since that is not
1356possible with a BufReadCmd, use the |:preserve| command to make sure the
1357original file isn't needed for recovery. You might want to do this only when
1358you expect the file to be modified.
1359
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00001360For file read and write commands the |v:cmdarg| variable holds the "++enc="
1361and "++ff=" argument that are effective. These should be used for the command
1362that reads/writes the file. The |v:cmdbang| variable is one when "!" was
1363used, zero otherwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001364
Bram Moolenaarc88ebf72010-07-22 22:30:23 +02001365See the $VIMRUNTIME/plugin/netrwPlugin.vim for examples.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001366
Bram Moolenaarb3480382005-12-11 21:33:32 +00001367==============================================================================
136811. Disabling autocommands *autocmd-disable*
1369
1370To disable autocommands for some time use the 'eventignore' option. Note that
1371this may cause unexpected behavior, make sure you restore 'eventignore'
1372afterwards, using a |:try| block with |:finally|.
1373
1374 *:noautocmd* *:noa*
1375To disable autocommands for just one command use the ":noautocmd" command
1376modifier. This will set 'eventignore' to "all" for the duration of the
1377following command. Example: >
1378
1379 :noautocmd w fname.gz
1380
1381This will write the file without triggering the autocommands defined by the
1382gzip plugin.
1383
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00001384
Bram Moolenaar071d4272004-06-13 20:20:40 +00001385 vim:tw=78:ts=8:ft=help:norl: