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