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