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