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