blob: 204a9117c4b104efd0665af28668b1adc0a4fed5 [file] [log] [blame]
Girish Palya92f68e22025-04-21 11:12:41 +02001*autocmd.txt* For Vim version 9.1. Last change: 2025 Apr 21
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
Bram Moolenaar675e8d62018-06-24 20:42:01 +02007Automatic commands *autocommand* *autocommands*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008
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
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24==============================================================================
251. Introduction *autocmd-intro*
26
Bram Moolenaard4755bb2004-09-02 19:12:26 +000027You can specify commands to be executed automatically when reading or writing
28a file, when entering or leaving a buffer or window, and when exiting Vim.
29For example, you can create an autocommand to set the 'cindent' option for
30files matching *.c. You can also use autocommands to implement advanced
Bram Moolenaar071d4272004-06-13 20:20:40 +000031features, such as editing compressed files (see |gzip-example|). The usual
32place to put autocommands is in your .vimrc or .exrc file.
33
Bram Moolenaar72540672018-02-09 22:00:53 +010034 *E203* *E204* *E143* *E855* *E937* *E952*
Bram Moolenaar071d4272004-06-13 20:20:40 +000035WARNING: Using autocommands is very powerful, and may lead to unexpected side
36effects. Be careful not to destroy your text.
37- It's a good idea to do some testing on an expendable copy of a file first.
38 For example: If you use autocommands to decompress a file when starting to
39 edit it, make sure that the autocommands for compressing when writing work
40 correctly.
41- Be prepared for an error halfway through (e.g., disk full). Vim will mostly
42 be able to undo the changes to the buffer, but you may have to clean up the
43 changes to other files by hand (e.g., compress a file that has been
44 decompressed).
45- If the BufRead* events allow you to edit a compressed file, the FileRead*
46 events should do the same (this makes recovery possible in some rare cases).
47 It's a good idea to use the same autocommands for the File* and Buf* events
48 when possible.
49
Yegappan Lakshmanan971f6822022-05-24 11:40:11 +010050Recommended use:
51- Always use a group, so that it's easy to delete the autocommand.
52- Keep the command itself short, call a function to do more work.
Bram Moolenaarcfa8f9a2022-06-03 21:59:47 +010053- Make it so that the script it is defined in can be sourced several times
Yegappan Lakshmanan971f6822022-05-24 11:40:11 +010054 without the autocommand being repeated.
55
56Example in Vim9 script: >
Boyang Du72985652024-07-09 18:46:12 +020057 autocmd_add([{replace: true,
Yegappan Lakshmanan971f6822022-05-24 11:40:11 +010058 group: 'DemoGroup',
59 event: 'BufEnter',
60 pattern: '*.txt',
61 cmd: 'call DemoBufEnter()'
Boyang Du72985652024-07-09 18:46:12 +020062 }])
Yegappan Lakshmanan971f6822022-05-24 11:40:11 +010063
64In legacy script: >
Boyang Du72985652024-07-09 18:46:12 +020065 call autocmd_add([#{replace: v:true,
Yegappan Lakshmanan971f6822022-05-24 11:40:11 +010066 \ group: 'DemoGroup',
Bram Moolenaar938ae282023-02-20 20:44:55 +000067 \ event: 'BufEnter',
Yegappan Lakshmanan971f6822022-05-24 11:40:11 +010068 \ pattern: '*.txt',
69 \ cmd: 'call DemoBufEnter()'
Boyang Du72985652024-07-09 18:46:12 +020070 \ }])
Yegappan Lakshmanan971f6822022-05-24 11:40:11 +010071
Bram Moolenaar071d4272004-06-13 20:20:40 +000072==============================================================================
732. Defining autocommands *autocmd-define*
74
Bram Moolenaar071d4272004-06-13 20:20:40 +000075 *:au* *:autocmd*
Bram Moolenaarfd31be22022-01-16 14:46:06 +000076:au[tocmd] [group] {event} {aupat} [++once] [++nested] {cmd}
Bram Moolenaar071d4272004-06-13 20:20:40 +000077 Add {cmd} to the list of commands that Vim will
78 execute automatically on {event} for a file matching
Bram Moolenaarfd31be22022-01-16 14:46:06 +000079 {aupat} |autocmd-patterns|.
Bram Moolenaar85388672021-01-31 17:03:52 +010080 Here {event} cannot be "*". *E1155*
Bram Moolenaar98ef2332018-03-18 14:44:37 +010081 Note: A quote character is seen as argument to the
82 :autocmd and won't start a comment.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +010083 Vim always adds the {cmd} after existing autocommands,
84 so that the autocommands execute in the order in which
Bram Moolenaareb93f3f2019-04-04 15:04:56 +020085 they were given.
86 See |autocmd-nested| for [++nested]. "nested"
87 (without the ++) can also be used, for backwards
Bram Moolenaar1588bc82022-03-08 21:35:07 +000088 compatibility, but not in |Vim9| script. *E1078*
Bram Moolenaareb93f3f2019-04-04 15:04:56 +020089 *autocmd-once*
90 If [++once] is supplied the command is executed once,
91 then removed ("one shot").
Bram Moolenaar071d4272004-06-13 20:20:40 +000092
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +000093The special pattern <buffer> or <buffer=N> defines a buffer-local autocommand.
94See |autocmd-buflocal|.
95
Bram Moolenaar1b884a02020-12-10 21:11:27 +010096If the `:autocmd` is in Vim9 script (a script that starts with `:vim9script`
97and in a `:def` function) then {cmd} will be executed as in Vim9
Bram Moolenaar4466ad62020-11-21 13:16:30 +010098script. Thus this depends on where the autocmd is defined, not where it is
99triggered.
Bram Moolenaarf1dcd142022-12-31 15:30:45 +0000100 *:autocmd-block*
Bram Moolenaar6aa57292021-08-14 21:25:52 +0200101{cmd} can be a block, like with `:command`, see |:command-repl|. Example: >
Bram Moolenaar73b8b0a2021-08-01 14:52:32 +0200102 au BufReadPost *.xml {
103 setlocal matchpairs+=<:>
104 /<start
105 }
106
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +0100107The |autocmd_add()| function can be used to add a list of autocmds and autocmd
Yegappan Lakshmanan971f6822022-05-24 11:40:11 +0100108groups from a Vim script. It is preferred if you have anything that would
109require using `:execute` with `:autocmd`.
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +0100110
Bram Moolenaare99e8442016-07-26 20:43:40 +0200111Note: The ":autocmd" command can only be followed by another command when the
Bram Moolenaar88a42052021-11-21 21:13:36 +0000112'|' appears where the pattern is expected. This works: >
Bram Moolenaare99e8442016-07-26 20:43:40 +0200113 :augroup mine | au! BufRead | augroup END
114But this sees "augroup" as part of the defined command: >
Bram Moolenaarb0d45e72017-11-05 18:19:24 +0100115 :augroup mine | au! BufRead * | augroup END
Bram Moolenaare99e8442016-07-26 20:43:40 +0200116 :augroup mine | au BufRead * set tw=70 | augroup END
Bram Moolenaarb0d45e72017-11-05 18:19:24 +0100117Instead you can put the group name into the command: >
118 :au! mine BufRead *
119 :au mine BufRead * set tw=70
120Or use `:execute`: >
121 :augroup mine | exe "au! BufRead *" | augroup END
122 :augroup mine | exe "au BufRead * set tw=70" | augroup END
Bram Moolenaare99e8442016-07-26 20:43:40 +0200123
Bram Moolenaar75ab5902022-04-18 15:36:40 +0100124< *autocmd-expand*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000125Note that special characters (e.g., "%", "<cword>") in the ":autocmd"
126arguments are not expanded when the autocommand is defined. These will be
127expanded when the Event is recognized, and the {cmd} is executed. The only
128exception is that "<sfile>" is expanded when the autocmd is defined. Example:
129>
130 :au BufNewFile,BufRead *.html so <sfile>:h/html.vim
131
132Here Vim expands <sfile> to the name of the file containing this line.
133
Bram Moolenaar2ec618c2016-10-01 14:47:05 +0200134`:autocmd` adds to the list of autocommands regardless of whether they are
135already present. When your .vimrc file is sourced twice, the autocommands
136will appear twice. To avoid this, define your autocommands in a group, so
137that you can easily clear them: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000138
Bram Moolenaar2ec618c2016-10-01 14:47:05 +0200139 augroup vimrc
Bram Moolenaar98ef2332018-03-18 14:44:37 +0100140 " Remove all vimrc autocommands
141 autocmd!
Bram Moolenaar2ec618c2016-10-01 14:47:05 +0200142 au BufNewFile,BufRead *.html so <sfile>:h/html.vim
143 augroup END
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144
145If you don't want to remove all autocommands, you can instead use a variable
146to ensure that Vim includes the autocommands only once: >
147
148 :if !exists("autocommands_loaded")
149 : let autocommands_loaded = 1
150 : au ...
151 :endif
152
153When the [group] argument is not given, Vim uses the current group (as defined
154with ":augroup"); otherwise, Vim uses the group defined with [group]. Note
155that [group] must have been defined before. You cannot define a new group
156with ":au group ..."; use ":augroup" for that.
157
158While testing autocommands, you might find the 'verbose' option to be useful: >
159 :set verbose=9
160This setting makes Vim echo the autocommands as it executes them.
161
162When defining an autocommand in a script, it will be able to call functions
163local to the script and use mappings local to the script. When the event is
164triggered and the command executed, it will run in the context of the script
165it was defined in. This matters if |<SID>| is used in a command.
166
Bram Moolenaar446cb832008-06-24 21:56:24 +0000167When executing the commands, the message from one command overwrites a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000168previous message. This is different from when executing the commands
169manually. Mostly the screen will not scroll up, thus there is no hit-enter
170prompt. When one command outputs two messages this can happen anyway.
171
172==============================================================================
1733. Removing autocommands *autocmd-remove*
174
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +0100175In addition to the below described commands, the |autocmd_delete()| function can
176be used to remove a list of autocmds and autocmd groups from a Vim script.
177
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000178:au[tocmd]! [group] {event} {aupat} [++once] [++nested] {cmd}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000179 Remove all autocommands associated with {event} and
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000180 {aupat}, and add the command {cmd}.
Bram Moolenaareb93f3f2019-04-04 15:04:56 +0200181 See |autocmd-once| for [++once].
182 See |autocmd-nested| for [++nested].
Bram Moolenaar071d4272004-06-13 20:20:40 +0000183
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000184:au[tocmd]! [group] {event} {aupat}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000185 Remove all autocommands associated with {event} and
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000186 {aupat}.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000187
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000188:au[tocmd]! [group] * {aupat}
189 Remove all autocommands associated with {aupat} for
190 all events.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000191
192:au[tocmd]! [group] {event}
193 Remove ALL autocommands for {event}.
Bram Moolenaar2ec618c2016-10-01 14:47:05 +0200194 Warning: You should not do this without a group for
195 |BufRead| and other common events, it can break
196 plugins, syntax highlighting, etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000197
198:au[tocmd]! [group] Remove ALL autocommands.
Bram Moolenaar98ef2332018-03-18 14:44:37 +0100199 Note: a quote will be seen as argument to the :autocmd
200 and won't start a comment.
Bram Moolenaar2ec618c2016-10-01 14:47:05 +0200201 Warning: You should normally not do this without a
202 group, it breaks plugins, syntax highlighting, etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000203
204When the [group] argument is not given, Vim uses the current group (as defined
205with ":augroup"); otherwise, Vim uses the group defined with [group].
206
207==============================================================================
2084. Listing autocommands *autocmd-list*
209
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000210:au[tocmd] [group] {event} {aupat}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000211 Show the autocommands associated with {event} and
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000212 {aupat}.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000213
Bram Moolenaarfd31be22022-01-16 14:46:06 +0000214:au[tocmd] [group] * {aupat}
215 Show the autocommands associated with {aupat} for all
Bram Moolenaar071d4272004-06-13 20:20:40 +0000216 events.
217
218:au[tocmd] [group] {event}
219 Show all autocommands for {event}.
220
221:au[tocmd] [group] Show all autocommands.
222
223If you provide the [group] argument, Vim lists only the autocommands for
224[group]; otherwise, Vim lists the autocommands for ALL groups. Note that this
225argument behavior differs from that for defining and removing autocommands.
226
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000227In order to list buffer-local autocommands, use a pattern in the form <buffer>
228or <buffer=N>. See |autocmd-buflocal|.
229
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +0100230The |autocmd_get()| function can be used from a Vim script to get a list of
231autocmds.
232
Bram Moolenaarac6e65f2005-08-29 22:25:38 +0000233 *:autocmd-verbose*
234When 'verbose' is non-zero, listing an autocommand will also display where it
235was last defined. Example: >
236
237 :verbose autocmd BufEnter
238 FileExplorer BufEnter
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000239 * call s:LocalBrowse(expand("<amatch>"))
Bram Moolenaarac6e65f2005-08-29 22:25:38 +0000240 Last set from /usr/share/vim/vim-7.0/plugin/NetrwPlugin.vim
241<
242See |:verbose-cmd| for more information.
243
Bram Moolenaar071d4272004-06-13 20:20:40 +0000244==============================================================================
2455. Events *autocmd-events* *E215* *E216*
246
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000247You can specify a comma-separated list of event names. No white space can be
248used in this list. The command applies to all the events in the list.
249
250For READING FILES there are four kinds of events possible:
251 BufNewFile starting to edit a non-existent file
252 BufReadPre BufReadPost starting to edit an existing file
253 FilterReadPre FilterReadPost read the temp file with filter output
254 FileReadPre FileReadPost any other file read
255Vim uses only one of these four kinds when reading a file. The "Pre" and
256"Post" events are both triggered, before and after reading the file.
257
258Note that the autocommands for the *ReadPre events and all the Filter events
259are not allowed to change the current buffer (you will get an error message if
260this happens). This is to prevent the file to be read into the wrong buffer.
261
262Note that the 'modified' flag is reset AFTER executing the BufReadPost
263and BufNewFile autocommands. But when the 'modified' option was set by the
264autocommands, this doesn't happen.
265
266You can use the 'eventignore' option to ignore a number of events or all
267events.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268 *autocommand-events* *{event}*
269Vim recognizes the following events. Vim ignores the case of event names
270(e.g., you can use "BUFread" or "bufread" instead of "BufRead").
271
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000272First an overview by function with a short explanation. Then the list
Bram Moolenaar551dbcc2006-04-25 22:13:59 +0000273alphabetically with full explanations |autocmd-events-abc|.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000274
275Name triggered by ~
276
277 Reading
278|BufNewFile| starting to edit a file that doesn't exist
279|BufReadPre| starting to edit a new buffer, before reading the file
280|BufRead| starting to edit a new buffer, after reading the file
281|BufReadPost| starting to edit a new buffer, after reading the file
282|BufReadCmd| before starting to edit a new buffer |Cmd-event|
283
284|FileReadPre| before reading a file with a ":read" command
285|FileReadPost| after reading a file with a ":read" command
Bram Moolenaar551dbcc2006-04-25 22:13:59 +0000286|FileReadCmd| before reading a file with a ":read" command |Cmd-event|
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000287
288|FilterReadPre| before reading a file from a filter command
289|FilterReadPost| after reading a file from a filter command
290
291|StdinReadPre| before reading from stdin into the buffer
292|StdinReadPost| After reading from the stdin into the buffer
293
294 Writing
295|BufWrite| starting to write the whole buffer to a file
296|BufWritePre| starting to write the whole buffer to a file
297|BufWritePost| after writing the whole buffer to a file
298|BufWriteCmd| before writing the whole buffer to a file |Cmd-event|
299
300|FileWritePre| starting to write part of a buffer to a file
301|FileWritePost| after writing part of a buffer to a file
302|FileWriteCmd| before writing part of a buffer to a file |Cmd-event|
303
304|FileAppendPre| starting to append to a file
305|FileAppendPost| after appending to a file
306|FileAppendCmd| before appending to a file |Cmd-event|
307
308|FilterWritePre| starting to write a file for a filter command or diff
309|FilterWritePost| after writing a file for a filter command or diff
310
311 Buffers
312|BufAdd| just after adding a buffer to the buffer list
313|BufCreate| just after adding a buffer to the buffer list
314|BufDelete| before deleting a buffer from the buffer list
315|BufWipeout| before completely deleting a buffer
316
317|BufFilePre| before changing the name of the current buffer
318|BufFilePost| after changing the name of the current buffer
319
320|BufEnter| after entering a buffer
321|BufLeave| before leaving to another buffer
322|BufWinEnter| after a buffer is displayed in a window
323|BufWinLeave| before a buffer is removed from a window
324
325|BufUnload| before unloading a buffer
Bram Moolenaarcb80aa22020-10-26 21:12:46 +0100326|BufHidden| just before a buffer becomes hidden
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000327|BufNew| just after creating a new buffer
328
329|SwapExists| detected an existing swap file
330
331 Options
332|FileType| when the 'filetype' option has been set
333|Syntax| when the 'syntax' option has been set
334|EncodingChanged| after the 'encoding' option has been changed
335|TermChanged| after the value of 'term' has changed
Bram Moolenaar53744302015-07-17 17:38:22 +0200336|OptionSet| after setting any option
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000337
338 Startup and exit
339|VimEnter| after doing all the startup stuff
340|GUIEnter| after starting the GUI successfully
Bram Moolenaard09acef2012-09-21 14:54:30 +0200341|GUIFailed| after starting the GUI failed
Bram Moolenaard7afed32007-05-06 13:26:41 +0000342|TermResponse| after the terminal response to |t_RV| is received
Danek Duvalld7d56032024-01-14 20:19:59 +0100343|TermResponseAll| after the terminal response to |t_RV| and others is received
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000344
Bram Moolenaar12a96de2018-03-11 14:44:18 +0100345|QuitPre| when using `:quit`, before deciding whether to exit
346|ExitPre| when using a command that may make Vim exit
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000347|VimLeavePre| before exiting Vim, before writing the viminfo file
348|VimLeave| before exiting Vim, after writing the viminfo file
349
Bram Moolenaar100118c2020-12-11 19:30:34 +0100350|VimSuspend| when suspending Vim
351|VimResume| when Vim is resumed after being suspended
352
Bram Moolenaar28ed4df2019-10-26 16:21:40 +0200353 Terminal
354|TerminalOpen| after a terminal buffer was created
355|TerminalWinOpen| after a terminal buffer was created in a new window
356
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000357 Various
358|FileChangedShell| Vim notices that a file changed since editing started
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +0000359|FileChangedShellPost| After handling a file changed since editing started
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000360|FileChangedRO| before making the first change to a read-only file
361
Bram Moolenaar2c64ca12018-10-19 16:22:31 +0200362|DiffUpdated| after diffs have been updated
Bram Moolenaar28e8f732022-02-09 12:58:20 +0000363|DirChangedPre| before the working directory will change
Bram Moolenaarb7407d32018-02-03 17:36:27 +0100364|DirChanged| after the working directory has changed
365
Bram Moolenaara94bc432006-03-10 21:42:59 +0000366|ShellCmdPost| after executing a shell command
367|ShellFilterPost| after filtering with a shell command
368
Bram Moolenaard5005162014-08-22 23:05:54 +0200369|CmdUndefined| a user command is used but it isn't defined
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000370|FuncUndefined| a user function is used but it isn't defined
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +0000371|SpellFileMissing| a spell file is used but it can't be found
Bram Moolenaar1f35bf92006-03-07 22:38:47 +0000372|SourcePre| before sourcing a Vim script
Bram Moolenaar2a953fc2019-01-26 17:41:47 +0100373|SourcePost| after sourcing a Vim script
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +0000374|SourceCmd| before sourcing a Vim script |Cmd-event|
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000375
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +0000376|VimResized| after the Vim window size changed
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000377|FocusGained| Vim got input focus
378|FocusLost| Vim lost input focus
379|CursorHold| the user doesn't press a key for a while
Bram Moolenaar754b5602006-02-09 23:53:20 +0000380|CursorHoldI| the user doesn't press a key for a while in Insert mode
381|CursorMoved| the cursor was moved in Normal mode
Shougo Matsushitad0952142024-06-20 22:05:16 +0200382|CursorMovedC| the cursor was moved in the |Command-line|
Bram Moolenaar754b5602006-02-09 23:53:20 +0000383|CursorMovedI| the cursor was moved in Insert mode
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000384
Sergey Vlasov1f47db72024-01-25 23:07:00 +0100385|WinNewPre| before creating a new window
Bram Moolenaarc917da42016-07-19 22:31:36 +0200386|WinNew| after creating a new window
Bram Moolenaar12c11d52016-07-19 23:13:03 +0200387|TabNew| after creating a new tab page
naohiro ono23beefe2021-11-13 12:38:49 +0000388|WinClosed| after closing a window
Bram Moolenaar12c11d52016-07-19 23:13:03 +0200389|TabClosed| after closing a tab page
Jim Zhou5606ca52025-03-13 21:58:25 +0100390|TabClosedPre| before closing a tab page
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000391|WinEnter| after entering another window
392|WinLeave| before leaving a window
Bram Moolenaarfaa959a2006-02-20 21:37:40 +0000393|TabEnter| after entering another tab page
394|TabLeave| before leaving a tab page
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000395|CmdwinEnter| after entering the command-line window
396|CmdwinLeave| before leaving the command-line window
397
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100398|CmdlineChanged| after a change was made to the command-line text
399|CmdlineEnter| after the cursor moves to the command line
400|CmdlineLeave| before the cursor leaves the command line
Girish Palya92f68e22025-04-21 11:12:41 +0200401|CmdlineLeavePre| before preparing to leave the command line
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100402
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000403|InsertEnter| starting Insert mode
404|InsertChange| when typing <Insert> while in Insert or Replace mode
405|InsertLeave| when leaving Insert mode
Bram Moolenaar938ae282023-02-20 20:44:55 +0000406|InsertLeavePre| just before leaving Insert mode
Bram Moolenaare659c952011-05-19 17:25:41 +0200407|InsertCharPre| when a character was typed in Insert mode, before
408 inserting it
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000409
=?UTF-8?q?Magnus=20Gro=C3=9F?=f1e88762021-09-12 13:39:55 +0200410|ModeChanged| after changing the mode
411
Bram Moolenaardfb18412013-12-11 18:53:29 +0100412|TextChanged| after a change was made to the text in Normal mode
413|TextChangedI| after a change was made to the text in Insert mode
Bram Moolenaar5a093432018-02-10 18:15:19 +0100414 when popup menu is not visible
415|TextChangedP| after a change was made to the text in Insert mode
416 when popup menu visible
Shougo Matsushita4ccaedf2022-10-15 11:48:00 +0100417|TextChangedT| after a change was made to the text in Terminal mode
Bram Moolenaarb477af22018-07-15 20:20:18 +0200418|TextYankPost| after text has been yanked or deleted
Bram Moolenaardfb18412013-12-11 18:53:29 +0100419
Bram Moolenaar8aeec402019-09-15 23:02:04 +0200420|SafeState| nothing pending, going to wait for the user to type a
421 character
Bram Moolenaar69198cb2019-09-16 21:58:13 +0200422|SafeStateAgain| repeated SafeState
Bram Moolenaar8aeec402019-09-15 23:02:04 +0200423
Bram Moolenaar15142e22018-04-30 22:19:58 +0200424|ColorSchemePre| before loading a color scheme
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000425|ColorScheme| after loading a color scheme
426
427|RemoteReply| a reply from a server Vim was received
428
429|QuickFixCmdPre| before a quickfix command is run
430|QuickFixCmdPost| after a quickfix command is run
431
432|SessionLoadPost| after loading a session file
433
h-east53753f62024-05-05 18:42:31 +0200434|SessionWritePost| after writing the session file using
435 the |:mksession| command
Colin Kennedye5f22802024-03-26 18:20:16 +0100436
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000437|MenuPopup| just before showing the popup menu
Bram Moolenaard7f246c2019-04-08 18:15:41 +0200438|CompleteChanged| after Insert mode completion menu changed
Bram Moolenaar3f169ce2020-01-26 22:43:31 +0100439|CompleteDonePre| after Insert mode completion is done, before clearing
440 info
441|CompleteDone| after Insert mode completion is done, after clearing
442 info
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000443
Shougo Matsushita83678842024-07-11 22:05:12 +0200444|KeyInputPre| just before a key is processed
445
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000446|User| to be used in combination with ":doautocmd"
Bram Moolenaarbe5ee862020-06-10 20:56:58 +0200447|SigUSR1| after the SIGUSR1 signal has been detected
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000448
LemonBoy09371822022-04-08 15:18:45 +0100449|WinScrolled| after scrolling or resizing a window
450
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000451
452The alphabetical list of autocommand events: *autocmd-events-abc*
453
454 *BufCreate* *BufAdd*
455BufAdd or BufCreate Just after creating a new buffer which is
456 added to the buffer list, or adding a buffer
457 to the buffer list.
458 Also used just after a buffer in the buffer
459 list has been renamed.
Bram Moolenaar469bdbd2019-12-11 23:05:48 +0100460 Not triggered for the initial buffers created
461 during startup.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000462 The BufCreate event is for historic reasons.
463 NOTE: When this autocommand is executed, the
464 current buffer "%" may be different from the
465 buffer being created "<afile>".
466 *BufDelete*
467BufDelete Before deleting a buffer from the buffer list.
468 The BufUnload may be called first (if the
469 buffer was loaded).
470 Also used just before a buffer in the buffer
471 list is renamed.
472 NOTE: When this autocommand is executed, the
473 current buffer "%" may be different from the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000474 buffer being deleted "<afile>" and "<abuf>".
Bram Moolenaarb849e712009-06-24 15:51:37 +0000475 Don't change to another buffer, it will cause
476 problems.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000477 *BufEnter*
478BufEnter After entering a buffer. Useful for setting
479 options for a file type. Also executed when
480 starting to edit a buffer, after the
481 BufReadPost autocommands.
482 *BufFilePost*
483BufFilePost After changing the name of the current buffer
484 with the ":file" or ":saveas" command.
Bram Moolenaar4770d092006-01-12 23:22:24 +0000485 *BufFilePre*
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000486BufFilePre Before changing the name of the current buffer
487 with the ":file" or ":saveas" command.
488 *BufHidden*
Bram Moolenaar790c18b2019-07-04 17:22:06 +0200489BufHidden Just before a buffer becomes hidden. That is,
490 when there are no longer windows that show
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000491 the buffer, but the buffer is not unloaded or
492 deleted. Not used for ":qa" or ":q" when
493 exiting Vim.
494 NOTE: When this autocommand is executed, the
495 current buffer "%" may be different from the
496 buffer being unloaded "<afile>".
497 *BufLeave*
498BufLeave Before leaving to another buffer. Also when
499 leaving or closing the current window and the
500 new current window is not for the same buffer.
501 Not used for ":qa" or ":q" when exiting Vim.
502 *BufNew*
503BufNew Just after creating a new buffer. Also used
504 just after a buffer has been renamed. When
505 the buffer is added to the buffer list BufAdd
506 will be triggered too.
507 NOTE: When this autocommand is executed, the
508 current buffer "%" may be different from the
509 buffer being created "<afile>".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000510 *BufNewFile*
511BufNewFile When starting to edit a file that doesn't
512 exist. Can be used to read in a skeleton
513 file.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000514 *BufRead* *BufReadPost*
515BufRead or BufReadPost When starting to edit a new buffer, after
516 reading the file into the buffer, before
517 executing the modelines. See |BufWinEnter|
518 for when you need to do something after
519 processing the modelines.
Bram Moolenaar75ab5902022-04-18 15:36:40 +0100520 Also triggered:
521 - when writing an unnamed buffer in a way that
522 the buffer gets a name
523 - after successfully recovering a file
524 - for the filetypedetect group when executing
525 ":filetype detect"
526 Not triggered:
527 - for the `:read file` command
528 - when the file doesn't exist
Bram Moolenaar4770d092006-01-12 23:22:24 +0000529 *BufReadCmd*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000530BufReadCmd Before starting to edit a new buffer. Should
531 read the file into the buffer. |Cmd-event|
Bram Moolenaar4770d092006-01-12 23:22:24 +0000532 *BufReadPre* *E200* *E201*
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000533BufReadPre When starting to edit a new buffer, before
534 reading the file into the buffer. Not used
535 if the file doesn't exist.
536 *BufUnload*
537BufUnload Before unloading a buffer. This is when the
538 text in the buffer is going to be freed. This
539 may be after a BufWritePost and before a
540 BufDelete. Also used for all buffers that are
541 loaded when Vim is going to exit.
542 NOTE: When this autocommand is executed, the
543 current buffer "%" may be different from the
544 buffer being unloaded "<afile>".
Bram Moolenaar64d8e252016-09-06 22:12:34 +0200545 Don't change to another buffer or window, it
546 will cause problems!
Bram Moolenaar0e1e25f2010-05-28 21:07:08 +0200547 When exiting and v:dying is 2 or more this
548 event is not triggered.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000549 *BufWinEnter*
550BufWinEnter After a buffer is displayed in a window. This
551 can be when the buffer is loaded (after
Bram Moolenaar446cb832008-06-24 21:56:24 +0000552 processing the modelines) or when a hidden
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000553 buffer is displayed in a window (and is no
Bram Moolenaar446cb832008-06-24 21:56:24 +0000554 longer hidden).
555 Does not happen for |:split| without
556 arguments, since you keep editing the same
557 buffer, or ":split" with a file that's already
Bram Moolenaarc236c162008-07-13 17:41:49 +0000558 open in a window, because it re-uses an
559 existing buffer. But it does happen for a
560 ":split" with the name of the current buffer,
561 since it reloads that buffer.
Bram Moolenaar606cb8b2018-05-03 20:40:20 +0200562 Does not happen for a terminal window, because
563 it starts in Terminal-Job mode and Normal mode
564 commands won't work. Use |TerminalOpen| instead.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000565 *BufWinLeave*
566BufWinLeave Before a buffer is removed from a window.
567 Not when it's still visible in another window.
568 Also triggered when exiting. It's triggered
569 before BufUnload or BufHidden.
570 NOTE: When this autocommand is executed, the
571 current buffer "%" may be different from the
572 buffer being unloaded "<afile>".
Bram Moolenaar0e1e25f2010-05-28 21:07:08 +0200573 When exiting and v:dying is 2 or more this
574 event is not triggered.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000575 *BufWipeout*
576BufWipeout Before completely deleting a buffer. The
577 BufUnload and BufDelete events may be called
578 first (if the buffer was loaded and was in the
579 buffer list). Also used just before a buffer
580 is renamed (also when it's not in the buffer
581 list).
582 NOTE: When this autocommand is executed, the
583 current buffer "%" may be different from the
584 buffer being deleted "<afile>".
Bram Moolenaarb849e712009-06-24 15:51:37 +0000585 Don't change to another buffer, it will cause
586 problems.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000587 *BufWrite* *BufWritePre*
588BufWrite or BufWritePre Before writing the whole buffer to a file.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000589 *BufWriteCmd*
590BufWriteCmd Before writing the whole buffer to a file.
591 Should do the writing of the file and reset
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000592 'modified' if successful, unless '+' is in
593 'cpo' and writing to another file |cpo-+|.
594 The buffer contents should not be changed.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +0200595 When the command resets 'modified' the undo
596 information is adjusted to mark older undo
Christian Brabandtdf684192025-04-03 12:33:02 +0200597 states as 'modified', like |:write| does. Use
598 the |'[| and |']| marks for the range of lines.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000599 |Cmd-event|
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000600 *BufWritePost*
601BufWritePost After writing the whole buffer to a file
602 (should undo the commands for BufWritePre).
Bram Moolenaard5005162014-08-22 23:05:54 +0200603 *CmdUndefined*
604CmdUndefined When a user command is used but it isn't
605 defined. Useful for defining a command only
606 when it's used. The pattern is matched
607 against the command name. Both <amatch> and
608 <afile> are set to the name of the command.
zeertzjqaf056942025-03-08 16:45:20 +0100609 This is triggered even when inside an
610 autocommand defined without |autocmd-nested|.
Bram Moolenaard5005162014-08-22 23:05:54 +0200611 NOTE: Autocompletion won't work until the
612 command is defined. An alternative is to
613 always define the user command and have it
614 invoke an autoloaded function. See |autoload|.
Bram Moolenaar153b7042018-01-31 15:48:32 +0100615 *CmdlineChanged*
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100616CmdlineChanged After a change was made to the text in the
617 command line. Be careful not to mess up
618 the command line, it may cause Vim to lock up.
Bram Moolenaar153b7042018-01-31 15:48:32 +0100619 <afile> is set to a single character,
620 indicating the type of command-line.
621 |cmdwin-char|
Bram Moolenaarfafcf0d2017-10-19 18:35:51 +0200622 *CmdlineEnter*
623CmdlineEnter After moving the cursor to the command line,
624 where the user can type a command or search
Bram Moolenaar957cf672020-11-12 14:21:06 +0100625 string; including non-interactive use of ":"
626 in a mapping, but not when using |<Cmd>|.
Bram Moolenaar938ae282023-02-20 20:44:55 +0000627 The pattern is matched against the character
628 representing the type of command-line.
629 |cmdwin-char|
Bram Moolenaarfafcf0d2017-10-19 18:35:51 +0200630 <afile> is set to a single character,
631 indicating the type of command-line.
Bram Moolenaarfafcf0d2017-10-19 18:35:51 +0200632 *CmdlineLeave*
Bram Moolenaar957cf672020-11-12 14:21:06 +0100633CmdlineLeave Before leaving the command line; including
634 non-interactive use of ":" in a mapping, but
635 not when using |<Cmd>|.
Bram Moolenaar01164a62017-11-02 22:58:42 +0100636 Also when abandoning the command line, after
637 typing CTRL-C or <Esc>.
638 When the commands result in an error the
639 command line is still executed.
Bram Moolenaarfafcf0d2017-10-19 18:35:51 +0200640 <afile> is set to a single character,
641 indicating the type of command-line.
642 |cmdwin-char|
Girish Palya92f68e22025-04-21 11:12:41 +0200643 *CmdlineLeavePre*
644CmdlineLeavePre Just before leaving the command line, and
645 before |CmdlineLeave|. Useful for capturing
646 completion info with |cmdcomplete_info()|, as
647 this information is cleared before
648 |CmdlineLeave| is triggered. Triggered for
649 non-interactive use of ":" in a mapping, but
650 not when using |<Cmd>|. Also triggered when
651 abandoning the command line by typing CTRL-C
652 or <Esc>. <afile> is set to a single
653 character indicating the command-line type.
654 See |cmdwin-char| for details.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000655 *CmdwinEnter*
656CmdwinEnter After entering the command-line window.
657 Useful for setting options specifically for
Bram Moolenaar96e38a82019-09-09 18:35:33 +0200658 this special type of window.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000659 <afile> is set to a single character,
660 indicating the type of command-line.
661 |cmdwin-char|
662 *CmdwinLeave*
663CmdwinLeave Before leaving the command-line window.
664 Useful to clean up any global setting done
Bram Moolenaar96e38a82019-09-09 18:35:33 +0200665 with CmdwinEnter.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000666 <afile> is set to a single character,
667 indicating the type of command-line.
668 |cmdwin-char|
669 *ColorScheme*
670ColorScheme After loading a color scheme. |:colorscheme|
Bram Moolenaar0daafaa2022-09-04 17:45:43 +0100671 Not triggered if the color scheme is not
672 found.
Bram Moolenaarb95186f2013-11-28 18:53:52 +0100673 The pattern is matched against the
674 colorscheme name. <afile> can be used for the
675 name of the actual file where this option was
676 set, and <amatch> for the new colorscheme
677 name.
678
Bram Moolenaar15142e22018-04-30 22:19:58 +0200679 *ColorSchemePre*
680ColorSchemePre Before loading a color scheme. |:colorscheme|
681 Useful to setup removing things added by a
682 color scheme, before another one is loaded.
Bram Moolenaar589edb32019-09-20 14:38:13 +0200683CompleteChanged *CompleteChanged*
Bram Moolenaard7f246c2019-04-08 18:15:41 +0200684 After each time the Insert mode completion
685 menu changed. Not fired on popup menu hide,
Bram Moolenaar3f169ce2020-01-26 22:43:31 +0100686 use |CompleteDonePre| or |CompleteDone| for
687 that. Never triggered recursively.
Bram Moolenaar754b5602006-02-09 23:53:20 +0000688
Bram Moolenaard7f246c2019-04-08 18:15:41 +0200689 Sets these |v:event| keys:
Bram Moolenaar911ead12019-04-21 00:03:35 +0200690 completed_item See |complete-items|.
Bram Moolenaard7f246c2019-04-08 18:15:41 +0200691 height nr of items visible
692 width screen cells
693 row top screen row
694 col leftmost screen column
695 size total nr of items
696 scrollbar TRUE if visible
697
698 It is not allowed to change the text |textlock|.
Bram Moolenaare9bd5722019-08-17 19:36:06 +0200699
700 The size and position of the popup are also
701 available by calling |pum_getpos()|.
702
Bram Moolenaar3f169ce2020-01-26 22:43:31 +0100703 *CompleteDonePre*
704CompleteDonePre After Insert mode completion is done. Either
705 when something was completed or abandoning
706 completion. |ins-completion|
707 |complete_info()| can be used, the info is
708 cleared after triggering CompleteDonePre.
709 The |v:completed_item| variable contains
710 information about the completed item.
711
Bram Moolenaar30b65812012-07-12 22:01:11 +0200712 *CompleteDone*
713CompleteDone After Insert mode completion is done. Either
714 when something was completed or abandoning
715 completion. |ins-completion|
Bram Moolenaar3f169ce2020-01-26 22:43:31 +0100716 |complete_info()| cannot be used, the info is
717 cleared before triggering CompleteDone. Use
718 CompleteDonePre if you need it.
Bram Moolenaar42a45122015-07-10 17:56:23 +0200719 The |v:completed_item| variable contains
720 information about the completed item.
Bram Moolenaar30b65812012-07-12 22:01:11 +0200721
glepnir1c5a1202024-12-04 20:27:34 +0100722 Sets these |v:event| keys:
723 complete_word The word that was
724 selected, empty if
725 abandoned complete.
726 complete_type |complete_info_mode|
727
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000728 *CursorHold*
729CursorHold When the user doesn't press a key for the time
Bram Moolenaard58a3bf2020-09-28 21:48:16 +0200730 specified with 'updatetime'. Not triggered
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000731 until the user has pressed a key (i.e. doesn't
732 fire every 'updatetime' ms if you leave Vim to
733 make some coffee. :) See |CursorHold-example|
734 for previewing tags.
735 This event is only triggered in Normal mode.
Bram Moolenaard7afed32007-05-06 13:26:41 +0000736 It is not triggered when waiting for a command
737 argument to be typed, or a movement after an
738 operator.
Bram Moolenaare3226be2005-12-18 22:10:00 +0000739 While recording the CursorHold event is not
740 triggered. |q|
Bram Moolenaar3a991dd2014-10-02 01:41:41 +0200741 *<CursorHold>*
742 Internally the autocommand is triggered by the
743 <CursorHold> key. In an expression mapping
744 |getchar()| may see this character.
745
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000746 Note: Interactive commands cannot be used for
747 this event. There is no hit-enter prompt,
748 the screen is updated directly (when needed).
749 Note: In the future there will probably be
750 another option to set the time.
751 Hint: to force an update of the status lines
752 use: >
753 :let &ro = &ro
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100754< {only on Amiga, Unix, Win32 and all GUI
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000755 versions}
Bram Moolenaar754b5602006-02-09 23:53:20 +0000756 *CursorHoldI*
757CursorHoldI Just like CursorHold, but in Insert mode.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +0200758 Not triggered when waiting for another key,
759 e.g. after CTRL-V, and not when in CTRL-X mode
760 |insert_expand|.
Bram Moolenaar754b5602006-02-09 23:53:20 +0000761
762 *CursorMoved*
Bram Moolenaar52b91d82013-06-15 21:39:51 +0200763CursorMoved After the cursor was moved in Normal or Visual
764 mode. Also when the text of the cursor line
765 has been changed, e.g., with "x", "rx" or "p".
Bram Moolenaar46eea442022-03-30 10:51:39 +0100766 Not always triggered when there is typeahead,
767 while executing commands in a script file,
768 when an operator is pending or when moving to
Bram Moolenaar90df4b92021-07-07 20:26:08 +0200769 another window while remaining at the same
770 cursor position.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000771 For an example see |match-parens|.
Bram Moolenaar26967612019-03-17 17:13:16 +0100772 Note: This can not be skipped with
773 `:noautocmd`.
Bram Moolenaarbf884932013-04-05 22:26:15 +0200774 Careful: This is triggered very often, don't
775 do anything that the user does not expect or
776 that is slow.
Shougo Matsushitad0952142024-06-20 22:05:16 +0200777 *CursorMovedC*
778CursorMovedC After the cursor was moved in the command
zeertzjq81456202024-07-07 20:48:25 +0200779 line. Be careful not to mess up the command
780 line, it may cause Vim to lock up.
Shougo Matsushitad0952142024-06-20 22:05:16 +0200781 <afile> is set to a single character,
782 indicating the type of command-line.
783 |cmdwin-char|
Bram Moolenaar754b5602006-02-09 23:53:20 +0000784 *CursorMovedI*
785CursorMovedI After the cursor was moved in Insert mode.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +0200786 Not triggered when the popup menu is visible.
Bram Moolenaar754b5602006-02-09 23:53:20 +0000787 Otherwise the same as CursorMoved.
Bram Moolenaar75ab5902022-04-18 15:36:40 +0100788 *DiffUpdated*
789DiffUpdated After diffs have been updated. Depending on
790 what kind of diff is being used (internal or
791 external) this can be triggered on every
792 change or when doing |:diffupdate|.
793 *DirChangedPre*
794DirChangedPre The working directory is going to be changed,
795 as with |DirChanged|. The pattern is like
796 with |DirChanged|. The new directory can be
797 found in v:event.directory.
798 *DirChanged*
799DirChanged The working directory has changed in response
800 to the |:cd| or |:tcd| or |:lcd| commands, or
801 as a result of the 'autochdir' option.
802 The pattern can be:
803 "window" to trigger on `:lcd`
804 "tabpage" to trigger on `:tcd`
805 "global" to trigger on `:cd`
806 "auto" to trigger on 'autochdir'.
807 "drop" to trigger on editing a file
808 <afile> is set to the new directory name.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000809 *EncodingChanged*
810EncodingChanged Fires off after the 'encoding' option has been
811 changed. Useful to set up fonts, for example.
Bram Moolenaar75ab5902022-04-18 15:36:40 +0100812 *ExitPre*
813ExitPre When using `:quit`, `:wq` in a way it makes
814 Vim exit, or using `:qall`, just after
815 |QuitPre|. Can be used to close any
816 non-essential window. Exiting may still be
817 cancelled if there is a modified buffer that
818 isn't automatically saved, use |VimLeavePre|
819 for really exiting.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000820 *FileAppendCmd*
821FileAppendCmd Before appending to a file. Should do the
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +0000822 appending to the file. Use the '[ and ']
Bram Moolenaar22863042021-10-16 15:23:36 +0100823 marks for the range of lines. |Cmd-event|
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000824 *FileAppendPost*
825FileAppendPost After appending to a file.
826 *FileAppendPre*
827FileAppendPre Before appending to a file. Use the '[ and ']
828 marks for the range of lines.
829 *FileChangedRO*
830FileChangedRO Before making the first change to a read-only
831 file. Can be used to check-out the file from
832 a source control system. Not triggered when
833 the change was caused by an autocommand.
834 This event is triggered when making the first
835 change in a buffer or the first change after
Bram Moolenaar61660ea2006-04-07 21:40:07 +0000836 'readonly' was set, just before the change is
837 applied to the text.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000838 WARNING: If the autocommand moves the cursor
839 the effect of the change is undefined.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000840 *E788*
841 It is not allowed to change to another buffer
842 here. You can reload the buffer but not edit
843 another one.
Bram Moolenaar92dff182014-02-11 19:15:50 +0100844 *E881*
845 If the number of lines changes saving for undo
846 may fail and the change will be aborted.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000847 *FileChangedShell*
848FileChangedShell When Vim notices that the modification time of
849 a file has changed since editing started.
850 Also when the file attributes of the file
Bram Moolenaare968e362014-05-13 20:23:24 +0200851 change or when the size of the file changes.
852 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000853 Mostly triggered after executing a shell
854 command, but also with a |:checktime| command
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200855 or when gvim regains input focus.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856 This autocommand is triggered for each changed
857 file. It is not used when 'autoread' is set
858 and the buffer was not changed. If a
859 FileChangedShell autocommand is present the
860 warning message and prompt is not given.
Bram Moolenaar19a09a12005-03-04 23:39:37 +0000861 The |v:fcs_reason| variable is set to indicate
862 what happened and |v:fcs_choice| can be used
863 to tell Vim what to do next.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000864 NOTE: When this autocommand is executed, the
865 current buffer "%" may be different from the
Bram Moolenaarcd5c8f82017-04-09 20:11:58 +0200866 buffer that was changed, which is in "<afile>".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867 NOTE: The commands must not change the current
868 buffer, jump to another buffer or delete a
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100869 buffer. *E246* *E811*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000870 NOTE: This event never nests, to avoid an
871 endless loop. This means that while executing
872 commands for the FileChangedShell event no
873 other FileChangedShell event will be
874 triggered.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +0000875 *FileChangedShellPost*
876FileChangedShellPost After handling a file that was changed outside
877 of Vim. Can be used to update the statusline.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000878 *FileEncoding*
879FileEncoding Obsolete. It still works and is equivalent
880 to |EncodingChanged|.
881 *FileReadCmd*
882FileReadCmd Before reading a file with a ":read" command.
883 Should do the reading of the file. |Cmd-event|
884 *FileReadPost*
885FileReadPost After reading a file with a ":read" command.
886 Note that Vim sets the '[ and '] marks to the
887 first and last line of the read. This can be
888 used to operate on the lines just read.
889 *FileReadPre*
890FileReadPre Before reading a file with a ":read" command.
891 *FileType*
Bram Moolenaard7afed32007-05-06 13:26:41 +0000892FileType When the 'filetype' option has been set. The
893 pattern is matched against the filetype.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000894 <afile> can be used for the name of the file
895 where this option was set, and <amatch> for
Bram Moolenaar74675a62017-07-15 13:53:23 +0200896 the new value of 'filetype'. Navigating to
897 another window or buffer is not allowed.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000898 See |filetypes|.
899 *FileWriteCmd*
900FileWriteCmd Before writing to a file, when not writing the
901 whole buffer. Should do the writing to the
902 file. Should not change the buffer. Use the
Christian Brabandtdf684192025-04-03 12:33:02 +0200903 |'[| and |']| marks for the range of lines.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000904 |Cmd-event|
905 *FileWritePost*
906FileWritePost After writing to a file, when not writing the
907 whole buffer.
908 *FileWritePre*
909FileWritePre Before writing to a file, when not writing the
Christian Brabandtdf684192025-04-03 12:33:02 +0200910 whole buffer. Use the |'[| and |']| marks for the
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000911 range of lines.
912 *FilterReadPost*
913FilterReadPost After reading a file from a filter command.
914 Vim checks the pattern against the name of
915 the current buffer as with FilterReadPre.
916 Not triggered when 'shelltemp' is off.
917 *FilterReadPre* *E135*
918FilterReadPre Before reading a file from a filter command.
919 Vim checks the pattern against the name of
920 the current buffer, not the name of the
921 temporary file that is the output of the
922 filter command.
923 Not triggered when 'shelltemp' is off.
924 *FilterWritePost*
925FilterWritePost After writing a file for a filter command or
Bram Moolenaar4c05fa02019-01-01 15:32:17 +0100926 making a diff with an external diff (see
Bram Moolenaar22863042021-10-16 15:23:36 +0100927 |DiffUpdated| for internal diff).
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000928 Vim checks the pattern against the name of
929 the current buffer as with FilterWritePre.
930 Not triggered when 'shelltemp' is off.
931 *FilterWritePre*
932FilterWritePre Before writing a file for a filter command or
Bram Moolenaar4c05fa02019-01-01 15:32:17 +0100933 making a diff with an external diff.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000934 Vim checks the pattern against the name of
935 the current buffer, not the name of the
936 temporary file that is the output of the
937 filter command.
938 Not triggered when 'shelltemp' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000939 *FocusGained*
940FocusGained When Vim got input focus. Only for the GUI
941 version and a few console versions where this
Christian Brabandt49ddeef2024-07-07 20:29:43 +0200942 can be detected. |xterm-focus-event|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000943 *FocusLost*
944FocusLost When Vim lost input focus. Only for the GUI
945 version and a few console versions where this
Christian Brabandt49ddeef2024-07-07 20:29:43 +0200946 can be detected. |xterm-focus-event|
947 May also happen when a dialog pops up.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000948 *FuncUndefined*
949FuncUndefined When a user function is used but it isn't
950 defined. Useful for defining a function only
Bram Moolenaard7afed32007-05-06 13:26:41 +0000951 when it's used. The pattern is matched
952 against the function name. Both <amatch> and
953 <afile> are set to the name of the function.
zeertzjqaf056942025-03-08 16:45:20 +0100954 This is triggered even when inside an
955 autocommand defined without |autocmd-nested|,
956 but not triggered when compiling a |Vim9|
Bram Moolenaar4072ba52020-12-23 13:56:35 +0100957 function.
Bram Moolenaard5005162014-08-22 23:05:54 +0200958 NOTE: When writing Vim scripts a better
959 alternative is to use an autoloaded function.
Bram Moolenaar7c626922005-02-07 22:01:03 +0000960 See |autoload-functions|.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000961 *GUIEnter*
962GUIEnter After starting the GUI successfully, and after
963 opening the window. It is triggered before
964 VimEnter when using gvim. Can be used to
965 position the window from a .gvimrc file: >
966 :autocmd GUIEnter * winpos 100 50
Bram Moolenaard7afed32007-05-06 13:26:41 +0000967< *GUIFailed*
968GUIFailed After starting the GUI failed. Vim may
969 continue to run in the terminal, if possible
970 (only on Unix and alikes, when connecting the
971 X server fails). You may want to quit Vim: >
972 :autocmd GUIFailed * qall
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000973< *InsertChange*
974InsertChange When typing <Insert> while in Insert or
975 Replace mode. The |v:insertmode| variable
976 indicates the new mode.
977 Be careful not to move the cursor or do
978 anything else that the user does not expect.
Bram Moolenaare659c952011-05-19 17:25:41 +0200979 *InsertCharPre*
980InsertCharPre When a character is typed in Insert mode,
981 before inserting the char.
982 The |v:char| variable indicates the char typed
983 and can be changed during the event to insert
984 a different character. When |v:char| is set
985 to more than one character this text is
986 inserted literally.
987 It is not allowed to change the text |textlock|.
988 The event is not triggered when 'paste' is
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100989 set. {only with the +eval feature}
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000990 *InsertEnter*
Bram Moolenaard7afed32007-05-06 13:26:41 +0000991InsertEnter Just before starting Insert mode. Also for
992 Replace mode and Virtual Replace mode. The
Bram Moolenaar4e330bb2005-12-07 21:04:31 +0000993 |v:insertmode| variable indicates the mode.
Bram Moolenaar097c9922013-05-19 21:15:15 +0200994 Be careful not to do anything else that the
995 user does not expect.
996 The cursor is restored afterwards. If you do
997 not want that set |v:char| to a non-empty
998 string.
Bram Moolenaarb53e13a2020-10-21 12:19:53 +0200999 *InsertLeavePre*
1000InsertLeavePre Just before leaving Insert mode. Also when
Bram Moolenaarcb80aa22020-10-26 21:12:46 +01001001 using CTRL-O |i_CTRL-O|. Be careful not to
Bram Moolenaarb53e13a2020-10-21 12:19:53 +02001002 change mode or use `:normal`, it will likely
1003 cause trouble.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +00001004 *InsertLeave*
Bram Moolenaarb53e13a2020-10-21 12:19:53 +02001005InsertLeave Just after leaving Insert mode. Also when
1006 using CTRL-O |i_CTRL-O|. But not for |i_CTRL-C|.
Shougo Matsushita83678842024-07-11 22:05:12 +02001007 *KeyInputPre*
Shougo Matsushitafcc1b572024-07-17 20:25:22 +02001008KeyInputPre Just before a key is processed after mappings
1009 have been applied. The pattern is matched
1010 against a string that indicates the current
1011 mode, which is the same as what is returned by
1012 `mode(1)`.
Shougo Matsushita83678842024-07-11 22:05:12 +02001013 The |v:char| variable indicates the key typed
1014 and can be changed during the event to process
1015 a different key. When |v:char| is not a
1016 single character or a special key, the first
1017 character is used.
1018 The following values of |v:event| are set:
1019 typed The key is typed or not.
Shougo Matsushita890f97c2024-08-18 16:57:04 +02001020 typedchar The (actual) typed key since
1021 the last |KeyInputPre| call.
1022 Note: "typedchar" may be empty if successive
1023 |KeyInputPre| autocmds are processed.
Shougo Matsushita83678842024-07-11 22:05:12 +02001024 It is not allowed to change the text
1025 |textlock| or the current mode.
1026 {only with the +eval feature}
Bram Moolenaar4e330bb2005-12-07 21:04:31 +00001027 *MenuPopup*
1028MenuPopup Just before showing the popup menu (under the
1029 right mouse button). Useful for adjusting the
1030 menu for what is under the cursor or mouse
1031 pointer.
Bram Moolenaar4c5d8152018-10-19 22:36:53 +02001032 The pattern is matched against one or two
1033 characters representing the mode:
Bram Moolenaar4e330bb2005-12-07 21:04:31 +00001034 n Normal
1035 v Visual
1036 o Operator-pending
1037 i Insert
Bram Moolenaar551dbcc2006-04-25 22:13:59 +00001038 c Command line
Bram Moolenaar4c5d8152018-10-19 22:36:53 +02001039 tl Terminal
=?UTF-8?q?Magnus=20Gro=C3=9F?=f1e88762021-09-12 13:39:55 +02001040 *ModeChanged*
1041ModeChanged After changing the mode. The pattern is
1042 matched against `'old_mode:new_mode'`, for
=?UTF-8?q?Magnus=20Gro=C3=9F?=25def2c2021-10-22 18:56:39 +01001043 example match against `*:c*` to simulate
1044 |CmdlineEnter|.
=?UTF-8?q?Magnus=20Gro=C3=9F?=f1e88762021-09-12 13:39:55 +02001045 The following values of |v:event| are set:
1046 old_mode The mode before it changed.
1047 new_mode The new mode as also returned
=?UTF-8?q?Magnus=20Gro=C3=9F?=25def2c2021-10-22 18:56:39 +01001048 by |mode()| called with a
1049 non-zero argument.
=?UTF-8?q?Magnus=20Gro=C3=9F?=f1e88762021-09-12 13:39:55 +02001050 When ModeChanged is triggered, old_mode will
1051 have the value of new_mode when the event was
1052 last triggered.
=?UTF-8?q?Magnus=20Gro=C3=9F?=25def2c2021-10-22 18:56:39 +01001053 This will be triggered on every minor mode
1054 change.
=?UTF-8?q?Magnus=20Gro=C3=9F?=f1e88762021-09-12 13:39:55 +02001055 Usage example to use relative line numbers
Bram Moolenaar6e649222021-10-04 21:32:54 +01001056 when entering Visual mode: >
=?UTF-8?q?Magnus=20Gro=C3=9F?=25def2c2021-10-22 18:56:39 +01001057 :au ModeChanged [vV\x16]*:* let &l:rnu = mode() =~# '^[vV\x16]'
1058 :au ModeChanged *:[vV\x16]* let &l:rnu = mode() =~# '^[vV\x16]'
1059 :au WinEnter,WinLeave * let &l:rnu = mode() =~# '^[vV\x16]'
=?UTF-8?q?Magnus=20Gro=C3=9F?=f1e88762021-09-12 13:39:55 +02001060< *OptionSet*
Bram Moolenaar53744302015-07-17 17:38:22 +02001061OptionSet After setting an option. The pattern is
1062 matched against the long option name.
Bram Moolenaard7c96872019-06-15 17:12:48 +02001063 |<amatch>| indicates what option has been set.
Bram Moolenaar53744302015-07-17 17:38:22 +02001064
Bram Moolenaard7c96872019-06-15 17:12:48 +02001065 |v:option_type| indicates whether it's global
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02001066 or local scoped.
Bram Moolenaard7c96872019-06-15 17:12:48 +02001067 |v:option_command| indicates what type of
1068 set/let command was used (follow the tag to
1069 see the table).
1070 |v:option_new| indicates the newly set value.
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02001071 |v:option_oldlocal| has the old local value.
1072 |v:option_oldglobal| has the old global value.
Bram Moolenaard7c96872019-06-15 17:12:48 +02001073 |v:option_old| indicates the old option value.
1074
1075 |v:option_oldlocal| is only set when |:set|
1076 or |:setlocal| or a |modeline| was used to set
1077 the option. Similarly |v:option_oldglobal| is
1078 only set when |:set| or |:setglobal| was used.
1079
Bram Moolenaar10e8ff92023-06-10 21:40:39 +01001080 This does not set |<abuf>|, you could use
1081 |bufnr()|.
1082
Bram Moolenaard7c96872019-06-15 17:12:48 +02001083 Note that when setting a |global-local| string
1084 option with |:set|, then |v:option_old| is the
1085 old global value. However, for all other kinds
1086 of options (local string options, global-local
1087 number options, ...) it is the old local
1088 value.
1089
1090 OptionSet is not triggered on startup and for
1091 the 'key' option for obvious reasons.
Bram Moolenaar53744302015-07-17 17:38:22 +02001092
Bram Moolenaarf9132812015-07-21 19:19:13 +02001093 Usage example: Check for the existence of the
1094 directory in the 'backupdir' and 'undodir'
1095 options, create the directory if it doesn't
1096 exist yet.
1097
1098 Note: It's a bad idea to reset an option
1099 during this autocommand, this may break a
1100 plugin. You can always use `:noa` to prevent
1101 triggering this autocommand.
Bram Moolenaar53744302015-07-17 17:38:22 +02001102
Bram Moolenaar95bafa22018-10-02 13:26:25 +02001103 When using |:set| in the autocommand the event
1104 is not triggered again.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +00001105 *QuickFixCmdPre*
1106QuickFixCmdPre Before a quickfix command is run (|:make|,
Bram Moolenaara6557602006-02-04 22:43:20 +00001107 |:lmake|, |:grep|, |:lgrep|, |:grepadd|,
1108 |:lgrepadd|, |:vimgrep|, |:lvimgrep|,
Bram Moolenaar6be7f872012-01-20 21:08:56 +01001109 |:vimgrepadd|, |:lvimgrepadd|, |:cscope|,
Bram Moolenaar84f72352012-03-11 15:57:40 +01001110 |:cfile|, |:cgetfile|, |:caddfile|, |:lfile|,
1111 |:lgetfile|, |:laddfile|, |:helpgrep|,
Bram Moolenaar64d8e252016-09-06 22:12:34 +02001112 |:lhelpgrep|, |:cexpr|, |:cgetexpr|,
1113 |:caddexpr|, |:cbuffer|, |:cgetbuffer|,
1114 |:caddbuffer|).
Bram Moolenaarf1eeae92010-05-14 23:14:42 +02001115 The pattern is matched against the command
1116 being run. When |:grep| is used but 'grepprg'
1117 is set to "internal" it still matches "grep".
Bram Moolenaar4e330bb2005-12-07 21:04:31 +00001118 This command cannot be used to set the
1119 'makeprg' and 'grepprg' variables.
1120 If this command causes an error, the quickfix
1121 command is not executed.
1122 *QuickFixCmdPost*
1123QuickFixCmdPost Like QuickFixCmdPre, but after a quickfix
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00001124 command is run, before jumping to the first
Bram Moolenaar8ec1f852012-03-07 20:13:49 +01001125 location. For |:cfile| and |:lfile| commands
Bram Moolenaarb59ae592022-11-23 23:46:31 +00001126 it is run after the error file is read and
1127 before moving to the first error.
Bram Moolenaar8ec1f852012-03-07 20:13:49 +01001128 See |QuickFixCmdPost-example|.
Bram Moolenaar30b65812012-07-12 22:01:11 +02001129 *QuitPre*
Bram Moolenaarac7bd632013-03-19 11:35:58 +01001130QuitPre When using `:quit`, `:wq` or `:qall`, before
1131 deciding whether it closes the current window
Bram Moolenaard2ea7cf2021-05-30 20:54:13 +02001132 or quits Vim. For `:wq` the buffer is written
1133 before QuitPre is triggered. Can be used to
1134 close any non-essential window if the current
1135 window is the last ordinary window.
Bram Moolenaar12a96de2018-03-11 14:44:18 +01001136 Also see |ExitPre|.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +00001137 *RemoteReply*
1138RemoteReply When a reply from a Vim that functions as
Bram Moolenaard7afed32007-05-06 13:26:41 +00001139 server was received |server2client()|. The
1140 pattern is matched against the {serverid}.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +00001141 <amatch> is equal to the {serverid} from which
1142 the reply was sent, and <afile> is the actual
1143 reply string.
1144 Note that even if an autocommand is defined,
1145 the reply should be read with |remote_read()|
1146 to consume it.
Bram Moolenaar8aeec402019-09-15 23:02:04 +02001147 *SafeState*
1148SafeState When nothing is pending, going to wait for the
1149 user to type a character.
1150 This will not be triggered when:
1151 - an operator is pending
1152 - a register was entered with "r
1153 - halfway executing a command
1154 - executing a mapping
1155 - there is typeahead
1156 - Insert mode completion is active
1157 - Command line completion is active
1158 You can use `mode()` to find out what state
1159 Vim is in. That may be:
zeertzjqe13b6652024-01-24 03:39:04 +08001160 - Visual mode
Bram Moolenaar8aeec402019-09-15 23:02:04 +02001161 - Normal mode
1162 - Insert mode
1163 - Command-line mode
1164 Depending on what you want to do, you may also
1165 check more with `state()`, e.g. whether the
1166 screen was scrolled for messages.
Bram Moolenaar69198cb2019-09-16 21:58:13 +02001167 *SafeStateAgain*
1168SafeStateAgain Like SafeState but after processing any
1169 messages and invoking callbacks. This may be
1170 triggered often, don't do something that takes
1171 time.
Bram Moolenaar8aeec402019-09-15 23:02:04 +02001172
Bram Moolenaar4e330bb2005-12-07 21:04:31 +00001173 *SessionLoadPost*
1174SessionLoadPost After loading the session file created using
1175 the |:mksession| command.
Colin Kennedye5f22802024-03-26 18:20:16 +01001176 *SessionWritePost*
1177SessionWritePost After writing a session file by calling
1178 the |:mksession| command.
Bram Moolenaara94bc432006-03-10 21:42:59 +00001179 *ShellCmdPost*
1180ShellCmdPost After executing a shell command with |:!cmd|,
1181 |:shell|, |:make| and |:grep|. Can be used to
1182 check for any changed files.
1183 *ShellFilterPost*
1184ShellFilterPost After executing a shell command with
1185 ":{range}!cmd", ":w !cmd" or ":r !cmd".
1186 Can be used to check for any changed files.
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00001187 *SourcePre*
1188SourcePre Before sourcing a Vim script. |:source|
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00001189 <afile> is the name of the file being sourced.
Bram Moolenaar2b618522019-01-12 13:26:03 +01001190 *SourcePost*
1191SourcePost After sourcing a Vim script. |:source|
1192 <afile> is the name of the file being sourced.
1193 Not triggered when sourcing was interrupted.
1194 Also triggered after a SourceCmd autocommand
1195 was triggered.
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00001196 *SourceCmd*
1197SourceCmd When sourcing a Vim script. |:source|
1198 <afile> is the name of the file being sourced.
1199 The autocommand must source this file.
1200 |Cmd-event|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001201 *SpellFileMissing*
1202SpellFileMissing When trying to load a spell checking file and
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00001203 it can't be found. The pattern is matched
1204 against the language. <amatch> is the
1205 language, 'encoding' also matters. See
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00001206 |spell-SpellFileMissing|.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +00001207 *StdinReadPost*
1208StdinReadPost After reading from the stdin into the buffer,
1209 before executing the modelines. Only used
1210 when the "-" argument was used when Vim was
1211 started |--|.
1212 *StdinReadPre*
1213StdinReadPre Before reading from stdin into the buffer.
1214 Only used when the "-" argument was used when
1215 Vim was started |--|.
1216 *SwapExists*
1217SwapExists Detected an existing swap file when starting
1218 to edit a file. Only when it is possible to
1219 select a way to handle the situation, when Vim
1220 would ask the user what to do.
1221 The |v:swapname| variable holds the name of
Bram Moolenaarb3480382005-12-11 21:33:32 +00001222 the swap file found, <afile> the file being
1223 edited. |v:swapcommand| may contain a command
1224 to be executed in the opened file.
1225 The commands should set the |v:swapchoice|
1226 variable to a string with one character to
1227 tell Vim what should be done next:
Bram Moolenaar4e330bb2005-12-07 21:04:31 +00001228 'o' open read-only
1229 'e' edit the file anyway
1230 'r' recover
1231 'd' delete the swap file
1232 'q' quit, don't edit the file
1233 'a' abort, like hitting CTRL-C
1234 When set to an empty string the user will be
1235 asked, as if there was no SwapExists autocmd.
Bram Moolenaarb849e712009-06-24 15:51:37 +00001236 *E812*
1237 It is not allowed to change to another buffer,
1238 change a buffer name or change directory
1239 here.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001240 {only available with the +eval feature}
Bram Moolenaar4e330bb2005-12-07 21:04:31 +00001241 *Syntax*
Bram Moolenaard7afed32007-05-06 13:26:41 +00001242Syntax When the 'syntax' option has been set. The
1243 pattern is matched against the syntax name.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +00001244 <afile> can be used for the name of the file
1245 where this option was set, and <amatch> for
1246 the new value of 'syntax'.
1247 See |:syn-on|.
Bram Moolenaar12c11d52016-07-19 23:13:03 +02001248 *TabClosed*
1249TabClosed After closing a tab page.
Jim Zhou5606ca52025-03-13 21:58:25 +01001250 *TabClosedPre*
1251TabClosedPre Before closing a tab page. The window layout
1252 is locked, thus opening and closing of windows
1253 is prohibited.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00001254 *TabEnter*
1255TabEnter Just after entering a tab page. |tab-page|
Bram Moolenaar56a907a2006-05-06 21:44:30 +00001256 After triggering the WinEnter and before
1257 triggering the BufEnter event.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00001258 *TabLeave*
1259TabLeave Just before leaving a tab page. |tab-page|
1260 A WinLeave event will have been triggered
1261 first.
Bram Moolenaarc917da42016-07-19 22:31:36 +02001262 *TabNew*
1263TabNew When a tab page was created. |tab-page|
1264 A WinEnter event will have been triggered
1265 first, TabEnter follows.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +00001266 *TermChanged*
1267TermChanged After the value of 'term' has changed. Useful
1268 for re-loading the syntax file to update the
1269 colors, fonts and other terminal-dependent
1270 settings. Executed for all loaded buffers.
Bram Moolenaarb852c3e2018-03-11 16:55:36 +01001271 *TerminalOpen*
1272TerminalOpen Just after a terminal buffer was created, with
1273 `:terminal` or |term_start()|. This event is
1274 triggered even if the buffer is created
1275 without a window, with the ++hidden option.
Bram Moolenaar28ed4df2019-10-26 16:21:40 +02001276 *TerminalWinOpen*
1277TerminalWinOpen Just after a terminal buffer was created, with
1278 `:terminal` or |term_start()|. This event is
1279 triggered only if the buffer is created
1280 with a window. Can be used to set window
1281 local options for the terminal window.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +00001282 *TermResponse*
1283TermResponse After the response to |t_RV| is received from
1284 the terminal. The value of |v:termresponse|
1285 can be used to do things depending on the
Christian Brabandt2abec432024-10-27 21:33:09 +01001286 terminal version.
1287 This is used in |defaults.vim| to detect
1288 putty terminal and set a dark background: >
1289
1290 au TermResponse *
1291 \ if v:termresponse == "\e[>0;136;0c"
1292 \ set bg=dark
1293 \ endif
1294<
1295 Note: that this event may be triggered halfway
1296 executing another event, especially if file
1297 I/O, a shell command or anything else that
1298 takes time is involved.
Danek Duvalld7d56032024-01-14 20:19:59 +01001299 *TermResponseAll*
1300TermResponseAll After the response to |t_RV|, |t_RC|, |t_RS|,
1301 |t_RB|, |t_RF|, or |t_u7| are received from
1302 the terminal. The value of |v:termresponse|,
1303 |v:termblinkresp|, |v:termstyleresp|,
1304 |v:termrbgresp|, |v:termrfgresp|, and
1305 |v:termu7resp|, correspondingly, can be used.
1306 <amatch> will be set to any of:
1307 "version",
1308 "cursorblink",
1309 "cursorshape",
1310 "background",
1311 "foreground",
1312 "ambiguouswidth"
1313 Note that this event may be triggered halfway
1314 executing another event, especially if file I/O,
1315 a shell command or anything else that takes time
1316 is involved.
Bram Moolenaarbf884932013-04-05 22:26:15 +02001317 *TextChanged*
1318TextChanged After a change was made to the text in the
Bram Moolenaard09091d2019-01-17 16:07:22 +01001319 current buffer in Normal mode. That is after
1320 |b:changedtick| has changed (also when that
1321 happened before the TextChanged autocommand
1322 was defined).
Bram Moolenaarbf884932013-04-05 22:26:15 +02001323 Not triggered when there is typeahead or when
1324 an operator is pending.
Bram Moolenaar26967612019-03-17 17:13:16 +01001325 Note: This can not be skipped with
1326 `:noautocmd`.
Bram Moolenaarbf884932013-04-05 22:26:15 +02001327 Careful: This is triggered very often, don't
1328 do anything that the user does not expect or
1329 that is slow.
1330 *TextChangedI*
1331TextChangedI After a change was made to the text in the
1332 current buffer in Insert mode.
1333 Not triggered when the popup menu is visible.
1334 Otherwise the same as TextChanged.
Bram Moolenaar5a093432018-02-10 18:15:19 +01001335 *TextChangedP*
1336TextChangedP After a change was made to the text in the
1337 current buffer in Insert mode, only when the
1338 popup menu is visible. Otherwise the same as
1339 TextChanged.
Shougo Matsushita4ccaedf2022-10-15 11:48:00 +01001340 *TextChangedT*
1341TextChangedT After a change was made to the text in the
1342 current buffer in Terminal mode.
1343 Otherwise the same as TextChanged.
Bram Moolenaarf0b03c42017-12-17 17:17:07 +01001344 *TextYankPost*
Bram Moolenaar7e1652c2017-12-16 18:27:02 +01001345TextYankPost After text has been yanked or deleted in the
1346 current buffer. The following values of
1347 |v:event| can be used to determine the operation
1348 that triggered this autocmd:
Bram Moolenaara016eeb2022-04-09 11:37:38 +01001349 inclusive TRUE if the motion is
1350 |inclusive| else the motion is
1351 |exclusive|.
Bram Moolenaar589edb32019-09-20 14:38:13 +02001352 operator The operation performed.
1353 regcontents Text that was stored in the
Bram Moolenaar7e1652c2017-12-16 18:27:02 +01001354 register, as a list of lines,
1355 like with: >
1356 getreg(r, 1, 1)
Bram Moolenaar22863042021-10-16 15:23:36 +01001357< regname Name of the register or empty
1358 string for the unnamed
1359 register, see |registers|.
Bram Moolenaar7e1652c2017-12-16 18:27:02 +01001360 regtype Type of the register, see
1361 |getregtype()|.
Bram Moolenaar37d16732020-06-12 22:09:01 +02001362 visual True if the operation is
1363 performed on a |Visual| area.
Bram Moolenaar7e1652c2017-12-16 18:27:02 +01001364 Not triggered when |quote_| is used nor when
1365 called recursively.
1366 It is not allowed to change the buffer text,
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00001367 see |textlock|. *E1064*
Jim Zhou7db96132025-03-12 20:57:24 +01001368 Also triggered indirectly when Vim tries to
1369 become owner of the Visual selection because
1370 of setting "autoselect" for 'guioptions' or
1371 'clipboard'.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001372 {only when compiled with the +eval feature}
Bram Moolenaarbe5ee862020-06-10 20:56:58 +02001373
Bram Moolenaar4e330bb2005-12-07 21:04:31 +00001374 *User*
1375User Never executed automatically. To be used for
1376 autocommands that are only executed with
1377 ":doautocmd".
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02001378 Note that when `:doautocmd User MyEvent` is
1379 used while there are no matching autocommands,
1380 you will get an error. If you don't want
LemonBoy09371822022-04-08 15:18:45 +01001381 that, either check whether an autocommand is
1382 defined using `exists('#User#MyEvent')` or
1383 define a dummy autocommand yourself.
1384 Example: >
1385 if exists('#User#MyEvent')
1386 doautocmd User MyEvent
1387 endif
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01001388<
Bram Moolenaarbe5ee862020-06-10 20:56:58 +02001389 *SigUSR1*
1390SigUSR1 After the SIGUSR1 signal has been detected.
1391 Could be used if other ways of notifying Vim
1392 are not feasible. E.g. to check for the
1393 result of a build that takes a long time, or
1394 when a motion sensor is triggered.
1395 {only on Unix}
1396
Bram Moolenaar4e330bb2005-12-07 21:04:31 +00001397 *UserGettingBored*
Bram Moolenaarbf884932013-04-05 22:26:15 +02001398UserGettingBored When the user presses the same key 42 times.
1399 Just kidding! :-)
Bram Moolenaar4e330bb2005-12-07 21:04:31 +00001400 *VimEnter*
1401VimEnter After doing all the startup stuff, including
1402 loading .vimrc files, executing the "-c cmd"
1403 arguments, creating all windows and loading
1404 the buffers in them.
Bram Moolenaar14735512016-03-26 21:00:08 +01001405 Just before this event is triggered the
1406 |v:vim_did_enter| variable is set, so that you
1407 can do: >
1408 if v:vim_did_enter
1409 call s:init()
1410 else
Bram Moolenaar589edb32019-09-20 14:38:13 +02001411 au VimEnter * call s:init()
Bram Moolenaar14735512016-03-26 21:00:08 +01001412 endif
1413< *VimLeave*
Bram Moolenaar4e330bb2005-12-07 21:04:31 +00001414VimLeave Before exiting Vim, just after writing the
1415 .viminfo file. Executed only once, like
1416 VimLeavePre.
1417 To detect an abnormal exit use |v:dying|.
Bram Moolenaar0e1e25f2010-05-28 21:07:08 +02001418 When v:dying is 2 or more this event is not
1419 triggered.
Bram Moolenaarf0068c52020-11-30 17:42:10 +01001420 To get the exit code use |v:exiting|.
Bram Moolenaar4e330bb2005-12-07 21:04:31 +00001421 *VimLeavePre*
1422VimLeavePre Before exiting Vim, just before writing the
1423 .viminfo file. This is executed only once,
1424 if there is a match with the name of what
1425 happens to be the current buffer when exiting.
1426 Mostly useful with a "*" pattern. >
1427 :autocmd VimLeavePre * call CleanupStuff()
1428< To detect an abnormal exit use |v:dying|.
Bram Moolenaar0e1e25f2010-05-28 21:07:08 +02001429 When v:dying is 2 or more this event is not
1430 triggered.
Bram Moolenaarf0068c52020-11-30 17:42:10 +01001431 To get the exit code use |v:exiting|.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001432 *VimResized*
1433VimResized After the Vim window was resized, thus 'lines'
1434 and/or 'columns' changed. Not when starting
1435 up though.
Bram Moolenaar100118c2020-12-11 19:30:34 +01001436 *VimResume*
1437VimResume When the Vim instance is resumed after being
1438 suspended and |VimSuspend| was triggered.
1439 Useful for triggering |:checktime| and ensure
1440 the buffers content did not change while Vim
1441 was suspended: >
1442 :autocmd VimResume * checktime
1443< *VimSuspend*
1444VimSuspend When the Vim instance is suspended. Only when
dbivolaruab16ad32021-12-29 19:41:47 +00001445 CTRL-Z was typed inside Vim, or when the SIGTSTP
1446 signal was sent to Vim, but not for SIGSTOP.
naohiro ono23beefe2021-11-13 12:38:49 +00001447 *WinClosed*
Bram Moolenaarb59ae592022-11-23 23:46:31 +00001448WinClosed When closing a window, just before it is
1449 removed from the window layout. The pattern
1450 is matched against the |window-ID|. Both
naohiro ono23beefe2021-11-13 12:38:49 +00001451 <amatch> and <afile> are set to the
1452 |window-ID|. Non-recursive (event cannot
1453 trigger itself).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001454 *WinEnter*
1455WinEnter After entering another window. Not done for
1456 the first window, when Vim has just started.
1457 Useful for setting the window height.
1458 If the window is for another buffer, Vim
1459 executes the BufEnter autocommands after the
1460 WinEnter autocommands.
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02001461 Note: For split and tabpage commands the
1462 WinEnter event is triggered after the split
1463 or tab command but before the file is loaded.
1464
Bram Moolenaar071d4272004-06-13 20:20:40 +00001465 *WinLeave*
1466WinLeave Before leaving a window. If the window to be
1467 entered next is for a different buffer, Vim
1468 executes the BufLeave autocommands before the
1469 WinLeave autocommands (but not for ":new").
1470 Not used for ":qa" or ":q" when exiting Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001471
Sergey Vlasov1f47db72024-01-25 23:07:00 +01001472 *WinNewPre*
1473WinNewPre Before creating a new window. Triggered
1474 before commands that modify window layout by
Christian Brabandtfb3f9692024-08-11 20:09:17 +02001475 creating a split.
h-east90e1fe42024-08-12 18:26:08 +02001476 Not done when creating tab pages and for the
1477 first window, as the window structure is not
Christian Brabandtfb3f9692024-08-11 20:09:17 +02001478 initialized yet and so is generally not safe.
Sergey Vlasov1f47db72024-01-25 23:07:00 +01001479 It is not allowed to modify window layout
1480 while executing commands for the WinNewPre
1481 event.
1482 Most useful to store current window layout
1483 and compare it with the new layout after the
1484 Window has been created.
1485
Bram Moolenaar12c11d52016-07-19 23:13:03 +02001486 *WinNew*
1487WinNew When a new window was created. Not done for
Bram Moolenaar50ba5262016-09-22 22:33:02 +02001488 the first window, when Vim has just started.
Bram Moolenaar12c11d52016-07-19 23:13:03 +02001489 Before a WinEnter event.
1490
LemonBoy09371822022-04-08 15:18:45 +01001491 *WinScrolled*
Bram Moolenaar35fc61c2022-11-22 12:40:50 +00001492WinScrolled After any window in the current tab page
1493 scrolled the text (horizontally or vertically)
1494 or changed width or height. See
1495 |win-scrolled-resized|.
Bram Moolenaar0a60f792022-11-19 21:18:11 +00001496
Christian Brabandtb8d5c852025-04-04 19:11:13 +02001497 Note: This can not be skipped with
1498 `:noautocmd`, because it triggers after
1499 processing normal commands when Vim is back in
1500 the main loop. If you want to disable this,
1501 consider setting the 'eventignore' option
1502 instead.
1503
Bram Moolenaar0a60f792022-11-19 21:18:11 +00001504 The pattern is matched against the |window-ID|
1505 of the first window that scrolled or resized.
1506 Both <amatch> and <afile> are set to the
1507 |window-ID|.
1508
Bram Moolenaar35fc61c2022-11-22 12:40:50 +00001509 |v:event| is set with information about size
1510 and scroll changes. |WinScrolled-event|
1511
Bram Moolenaar0a60f792022-11-19 21:18:11 +00001512 Only starts triggering after startup finished
1513 and the first screen redraw was done.
Bram Moolenaar35fc61c2022-11-22 12:40:50 +00001514 Does not trigger when defining the first
1515 WinScrolled or WinResized event, but may
1516 trigger when adding more.
Bram Moolenaar0a60f792022-11-19 21:18:11 +00001517
1518 Non-recursive: the event will not trigger
1519 while executing commands for the WinScrolled
1520 event. However, if the command causes a
1521 window to scroll or change size, then another
LemonBoy09371822022-04-08 15:18:45 +01001522 WinScrolled event will be triggered later.
Bram Moolenaar0a60f792022-11-19 21:18:11 +00001523
Bram Moolenaar35fc61c2022-11-22 12:40:50 +00001524
1525 *WinResized*
1526WinResized After a window in the current tab page changed
1527 width or height.
1528 See |win-scrolled-resized|.
1529
1530 |v:event| is set with information about size
1531 changes. |WinResized-event|
1532
1533 Same behavior as |WinScrolled| for the
1534 pattern, triggering and recursiveness.
LemonBoy09371822022-04-08 15:18:45 +01001535
Bram Moolenaar071d4272004-06-13 20:20:40 +00001536==============================================================================
Bram Moolenaarfd31be22022-01-16 14:46:06 +000015376. Patterns *autocmd-patterns* *{aupat}*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001538
LemonBoy09371822022-04-08 15:18:45 +01001539The {aupat} argument of `:autocmd` can be a comma-separated list. This works as
Bram Moolenaarfd31be22022-01-16 14:46:06 +00001540if the command was given with each pattern separately. Thus this command: >
Bram Moolenaar5a5f4592015-04-13 12:43:06 +02001541 :autocmd BufRead *.txt,*.info set et
1542Is equivalent to: >
1543 :autocmd BufRead *.txt set et
1544 :autocmd BufRead *.info set et
1545
Bram Moolenaarfd31be22022-01-16 14:46:06 +00001546The file pattern {aupat} is tested for a match against the file name in one of
Bram Moolenaar071d4272004-06-13 20:20:40 +00001547two ways:
15481. When there is no '/' in the pattern, Vim checks for a match against only
1549 the tail part of the file name (without its leading directory path).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +010015502. When there is a '/' in the pattern, Vim checks for a match against both the
1551 short file name (as you typed it) and the full file name (after expanding
1552 it to a full path and resolving symbolic links).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001553
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00001554The special pattern <buffer> or <buffer=N> is used for buffer-local
1555autocommands |autocmd-buflocal|. This pattern is not matched against the name
1556of a buffer.
1557
Bram Moolenaar071d4272004-06-13 20:20:40 +00001558Examples: >
1559 :autocmd BufRead *.txt set et
1560Set the 'et' option for all text files. >
1561
1562 :autocmd BufRead /vim/src/*.c set cindent
1563Set the 'cindent' option for C files in the /vim/src directory. >
1564
1565 :autocmd BufRead /tmp/*.c set ts=5
1566If you have a link from "/tmp/test.c" to "/home/nobody/vim/src/test.c", and
1567you start editing "/tmp/test.c", this autocommand will match.
1568
1569Note: To match part of a path, but not from the root directory, use a '*' as
1570the first character. Example: >
1571 :autocmd BufRead */doc/*.txt set tw=78
1572This autocommand will for example be executed for "/tmp/doc/xx.txt" and
1573"/usr/home/piet/doc/yy.txt". The number of directories does not matter here.
1574
1575
1576The file name that the pattern is matched against is after expanding
Bram Moolenaar446cb832008-06-24 21:56:24 +00001577wildcards. Thus if you issue this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001578 :e $ROOTDIR/main.$EXT
1579The argument is first expanded to: >
1580 /usr/root/main.py
1581Before it's matched with the pattern of the autocommand. Careful with this
1582when using events like FileReadCmd, the value of <amatch> may not be what you
1583expect.
1584
1585
1586Environment variables can be used in a pattern: >
1587 :autocmd BufRead $VIMRUNTIME/doc/*.txt set expandtab
1588And ~ can be used for the home directory (if $HOME is defined): >
1589 :autocmd BufWritePost ~/.vimrc so ~/.vimrc
1590 :autocmd BufRead ~archive/* set readonly
1591The environment variable is expanded when the autocommand is defined, not when
1592the autocommand is executed. This is different from the command!
1593
1594 *file-pattern*
1595The pattern is interpreted like mostly used in file names:
Bram Moolenaar3b1db362013-08-10 15:00:24 +02001596 * matches any sequence of characters; Unusual: includes path
Bram Moolenaar9d98fe92013-08-03 18:35:36 +02001597 separators
Bram Moolenaar071d4272004-06-13 20:20:40 +00001598 ? matches any single character
1599 \? matches a '?'
1600 . matches a '.'
1601 ~ matches a '~'
1602 , separates patterns
1603 \, matches a ','
1604 { } like \( \) in a |pattern|
1605 , inside { }: like \| in a |pattern|
Bram Moolenaara946afe2013-08-02 15:22:39 +02001606 \} literal }
1607 \{ literal {
1608 \\\{n,m\} like \{n,m} in a |pattern|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001609 \ special meaning like in a |pattern|
1610 [ch] matches 'c' or 'h'
1611 [^ch] match any character but 'c' and 'h'
1612
1613Note that for all systems the '/' character is used for path separator (even
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001614for MS-Windows). This was done because the backslash is difficult to use in a
1615pattern and to make the autocommands portable across different systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001616
Bram Moolenaar64d8e252016-09-06 22:12:34 +02001617It is possible to use |pattern| items, but they may not work as expected,
1618because of the translation done for the above.
1619
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00001620 *autocmd-changes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001621Matching with the pattern is done when an event is triggered. Changing the
1622buffer name in one of the autocommands, or even deleting the buffer, does not
1623change which autocommands will be executed. Example: >
1624
1625 au BufEnter *.foo bdel
1626 au BufEnter *.foo set modified
1627
1628This will delete the current buffer and then set 'modified' in what has become
1629the current buffer instead. Vim doesn't take into account that "*.foo"
1630doesn't match with that buffer name. It matches "*.foo" with the name of the
1631buffer at the moment the event was triggered.
1632
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00001633However, buffer-local autocommands will not be executed for a buffer that has
1634been wiped out with |:bwipe|. After deleting the buffer with |:bdel| the
1635buffer actually still exists (it becomes unlisted), thus the autocommands are
1636still executed.
1637
Bram Moolenaar071d4272004-06-13 20:20:40 +00001638==============================================================================
Bram Moolenaarc9b4b052006-04-30 18:54:39 +000016397. Buffer-local autocommands *autocmd-buflocal* *autocmd-buffer-local*
1640 *<buffer=N>* *<buffer=abuf>* *E680*
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00001641
1642Buffer-local autocommands are attached to a specific buffer. They are useful
1643if the buffer does not have a name and when the name does not match a specific
1644pattern. But it also means they must be explicitly added to each buffer.
1645
1646Instead of a pattern buffer-local autocommands use one of these forms:
1647 <buffer> current buffer
1648 <buffer=99> buffer number 99
1649 <buffer=abuf> using <abuf> (only when executing autocommands)
1650 |<abuf>|
1651
1652Examples: >
1653 :au CursorHold <buffer> echo 'hold'
1654 :au CursorHold <buffer=33> echo 'hold'
Bram Moolenaar88774fd2015-08-25 19:52:04 +02001655 :au BufNewFile * au CursorHold <buffer=abuf> echo 'hold'
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00001656
1657All the commands for autocommands also work with buffer-local autocommands,
1658simply use the special string instead of the pattern. Examples: >
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001659 :au! * <buffer> " remove buffer-local autocommands for
1660 " current buffer
1661 :au! * <buffer=33> " remove buffer-local autocommands for
1662 " buffer #33
Bram Moolenaar446cb832008-06-24 21:56:24 +00001663 :bufdo :au! CursorHold <buffer> " remove autocmd for given event for all
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001664 " buffers
1665 :au * <buffer> " list buffer-local autocommands for
1666 " current buffer
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00001667
1668Note that when an autocommand is defined for the current buffer, it is stored
1669with the buffer number. Thus it uses the form "<buffer=12>", where 12 is the
1670number of the current buffer. You will see this when listing autocommands,
1671for example.
1672
1673To test for presence of buffer-local autocommands use the |exists()| function
1674as follows: >
1675 :if exists("#CursorHold#<buffer=12>") | ... | endif
1676 :if exists("#CursorHold#<buffer>") | ... | endif " for current buffer
1677
1678When a buffer is wiped out its buffer-local autocommands are also gone, of
1679course. Note that when deleting a buffer, e.g., with ":bdel", it is only
1680unlisted, the autocommands are still present. In order to see the removal of
1681buffer-local autocommands: >
1682 :set verbose=6
1683
1684It is not possible to define buffer-local autocommands for a non-existent
1685buffer.
1686
1687==============================================================================
16888. Groups *autocmd-groups*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001689
1690Autocommands can be put together in a group. This is useful for removing or
1691executing a group of autocommands. For example, all the autocommands for
1692syntax highlighting are put in the "highlight" group, to be able to execute
1693":doautoall highlight BufRead" when the GUI starts.
1694
1695When no specific group is selected, Vim uses the default group. The default
1696group does not have a name. You cannot execute the autocommands from the
1697default group separately; you can execute them only by executing autocommands
1698for all groups.
1699
1700Normally, when executing autocommands automatically, Vim uses the autocommands
1701for all groups. The group only matters when executing autocommands with
1702":doautocmd" or ":doautoall", or when defining or deleting autocommands.
1703
1704The group name can contain any characters except white space. The group name
1705"end" is reserved (also in uppercase).
1706
1707The group name is case sensitive. Note that this is different from the event
1708name!
1709
1710 *:aug* *:augroup*
1711:aug[roup] {name} Define the autocmd group name for the
1712 following ":autocmd" commands. The name "end"
1713 or "END" selects the default group.
Bram Moolenaar256972a2015-12-29 19:10:25 +01001714 To avoid confusion, the name should be
1715 different from existing {event} names, as this
1716 most likely will not do what you intended.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001717
Bram Moolenaar64d8e252016-09-06 22:12:34 +02001718 *:augroup-delete* *E367* *W19* *E936*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001719:aug[roup]! {name} Delete the autocmd group {name}. Don't use
1720 this if there is still an autocommand using
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02001721 this group! You will get a warning if doing
Bram Moolenaare7b1ea02020-08-07 19:54:59 +02001722 it anyway. When the group is the current
1723 group you will get error E936.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001724
1725To enter autocommands for a specific group, use this method:
17261. Select the group with ":augroup {name}".
17272. Delete any old autocommands with ":au!".
17283. Define the autocommands.
17294. Go back to the default group with "augroup END".
1730
1731Example: >
1732 :augroup uncompress
1733 : au!
1734 : au BufEnter *.gz %!gunzip
1735 :augroup END
1736
1737This prevents having the autocommands defined twice (e.g., after sourcing the
1738.vimrc file again).
1739
Bram Moolenaar6e649222021-10-04 21:32:54 +01001740 *FileExplorer*
1741There is one group that is recognized by Vim: FileExplorer. If this group
1742exists Vim assumes that editing a directory is possible and will trigger a
1743plugin that lists the files in that directory. This is used by the |netrw|
1744plugin. This allows you to do: >
1745 browse edit
1746
Bram Moolenaar071d4272004-06-13 20:20:40 +00001747==============================================================================
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +000017489. Executing autocommands *autocmd-execute*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001749
1750Vim can also execute Autocommands non-automatically. This is useful if you
1751have changed autocommands, or when Vim has executed the wrong autocommands
1752(e.g., the file pattern match was wrong).
1753
1754Note that the 'eventignore' option applies here too. Events listed in this
1755option will not cause any commands to be executed.
1756
Bram Moolenaar61da1bf2019-06-06 12:14:49 +02001757 *:do* *:doau* *:doaut* *:doautocmd* *E217*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01001758:do[autocmd] [<nomodeline>] [group] {event} [fname]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001759 Apply the autocommands matching [fname] (default:
1760 current file name) for {event} to the current buffer.
1761 You can use this when the current file name does not
1762 match the right pattern, after changing settings, or
1763 to execute autocommands for a certain event.
1764 It's possible to use this inside an autocommand too,
1765 so you can base the autocommands for one extension on
1766 another extension. Example: >
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001767 :au BufEnter *.cpp so ~/.vimrc_cpp
1768 :au BufEnter *.cpp doau BufEnter x.c
Bram Moolenaar071d4272004-06-13 20:20:40 +00001769< Be careful to avoid endless loops. See
1770 |autocmd-nested|.
1771
1772 When the [group] argument is not given, Vim executes
1773 the autocommands for all groups. When the [group]
1774 argument is included, Vim executes only the matching
1775 autocommands for that group. Note: if you use an
1776 undefined group name, Vim gives you an error message.
Bram Moolenaar60542ac2012-02-12 20:14:01 +01001777 *<nomodeline>*
1778 After applying the autocommands the modelines are
1779 processed, so that their settings overrule the
1780 settings from autocommands, like what happens when
1781 editing a file. This is skipped when the <nomodeline>
1782 argument is present. You probably want to use
1783 <nomodeline> for events that are not used when loading
1784 a buffer, such as |User|.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02001785 Processing modelines is also skipped when no
1786 matching autocommands were executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001787
1788 *:doautoa* *:doautoall*
Bram Moolenaara61d5fb2012-02-12 00:18:58 +01001789:doautoa[ll] [<nomodeline>] [group] {event} [fname]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001790 Like ":doautocmd", but apply the autocommands to each
Bram Moolenaardad44732021-03-31 20:07:33 +02001791 loaded buffer. The current buffer is done last.
1792
1793 Note that [fname] is used to select the autocommands,
Bram Moolenaar4c295022021-05-02 17:19:11 +02001794 not the buffers to which they are applied. Example: >
1795 augroup mine
1796 autocmd!
1797 autocmd FileType * echo expand('<amatch>')
1798 augroup END
1799 doautoall mine FileType Loaded-Buffer
1800< Sourcing this script, you'll see as many
1801 "Loaded-Buffer" echoed as there are loaded buffers.
Bram Moolenaardad44732021-03-31 20:07:33 +02001802
Bram Moolenaar071d4272004-06-13 20:20:40 +00001803 Careful: Don't use this for autocommands that delete a
1804 buffer, change to another buffer or change the
1805 contents of a buffer; the result is unpredictable.
1806 This command is intended for autocommands that set
1807 options, change highlighting, and things like that.
1808
1809==============================================================================
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000181010. Using autocommands *autocmd-use*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001811
1812For WRITING FILES there are four possible sets of events. Vim uses only one
1813of these sets for a write command:
1814
1815BufWriteCmd BufWritePre BufWritePost writing the whole buffer
1816 FilterWritePre FilterWritePost writing to filter temp file
1817FileAppendCmd FileAppendPre FileAppendPost appending to a file
1818FileWriteCmd FileWritePre FileWritePost any other file write
1819
1820When there is a matching "*Cmd" autocommand, it is assumed it will do the
1821writing. No further writing is done and the other events are not triggered.
1822|Cmd-event|
1823
1824Note that the *WritePost commands should undo any changes to the buffer that
1825were caused by the *WritePre commands; otherwise, writing the file will have
1826the side effect of changing the buffer.
1827
1828Before executing the autocommands, the buffer from which the lines are to be
1829written temporarily becomes the current buffer. Unless the autocommands
1830change the current buffer or delete the previously current buffer, the
1831previously current buffer is made the current buffer again.
1832
1833The *WritePre and *AppendPre autocommands must not delete the buffer from
1834which the lines are to be written.
1835
1836The '[ and '] marks have a special position:
1837- Before the *ReadPre event the '[ mark is set to the line just above where
1838 the new lines will be inserted.
1839- Before the *ReadPost event the '[ mark is set to the first line that was
1840 just read, the '] mark to the last line.
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001841- Before executing the *WriteCmd, *WritePre and *AppendPre autocommands the '[
1842 mark is set to the first line that will be written, the '] mark to the last
1843 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001844Careful: '[ and '] change when using commands that change the buffer.
1845
1846In commands which expect a file name, you can use "<afile>" for the file name
1847that is being read |:<afile>| (you can also use "%" for the current file
1848name). "<abuf>" can be used for the buffer number of the currently effective
Bram Moolenaard2f3a8b2018-06-19 14:35:59 +02001849buffer. This also works for buffers that don't have a name. But it doesn't
Bram Moolenaar071d4272004-06-13 20:20:40 +00001850work for files without a buffer (e.g., with ":r file").
1851
1852 *gzip-example*
1853Examples for reading and writing compressed files: >
1854 :augroup gzip
1855 : autocmd!
1856 : autocmd BufReadPre,FileReadPre *.gz set bin
1857 : autocmd BufReadPost,FileReadPost *.gz '[,']!gunzip
1858 : autocmd BufReadPost,FileReadPost *.gz set nobin
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001859 : autocmd BufReadPost,FileReadPost *.gz execute ":doautocmd BufReadPost " .. expand("%:r")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001860 : autocmd BufWritePost,FileWritePost *.gz !mv <afile> <afile>:r
1861 : autocmd BufWritePost,FileWritePost *.gz !gzip <afile>:r
1862
1863 : autocmd FileAppendPre *.gz !gunzip <afile>
1864 : autocmd FileAppendPre *.gz !mv <afile>:r <afile>
1865 : autocmd FileAppendPost *.gz !mv <afile> <afile>:r
1866 : autocmd FileAppendPost *.gz !gzip <afile>:r
1867 :augroup END
1868
1869The "gzip" group is used to be able to delete any existing autocommands with
1870":autocmd!", for when the file is sourced twice.
1871
1872("<afile>:r" is the file name without the extension, see |:_%:|)
1873
1874The commands executed for the BufNewFile, BufRead/BufReadPost, BufWritePost,
1875FileAppendPost and VimLeave events do not set or reset the changed flag of the
1876buffer. When you decompress the buffer with the BufReadPost autocommands, you
1877can still exit with ":q". When you use ":undo" in BufWritePost to undo the
1878changes made by BufWritePre commands, you can still do ":q" (this also makes
1879"ZZ" work). If you do want the buffer to be marked as modified, set the
1880'modified' option.
1881
1882To execute Normal mode commands from an autocommand, use the ":normal"
1883command. Use with care! If the Normal mode command is not finished, the user
1884needs to type characters (e.g., after ":normal m" you need to type a mark
1885name).
1886
1887If you want the buffer to be unmodified after changing it, reset the
1888'modified' option. This makes it possible to exit the buffer with ":q"
1889instead of ":q!".
1890
1891 *autocmd-nested* *E218*
Bram Moolenaar26967612019-03-17 17:13:16 +01001892By default, autocommands do not nest. For example, if you use ":e" or ":w" in
1893an autocommand, Vim does not execute the BufRead and BufWrite autocommands for
Bram Moolenaar071d4272004-06-13 20:20:40 +00001894those commands. If you do want this, use the "nested" flag for those commands
1895in which you want nesting. For example: >
Bram Moolenaareb93f3f2019-04-04 15:04:56 +02001896 :autocmd FileChangedShell *.c ++nested e!
Bram Moolenaar071d4272004-06-13 20:20:40 +00001897The nesting is limited to 10 levels to get out of recursive loops.
1898
1899It's possible to use the ":au" command in an autocommand. This can be a
1900self-modifying command! This can be useful for an autocommand that should
1901execute only once.
1902
Bram Moolenaarb3480382005-12-11 21:33:32 +00001903If you want to skip autocommands for one command, use the |:noautocmd| command
1904modifier or the 'eventignore' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001905
1906Note: When reading a file (with ":read file" or with a filter command) and the
1907last line in the file does not have an <EOL>, Vim remembers this. At the next
1908write (with ":write file" or with a filter command), if the same line is
1909written again as the last line in a file AND 'binary' is set, Vim does not
1910supply an <EOL>. This makes a filter command on the just read lines write the
1911same file as was read, and makes a write command on just filtered lines write
1912the same file as was read from the filter. For example, another way to write
1913a compressed file: >
1914
1915 :autocmd FileWritePre *.gz set bin|'[,']!gzip
1916 :autocmd FileWritePost *.gz undo|set nobin
1917<
1918 *autocommand-pattern*
1919You can specify multiple patterns, separated by commas. Here are some
1920examples: >
1921
1922 :autocmd BufRead * set tw=79 nocin ic infercase fo=2croq
1923 :autocmd BufRead .letter set tw=72 fo=2tcrq
1924 :autocmd BufEnter .letter set dict=/usr/lib/dict/words
1925 :autocmd BufLeave .letter set dict=
1926 :autocmd BufRead,BufNewFile *.c,*.h set tw=0 cin noic
1927 :autocmd BufEnter *.c,*.h abbr FOR for (i = 0; i < 3; ++i)<CR>{<CR>}<Esc>O
1928 :autocmd BufLeave *.c,*.h unabbr FOR
1929
1930For makefiles (makefile, Makefile, imakefile, makefile.unix, etc.): >
1931
1932 :autocmd BufEnter ?akefile* set include=^s\=include
1933 :autocmd BufLeave ?akefile* set include&
1934
1935To always start editing C files at the first function: >
1936
1937 :autocmd BufRead *.c,*.h 1;/^{
1938
1939Without the "1;" above, the search would start from wherever the file was
1940entered, rather than from the start of the file.
1941
1942 *skeleton* *template*
1943To read a skeleton (template) file when opening a new file: >
1944
1945 :autocmd BufNewFile *.c 0r ~/vim/skeleton.c
1946 :autocmd BufNewFile *.h 0r ~/vim/skeleton.h
1947 :autocmd BufNewFile *.java 0r ~/vim/skeleton.java
1948
1949To insert the current date and time in a *.html file when writing it: >
1950
1951 :autocmd BufWritePre,FileWritePre *.html ks|call LastMod()|'s
1952 :fun LastMod()
1953 : if line("$") > 20
1954 : let l = 20
1955 : else
1956 : let l = line("$")
1957 : endif
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001958 : exe "1," .. l .. "g/Last modified: /s/Last modified: .*/Last modified: " ..
Bram Moolenaar071d4272004-06-13 20:20:40 +00001959 : \ strftime("%Y %b %d")
1960 :endfun
1961
1962You need to have a line "Last modified: <date time>" in the first 20 lines
1963of the file for this to work. Vim replaces <date time> (and anything in the
1964same line after it) with the current date and time. Explanation:
1965 ks mark current position with mark 's'
1966 call LastMod() call the LastMod() function to do the work
1967 's return the cursor to the old position
1968The LastMod() function checks if the file is shorter than 20 lines, and then
1969uses the ":g" command to find lines that contain "Last modified: ". For those
1970lines the ":s" command is executed to replace the existing date with the
1971current one. The ":execute" command is used to be able to use an expression
1972for the ":g" and ":s" commands. The date is obtained with the strftime()
1973function. You can change its argument to get another date string.
1974
1975When entering :autocmd on the command-line, completion of events and command
1976names may be done (with <Tab>, CTRL-D, etc.) where appropriate.
1977
1978Vim executes all matching autocommands in the order that you specify them.
1979It is recommended that your first autocommand be used for all files by using
1980"*" as the file pattern. This means that you can define defaults you like
1981here for any settings, and if there is another matching autocommand it will
1982override these. But if there is no other matching autocommand, then at least
1983your default settings are recovered (if entering this file from another for
1984which autocommands did match). Note that "*" will also match files starting
1985with ".", unlike Unix shells.
1986
1987 *autocmd-searchpat*
1988Autocommands do not change the current search patterns. Vim saves the current
1989search patterns before executing autocommands then restores them after the
1990autocommands finish. This means that autocommands do not affect the strings
1991highlighted with the 'hlsearch' option. Within autocommands, you can still
1992use search patterns normally, e.g., with the "n" command.
1993If you want an autocommand to set the search pattern, such that it is used
1994after the autocommand finishes, use the ":let @/ =" command.
1995The search-highlighting cannot be switched off with ":nohlsearch" in an
1996autocommand. Use the 'h' flag in the 'viminfo' option to disable search-
1997highlighting when starting Vim.
1998
1999 *Cmd-event*
2000When using one of the "*Cmd" events, the matching autocommands are expected to
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00002001do the file reading, writing or sourcing. This can be used when working with
2002a special kind of file, for example on a remote system.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002003CAREFUL: If you use these events in a wrong way, it may have the effect of
2004making it impossible to read or write the matching files! Make sure you test
2005your autocommands properly. Best is to use a pattern that will never match a
2006normal file name, for example "ftp://*".
2007
2008When defining a BufReadCmd it will be difficult for Vim to recover a crashed
2009editing session. When recovering from the original file, Vim reads only those
2010parts of a file that are not found in the swap file. Since that is not
2011possible with a BufReadCmd, use the |:preserve| command to make sure the
2012original file isn't needed for recovery. You might want to do this only when
2013you expect the file to be modified.
2014
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00002015For file read and write commands the |v:cmdarg| variable holds the "++enc="
2016and "++ff=" argument that are effective. These should be used for the command
2017that reads/writes the file. The |v:cmdbang| variable is one when "!" was
2018used, zero otherwise.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002019
Bram Moolenaarc88ebf72010-07-22 22:30:23 +02002020See the $VIMRUNTIME/plugin/netrwPlugin.vim for examples.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002021
Bram Moolenaarb3480382005-12-11 21:33:32 +00002022==============================================================================
202311. Disabling autocommands *autocmd-disable*
2024
2025To disable autocommands for some time use the 'eventignore' option. Note that
2026this may cause unexpected behavior, make sure you restore 'eventignore'
2027afterwards, using a |:try| block with |:finally|.
2028
Luuk van Baalb7147f82025-02-08 18:52:39 +01002029To disable autocmds indefinitely in a specific window use the 'eventignorewin'
2030option. This can only be used to ignore window and buffer related events.
2031
Bram Moolenaarb3480382005-12-11 21:33:32 +00002032 *:noautocmd* *:noa*
2033To disable autocommands for just one command use the ":noautocmd" command
2034modifier. This will set 'eventignore' to "all" for the duration of the
2035following command. Example: >
2036
2037 :noautocmd w fname.gz
2038
2039This will write the file without triggering the autocommands defined by the
2040gzip plugin.
2041
Bram Moolenaar26967612019-03-17 17:13:16 +01002042Note that some autocommands are not triggered right away, but only later.
2043This specifically applies to |CursorMoved| and |TextChanged|.
2044
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00002045
Bram Moolenaar91f84f62018-07-29 15:07:52 +02002046 vim:tw=78:ts=8:noet:ft=help:norl: