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