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