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