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