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