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