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