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