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