annotate runtime/doc/autocmd.txt @ 14864:40ef13331e02

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