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