Mercurial > vim
annotate runtime/doc/map.txt @ 26708:f0d7cb510ce3
Update runtime files
Commit: https://github.com/vim/vim/commit/fa3b72348d88343390fbe212cfc230fec1602fc2
Author: Bram Moolenaar <Bram@vim.org>
Date: Fri Dec 24 13:18:38 2021 +0000
Update runtime files
author | Bram Moolenaar <Bram@vim.org> |
---|---|
date | Fri, 24 Dec 2021 14:30:04 +0100 |
parents | 3a63b1e4a6f4 |
children | edb7d53fc7e3 |
rev | line source |
---|---|
26708 | 1 *map.txt* For Vim version 8.2. Last change: 2021 Dec 20 |
7 | 2 |
3 | |
4 VIM REFERENCE MANUAL by Bram Moolenaar | |
5 | |
6 | |
7 Key mapping, abbreviations and user-defined commands. | |
8 | |
9 This subject is introduced in sections |05.3|, |24.7| and |40.1| of the user | |
10 manual. | |
11 | |
12 1. Key mapping |key-mapping| | |
592 | 13 1.1 MAP COMMANDS |:map-commands| |
14 1.2 Special arguments |:map-arguments| | |
15 1.3 Mapping and modes |:map-modes| | |
16 1.4 Listing mappings |map-listing| | |
17 1.5 Mapping special keys |:map-special-keys| | |
18 1.6 Special characters |:map-special-chars| | |
19 1.7 What keys to map |map-which-keys| | |
20 1.8 Examples |map-examples| | |
21 1.9 Using mappings |map-typing| | |
22 1.10 Mapping alt-keys |:map-alt-keys| | |
18400
f66fee58e7e2
patch 8.1.2194: modifyOtherKeys is not enabled by default
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
23 1.11 Mapping in modifyOtherKeys mode |modifyOtherKeys| |
f66fee58e7e2
patch 8.1.2194: modifyOtherKeys is not enabled by default
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
24 1.12 Mapping an operator |:map-operator| |
7 | 25 2. Abbreviations |abbreviations| |
26 3. Local mappings and functions |script-local| | |
27 4. User-defined commands |user-commands| | |
28 | |
29 ============================================================================== | |
30 1. Key mapping *key-mapping* *mapping* *macro* | |
31 | |
32 Key mapping is used to change the meaning of typed keys. The most common use | |
12559 | 33 is to define a sequence of commands for a function key. Example: > |
7 | 34 |
35 :map <F2> a<C-R>=strftime("%c")<CR><Esc> | |
36 | |
236 | 37 This appends the current date and time after the cursor (in <> notation |<>|). |
7 | 38 |
592 | 39 |
40 1.1 MAP COMMANDS *:map-commands* | |
41 | |
7 | 42 There are commands to enter new mappings, remove mappings and list mappings. |
43 See |map-overview| for the various forms of "map" and their relationships with | |
44 modes. | |
45 | |
46 {lhs} means left-hand-side *{lhs}* | |
47 {rhs} means right-hand-side *{rhs}* | |
48 | |
663 | 49 :map {lhs} {rhs} |mapmode-nvo| *:map* |
50 :nm[ap] {lhs} {rhs} |mapmode-n| *:nm* *:nmap* | |
51 :vm[ap] {lhs} {rhs} |mapmode-v| *:vm* *:vmap* | |
788 | 52 :xm[ap] {lhs} {rhs} |mapmode-x| *:xm* *:xmap* |
4358 | 53 :smap {lhs} {rhs} |mapmode-s| *:smap* |
663 | 54 :om[ap] {lhs} {rhs} |mapmode-o| *:om* *:omap* |
55 :map! {lhs} {rhs} |mapmode-ic| *:map!* | |
56 :im[ap] {lhs} {rhs} |mapmode-i| *:im* *:imap* | |
16944 | 57 :lm[ap] {lhs} {rhs} |mapmode-l| *:lm* *:lma* *:lmap* |
663 | 58 :cm[ap] {lhs} {rhs} |mapmode-c| *:cm* *:cmap* |
12499 | 59 :tma[p] {lhs} {rhs} |mapmode-t| *:tma* *:tmap* |
7 | 60 Map the key sequence {lhs} to {rhs} for the modes |
61 where the map command applies. The result, including | |
62 {rhs}, is then further scanned for mappings. This | |
63 allows for nested and recursive use of mappings. | |
26148 | 64 Note: Trailing spaces are included in the {rhs}, |
65 because space is a valid Normal mode command. | |
7 | 66 |
5968 | 67 *:nore* *:norem* |
68 :no[remap] {lhs} {rhs} |mapmode-nvo| *:no* *:noremap* *:nor* | |
69 :nn[oremap] {lhs} {rhs} |mapmode-n| *:nn* *:nnoremap* | |
70 :vn[oremap] {lhs} {rhs} |mapmode-v| *:vn* *:vnoremap* | |
71 :xn[oremap] {lhs} {rhs} |mapmode-x| *:xn* *:xnoremap* | |
16944 | 72 :snor[emap] {lhs} {rhs} |mapmode-s| *:snor* *:snore* *:snoremap* |
5968 | 73 :ono[remap] {lhs} {rhs} |mapmode-o| *:ono* *:onoremap* |
74 :no[remap]! {lhs} {rhs} |mapmode-ic| *:no!* *:noremap!* | |
16944 | 75 :ino[remap] {lhs} {rhs} |mapmode-i| *:ino* *:inor* *:inoremap* |
5968 | 76 :ln[oremap] {lhs} {rhs} |mapmode-l| *:ln* *:lnoremap* |
16944 | 77 :cno[remap] {lhs} {rhs} |mapmode-c| *:cno* *:cnor* *:cnoremap* |
12457
dfb8254aa735
patch 8.0.1108: cannot specify mappings for the terminal window
Christian Brabandt <cb@256bit.org>
parents:
12419
diff
changeset
|
78 :tno[remap] {lhs} {rhs} |mapmode-t| *:tno* *:tnoremap* |
7 | 79 Map the key sequence {lhs} to {rhs} for the modes |
80 where the map command applies. Disallow mapping of | |
81 {rhs}, to avoid nested and recursive mappings. Often | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16399
diff
changeset
|
82 used to redefine a command. |
7 | 83 |
84 | |
663 | 85 :unm[ap] {lhs} |mapmode-nvo| *:unm* *:unmap* |
86 :nun[map] {lhs} |mapmode-n| *:nun* *:nunmap* | |
87 :vu[nmap] {lhs} |mapmode-v| *:vu* *:vunmap* | |
788 | 88 :xu[nmap] {lhs} |mapmode-x| *:xu* *:xunmap* |
89 :sunm[ap] {lhs} |mapmode-s| *:sunm* *:sunmap* | |
663 | 90 :ou[nmap] {lhs} |mapmode-o| *:ou* *:ounmap* |
91 :unm[ap]! {lhs} |mapmode-ic| *:unm!* *:unmap!* | |
92 :iu[nmap] {lhs} |mapmode-i| *:iu* *:iunmap* | |
93 :lu[nmap] {lhs} |mapmode-l| *:lu* *:lunmap* | |
16944 | 94 :cu[nmap] {lhs} |mapmode-c| *:cu* *:cun* *:cunmap* |
12499 | 95 :tunma[p] {lhs} |mapmode-t| *:tunma* *:tunmap* |
7 | 96 Remove the mapping of {lhs} for the modes where the |
97 map command applies. The mapping may remain defined | |
98 for other modes where it applies. | |
26219 | 99 It also works when {lhs} matches the {rhs} of a |
100 mapping. This is for when when an abbreviation | |
101 applied. | |
7 | 102 Note: Trailing spaces are included in the {lhs}. This |
103 unmap does NOT work: > | |
104 :map @@ foo | |
105 :unmap @@ | print | |
106 | |
663 | 107 :mapc[lear] |mapmode-nvo| *:mapc* *:mapclear* |
108 :nmapc[lear] |mapmode-n| *:nmapc* *:nmapclear* | |
109 :vmapc[lear] |mapmode-v| *:vmapc* *:vmapclear* | |
788 | 110 :xmapc[lear] |mapmode-x| *:xmapc* *:xmapclear* |
111 :smapc[lear] |mapmode-s| *:smapc* *:smapclear* | |
663 | 112 :omapc[lear] |mapmode-o| *:omapc* *:omapclear* |
113 :mapc[lear]! |mapmode-ic| *:mapc!* *:mapclear!* | |
114 :imapc[lear] |mapmode-i| *:imapc* *:imapclear* | |
115 :lmapc[lear] |mapmode-l| *:lmapc* *:lmapclear* | |
116 :cmapc[lear] |mapmode-c| *:cmapc* *:cmapclear* | |
12457
dfb8254aa735
patch 8.0.1108: cannot specify mappings for the terminal window
Christian Brabandt <cb@256bit.org>
parents:
12419
diff
changeset
|
117 :tmapc[lear] |mapmode-t| *:tmapc* *:tmapclear* |
7 | 118 Remove ALL mappings for the modes where the map |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16399
diff
changeset
|
119 command applies. |
2908 | 120 Use the <buffer> argument to remove buffer-local |
121 mappings |:map-<buffer>| | |
7 | 122 Warning: This also removes the default mappings. |
123 | |
663 | 124 :map |mapmode-nvo| |
125 :nm[ap] |mapmode-n| | |
126 :vm[ap] |mapmode-v| | |
788 | 127 :xm[ap] |mapmode-x| |
128 :sm[ap] |mapmode-s| | |
663 | 129 :om[ap] |mapmode-o| |
130 :map! |mapmode-ic| | |
131 :im[ap] |mapmode-i| | |
132 :lm[ap] |mapmode-l| | |
133 :cm[ap] |mapmode-c| | |
12499 | 134 :tma[p] |mapmode-t| |
7 | 135 List all key mappings for the modes where the map |
136 command applies. Note that ":map" and ":map!" are | |
137 used most often, because they include the other modes. | |
138 | |
663 | 139 :map {lhs} |mapmode-nvo| *:map_l* |
140 :nm[ap] {lhs} |mapmode-n| *:nmap_l* | |
141 :vm[ap] {lhs} |mapmode-v| *:vmap_l* | |
788 | 142 :xm[ap] {lhs} |mapmode-x| *:xmap_l* |
143 :sm[ap] {lhs} |mapmode-s| *:smap_l* | |
663 | 144 :om[ap] {lhs} |mapmode-o| *:omap_l* |
145 :map! {lhs} |mapmode-ic| *:map_l!* | |
146 :im[ap] {lhs} |mapmode-i| *:imap_l* | |
147 :lm[ap] {lhs} |mapmode-l| *:lmap_l* | |
148 :cm[ap] {lhs} |mapmode-c| *:cmap_l* | |
12499 | 149 :tma[p] {lhs} |mapmode-t| *:tmap_l* |
7 | 150 List the key mappings for the key sequences starting |
151 with {lhs} in the modes where the map command applies. | |
152 | |
153 These commands are used to map a key or key sequence to a string of | |
154 characters. You can use this to put command sequences under function keys, | |
155 translate one key into another, etc. See |:mkexrc| for how to save and | |
156 restore the current mappings. | |
157 | |
592 | 158 *map-ambiguous* |
159 When two mappings start with the same sequence of characters, they are | |
160 ambiguous. Example: > | |
161 :imap aa foo | |
162 :imap aaa bar | |
163 When Vim has read "aa", it will need to get another character to be able to | |
164 decide if "aa" or "aaa" should be mapped. This means that after typing "aa" | |
165 that mapping won't get expanded yet, Vim is waiting for another character. | |
166 If you type a space, then "foo" will get inserted, plus the space. If you | |
167 type "a", then "bar" will get inserted. | |
168 | |
169 | |
170 1.2 SPECIAL ARGUMENTS *:map-arguments* | |
171 | |
5035
1cf89d38aa76
updated for version 7.3.1261
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
172 "<buffer>", "<nowait>", "<silent>", "<special>", "<script>", "<expr>" and |
1cf89d38aa76
updated for version 7.3.1261
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
173 "<unique>" can be used in any order. They must appear right after the |
1cf89d38aa76
updated for version 7.3.1261
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
174 command, before any other arguments. |
721 | 175 |
26591 | 176 *:map-local* *:map-<buffer>* *:map-buffer* *E224* *E225* |
1668 | 177 If the first argument to one of these commands is "<buffer>" the mapping will |
178 be effective in the current buffer only. Example: > | |
7 | 179 :map <buffer> ,w /[.,;]<CR> |
180 Then you can map ",w" to something else in another buffer: > | |
181 :map <buffer> ,w /[#&!]<CR> | |
5035
1cf89d38aa76
updated for version 7.3.1261
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
182 The local buffer mappings are used before the global ones. See <nowait> below |
1cf89d38aa76
updated for version 7.3.1261
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
183 to make a short local mapping not taking effect when a longer global one |
1cf89d38aa76
updated for version 7.3.1261
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
184 exists. |
7 | 185 The "<buffer>" argument can also be used to clear mappings: > |
186 :unmap <buffer> ,w | |
187 :mapclear <buffer> | |
188 Local mappings are also cleared when a buffer is deleted, but not when it is | |
189 unloaded. Just like local option values. | |
4869 | 190 Also see |map-precedence|. |
7 | 191 |
5035
1cf89d38aa76
updated for version 7.3.1261
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
192 *:map-<nowait>* *:map-nowait* |
1cf89d38aa76
updated for version 7.3.1261
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
193 When defining a buffer-local mapping for "," there may be a global mapping |
1cf89d38aa76
updated for version 7.3.1261
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
194 that starts with ",". Then you need to type another character for Vim to know |
1cf89d38aa76
updated for version 7.3.1261
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
195 whether to use the "," mapping or the longer one. To avoid this add the |
1cf89d38aa76
updated for version 7.3.1261
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
196 <nowait> argument. Then the mapping will be used when it matches, Vim does |
1cf89d38aa76
updated for version 7.3.1261
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
197 not wait for more characters to be typed. However, if the characters were |
11473 | 198 already typed they are used. |
21991 | 199 Note that this works when the <nowait> mapping fully matches and is found |
200 before any partial matches. This works when: | |
201 - There is only one matching buffer-local mapping, since these are always | |
202 found before global mappings. | |
22171 | 203 - There is another buffer-local mapping that partly matches, but it is |
21991 | 204 defined earlier (last defined mapping is found first). |
5035
1cf89d38aa76
updated for version 7.3.1261
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
205 |
7 | 206 *:map-<silent>* *:map-silent* |
207 To define a mapping which will not be echoed on the command line, add | |
208 "<silent>" as the first argument. Example: > | |
209 :map <silent> ,h /Header<CR> | |
210 The search string will not be echoed when using this mapping. Messages from | |
211 the executed command are still given though. To shut them up too, add a | |
212 ":silent" in the executed command: > | |
213 :map <silent> ,h :exe ":silent normal /Header\r"<CR> | |
214 Prompts will still be given, e.g., for inputdialog(). | |
215 Using "<silent>" for an abbreviation is possible, but will cause redrawing of | |
216 the command line to fail. | |
217 | |
859 | 218 *:map-<special>* *:map-special* |
219 Define a mapping with <> notation for special keys, even though the "<" flag | |
220 may appear in 'cpoptions'. This is useful if the side effect of setting | |
221 'cpoptions' is not desired. Example: > | |
222 :map <special> <F12> /Header<CR> | |
223 < | |
7 | 224 *:map-<script>* *:map-script* |
225 If the first argument to one of these commands is "<script>" and it is used to | |
226 define a new mapping or abbreviation, the mapping will only remap characters | |
227 in the {rhs} using mappings that were defined local to a script, starting with | |
228 "<SID>". This can be used to avoid that mappings from outside a script | |
229 interfere (e.g., when CTRL-V is remapped in mswin.vim), but do use other | |
230 mappings defined in the script. | |
231 Note: ":map <script>" and ":noremap <script>" do the same thing. The | |
232 "<script>" overrules the command name. Using ":noremap <script>" is | |
233 preferred, because it's clearer that remapping is (mostly) disabled. | |
234 | |
26591 | 235 *:map-<unique>* *:map-unique* *E226* *E227* |
7 | 236 If the first argument to one of these commands is "<unique>" and it is used to |
237 define a new mapping or abbreviation, the command will fail if the mapping or | |
238 abbreviation already exists. Example: > | |
239 :map <unique> ,w /[#&!]<CR> | |
240 When defining a local mapping, there will also be a check if a global map | |
241 already exists which is equal. | |
242 Example of what will fail: > | |
243 :map ,w /[#&!]<CR> | |
244 :map <buffer> <unique> ,w /[.,;]<CR> | |
626 | 245 If you want to map a key and then have it do what it was originally mapped to, |
246 have a look at |maparg()|. | |
7 | 247 |
721 | 248 *:map-<expr>* *:map-expression* |
249 If the first argument to one of these commands is "<expr>" and it is used to | |
250 define a new mapping or abbreviation, the argument is an expression. The | |
251 expression is evaluated to obtain the {rhs} that is used. Example: > | |
24569 | 252 :inoremap <expr> . <SID>InsertDot() |
253 The result of the s:InsertDot() function will be inserted. It could check the | |
721 | 254 text before the cursor and start omni completion when some condition is met. |
24569 | 255 Using a script-local function is preferred, to avoid polluting the global |
256 namespace. Use <SID> in the RHS so that the script that the mapping was | |
257 defined in can be found. | |
721 | 258 |
1969 | 259 For abbreviations |v:char| is set to the character that was typed to trigger |
260 the abbreviation. You can use this to decide how to expand the {lhs}. You | |
3082 | 261 should not either insert or change the v:char. |
1969 | 262 |
22565 | 263 In case you want the mapping to not do anything, you can have the expression |
264 evaluate to an empty string. If something changed that requires Vim to | |
265 go through the main loop (e.g. to update the display), return "\<Ignore>". | |
266 This is similar to "nothing" but makes Vim return from the loop that waits for | |
267 input. Example: > | |
268 func s:OpenPopup() | |
269 call popup_create(... arguments ...) | |
270 return "\<Ignore>" | |
271 endfunc | |
24569 | 272 nnoremap <expr> <F3> <SID>OpenPopup() |
22565 | 273 |
24142
34acfef7f60c
patch 8.2.2612: col('.') may get outdated column value
Bram Moolenaar <Bram@vim.org>
parents:
23164
diff
changeset
|
274 Also, keep in mind that the expression may be evaluated when looking for |
34acfef7f60c
patch 8.2.2612: col('.') may get outdated column value
Bram Moolenaar <Bram@vim.org>
parents:
23164
diff
changeset
|
275 typeahead, before the previous command has been executed. For example: > |
34acfef7f60c
patch 8.2.2612: col('.') may get outdated column value
Bram Moolenaar <Bram@vim.org>
parents:
23164
diff
changeset
|
276 func StoreColumn() |
34acfef7f60c
patch 8.2.2612: col('.') may get outdated column value
Bram Moolenaar <Bram@vim.org>
parents:
23164
diff
changeset
|
277 let g:column = col('.') |
34acfef7f60c
patch 8.2.2612: col('.') may get outdated column value
Bram Moolenaar <Bram@vim.org>
parents:
23164
diff
changeset
|
278 return 'x' |
34acfef7f60c
patch 8.2.2612: col('.') may get outdated column value
Bram Moolenaar <Bram@vim.org>
parents:
23164
diff
changeset
|
279 endfunc |
34acfef7f60c
patch 8.2.2612: col('.') may get outdated column value
Bram Moolenaar <Bram@vim.org>
parents:
23164
diff
changeset
|
280 nnoremap <expr> x StoreColumn() |
34acfef7f60c
patch 8.2.2612: col('.') may get outdated column value
Bram Moolenaar <Bram@vim.org>
parents:
23164
diff
changeset
|
281 nmap ! f!x |
24278 | 282 You will notice that g:column has the value from before executing "f!", |
283 because "x" is evaluated before "f!" is executed. | |
24142
34acfef7f60c
patch 8.2.2612: col('.') may get outdated column value
Bram Moolenaar <Bram@vim.org>
parents:
23164
diff
changeset
|
284 This can be solved by inserting <Ignore> before the character that is |
34acfef7f60c
patch 8.2.2612: col('.') may get outdated column value
Bram Moolenaar <Bram@vim.org>
parents:
23164
diff
changeset
|
285 expression-mapped: > |
34acfef7f60c
patch 8.2.2612: col('.') may get outdated column value
Bram Moolenaar <Bram@vim.org>
parents:
23164
diff
changeset
|
286 nmap ! f!<Ignore>x |
34acfef7f60c
patch 8.2.2612: col('.') may get outdated column value
Bram Moolenaar <Bram@vim.org>
parents:
23164
diff
changeset
|
287 |
721 | 288 Be very careful about side effects! The expression is evaluated while |
856 | 289 obtaining characters, you may very well make the command dysfunctional. |
290 For this reason the following is blocked: | |
1132 | 291 - Changing the buffer text |textlock|. |
292 - Editing another buffer. | |
293 - The |:normal| command. | |
294 - Moving the cursor is allowed, but it is restored afterwards. | |
856 | 295 If you want the mapping to do any of these let the returned characters do |
22862
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
296 that, or use a |<Cmd>| mapping instead. |
721 | 297 |
3153 | 298 You can use getchar(), it consumes typeahead if there is any. E.g., if you |
299 have these mappings: > | |
300 inoremap <expr> <C-L> nr2char(getchar()) | |
301 inoremap <expr> <C-L>x "foo" | |
302 If you now type CTRL-L nothing happens yet, Vim needs the next character to | |
303 decide what mapping to use. If you type 'x' the second mapping is used and | |
3224 | 304 "foo" is inserted. If you type any other key the first mapping is used, |
305 getchar() gets the typed key and returns it. | |
3153 | 306 |
721 | 307 Here is an example that inserts a list number that increases: > |
308 let counter = 0 | |
309 inoremap <expr> <C-L> ListItem() | |
310 inoremap <expr> <C-R> ListReset() | |
311 | |
312 func ListItem() | |
313 let g:counter += 1 | |
314 return g:counter . '. ' | |
315 endfunc | |
316 | |
317 func ListReset() | |
318 let g:counter = 0 | |
319 return '' | |
320 endfunc | |
321 | |
727 | 322 CTRL-L inserts the next number, CTRL-R resets the count. CTRL-R returns an |
721 | 323 empty string, so that nothing is inserted. |
7 | 324 |
22171 | 325 Note that using 0x80 as a single byte before other text does not work, it will |
326 be seen as a special key. | |
837 | 327 |
22862
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
328 *<Cmd>* *:map-cmd* |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
329 The special text <Cmd> begins a "command mapping", it executes the command |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
330 directly without changing modes. Where you might use ":...<CR>" in the |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
331 {rhs} of a mapping, you can instead use "<Cmd>...<CR>". |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
332 Example: > |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
333 noremap x <Cmd>echo mode(1)<CR> |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
334 < |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
335 This is more flexible than `:<C-U>` in Visual and Operator-pending mode, or |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
336 `<C-O>:` in Insert mode, because the commands are executed directly in the |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
337 current mode, instead of always going to Normal mode. Visual mode is |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
338 preserved, so tricks with |gv| are not needed. Commands can be invoked |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
339 directly in Command-line mode (which would otherwise require timer hacks). |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
340 Example of using <Cmd> halfway Insert mode: > |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
341 nnoremap <F3> aText <Cmd>echo mode(1)<CR> Added<Esc> |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
342 |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
343 Unlike <expr> mappings, there are no special restrictions on the <Cmd> |
22958 | 344 command: it is executed as if an (unrestricted) |autocommand| was invoked. |
22862
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
345 |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
346 Note: |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
347 - Because <Cmd> avoids mode-changes it does not trigger |CmdlineEnter| and |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
348 |CmdlineLeave| events, because no user interaction is expected. |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
349 - For the same reason, |keycodes| like <C-R><C-W> are interpreted as plain, |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
350 unmapped keys. |
22958 | 351 - The command is not echo'ed, no need for <silent>. |
26219 | 352 - The {rhs} is not subject to abbreviations nor to other mappings, even if the |
353 mapping is recursive. | |
22958 | 354 - In Visual mode you can use `line('v')` and `col('v')` to get one end of the |
355 Visual area, the cursor is at the other end. | |
22862
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
356 - In Select mode, |:map| and |:vmap| command mappings are executed in |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
357 Visual mode. Use |:smap| to handle Select mode differently. |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
358 |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
359 *E1135* *E1136* |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
360 <Cmd> commands must terminate, that is, they must be followed by <CR> in the |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
361 {rhs} of the mapping definition. |Command-line| mode is never entered. |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
362 |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
363 *E1137* |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
364 <Cmd> commands can have only normal characters and cannot contain special |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
365 characters like function keys. |
6d50182e7e24
patch 8.2.1978: making a mapping work in all modes is complicated
Bram Moolenaar <Bram@vim.org>
parents:
22565
diff
changeset
|
366 |
7 | 367 |
592 | 368 1.3 MAPPING AND MODES *:map-modes* |
1619 | 369 *mapmode-nvo* *mapmode-n* *mapmode-v* *mapmode-o* |
7 | 370 |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1969
diff
changeset
|
371 There are six sets of mappings |
7 | 372 - For Normal mode: When typing commands. |
373 - For Visual mode: When typing commands while the Visual area is highlighted. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1969
diff
changeset
|
374 - For Select mode: like Visual mode but typing text replaces the selection. |
7 | 375 - For Operator-pending mode: When an operator is pending (after "d", "y", "c", |
1619 | 376 etc.). See below: |omap-info|. |
236 | 377 - For Insert mode. These are also used in Replace mode. |
7 | 378 - For Command-line mode: When entering a ":" or "/" command. |
379 | |
380 Special case: While typing a count for a command in Normal mode, mapping zero | |
381 is disabled. This makes it possible to map zero without making it impossible | |
382 to type a count with a zero. | |
383 | |
384 *map-overview* *map-modes* | |
5908 | 385 Overview of which map command works in which mode. More details below. |
386 COMMANDS MODES ~ | |
387 :map :noremap :unmap Normal, Visual, Select, Operator-pending | |
388 :nmap :nnoremap :nunmap Normal | |
389 :vmap :vnoremap :vunmap Visual and Select | |
390 :smap :snoremap :sunmap Select | |
391 :xmap :xnoremap :xunmap Visual | |
392 :omap :onoremap :ounmap Operator-pending | |
393 :map! :noremap! :unmap! Insert and Command-line | |
394 :imap :inoremap :iunmap Insert | |
395 :lmap :lnoremap :lunmap Insert, Command-line, Lang-Arg | |
396 :cmap :cnoremap :cunmap Command-line | |
12457
dfb8254aa735
patch 8.0.1108: cannot specify mappings for the terminal window
Christian Brabandt <cb@256bit.org>
parents:
12419
diff
changeset
|
397 :tmap :tnoremap :tunmap Terminal-Job |
7 | 398 |
24636 | 399 Same information in a table: |
400 *map-table* | |
401 Mode | Norm | Ins | Cmd | Vis | Sel | Opr | Term | Lang | ~ | |
402 Command +------+-----+-----+-----+-----+-----+------+------+ ~ | |
403 [nore]map | yes | - | - | yes | yes | yes | - | - | | |
404 n[nore]map | yes | - | - | - | - | - | - | - | | |
405 [nore]map! | - | yes | yes | - | - | - | - | - | | |
406 i[nore]map | - | yes | - | - | - | - | - | - | | |
407 c[nore]map | - | - | yes | - | - | - | - | - | | |
408 v[nore]map | - | - | - | yes | yes | - | - | - | | |
409 x[nore]map | - | - | - | yes | - | - | - | - | | |
410 s[nore]map | - | - | - | - | yes | - | - | - | | |
411 o[nore]map | - | - | - | - | - | yes | - | - | | |
412 t[nore]map | - | - | - | - | - | - | yes | - | | |
413 l[nore]map | - | yes | yes | - | - | - | - | yes | | |
414 | |
5908 | 415 |
416 COMMANDS MODES ~ | |
856 | 417 Normal Visual+Select Operator-pending ~ |
418 :map :noremap :unmap :mapclear yes yes yes | |
419 :nmap :nnoremap :nunmap :nmapclear yes - - | |
420 :vmap :vnoremap :vunmap :vmapclear - yes - | |
421 :omap :onoremap :ounmap :omapclear - - yes | |
788 | 422 |
826 | 423 :nunmap can also be used outside of a monastery. |
856 | 424 *mapmode-x* *mapmode-s* |
788 | 425 Some commands work both in Visual and Select mode, some in only one. Note |
426 that quite often "Visual" is mentioned where both Visual and Select mode | |
427 apply. |Select-mode-mapping| | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1969
diff
changeset
|
428 NOTE: Mapping a printable character in Select mode may confuse the user. It's |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1969
diff
changeset
|
429 better to explicitly use :xmap and :smap for printable characters. Or use |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1969
diff
changeset
|
430 :sunmap after defining the mapping. |
788 | 431 |
5908 | 432 COMMANDS MODES ~ |
856 | 433 Visual Select ~ |
434 :vmap :vnoremap :vunmap :vmapclear yes yes | |
435 :xmap :xnoremap :xunmap :xmapclear yes - | |
436 :smap :snoremap :sunmap :smapclear - yes | |
7 | 437 |
663 | 438 *mapmode-ic* *mapmode-i* *mapmode-c* *mapmode-l* |
788 | 439 Some commands work both in Insert mode and Command-line mode, some not: |
440 | |
5908 | 441 COMMANDS MODES ~ |
7 | 442 Insert Command-line Lang-Arg ~ |
443 :map! :noremap! :unmap! :mapclear! yes yes - | |
444 :imap :inoremap :iunmap :imapclear yes - - | |
445 :cmap :cnoremap :cunmap :cmapclear - yes - | |
446 :lmap :lnoremap :lunmap :lmapclear yes* yes* yes* | |
447 | |
18594 | 448 * If 'iminsert' is 1, see |language-mapping| below. |
449 | |
7 | 450 The original Vi did not have separate mappings for |
451 Normal/Visual/Operator-pending mode and for Insert/Command-line mode. | |
452 Therefore the ":map" and ":map!" commands enter and display mappings for | |
453 several modes. In Vim you can use the ":nmap", ":vmap", ":omap", ":cmap" and | |
454 ":imap" commands to enter mappings for each mode separately. | |
455 | |
12457
dfb8254aa735
patch 8.0.1108: cannot specify mappings for the terminal window
Christian Brabandt <cb@256bit.org>
parents:
12419
diff
changeset
|
456 *mapmode-t* |
dfb8254aa735
patch 8.0.1108: cannot specify mappings for the terminal window
Christian Brabandt <cb@256bit.org>
parents:
12419
diff
changeset
|
457 The terminal mappings are used in a terminal window, when typing keys for the |
dfb8254aa735
patch 8.0.1108: cannot specify mappings for the terminal window
Christian Brabandt <cb@256bit.org>
parents:
12419
diff
changeset
|
458 job running in the terminal. See |terminal-typing|. |
dfb8254aa735
patch 8.0.1108: cannot specify mappings for the terminal window
Christian Brabandt <cb@256bit.org>
parents:
12419
diff
changeset
|
459 |
1619 | 460 *omap-info* |
461 Operator-pending mappings can be used to define a movement command that can be | |
14864 | 462 used with any operator. Simple example: > |
463 :omap { w | |
464 makes "y{" work like "yw" and "d{" like "dw". | |
1619 | 465 |
466 To ignore the starting cursor position and select different text, you can have | |
467 the omap start Visual mode to select the text to be operated upon. Example | |
468 that operates on a function name in the current line: > | |
469 onoremap <silent> F :<C-U>normal! 0f(hviw<CR> | |
470 The CTRL-U (<C-U>) is used to remove the range that Vim may insert. The | |
471 Normal mode commands find the first '(' character and select the first word | |
472 before it. That usually is the function name. | |
473 | |
7 | 474 To enter a mapping for Normal and Visual mode, but not Operator-pending mode, |
14864 | 475 first define it for all three modes, then unmap it for |
476 Operator-pending mode: > | |
7 | 477 :map xx something-difficult |
478 :ounmap xx | |
14864 | 479 |
7 | 480 Likewise for a mapping for Visual and Operator-pending mode or Normal and |
481 Operator-pending mode. | |
482 | |
483 *language-mapping* | |
484 ":lmap" defines a mapping that applies to: | |
485 - Insert mode | |
486 - Command-line mode | |
487 - when entering a search pattern | |
488 - the argument of the commands that accept a text character, such as "r" and | |
489 "f" | |
490 - for the input() line | |
491 Generally: Whenever a character is to be typed that is part of the text in the | |
492 buffer, not a Vim command character. "Lang-Arg" isn't really another mode, | |
493 it's just used here for this situation. | |
494 The simplest way to load a set of related language mappings is by using the | |
495 'keymap' option. See |45.5|. | |
496 In Insert mode and in Command-line mode the mappings can be disabled with | |
5340 | 497 the CTRL-^ command |i_CTRL-^| |c_CTRL-^|. These commands change the value of |
5294 | 498 the 'iminsert' option. When starting to enter a normal command line (not a |
499 search pattern) the mappings are disabled until a CTRL-^ is typed. The state | |
500 last used is remembered for Insert mode and Search patterns separately. The | |
501 state for Insert mode is also used when typing a character as an argument to | |
502 command like "f" or "t". | |
7 | 503 Language mappings will never be applied to already mapped characters. They |
504 are only used for typed characters. This assumes that the language mapping | |
505 was already done when typing the mapping. | |
506 | |
507 | |
592 | 508 1.4 LISTING MAPPINGS *map-listing* |
509 | |
7 | 510 When listing mappings the characters in the first two columns are: |
511 | |
512 CHAR MODE ~ | |
1132 | 513 <Space> Normal, Visual, Select and Operator-pending |
7 | 514 n Normal |
1132 | 515 v Visual and Select |
516 s Select | |
517 x Visual | |
7 | 518 o Operator-pending |
519 ! Insert and Command-line | |
520 i Insert | |
521 l ":lmap" mappings for Insert, Command-line and Lang-Arg | |
522 c Command-line | |
12481
bcd9b3e4a5c8
patch 8.0.1120: :tm means :tmap instead of :tmenu
Christian Brabandt <cb@256bit.org>
parents:
12457
diff
changeset
|
523 t Terminal-Job |
7 | 524 |
525 Just before the {rhs} a special character can appear: | |
526 * indicates that it is not remappable | |
527 & indicates that only script-local mappings are remappable | |
528 @ indicates a buffer-local mapping | |
529 | |
530 Everything from the first non-blank after {lhs} up to the end of the line | |
531 (or '|') is considered to be part of {rhs}. This allows the {rhs} to end | |
532 with a space. | |
533 | |
534 Note: When using mappings for Visual mode, you can use the "'<" mark, which | |
535 is the start of the last selected Visual area in the current buffer |'<|. | |
536 | |
10004
8061455d9179
commit https://github.com/vim/vim/commit/818078ddfbb8cc2546f697c5675a251d095722ec
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
537 The |:filter| command can be used to select what mappings to list. The |
8061455d9179
commit https://github.com/vim/vim/commit/818078ddfbb8cc2546f697c5675a251d095722ec
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
538 pattern is matched against the {lhs} and {rhs} in the raw form. |
8061455d9179
commit https://github.com/vim/vim/commit/818078ddfbb8cc2546f697c5675a251d095722ec
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
539 |
481 | 540 *:map-verbose* |
541 When 'verbose' is non-zero, listing a key map will also display where it was | |
542 last defined. Example: > | |
543 | |
544 :verbose map <C-W>* | |
545 n <C-W>* * <C-W><C-S>* | |
856 | 546 Last set from /home/abcd/.vimrc |
481 | 547 |
483 | 548 See |:verbose-cmd| for more information. |
481 | 549 |
592 | 550 |
551 1.5 MAPPING SPECIAL KEYS *:map-special-keys* | |
552 | |
553 There are three ways to map a special key: | |
554 1. The Vi-compatible method: Map the key code. Often this is a sequence that | |
555 starts with <Esc>. To enter a mapping like this you type ":map " and then | |
556 you have to type CTRL-V before hitting the function key. Note that when | |
557 the key code for the key is in the termcap (the t_ options), it will | |
558 automatically be translated into the internal code and become the second | |
559 way of mapping (unless the 'k' flag is included in 'cpoptions'). | |
560 2. The second method is to use the internal code for the function key. To | |
561 enter such a mapping type CTRL-K and then hit the function key, or use | |
562 the form "#1", "#2", .. "#9", "#0", "<Up>", "<S-Down>", "<S-F7>", etc. | |
563 (see table of keys |key-notation|, all keys from <Up> can be used). The | |
564 first ten function keys can be defined in two ways: Just the number, like | |
565 "#2", and with "<F>", like "<F2>". Both stand for function key 2. "#0" | |
566 refers to function key 10, defined with option 't_f10', which may be | |
567 function key zero on some keyboards. The <> form cannot be used when | |
568 'cpoptions' includes the '<' flag. | |
569 3. Use the termcap entry, with the form <t_xx>, where "xx" is the name of the | |
570 termcap entry. Any string entry can be used. For example: > | |
571 :map <t_F3> G | |
572 < Maps function key 13 to "G". This does not work if 'cpoptions' includes | |
573 the '<' flag. | |
574 | |
575 The advantage of the second and third method is that the mapping will work on | |
576 different terminals without modification (the function key will be | |
577 translated into the same internal code or the actual key code, no matter what | |
578 terminal you are using. The termcap must be correct for this to work, and you | |
579 must use the same mappings). | |
580 | |
581 DETAIL: Vim first checks if a sequence from the keyboard is mapped. If it | |
582 isn't the terminal key codes are tried (see |terminal-options|). If a | |
583 terminal code is found it is replaced with the internal code. Then the check | |
584 for a mapping is done again (so you can map an internal code to something | |
585 else). What is written into the script file depends on what is recognized. | |
586 If the terminal key code was recognized as a mapping the key code itself is | |
587 written to the script file. If it was recognized as a terminal code the | |
588 internal code is written to the script file. | |
589 | |
590 | |
591 1.6 SPECIAL CHARACTERS *:map-special-chars* | |
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6447
diff
changeset
|
592 *map_backslash* *map-backslash* |
7 | 593 Note that only CTRL-V is mentioned here as a special character for mappings |
594 and abbreviations. When 'cpoptions' does not contain 'B', a backslash can | |
595 also be used like CTRL-V. The <> notation can be fully used then |<>|. But | |
596 you cannot use "<C-V>" like CTRL-V to escape the special meaning of what | |
597 follows. | |
598 | |
599 To map a backslash, or use a backslash literally in the {rhs}, the special | |
600 sequence "<Bslash>" can be used. This avoids the need to double backslashes | |
601 when using nested mappings. | |
602 | |
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6447
diff
changeset
|
603 *map_CTRL-C* *map-CTRL-C* |
532 | 604 Using CTRL-C in the {lhs} is possible, but it will only work when Vim is |
605 waiting for a key, not when Vim is busy with something. When Vim is busy | |
606 CTRL-C interrupts/breaks the command. | |
607 When using the GUI version on MS-Windows CTRL-C can be mapped to allow a Copy | |
608 command to the clipboard. Use CTRL-Break to interrupt Vim. | |
7 | 609 |
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6447
diff
changeset
|
610 *map_space_in_lhs* *map-space_in_lhs* |
7 | 611 To include a space in {lhs} precede it with a CTRL-V (type two CTRL-Vs for |
612 each space). | |
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6447
diff
changeset
|
613 *map_space_in_rhs* *map-space_in_rhs* |
7 | 614 If you want a {rhs} that starts with a space, use "<Space>". To be fully Vi |
615 compatible (but unreadable) don't use the |<>| notation, precede {rhs} with a | |
616 single CTRL-V (you have to type CTRL-V two times). | |
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6447
diff
changeset
|
617 *map_empty_rhs* *map-empty-rhs* |
7 | 618 You can create an empty {rhs} by typing nothing after a single CTRL-V (you |
619 have to type CTRL-V two times). Unfortunately, you cannot do this in a vimrc | |
620 file. | |
621 *<Nop>* | |
2826 | 622 An easier way to get a mapping that doesn't produce anything, is to use |
623 "<Nop>" for the {rhs}. This only works when the |<>| notation is enabled. | |
624 For example, to make sure that function key 8 does nothing at all: > | |
7 | 625 :map <F8> <Nop> |
626 :map! <F8> <Nop> | |
627 < | |
592 | 628 *map-multibyte* |
629 It is possible to map multibyte characters, but only the whole character. You | |
630 cannot map the first byte only. This was done to prevent problems in this | |
631 scenario: > | |
632 :set encoding=latin1 | |
633 :imap <M-C> foo | |
634 :set encoding=utf-8 | |
635 The mapping for <M-C> is defined with the latin1 encoding, resulting in a 0xc3 | |
13857 | 636 byte. If you type the character á (0xe1 <M-a>) in UTF-8 encoding this is the |
2826 | 637 two bytes 0xc3 0xa1. You don't want the 0xc3 byte to be mapped then or |
13857 | 638 otherwise it would be impossible to type the á character. |
592 | 639 |
7 | 640 *<Leader>* *mapleader* |
641 To define a mapping which uses the "mapleader" variable, the special string | |
642 "<Leader>" can be used. It is replaced with the string value of "mapleader". | |
643 If "mapleader" is not set or empty, a backslash is used instead. Example: > | |
644 :map <Leader>A oanother line<Esc> | |
645 Works like: > | |
646 :map \A oanother line<Esc> | |
647 But after: > | |
648 :let mapleader = "," | |
649 It works like: > | |
650 :map ,A oanother line<Esc> | |
651 | |
652 Note that the value of "mapleader" is used at the moment the mapping is | |
653 defined. Changing "mapleader" after that has no effect for already defined | |
654 mappings. | |
655 | |
656 *<LocalLeader>* *maplocalleader* | |
1619 | 657 <LocalLeader> is just like <Leader>, except that it uses "maplocalleader" |
658 instead of "mapleader". <LocalLeader> is to be used for mappings which are | |
659 local to a buffer. Example: > | |
3312 | 660 :map <buffer> <LocalLeader>A oanother line<Esc> |
7 | 661 < |
662 In a global plugin <Leader> should be used and in a filetype plugin | |
663 <LocalLeader>. "mapleader" and "maplocalleader" can be equal. Although, if | |
664 you make them different, there is a smaller chance of mappings from global | |
665 plugins to clash with mappings for filetype plugins. For example, you could | |
666 keep "mapleader" at the default backslash, and set "maplocalleader" to an | |
667 underscore. | |
668 | |
669 *map-<SID>* | |
670 In a script the special key name "<SID>" can be used to define a mapping | |
671 that's local to the script. See |<SID>| for details. | |
672 | |
673 *<Plug>* | |
674 The special key name "<Plug>" can be used for an internal mapping, which is | |
675 not to be matched with any key sequence. This is useful in plugins | |
676 |using-<Plug>|. | |
677 | |
678 *<Char>* *<Char->* | |
679 To map a character by its decimal, octal or hexadecimal number the <Char> | |
680 construct can be used: | |
681 <Char-123> character 123 | |
682 <Char-033> character 27 | |
683 <Char-0x7f> character 127 | |
3082 | 684 <S-Char-114> character 114 ('r') shifted ('R') |
21991 | 685 This is useful to specify a (multibyte) character in a 'keymap' file. |
7 | 686 Upper and lowercase differences are ignored. |
687 | |
688 *map-comments* | |
689 It is not possible to put a comment after these commands, because the '"' | |
11160 | 690 character is considered to be part of the {lhs} or {rhs}. However, one can |
691 use |", since this starts a new, empty command with a comment. | |
7 | 692 |
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6447
diff
changeset
|
693 *map_bar* *map-bar* |
7 | 694 Since the '|' character is used to separate a map command from the next |
695 command, you will have to do something special to include a '|' in {rhs}. | |
696 There are three methods: | |
697 use works when example ~ | |
698 <Bar> '<' is not in 'cpoptions' :map _l :!ls <Bar> more^M | |
699 \| 'b' is not in 'cpoptions' :map _l :!ls \| more^M | |
700 ^V| always, in Vim and Vi :map _l :!ls ^V| more^M | |
701 | |
702 (here ^V stands for CTRL-V; to get one CTRL-V you have to type it twice; you | |
703 cannot use the <> notation "<C-V>" here). | |
704 | |
705 All three work when you use the default setting for 'cpoptions'. | |
706 | |
707 When 'b' is present in 'cpoptions', "\|" will be recognized as a mapping | |
708 ending in a '\' and then another command. This is Vi compatible, but | |
709 illogical when compared to other commands. | |
710 | |
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6447
diff
changeset
|
711 *map_return* *map-return* |
7 | 712 When you have a mapping that contains an Ex command, you need to put a line |
713 terminator after it to have it executed. The use of <CR> is recommended for | |
714 this (see |<>|). Example: > | |
5692
80e5f9584b02
Update runtime files. Add Euphoria syntax files.
Bram Moolenaar <bram@vim.org>
parents:
5340
diff
changeset
|
715 :map _ls :!ls -l %:S<CR>:echo "the end"<CR> |
7 | 716 |
717 To avoid mapping of the characters you type in insert or Command-line mode, | |
718 type a CTRL-V first. The mapping in Insert mode is disabled if the 'paste' | |
719 option is on. | |
5239 | 720 *map-error* |
7 | 721 Note that when an error is encountered (that causes an error message or beep) |
722 the rest of the mapping is not executed. This is Vi-compatible. | |
723 | |
724 Note that the second character (argument) of the commands @zZtTfF[]rm'`"v | |
725 and CTRL-X is not mapped. This was done to be able to use all the named | |
726 registers and marks, even when the command with the same name has been | |
727 mapped. | |
728 | |
592 | 729 |
730 1.7 WHAT KEYS TO MAP *map-which-keys* | |
731 | |
7 | 732 If you are going to map something, you will need to choose which key(s) to use |
733 for the {lhs}. You will have to avoid keys that are used for Vim commands, | |
734 otherwise you would not be able to use those commands anymore. Here are a few | |
735 suggestions: | |
736 - Function keys <F2>, <F3>, etc.. Also the shifted function keys <S-F1>, | |
737 <S-F2>, etc. Note that <F1> is already used for the help command. | |
2324
0a258a67051d
In Visual mode with 'showcmd' display the number of bytes and characters.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
738 - Meta-keys (with the ALT key pressed). Depending on your keyboard accented |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1969
diff
changeset
|
739 characters may be used as well. |:map-alt-keys| |
7 | 740 - Use the '_' or ',' character and then any other character. The "_" and "," |
741 commands do exist in Vim (see |_| and |,|), but you probably never use them. | |
742 - Use a key that is a synonym for another command. For example: CTRL-P and | |
743 CTRL-N. Use an extra character to allow more mappings. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1969
diff
changeset
|
744 - The key defined by <Leader> and one or more other keys. This is especially |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1969
diff
changeset
|
745 useful in scripts. |mapleader| |
7 | 746 |
747 See the file "index" for keys that are not used and thus can be mapped without | |
748 losing any builtin function. You can also use ":help {key}^D" to find out if | |
749 a key is used for some command. ({key} is the specific key you want to find | |
750 out about, ^D is CTRL-D). | |
751 | |
592 | 752 |
753 1.8 EXAMPLES *map-examples* | |
754 | |
7 | 755 A few examples (given as you type them, for "<CR>" you type four characters; |
756 the '<' flag must not be present in 'cpoptions' for this to work). > | |
757 | |
758 :map <F3> o#include | |
759 :map <M-g> /foo<CR>cwbar<Esc> | |
760 :map _x d/END/e<CR> | |
761 :map! qq quadrillion questions | |
1132 | 762 |
763 | |
764 Multiplying a count | |
765 | |
766 When you type a count before triggering a mapping, it's like the count was | |
767 typed before the {lhs}. For example, with this mapping: > | |
768 :map <F4> 3w | |
769 Typing 2<F4> will result in "23w". Thus not moving 2 * 3 words but 23 words. | |
770 If you want to multiply counts use the expression register: > | |
771 :map <F4> @='3w'<CR> | |
772 The part between quotes is the expression being executed. |@=| | |
773 | |
592 | 774 |
775 1.9 USING MAPPINGS *map-typing* | |
776 | |
7 | 777 Vim will compare what you type with the start of a mapped sequence. If there |
778 is an incomplete match, it will get more characters until there either is a | |
779 complete match or until there is no match at all. Example: If you map! "qq", | |
780 the first 'q' will not appear on the screen until you type another | |
781 character. This is because Vim cannot know if the next character will be a | |
782 'q' or not. If the 'timeout' option is on (which is the default) Vim will | |
783 only wait for one second (or as long as specified with the 'timeoutlen' | |
784 option). After that it assumes that the 'q' is to be interpreted as such. If | |
785 you type slowly, or your system is slow, reset the 'timeout' option. Then you | |
786 might want to set the 'ttimeout' option. | |
787 | |
12499 | 788 *map-precedence* |
4869 | 789 Buffer-local mappings (defined using |:map-<buffer>|) take precedence over |
790 global mappings. When a buffer-local mapping is the same as a global mapping, | |
791 Vim will use the buffer-local mapping. In addition, Vim will use a complete | |
5055 | 792 mapping immediately if it was defined with <nowait>, even if a longer mapping |
793 has the same prefix. For example, given the following two mappings: > | |
794 :map <buffer> <nowait> \a :echo "Local \a"<CR> | |
795 :map \abc :echo "Global \abc"<CR> | |
796 When typing \a the buffer-local mapping will be used immediately. Vim will | |
797 not wait for more characters to see if the user might be typing \abc. | |
4869 | 798 |
7 | 799 *map-keys-fails* |
588 | 800 There are situations where key codes might not be recognized: |
7 | 801 - Vim can only read part of the key code. Mostly this is only the first |
802 character. This happens on some Unix versions in an xterm. | |
803 - The key code is after character(s) that are mapped. E.g., "<F1><F1>" or | |
804 "g<F1>". | |
588 | 805 |
7 | 806 The result is that the key code is not recognized in this situation, and the |
588 | 807 mapping fails. There are two actions needed to avoid this problem: |
808 | |
7 | 809 - Remove the 'K' flag from 'cpoptions'. This will make Vim wait for the rest |
810 of the characters of the function key. | |
811 - When using <F1> to <F4> the actual key code generated may correspond to | |
812 <xF1> to <xF4>. There are mappings from <xF1> to <F1>, <xF2> to <F2>, etc., | |
813 but these are not recognized after another half a mapping. Make sure the | |
814 key codes for <F1> to <F4> are correct: > | |
815 :set <F1>=<type CTRL-V><type F1> | |
816 < Type the <F1> as four characters. The part after the "=" must be done with | |
817 the actual keys, not the literal text. | |
818 Another solution is to use the actual key code in the mapping for the second | |
819 special key: > | |
820 :map <F1><Esc>OP :echo "yes"<CR> | |
821 Don't type a real <Esc>, Vim will recognize the key code and replace it with | |
822 <F1> anyway. | |
823 | |
588 | 824 Another problem may be that when keeping ALT or Meta pressed the terminal |
825 prepends ESC instead of setting the 8th bit. See |:map-alt-keys|. | |
826 | |
7 | 827 *recursive_mapping* |
828 If you include the {lhs} in the {rhs} you have a recursive mapping. When | |
829 {lhs} is typed, it will be replaced with {rhs}. When the {lhs} which is | |
830 included in {rhs} is encountered it will be replaced with {rhs}, and so on. | |
831 This makes it possible to repeat a command an infinite number of times. The | |
832 only problem is that the only way to stop this is by causing an error. The | |
833 macros to solve a maze uses this, look there for an example. There is one | |
834 exception: If the {rhs} starts with {lhs}, the first character is not mapped | |
835 again (this is Vi compatible). | |
836 For example: > | |
837 :map ab abcd | |
838 will execute the "a" command and insert "bcd" in the text. The "ab" in the | |
839 {rhs} will not be mapped again. | |
840 | |
841 If you want to exchange the meaning of two keys you should use the :noremap | |
842 command. For example: > | |
843 :noremap k j | |
844 :noremap j k | |
845 This will exchange the cursor up and down commands. | |
846 | |
847 With the normal :map command, when the 'remap' option is on, mapping takes | |
848 place until the text is found not to be a part of a {lhs}. For example, if | |
849 you use: > | |
850 :map x y | |
851 :map y x | |
852 Vim will replace x with y, and then y with x, etc. When this has happened | |
853 'maxmapdepth' times (default 1000), Vim will give the error message | |
854 "recursive mapping". | |
855 | |
856 *:map-undo* | |
857 If you include an undo command inside a mapped sequence, this will bring the | |
858 text back in the state before executing the macro. This is compatible with | |
859 the original Vi, as long as there is only one undo command in the mapped | |
860 sequence (having two undo commands in a mapped sequence did not make sense | |
861 in the original Vi, you would get back the text before the first undo). | |
862 | |
863 | |
592 | 864 1.10 MAPPING ALT-KEYS *:map-alt-keys* |
588 | 865 |
866 In the GUI Vim handles the Alt key itself, thus mapping keys with ALT should | |
867 always work. But in a terminal Vim gets a sequence of bytes and has to figure | |
868 out whether ALT was pressed or not. | |
869 | |
18400
f66fee58e7e2
patch 8.1.2194: modifyOtherKeys is not enabled by default
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
870 If the terminal supports the modifyOtherKeys mode and it has been enabled, |
f66fee58e7e2
patch 8.1.2194: modifyOtherKeys is not enabled by default
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
871 then Vim can recognize more key combinations, see |modifyOtherKeys| below. |
f66fee58e7e2
patch 8.1.2194: modifyOtherKeys is not enabled by default
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
872 |
588 | 873 By default Vim assumes that pressing the ALT key sets the 8th bit of a typed |
605 | 874 character. Most decent terminals can work that way, such as xterm, aterm and |
588 | 875 rxvt. If your <A-k> mappings don't work it might be that the terminal is |
876 prefixing the character with an ESC character. But you can just as well type | |
877 ESC before a character, thus Vim doesn't know what happened (except for | |
878 checking the delay between characters, which is not reliable). | |
879 | |
880 As of this writing, some mainstream terminals like gnome-terminal and konsole | |
881 use the ESC prefix. There doesn't appear a way to have them use the 8th bit | |
605 | 882 instead. Xterm should work well by default. Aterm and rxvt should work well |
883 when started with the "--meta8" argument. You can also tweak resources like | |
884 "metaSendsEscape", "eightBitInput" and "eightBitOutput". | |
588 | 885 |
886 On the Linux console, this behavior can be toggled with the "setmetamode" | |
887 command. Bear in mind that not using an ESC prefix could get you in trouble | |
888 with other programs. You should make sure that bash has the "convert-meta" | |
889 option set to "on" in order for your Meta keybindings to still work on it | |
890 (it's the default readline behavior, unless changed by specific system | |
891 configuration). For that, you can add the line: > | |
892 | |
893 set convert-meta on | |
894 | |
895 to your ~/.inputrc file. If you're creating the file, you might want to use: > | |
896 | |
897 $include /etc/inputrc | |
898 | |
899 as the first line, if that file exists on your system, to keep global options. | |
900 This may cause a problem for entering special characters, such as the umlaut. | |
901 Then you should use CTRL-V before that character. | |
902 | |
903 Bear in mind that convert-meta has been reported to have troubles when used in | |
904 UTF-8 locales. On terminals like xterm, the "metaSendsEscape" resource can be | |
905 toggled on the fly through the "Main Options" menu, by pressing Ctrl-LeftClick | |
906 on the terminal; that's a good last resource in case you want to send ESC when | |
11473 | 907 using other applications but not when inside Vim. |
588 | 908 |
592 | 909 |
18400
f66fee58e7e2
patch 8.1.2194: modifyOtherKeys is not enabled by default
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
910 1.11 MAPPING IN modifyOtherKeys mode *modifyOtherKeys* |
f66fee58e7e2
patch 8.1.2194: modifyOtherKeys is not enabled by default
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
911 |
f66fee58e7e2
patch 8.1.2194: modifyOtherKeys is not enabled by default
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
912 Xterm and a few other terminals can be put in a mode where keys with modifiers |
f66fee58e7e2
patch 8.1.2194: modifyOtherKeys is not enabled by default
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
913 are sent with a special escape code. Vim recognizes these codes and can then |
f66fee58e7e2
patch 8.1.2194: modifyOtherKeys is not enabled by default
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
914 make a difference between CTRL-H and Backspace, even when Backspace sends the |
f66fee58e7e2
patch 8.1.2194: modifyOtherKeys is not enabled by default
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
915 character 8. And many more special keys. |
f66fee58e7e2
patch 8.1.2194: modifyOtherKeys is not enabled by default
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
916 |
f66fee58e7e2
patch 8.1.2194: modifyOtherKeys is not enabled by default
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
917 For xterm modifyOtherKeys is enabled in the builtin termcap entry. If this is |
f66fee58e7e2
patch 8.1.2194: modifyOtherKeys is not enabled by default
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
918 not used you can enable modifyOtherKeys with these lines in your vimrc: > |
f66fee58e7e2
patch 8.1.2194: modifyOtherKeys is not enabled by default
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
919 let &t_TI = "\<Esc>[>4;2m" |
f66fee58e7e2
patch 8.1.2194: modifyOtherKeys is not enabled by default
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
920 let &t_TE = "\<Esc>[>4;m" |
f66fee58e7e2
patch 8.1.2194: modifyOtherKeys is not enabled by default
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
921 |
f66fee58e7e2
patch 8.1.2194: modifyOtherKeys is not enabled by default
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
922 In case the modifyOtherKeys mode causes problems you can disable it: > |
f66fee58e7e2
patch 8.1.2194: modifyOtherKeys is not enabled by default
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
923 let &t_TI = "" |
f66fee58e7e2
patch 8.1.2194: modifyOtherKeys is not enabled by default
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
924 let &t_TE = "" |
f66fee58e7e2
patch 8.1.2194: modifyOtherKeys is not enabled by default
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
925 It does not take effect immediately. To have this work without restarting Vim |
18594 | 926 execute a shell command, e.g.: `!ls` Or put the lines in your |vimrc|. |
927 | |
928 When modifyOtherKeys is enabled you can map <C-[> and <C-S-{>: > | |
929 imap <C-[> [[[ | |
22526
6325ef9143bc
patch 8.2.1811: mapping Ctrl-key does not work for '{', '}' and '|'
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
930 imap <C-{> {{{ |
6325ef9143bc
patch 8.2.1811: mapping Ctrl-key does not work for '{', '}' and '|'
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
931 Without modifyOtherKeys <C-[> and <C-{> are indistinguishable from Esc. |
6325ef9143bc
patch 8.2.1811: mapping Ctrl-key does not work for '{', '}' and '|'
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
932 Note that <C-{> is used and not <C-S-[> or <C-S-{>. This works on most |
6325ef9143bc
patch 8.2.1811: mapping Ctrl-key does not work for '{', '}' and '|'
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
933 keyboards. Similarly, <C-}> is used instead of <C-S-]> or <C-S-}> and |
6325ef9143bc
patch 8.2.1811: mapping Ctrl-key does not work for '{', '}' and '|'
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
934 <C-|> instead of <C-S-\> or <C-S-|>. Note that '|' has a special meaning in a |
6325ef9143bc
patch 8.2.1811: mapping Ctrl-key does not work for '{', '}' and '|'
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
935 mapping, see |map-bar|. |
6325ef9143bc
patch 8.2.1811: mapping Ctrl-key does not work for '{', '}' and '|'
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
936 |
6325ef9143bc
patch 8.2.1811: mapping Ctrl-key does not work for '{', '}' and '|'
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
937 WARNING: if you map <C-[> you may very well break any key codes that start |
6325ef9143bc
patch 8.2.1811: mapping Ctrl-key does not work for '{', '}' and '|'
Bram Moolenaar <Bram@vim.org>
parents:
22328
diff
changeset
|
938 with Esc. Make sure it comes AFTER other mappings. |
18400
f66fee58e7e2
patch 8.1.2194: modifyOtherKeys is not enabled by default
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
939 |
21499 | 940 A known side effect is that in Insert mode the raw escape sequence is inserted |
941 after the CTRL-V key. This can be used to check whether modifyOtherKeys is | |
942 enabled: In Insert mode type CTRL-SHIFT-V CTRL-V, if you get one byte then | |
943 modifyOtherKeys is off, if you get <1b>27;5;118~ then it is on. | |
18400
f66fee58e7e2
patch 8.1.2194: modifyOtherKeys is not enabled by default
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
944 |
18594 | 945 When the 'esckeys' option is off, then modifyOtherKeys will be disabled in |
946 Insert mode to avoid every key with a modifier causing Insert mode to end. | |
947 | |
18400
f66fee58e7e2
patch 8.1.2194: modifyOtherKeys is not enabled by default
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
948 |
f66fee58e7e2
patch 8.1.2194: modifyOtherKeys is not enabled by default
Bram Moolenaar <Bram@vim.org>
parents:
16944
diff
changeset
|
949 1.12 MAPPING AN OPERATOR *:map-operator* |
592 | 950 |
951 An operator is used before a {motion} command. To define your own operator | |
23164 | 952 you must create a mapping that first sets the 'operatorfunc' option and then |
592 | 953 invoke the |g@| operator. After the user types the {motion} command the |
954 specified function will be called. | |
955 | |
626 | 956 *g@* *E774* *E775* |
592 | 957 g@{motion} Call the function set by the 'operatorfunc' option. |
958 The '[ mark is positioned at the start of the text | |
959 moved over by {motion}, the '] mark on the last | |
960 character of the text. | |
961 The function is called with one String argument: | |
962 "line" {motion} was |linewise| | |
963 "char" {motion} was |characterwise| | |
2324
0a258a67051d
In Visual mode with 'showcmd' display the number of bytes and characters.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
964 "block" {motion} was |blockwise-visual| |
26708 | 965 The type can be forced, see |forced-motion|. |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
966 {not available when compiled without the |+eval| |
592 | 967 feature} |
968 | |
969 Here is an example that counts the number of spaces with <F4>: > | |
970 | |
22171 | 971 nnoremap <expr> <F4> CountSpaces() |
972 xnoremap <expr> <F4> CountSpaces() | |
973 " doubling <F4> works on a line | |
974 nnoremap <expr> <F4><F4> CountSpaces() .. '_' | |
592 | 975 |
26708 | 976 function CountSpaces(context = {}, type = '') abort |
22171 | 977 if a:type == '' |
26708 | 978 let context = #{ |
979 \ dot_command: v:false, | |
980 \ extend_block: '', | |
981 \ virtualedit: [&l:virtualedit, &g:virtualedit], | |
982 \ } | |
983 let &operatorfunc = function('CountSpaces', [context]) | |
26591 | 984 set virtualedit=block |
22171 | 985 return 'g@' |
26591 | 986 endif |
22171 | 987 |
26708 | 988 let save = #{ |
989 \ clipboard: &clipboard, | |
990 \ selection: &selection, | |
991 \ virtualedit: [&l:virtualedit, &g:virtualedit], | |
992 \ register: getreginfo('"'), | |
993 \ visual_marks: [getpos("'<"), getpos("'>")], | |
994 \ } | |
592 | 995 |
22171 | 996 try |
26591 | 997 set clipboard= selection=inclusive virtualedit= |
26708 | 998 let commands = #{ |
999 \ line: "'[V']", | |
1000 \ char: "`[v`]", | |
1001 \ block: "`[\<C-V>`]", | |
1002 \ }[a:type] | |
1003 let [_, _, col, off] = getpos("']") | |
1004 if off != 0 | |
1005 let vcol = getline("'[")->strpart(0, col + off)->strdisplaywidth() | |
1006 if vcol >= [line("'["), '$']->virtcol() - 1 | |
1007 let a:context.extend_block = '$' | |
1008 else | |
1009 let a:context.extend_block = vcol .. '|' | |
1010 endif | |
1011 endif | |
1012 if a:context.extend_block != '' | |
1013 let commands ..= 'oO' .. a:context.extend_block | |
26591 | 1014 endif |
1015 let commands ..= 'y' | |
1016 execute 'silent noautocmd keepjumps normal! ' .. commands | |
1017 echomsg getreg('"')->count(' ') | |
22171 | 1018 finally |
26708 | 1019 call setreg('"', save.register) |
1020 call setpos("'<", save.visual_marks[0]) | |
1021 call setpos("'>", save.visual_marks[1]) | |
1022 let &clipboard = save.clipboard | |
1023 let &selection = save.selection | |
1024 let [&l:virtualedit, &g:virtualedit] = get(a:context.dot_command ? save : a:context, 'virtualedit') | |
1025 let a:context.dot_command = v:true | |
22171 | 1026 endtry |
1027 endfunction | |
592 | 1028 |
22171 | 1029 An <expr> mapping is used to be able to fetch any prefixed count and register. |
1030 This also avoids using a command line, which would trigger CmdlineEnter and | |
1031 CmdlineLeave autocommands. | |
592 | 1032 |
1033 Note that the 'selection' option is temporarily set to "inclusive" to be able | |
1034 to yank exactly the right text by using Visual mode from the '[ to the '] | |
1035 mark. | |
1036 | |
22171 | 1037 Also note that the 'clipboard' option is temporarily emptied to avoid |
1038 clobbering the `"*` or `"+` registers, if its value contains the item `unnamed` | |
1039 or `unnamedplus`. | |
592 | 1040 |
26050 | 1041 The `mode()` function will return the state as it will be after applying the |
1042 operator. | |
1043 | |
26175
6b4f017d7005
patch 8.2.3619: cannot use a lambda for 'operatorfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26148
diff
changeset
|
1044 Here is an example for using a lambda function to create a normal-mode |
6b4f017d7005
patch 8.2.3619: cannot use a lambda for 'operatorfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26148
diff
changeset
|
1045 operator to add quotes around text in the current line: > |
6b4f017d7005
patch 8.2.3619: cannot use a lambda for 'operatorfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26148
diff
changeset
|
1046 |
6b4f017d7005
patch 8.2.3619: cannot use a lambda for 'operatorfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26148
diff
changeset
|
1047 nnoremap <F4> <Cmd>let &opfunc='{t -> |
6b4f017d7005
patch 8.2.3619: cannot use a lambda for 'operatorfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26148
diff
changeset
|
1048 \ getline(".") |
6b4f017d7005
patch 8.2.3619: cannot use a lambda for 'operatorfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26148
diff
changeset
|
1049 \ ->split("\\zs") |
6b4f017d7005
patch 8.2.3619: cannot use a lambda for 'operatorfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26148
diff
changeset
|
1050 \ ->insert("\"", col("'']")) |
6b4f017d7005
patch 8.2.3619: cannot use a lambda for 'operatorfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26148
diff
changeset
|
1051 \ ->insert("\"", col("''[") - 1) |
6b4f017d7005
patch 8.2.3619: cannot use a lambda for 'operatorfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26148
diff
changeset
|
1052 \ ->join("") |
6b4f017d7005
patch 8.2.3619: cannot use a lambda for 'operatorfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26148
diff
changeset
|
1053 \ ->setline(".")}'<CR>g@ |
6b4f017d7005
patch 8.2.3619: cannot use a lambda for 'operatorfunc'
Bram Moolenaar <Bram@vim.org>
parents:
26148
diff
changeset
|
1054 |
7 | 1055 ============================================================================== |
1056 2. Abbreviations *abbreviations* *Abbreviations* | |
1057 | |
1058 Abbreviations are used in Insert mode, Replace mode and Command-line mode. | |
1059 If you enter a word that is an abbreviation, it is replaced with the word it | |
1060 stands for. This can be used to save typing for often used long words. And | |
1061 you can use it to automatically correct obvious spelling errors. | |
1062 Examples: | |
1063 | |
1190 | 1064 :iab ms Microsoft |
7 | 1065 :iab tihs this |
1066 | |
1067 There are three types of abbreviations: | |
1068 | |
1069 full-id The "full-id" type consists entirely of keyword characters (letters | |
1070 and characters from 'iskeyword' option). This is the most common | |
1071 abbreviation. | |
1072 | |
1073 Examples: "foo", "g3", "-1" | |
1074 | |
1075 end-id The "end-id" type ends in a keyword character, but all the other | |
1076 characters are not keyword characters. | |
1077 | |
1078 Examples: "#i", "..f", "$/7" | |
1079 | |
1080 non-id The "non-id" type ends in a non-keyword character, the other | |
1236 | 1081 characters may be of any type, excluding space and tab. {this type |
7 | 1082 is not supported by Vi} |
1083 | |
1084 Examples: "def#", "4/7$" | |
1085 | |
1086 Examples of strings that cannot be abbreviations: "a.b", "#def", "a b", "_$r" | |
1087 | |
1088 An abbreviation is only recognized when you type a non-keyword character. | |
1089 This can also be the <Esc> that ends insert mode or the <CR> that ends a | |
1090 command. The non-keyword character which ends the abbreviation is inserted | |
1091 after the expanded abbreviation. An exception to this is the character <C-]>, | |
1092 which is used to expand an abbreviation without inserting any extra | |
1093 characters. | |
1094 | |
1095 Example: > | |
1096 :ab hh hello | |
1097 < "hh<Space>" is expanded to "hello<Space>" | |
1098 "hh<C-]>" is expanded to "hello" | |
1099 | |
1100 The characters before the cursor must match the abbreviation. Each type has | |
1101 an additional rule: | |
1102 | |
1103 full-id In front of the match is a non-keyword character, or this is where | |
1104 the line or insertion starts. Exception: When the abbreviation is | |
1105 only one character, it is not recognized if there is a non-keyword | |
13937 | 1106 character in front of it, other than a space or a tab. However, for |
1107 the command line "'<,'>" (or any other marks) is ignored, as if the | |
1108 command line starts after it. | |
7 | 1109 |
1236 | 1110 end-id In front of the match is a keyword character, or a space or a tab, |
7 | 1111 or this is where the line or insertion starts. |
1112 | |
1236 | 1113 non-id In front of the match is a space, tab or the start of the line or |
7 | 1114 the insertion. |
1115 | |
1116 Examples: ({CURSOR} is where you type a non-keyword character) > | |
1117 :ab foo four old otters | |
1118 < " foo{CURSOR}" is expanded to " four old otters" | |
1119 " foobar{CURSOR}" is not expanded | |
1120 "barfoo{CURSOR}" is not expanded | |
1121 > | |
1122 :ab #i #include | |
1123 < "#i{CURSOR}" is expanded to "#include" | |
1124 ">#i{CURSOR}" is not expanded | |
1125 > | |
42 | 1126 :ab ;; <endofline> |
7 | 1127 < "test;;" is not expanded |
1128 "test ;;" is expanded to "test <endofline>" | |
1129 | |
6292
31f7581068a9
Update runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
6259
diff
changeset
|
1130 To avoid the abbreviation in Insert mode: Type CTRL-V before the character |
31f7581068a9
Update runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
6259
diff
changeset
|
1131 that would trigger the abbreviation. E.g. CTRL-V <Space>. Or type part of |
31f7581068a9
Update runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
6259
diff
changeset
|
1132 the abbreviation, exit insert mode with <Esc>, re-enter insert mode with "a" |
31f7581068a9
Update runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
6259
diff
changeset
|
1133 and type the rest. |
31f7581068a9
Update runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
6259
diff
changeset
|
1134 |
7 | 1135 To avoid the abbreviation in Command-line mode: Type CTRL-V twice somewhere in |
1136 the abbreviation to avoid it to be replaced. A CTRL-V in front of a normal | |
1137 character is mostly ignored otherwise. | |
1138 | |
1139 It is possible to move the cursor after an abbreviation: > | |
1140 :iab if if ()<Left> | |
1141 This does not work if 'cpoptions' includes the '<' flag. |<>| | |
1142 | |
1143 You can even do more complicated things. For example, to consume the space | |
1144 typed after an abbreviation: > | |
1145 func Eatchar(pat) | |
685 | 1146 let c = nr2char(getchar(0)) |
7 | 1147 return (c =~ a:pat) ? '' : c |
1148 endfunc | |
1149 iabbr <silent> if if ()<Left><C-R>=Eatchar('\s')<CR> | |
1150 | |
1151 There are no default abbreviations. | |
1152 | |
1153 Abbreviations are never recursive. You can use ":ab f f-o-o" without any | |
1154 problem. But abbreviations can be mapped. {some versions of Vi support | |
1155 recursive abbreviations, for no apparent reason} | |
1156 | |
1157 Abbreviations are disabled if the 'paste' option is on. | |
1158 | |
1159 *:abbreviate-local* *:abbreviate-<buffer>* | |
1160 Just like mappings, abbreviations can be local to a buffer. This is mostly | |
1161 used in a |filetype-plugin| file. Example for a C plugin file: > | |
1162 :abb <buffer> FF for (i = 0; i < ; ++i) | |
1163 < | |
1164 *:ab* *:abbreviate* | |
1165 :ab[breviate] list all abbreviations. The character in the first | |
1166 column indicates the mode where the abbreviation is | |
1167 used: 'i' for insert mode, 'c' for Command-line | |
1168 mode, '!' for both. These are the same as for | |
1169 mappings, see |map-listing|. | |
1170 | |
502 | 1171 *:abbreviate-verbose* |
1172 When 'verbose' is non-zero, listing an abbreviation will also display where it | |
1173 was last defined. Example: > | |
1174 | |
1175 :verbose abbreviate | |
856 | 1176 ! teh the |
502 | 1177 Last set from /home/abcd/vim/abbr.vim |
1178 | |
1179 See |:verbose-cmd| for more information. | |
1180 | |
7 | 1181 :ab[breviate] {lhs} list the abbreviations that start with {lhs} |
1182 You may need to insert a CTRL-V (type it twice) to | |
1183 avoid that a typed {lhs} is expanded, since | |
1184 command-line abbreviations apply here. | |
1185 | |
2908 | 1186 :ab[breviate] [<expr>] [<buffer>] {lhs} {rhs} |
7 | 1187 add abbreviation for {lhs} to {rhs}. If {lhs} already |
1188 existed it is replaced with the new {rhs}. {rhs} may | |
1189 contain spaces. | |
838 | 1190 See |:map-<expr>| for the optional <expr> argument. |
2908 | 1191 See |:map-<buffer>| for the optional <buffer> argument. |
7 | 1192 |
1193 *:una* *:unabbreviate* | |
18928 | 1194 :una[bbreviate] [<buffer>] {lhs} |
1195 Remove abbreviation for {lhs} from the list. If none | |
7 | 1196 is found, remove abbreviations in which {lhs} matches |
1197 with the {rhs}. This is done so that you can even | |
1198 remove abbreviations after expansion. To avoid | |
1199 expansion insert a CTRL-V (type it twice). | |
1200 | |
1201 *:norea* *:noreabbrev* | |
2908 | 1202 :norea[bbrev] [<expr>] [<buffer>] [lhs] [rhs] |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16399
diff
changeset
|
1203 Same as ":ab", but no remapping for this {rhs}. |
7 | 1204 |
16944 | 1205 *:ca* *:cab* *:cabbrev* |
2908 | 1206 :ca[bbrev] [<expr>] [<buffer>] [lhs] [rhs] |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16399
diff
changeset
|
1207 Same as ":ab", but for Command-line mode only. |
7 | 1208 |
1209 *:cuna* *:cunabbrev* | |
18928 | 1210 :cuna[bbrev] [<buffer>] {lhs} |
1211 Same as ":una", but for Command-line mode only. | |
7 | 1212 |
1213 *:cnorea* *:cnoreabbrev* | |
2908 | 1214 :cnorea[bbrev] [<expr>] [<buffer>] [lhs] [rhs] |
7 | 1215 same as ":ab", but for Command-line mode only and no |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16399
diff
changeset
|
1216 remapping for this {rhs} |
7 | 1217 |
1218 *:ia* *:iabbrev* | |
2908 | 1219 :ia[bbrev] [<expr>] [<buffer>] [lhs] [rhs] |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16399
diff
changeset
|
1220 Same as ":ab", but for Insert mode only. |
7 | 1221 |
1222 *:iuna* *:iunabbrev* | |
18928 | 1223 :iuna[bbrev] [<buffer>] {lhs} |
1224 Same as ":una", but for insert mode only. | |
7 | 1225 |
1226 *:inorea* *:inoreabbrev* | |
2908 | 1227 :inorea[bbrev] [<expr>] [<buffer>] [lhs] [rhs] |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16399
diff
changeset
|
1228 Same as ":ab", but for Insert mode only and no |
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16399
diff
changeset
|
1229 remapping for this {rhs}. |
7 | 1230 |
1231 *:abc* *:abclear* | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16399
diff
changeset
|
1232 :abc[lear] [<buffer>] Remove all abbreviations. |
7 | 1233 |
1234 *:iabc* *:iabclear* | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16399
diff
changeset
|
1235 :iabc[lear] [<buffer>] Remove all abbreviations for Insert mode. |
7 | 1236 |
1237 *:cabc* *:cabclear* | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16399
diff
changeset
|
1238 :cabc[lear] [<buffer>] Remove all abbreviations for Command-line mode. |
7 | 1239 |
1240 *using_CTRL-V* | |
1241 It is possible to use special characters in the rhs of an abbreviation. | |
1242 CTRL-V has to be used to avoid the special meaning of most non printable | |
1243 characters. How many CTRL-Vs need to be typed depends on how you enter the | |
1244 abbreviation. This also applies to mappings. Let's use an example here. | |
1245 | |
1246 Suppose you want to abbreviate "esc" to enter an <Esc> character. When you | |
1247 type the ":ab" command in Vim, you have to enter this: (here ^V is a CTRL-V | |
1248 and ^[ is <Esc>) | |
1249 | |
1250 You type: ab esc ^V^V^V^V^V^[ | |
1251 | |
1252 All keyboard input is subjected to ^V quote interpretation, so | |
1253 the first, third, and fifth ^V characters simply allow the second, | |
1254 and fourth ^Vs, and the ^[, to be entered into the command-line. | |
1255 | |
1256 You see: ab esc ^V^V^[ | |
1257 | |
1258 The command-line contains two actual ^Vs before the ^[. This is | |
1259 how it should appear in your .exrc file, if you choose to go that | |
1260 route. The first ^V is there to quote the second ^V; the :ab | |
1261 command uses ^V as its own quote character, so you can include quoted | |
42 | 1262 whitespace or the | character in the abbreviation. The :ab command |
7 | 1263 doesn't do anything special with the ^[ character, so it doesn't need |
1264 to be quoted. (Although quoting isn't harmful; that's why typing 7 | |
1265 [but not 8!] ^Vs works.) | |
1266 | |
1267 Stored as: esc ^V^[ | |
1268 | |
1269 After parsing, the abbreviation's short form ("esc") and long form | |
1270 (the two characters "^V^[") are stored in the abbreviation table. | |
1271 If you give the :ab command with no arguments, this is how the | |
1272 abbreviation will be displayed. | |
1273 | |
1274 Later, when the abbreviation is expanded because the user typed in | |
1275 the word "esc", the long form is subjected to the same type of | |
1276 ^V interpretation as keyboard input. So the ^V protects the ^[ | |
42 | 1277 character from being interpreted as the "exit Insert mode" character. |
7 | 1278 Instead, the ^[ is inserted into the text. |
1279 | |
1280 Expands to: ^[ | |
1281 | |
1282 [example given by Steve Kirkendall] | |
1283 | |
1284 ============================================================================== | |
1285 3. Local mappings and functions *script-local* | |
1286 | |
1287 When using several Vim script files, there is the danger that mappings and | |
1288 functions used in one script use the same name as in other scripts. To avoid | |
1289 this, they can be made local to the script. | |
1290 | |
1291 *<SID>* *<SNR>* *E81* | |
1292 The string "<SID>" can be used in a mapping or menu. This requires that the | |
1293 '<' flag is not present in 'cpoptions'. | |
1294 When executing the map command, Vim will replace "<SID>" with the special | |
1295 key code <SNR>, followed by a number that's unique for the script, and an | |
1296 underscore. Example: > | |
1297 :map <SID>Add | |
1298 could define a mapping "<SNR>23_Add". | |
1299 | |
1300 When defining a function in a script, "s:" can be prepended to the name to | |
1301 make it local to the script. But when a mapping is executed from outside of | |
1302 the script, it doesn't know in which script the function was defined. To | |
1303 avoid this problem, use "<SID>" instead of "s:". The same translation is done | |
1304 as for mappings. This makes it possible to define a call to the function in | |
42 | 1305 a mapping. |
7 | 1306 |
1307 When a local function is executed, it runs in the context of the script it was | |
1308 defined in. This means that new functions and mappings it defines can also | |
1309 use "s:" or "<SID>" and it will use the same unique number as when the | |
1310 function itself was defined. Also, the "s:var" local script variables can be | |
1311 used. | |
1312 | |
1313 When executing an autocommand or a user command, it will run in the context of | |
1314 the script it was defined in. This makes it possible that the command calls a | |
1315 local function or uses a local mapping. | |
1316 | |
21594
5daca8504c63
patch 8.2.1347: cannot easily get the script ID
Bram Moolenaar <Bram@vim.org>
parents:
21499
diff
changeset
|
1317 In case the value is used in a context where <SID> cannot be correctly |
5daca8504c63
patch 8.2.1347: cannot easily get the script ID
Bram Moolenaar <Bram@vim.org>
parents:
21499
diff
changeset
|
1318 expanded, use the expand() function: > |
5daca8504c63
patch 8.2.1347: cannot easily get the script ID
Bram Moolenaar <Bram@vim.org>
parents:
21499
diff
changeset
|
1319 let &includexpr = expand('<SID>') .. 'My_includeexpr()' |
5daca8504c63
patch 8.2.1347: cannot easily get the script ID
Bram Moolenaar <Bram@vim.org>
parents:
21499
diff
changeset
|
1320 |
7 | 1321 Otherwise, using "<SID>" outside of a script context is an error. |
1322 | |
1323 If you need to get the script number to use in a complicated script, you can | |
625 | 1324 use this function: > |
22958 | 1325 func s:ScriptNumber() |
1326 return matchstr(expand('<SID>'), '<SNR>\zs\d\+\ze_') | |
1327 endfunc | |
7 | 1328 |
1329 The "<SNR>" will be shown when listing functions and mappings. This is useful | |
1330 to find out what they are defined to. | |
1331 | |
1332 The |:scriptnames| command can be used to see which scripts have been sourced | |
1333 and what their <SNR> number is. | |
1334 | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16399
diff
changeset
|
1335 This is all {not available when compiled without the |+eval| feature}. |
7 | 1336 |
1337 ============================================================================== | |
1338 4. User-defined commands *user-commands* | |
1339 | |
236 | 1340 It is possible to define your own Ex commands. A user-defined command can act |
7 | 1341 just like a built-in command (it can have a range or arguments, arguments can |
1342 be completed as filenames or buffer names, etc), except that when the command | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1969
diff
changeset
|
1343 is executed, it is transformed into a normal Ex command and then executed. |
7 | 1344 |
1345 For starters: See section |40.2| in the user manual. | |
1346 | |
2642 | 1347 *E183* *E841* *user-cmd-ambiguous* |
7 | 1348 All user defined commands must start with an uppercase letter, to avoid |
2642 | 1349 confusion with builtin commands. Exceptions are these builtin commands: |
1350 :Next | |
1351 :X | |
1352 They cannot be used for a user defined command. ":Print" is also an existing | |
1353 command, but it is deprecated and can be overruled. | |
1354 | |
1355 The other characters of the user command can be uppercase letters, lowercase | |
1356 letters or digits. When using digits, note that other commands that take a | |
1357 numeric argument may become ambiguous. For example, the command ":Cc2" could | |
1358 be the user command ":Cc2" without an argument, or the command ":Cc" with | |
1359 argument "2". It is advised to put a space between the command name and the | |
1360 argument to avoid these problems. | |
7 | 1361 |
236 | 1362 When using a user-defined command, the command can be abbreviated. However, if |
1363 an abbreviation is not unique, an error will be issued. Furthermore, a | |
7 | 1364 built-in command will always take precedence. |
1365 | |
1366 Example: > | |
1367 :command Rename ... | |
1368 :command Renumber ... | |
1369 :Rena " Means "Rename" | |
1370 :Renu " Means "Renumber" | |
1371 :Ren " Error - ambiguous | |
1372 :command Paste ... | |
1373 :P " The built-in :Print | |
1374 | |
1375 It is recommended that full names for user-defined commands are used in | |
1376 scripts. | |
1377 | |
1378 :com[mand] *:com* *:command* | |
236 | 1379 List all user-defined commands. When listing commands, |
16399
47d6e874955c
patch 8.1.1204: output of :command with address completion is not nice
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1380 the characters in the first columns are: |
7 | 1381 ! Command has the -bang attribute |
1382 " Command has the -register attribute | |
16399
47d6e874955c
patch 8.1.1204: output of :command with address completion is not nice
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1383 | Command has the -bar attribute |
7 | 1384 b Command is local to current buffer |
1385 (see below for details on attributes) | |
10004
8061455d9179
commit https://github.com/vim/vim/commit/818078ddfbb8cc2546f697c5675a251d095722ec
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
1386 The list can be filtered on command name with |
8061455d9179
commit https://github.com/vim/vim/commit/818078ddfbb8cc2546f697c5675a251d095722ec
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
1387 |:filter|, e.g., to list all commands with "Pyth" in |
8061455d9179
commit https://github.com/vim/vim/commit/818078ddfbb8cc2546f697c5675a251d095722ec
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
1388 the name: > |
8061455d9179
commit https://github.com/vim/vim/commit/818078ddfbb8cc2546f697c5675a251d095722ec
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
1389 filter Pyth command |
7 | 1390 |
1391 :com[mand] {cmd} List the user-defined commands that start with {cmd} | |
1392 | |
482 | 1393 *:command-verbose* |
1394 When 'verbose' is non-zero, listing a command will also display where it was | |
1395 last defined. Example: > | |
1396 | |
1397 :verbose command TOhtml | |
856 | 1398 < Name Args Range Complete Definition ~ |
1399 TOhtml 0 % :call Convert2HTML(<line1>, <line2>) ~ | |
1400 Last set from /usr/share/vim/vim-7.0/plugin/tohtml.vim ~ | |
1401 | |
483 | 1402 See |:verbose-cmd| for more information. |
482 | 1403 |
7 | 1404 *E174* *E182* |
23164 | 1405 :com[mand][!] [{attr}...] {cmd} {repl} |
7 | 1406 Define a user command. The name of the command is |
23164 | 1407 {cmd} and its replacement text is {repl}. The |
1408 command's attributes (see below) are {attr}. If the | |
1409 command already exists, an error is reported, unless a | |
1410 ! is specified, in which case the command is | |
1411 redefined. There is one exception: When sourcing a | |
1412 script again, a command that was previously defined in | |
1413 that script will be silently replaced. | |
15125
b101b193d5ff
patch 8.1.0573: cannot redefine user command without ! in same script
Bram Moolenaar <Bram@vim.org>
parents:
14864
diff
changeset
|
1414 |
7 | 1415 |
1416 :delc[ommand] {cmd} *:delc* *:delcommand* *E184* | |
1417 Delete the user-defined command {cmd}. | |
1418 | |
25796
60e4892dfa45
patch 8.2.3433: :delcommand does not take a -buffer option
Bram Moolenaar <Bram@vim.org>
parents:
25619
diff
changeset
|
1419 :delc[ommand] -buffer {cmd} *E1237* |
60e4892dfa45
patch 8.2.3433: :delcommand does not take a -buffer option
Bram Moolenaar <Bram@vim.org>
parents:
25619
diff
changeset
|
1420 Delete the user-defined command {cmd} that was defined |
60e4892dfa45
patch 8.2.3433: :delcommand does not take a -buffer option
Bram Moolenaar <Bram@vim.org>
parents:
25619
diff
changeset
|
1421 for the current buffer. |
60e4892dfa45
patch 8.2.3433: :delcommand does not take a -buffer option
Bram Moolenaar <Bram@vim.org>
parents:
25619
diff
changeset
|
1422 |
7 | 1423 :comc[lear] *:comc* *:comclear* |
1424 Delete all user-defined commands. | |
1425 | |
15125
b101b193d5ff
patch 8.1.0573: cannot redefine user command without ! in same script
Bram Moolenaar <Bram@vim.org>
parents:
14864
diff
changeset
|
1426 |
b101b193d5ff
patch 8.1.0573: cannot redefine user command without ! in same script
Bram Moolenaar <Bram@vim.org>
parents:
14864
diff
changeset
|
1427 Command attributes ~ |
7 | 1428 |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1969
diff
changeset
|
1429 User-defined commands are treated by Vim just like any other Ex commands. They |
236 | 1430 can have arguments, or have a range specified. Arguments are subject to |
1431 completion as filenames, buffers, etc. Exactly how this works depends upon the | |
7 | 1432 command's attributes, which are specified when the command is defined. |
1433 | |
1434 There are a number of attributes, split into four categories: argument | |
236 | 1435 handling, completion behavior, range handling, and special cases. The |
7 | 1436 attributes are described below, by category. |
1437 | |
1438 | |
15125
b101b193d5ff
patch 8.1.0573: cannot redefine user command without ! in same script
Bram Moolenaar <Bram@vim.org>
parents:
14864
diff
changeset
|
1439 Argument handling ~ |
b101b193d5ff
patch 8.1.0573: cannot redefine user command without ! in same script
Bram Moolenaar <Bram@vim.org>
parents:
14864
diff
changeset
|
1440 *E175* *E176* *:command-nargs* |
7 | 1441 By default, a user defined command will take no arguments (and an error is |
236 | 1442 reported if any are supplied). However, it is possible to specify that the |
1443 command can take arguments, using the -nargs attribute. Valid cases are: | |
7 | 1444 |
1445 -nargs=0 No arguments are allowed (the default) | |
15194 | 1446 -nargs=1 Exactly one argument is required, it includes spaces |
2826 | 1447 -nargs=* Any number of arguments are allowed (0, 1, or many), |
1448 separated by white space | |
7 | 1449 -nargs=? 0 or 1 arguments are allowed |
1450 -nargs=+ Arguments must be supplied, but any number are allowed | |
1451 | |
1236 | 1452 Arguments are considered to be separated by (unescaped) spaces or tabs in this |
2826 | 1453 context, except when there is one argument, then the white space is part of |
1454 the argument. | |
7 | 1455 |
1456 Note that arguments are used as text, not as expressions. Specifically, | |
1457 "s:var" will use the script-local variable in the script where the command was | |
1458 defined, not where it is invoked! Example: | |
1459 script1.vim: > | |
1460 :let s:error = "None" | |
1461 :command -nargs=1 Error echoerr <args> | |
1462 < script2.vim: > | |
1463 :source script1.vim | |
1464 :let s:error = "Wrong!" | |
1465 :Error s:error | |
1619 | 1466 Executing script2.vim will result in "None" being echoed. Not what you |
7 | 1467 intended! Calling a function may be an alternative. |
1468 | |
15125
b101b193d5ff
patch 8.1.0573: cannot redefine user command without ! in same script
Bram Moolenaar <Bram@vim.org>
parents:
14864
diff
changeset
|
1469 |
b101b193d5ff
patch 8.1.0573: cannot redefine user command without ! in same script
Bram Moolenaar <Bram@vim.org>
parents:
14864
diff
changeset
|
1470 Completion behavior ~ |
15194 | 1471 *:command-completion* *E179* *E180* *E181* |
15125
b101b193d5ff
patch 8.1.0573: cannot redefine user command without ! in same script
Bram Moolenaar <Bram@vim.org>
parents:
14864
diff
changeset
|
1472 *:command-complete* |
7 | 1473 By default, the arguments of user defined commands do not undergo completion. |
1474 However, by specifying one or the other of the following attributes, argument | |
1475 completion can be enabled: | |
1476 | |
13551
1fd0f8392946
patch 8.0.1649: no completion for argument list commands
Christian Brabandt <cb@256bit.org>
parents:
12559
diff
changeset
|
1477 -complete=arglist file names in argument list |
7 | 1478 -complete=augroup autocmd groups |
1479 -complete=buffer buffer names | |
3503 | 1480 -complete=behave :behave suboptions |
2970 | 1481 -complete=color color schemes |
7 | 1482 -complete=command Ex command (and arguments) |
2970 | 1483 -complete=compiler compilers |
2596 | 1484 -complete=cscope |:cscope| suboptions |
7 | 1485 -complete=dir directory names |
1486 -complete=environment environment variable names | |
1487 -complete=event autocommand events | |
1488 -complete=expression Vim expression | |
1489 -complete=file file and directory names | |
2970 | 1490 -complete=file_in_path file and directory names in |'path'| |
2444
3fbd9bce03f1
Support syntax and filetype completion for user commands. (Christian Brabandt)
Bram Moolenaar <bram@vim.org>
parents:
2420
diff
changeset
|
1491 -complete=filetype filetype names |'filetype'| |
7 | 1492 -complete=function function name |
1493 -complete=help help subjects | |
1494 -complete=highlight highlight groups | |
3503 | 1495 -complete=history :history suboptions |
2970 | 1496 -complete=locale locale names (as output of locale -a) |
11995
7df3dd3c0ac1
patch 8.0.0878: no completion for :mapclear
Christian Brabandt <cb@256bit.org>
parents:
11473
diff
changeset
|
1497 -complete=mapclear buffer argument |
7 | 1498 -complete=mapping mapping name |
1499 -complete=menu menus | |
10275
6d8b2da002e9
commit https://github.com/vim/vim/commit/9e507ca8a3e1535e62de4bd86374b0fcd18ef5b8
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
1500 -complete=messages |:messages| suboptions |
7 | 1501 -complete=option options |
9464
be72f4201a1d
commit https://github.com/vim/vim/commit/063b9d15abea041a5bfff3ffc4e219e26fd1d4fa
Christian Brabandt <cb@256bit.org>
parents:
9286
diff
changeset
|
1502 -complete=packadd optional package |pack-add| names |
2444
3fbd9bce03f1
Support syntax and filetype completion for user commands. (Christian Brabandt)
Bram Moolenaar <bram@vim.org>
parents:
2420
diff
changeset
|
1503 -complete=shellcmd Shell command |
2596 | 1504 -complete=sign |:sign| suboptions |
2444
3fbd9bce03f1
Support syntax and filetype completion for user commands. (Christian Brabandt)
Bram Moolenaar <bram@vim.org>
parents:
2420
diff
changeset
|
1505 -complete=syntax syntax file names |'syntax'| |
4803
220bdea4f579
updated for version 7.3.1148
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
1506 -complete=syntime |:syntime| suboptions |
7 | 1507 -complete=tag tags |
1508 -complete=tag_listfiles tags, file names are shown when CTRL-D is hit | |
3744 | 1509 -complete=user user names |
7 | 1510 -complete=var user variables |
1511 -complete=custom,{func} custom completion, defined via {func} | |
406 | 1512 -complete=customlist,{func} custom completion, defined via {func} |
7 | 1513 |
6259 | 1514 Note: That some completion methods might expand environment variables. |
1515 | |
557 | 1516 |
15125
b101b193d5ff
patch 8.1.0573: cannot redefine user command without ! in same script
Bram Moolenaar <Bram@vim.org>
parents:
14864
diff
changeset
|
1517 Custom completion ~ |
b101b193d5ff
patch 8.1.0573: cannot redefine user command without ! in same script
Bram Moolenaar <Bram@vim.org>
parents:
14864
diff
changeset
|
1518 *:command-completion-custom* |
b101b193d5ff
patch 8.1.0573: cannot redefine user command without ! in same script
Bram Moolenaar <Bram@vim.org>
parents:
14864
diff
changeset
|
1519 *:command-completion-customlist* *E467* *E468* |
7 | 1520 It is possible to define customized completion schemes via the "custom,{func}" |
406 | 1521 or the "customlist,{func}" completion argument. The {func} part should be a |
1619 | 1522 function with the following signature: > |
7 | 1523 |
1524 :function {func}(ArgLead, CmdLine, CursorPos) | |
1525 | |
406 | 1526 The function need not use all these arguments. The function should provide the |
1527 completion candidates as the return value. | |
1528 | |
1529 For the "custom" argument, the function should return the completion | |
1530 candidates one per line in a newline separated string. | |
1531 | |
1532 For the "customlist" argument, the function should return the completion | |
557 | 1533 candidates as a Vim List. Non-string items in the list are ignored. |
406 | 1534 |
1535 The function arguments are: | |
7 | 1536 ArgLead the leading portion of the argument currently being |
1537 completed on | |
1538 CmdLine the entire command line | |
557 | 1539 CursorPos the cursor position in it (byte index) |
406 | 1540 The function may use these for determining context. For the "custom" |
1541 argument, it is not necessary to filter candidates against the (implicit | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1969
diff
changeset
|
1542 pattern in) ArgLead. Vim will filter the candidates with its regexp engine |
406 | 1543 after function return, and this is probably more efficient in most cases. For |
1544 the "customlist" argument, Vim will not filter the returned completion | |
1545 candidates and the user supplied function should filter the candidates. | |
7 | 1546 |
1547 The following example lists user names to a Finger command > | |
1548 :com -complete=custom,ListUsers -nargs=1 Finger !finger <args> | |
1549 :fun ListUsers(A,L,P) | |
1550 : return system("cut -d: -f1 /etc/passwd") | |
1551 :endfun | |
1552 | |
406 | 1553 The following example completes filenames from the directories specified in |
1554 the 'path' option: > | |
1555 :com -nargs=1 -bang -complete=customlist,EditFileComplete | |
1556 \ EditFile edit<bang> <args> | |
1557 :fun EditFileComplete(A,L,P) | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1969
diff
changeset
|
1558 : return split(globpath(&path, a:A), "\n") |
406 | 1559 :endfun |
1560 < | |
2420
6de9efd58dc0
Updated runtime files. New netrw plugin version.
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
1561 This example does not work for file names with spaces! |
6de9efd58dc0
Updated runtime files. New netrw plugin version.
Bram Moolenaar <bram@vim.org>
parents:
2413
diff
changeset
|
1562 |
557 | 1563 |
15125
b101b193d5ff
patch 8.1.0573: cannot redefine user command without ! in same script
Bram Moolenaar <Bram@vim.org>
parents:
14864
diff
changeset
|
1564 Range handling ~ |
b101b193d5ff
patch 8.1.0573: cannot redefine user command without ! in same script
Bram Moolenaar <Bram@vim.org>
parents:
14864
diff
changeset
|
1565 *E177* *E178* *:command-range* *:command-count* |
236 | 1566 By default, user-defined commands do not accept a line number range. However, |
7 | 1567 it is possible to specify that the command does take a range (the -range |
1568 attribute), or that it takes an arbitrary count value, either in the line | |
1569 number position (-range=N, like the |:split| command) or as a "count" | |
1132 | 1570 argument (-count=N, like the |:Next| command). The count will then be |
1571 available in the argument with |<count>|. | |
1572 | |
1573 Possible attributes are: | |
7 | 1574 |
1575 -range Range allowed, default is current line | |
1576 -range=% Range allowed, default is whole file (1,$) | |
1577 -range=N A count (default N) which is specified in the line | |
2788 | 1578 number position (like |:split|); allows for zero line |
1579 number. | |
7 | 1580 -count=N A count (default N) which is specified either in the line |
171 | 1581 number position, or as an initial argument (like |:Next|). |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16399
diff
changeset
|
1582 -count acts like -count=0 |
7 | 1583 |
1584 Note that -range=N and -count=N are mutually exclusive - only one should be | |
1585 specified. | |
1586 | |
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
1587 *:command-addr* |
6424 | 1588 It is possible that the special characters in the range like ., $ or % which |
1589 by default correspond to the current line, last line and the whole buffer, | |
1590 relate to arguments, (loaded) buffers, windows or tab pages. | |
1591 | |
16399
47d6e874955c
patch 8.1.1204: output of :command with address completion is not nice
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1592 Possible values are (second column is the short name used in listing): |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16399
diff
changeset
|
1593 -addr=lines Range of lines (this is the default for -range) |
16399
47d6e874955c
patch 8.1.1204: output of :command with address completion is not nice
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1594 -addr=arguments arg Range for arguments |
47d6e874955c
patch 8.1.1204: output of :command with address completion is not nice
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1595 -addr=buffers buf Range for buffers (also not loaded buffers) |
47d6e874955c
patch 8.1.1204: output of :command with address completion is not nice
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1596 -addr=loaded_buffers load Range for loaded buffers |
47d6e874955c
patch 8.1.1204: output of :command with address completion is not nice
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1597 -addr=windows win Range for windows |
47d6e874955c
patch 8.1.1204: output of :command with address completion is not nice
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1598 -addr=tabs tab Range for tab pages |
47d6e874955c
patch 8.1.1204: output of :command with address completion is not nice
Bram Moolenaar <Bram@vim.org>
parents:
15194
diff
changeset
|
1599 -addr=quickfix qf Range for quickfix entries |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16399
diff
changeset
|
1600 -addr=other ? other kind of range; can use ".", "$" and "%" |
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16399
diff
changeset
|
1601 as with "lines" (this is the default for |
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16399
diff
changeset
|
1602 -count) |
6424 | 1603 |
15125
b101b193d5ff
patch 8.1.0573: cannot redefine user command without ! in same script
Bram Moolenaar <Bram@vim.org>
parents:
14864
diff
changeset
|
1604 |
b101b193d5ff
patch 8.1.0573: cannot redefine user command without ! in same script
Bram Moolenaar <Bram@vim.org>
parents:
14864
diff
changeset
|
1605 Special cases ~ |
b101b193d5ff
patch 8.1.0573: cannot redefine user command without ! in same script
Bram Moolenaar <Bram@vim.org>
parents:
14864
diff
changeset
|
1606 *:command-bang* *:command-bar* |
1132 | 1607 *:command-register* *:command-buffer* |
26148 | 1608 *:command-keepscript* |
7 | 1609 There are some special cases as well: |
1610 | |
1611 -bang The command can take a ! modifier (like :q or :w) | |
1612 -bar The command can be followed by a "|" and another command. | |
1613 A "|" inside the command argument is not allowed then. | |
1614 Also checks for a " to start a comment. | |
1615 -register The first argument to the command can be an optional | |
1616 register name (like :del, :put, :yank). | |
1617 -buffer The command will only be available in the current buffer. | |
26103
d079ab2ba260
patch 8.2.3584: "verbose set efm" reports location of the :compiler command
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1618 -keepscript Do not use the location of where the user command was |
d079ab2ba260
patch 8.2.3584: "verbose set efm" reports location of the :compiler command
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1619 defined for verbose messages, use the location of where |
d079ab2ba260
patch 8.2.3584: "verbose set efm" reports location of the :compiler command
Bram Moolenaar <Bram@vim.org>
parents:
26050
diff
changeset
|
1620 the user command was invoked. |
7 | 1621 |
1622 In the cases of the -count and -register attributes, if the optional argument | |
1623 is supplied, it is removed from the argument list and is available to the | |
1624 replacement text separately. | |
5340 | 1625 Note that these arguments can be abbreviated, but that is a deprecated |
1626 feature. Use the full name for new scripts. | |
7 | 1627 |
15125
b101b193d5ff
patch 8.1.0573: cannot redefine user command without ! in same script
Bram Moolenaar <Bram@vim.org>
parents:
14864
diff
changeset
|
1628 |
b101b193d5ff
patch 8.1.0573: cannot redefine user command without ! in same script
Bram Moolenaar <Bram@vim.org>
parents:
14864
diff
changeset
|
1629 Replacement text ~ |
25463
05f9e8f2016c
patch 8.2.3268: cannot use a block with :autocmd like with :command
Bram Moolenaar <Bram@vim.org>
parents:
25402
diff
changeset
|
1630 *:command-repl* |
25382
b80e4e9c4988
patch 8.2.3228: cannot use a simple block for the :command argument
Bram Moolenaar <Bram@vim.org>
parents:
24636
diff
changeset
|
1631 The {repl} argument is normally one long string, possibly with "|" separated |
b80e4e9c4988
patch 8.2.3228: cannot use a simple block for the :command argument
Bram Moolenaar <Bram@vim.org>
parents:
24636
diff
changeset
|
1632 commands. A special case is when the argument is "{", then the following |
b80e4e9c4988
patch 8.2.3228: cannot use a simple block for the :command argument
Bram Moolenaar <Bram@vim.org>
parents:
24636
diff
changeset
|
1633 lines, up to a line starting with "}" are used and |Vim9| syntax applies. |
b80e4e9c4988
patch 8.2.3228: cannot use a simple block for the :command argument
Bram Moolenaar <Bram@vim.org>
parents:
24636
diff
changeset
|
1634 Example: > |
b80e4e9c4988
patch 8.2.3228: cannot use a simple block for the :command argument
Bram Moolenaar <Bram@vim.org>
parents:
24636
diff
changeset
|
1635 :command MyCommand { |
b80e4e9c4988
patch 8.2.3228: cannot use a simple block for the :command argument
Bram Moolenaar <Bram@vim.org>
parents:
24636
diff
changeset
|
1636 echo 'hello' |
b80e4e9c4988
patch 8.2.3228: cannot use a simple block for the :command argument
Bram Moolenaar <Bram@vim.org>
parents:
24636
diff
changeset
|
1637 g:calledMyCommand = true |
b80e4e9c4988
patch 8.2.3228: cannot use a simple block for the :command argument
Bram Moolenaar <Bram@vim.org>
parents:
24636
diff
changeset
|
1638 } |
25521
2063b858cad9
patch 8.2.3297: cannot use all commands inside a {} block
Bram Moolenaar <Bram@vim.org>
parents:
25463
diff
changeset
|
1639 < *E1231* |
2063b858cad9
patch 8.2.3297: cannot use all commands inside a {} block
Bram Moolenaar <Bram@vim.org>
parents:
25463
diff
changeset
|
1640 There must be white space before the "{". No nesting is supported, inline |
2063b858cad9
patch 8.2.3297: cannot use all commands inside a {} block
Bram Moolenaar <Bram@vim.org>
parents:
25463
diff
changeset
|
1641 functions cannot be used. Commands where a "|" may appear in the argument, |
2063b858cad9
patch 8.2.3297: cannot use all commands inside a {} block
Bram Moolenaar <Bram@vim.org>
parents:
25463
diff
changeset
|
1642 such as commands with an expression argument, cannot be followed by a "|" and |
2063b858cad9
patch 8.2.3297: cannot use all commands inside a {} block
Bram Moolenaar <Bram@vim.org>
parents:
25463
diff
changeset
|
1643 another command. |
25382
b80e4e9c4988
patch 8.2.3228: cannot use a simple block for the :command argument
Bram Moolenaar <Bram@vim.org>
parents:
24636
diff
changeset
|
1644 |
23164 | 1645 The replacement text {repl} for a user defined command is scanned for special |
1646 escape sequences, using <...> notation. Escape sequences are replaced with | |
1647 values from the entered command line, and all other text is copied unchanged. | |
1648 The resulting string is executed as an Ex command. To avoid the replacement | |
1649 use <lt> in place of the initial <. Thus to include "<bang>" literally use | |
788 | 1650 "<lt>bang>". |
7 | 1651 |
1652 The valid escape sequences are | |
1653 | |
1654 *<line1>* | |
1655 <line1> The starting line of the command range. | |
1656 *<line2>* | |
1657 <line2> The final line of the command range. | |
12419
d216d9e8ac57
patch 8.0.1089: cannot get range count in user command
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
1658 *<range>* |
d216d9e8ac57
patch 8.0.1089: cannot get range count in user command
Christian Brabandt <cb@256bit.org>
parents:
11995
diff
changeset
|
1659 <range> The number of items in the command range: 0, 1 or 2 |
7 | 1660 *<count>* |
1661 <count> Any count supplied (as described for the '-range' | |
1662 and '-count' attributes). | |
1663 *<bang>* | |
1664 <bang> (See the '-bang' attribute) Expands to a ! if the | |
1665 command was executed with a ! modifier, otherwise | |
1666 expands to nothing. | |
22328 | 1667 *<mods>* *<q-mods>* *:command-modifiers* |
9230
f7fb117883ba
commit https://github.com/vim/vim/commit/63a60ded3fd584847a05dccf058026e682abad90
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
1668 <mods> The command modifiers, if specified. Otherwise, expands to |
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9230
diff
changeset
|
1669 nothing. Supported modifiers are |:aboveleft|, |:belowright|, |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9230
diff
changeset
|
1670 |:botright|, |:browse|, |:confirm|, |:hide|, |:keepalt|, |
9737
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1671 |:keepjumps|, |:keepmarks|, |:keeppatterns|, |:leftabove|, |
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1672 |:lockmarks|, |:noswapfile| |:rightbelow|, |:silent|, |:tab|, |
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1673 |:topleft|, |:verbose|, and |:vertical|. |
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1674 Note that these are not yet supported: |:noautocmd|, |
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
1675 |:sandbox| and |:unsilent|. |
9230
f7fb117883ba
commit https://github.com/vim/vim/commit/63a60ded3fd584847a05dccf058026e682abad90
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
1676 Examples: > |
f7fb117883ba
commit https://github.com/vim/vim/commit/63a60ded3fd584847a05dccf058026e682abad90
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
1677 command! -nargs=+ -complete=file MyEdit |
f7fb117883ba
commit https://github.com/vim/vim/commit/63a60ded3fd584847a05dccf058026e682abad90
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
1678 \ for f in expand(<q-args>, 0, 1) | |
f7fb117883ba
commit https://github.com/vim/vim/commit/63a60ded3fd584847a05dccf058026e682abad90
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
1679 \ exe '<mods> split ' . f | |
f7fb117883ba
commit https://github.com/vim/vim/commit/63a60ded3fd584847a05dccf058026e682abad90
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
1680 \ endfor |
f7fb117883ba
commit https://github.com/vim/vim/commit/63a60ded3fd584847a05dccf058026e682abad90
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
1681 |
f7fb117883ba
commit https://github.com/vim/vim/commit/63a60ded3fd584847a05dccf058026e682abad90
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
1682 function! SpecialEdit(files, mods) |
f7fb117883ba
commit https://github.com/vim/vim/commit/63a60ded3fd584847a05dccf058026e682abad90
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
1683 for f in expand(a:files, 0, 1) |
f7fb117883ba
commit https://github.com/vim/vim/commit/63a60ded3fd584847a05dccf058026e682abad90
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
1684 exe a:mods . ' split ' . f |
f7fb117883ba
commit https://github.com/vim/vim/commit/63a60ded3fd584847a05dccf058026e682abad90
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
1685 endfor |
f7fb117883ba
commit https://github.com/vim/vim/commit/63a60ded3fd584847a05dccf058026e682abad90
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
1686 endfunction |
f7fb117883ba
commit https://github.com/vim/vim/commit/63a60ded3fd584847a05dccf058026e682abad90
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
1687 command! -nargs=+ -complete=file Sedit |
f7fb117883ba
commit https://github.com/vim/vim/commit/63a60ded3fd584847a05dccf058026e682abad90
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
1688 \ call SpecialEdit(<q-args>, <q-mods>) |
f7fb117883ba
commit https://github.com/vim/vim/commit/63a60ded3fd584847a05dccf058026e682abad90
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
1689 < |
7 | 1690 *<reg>* *<register>* |
1691 <reg> (See the '-register' attribute) The optional register, | |
236 | 1692 if specified. Otherwise, expands to nothing. <register> |
7 | 1693 is a synonym for this. |
1694 *<args>* | |
1695 <args> The command arguments, exactly as supplied (but as | |
1696 noted above, any count or register can consume some | |
1697 of the arguments, which are then not part of <args>). | |
1698 <lt> A single '<' (Less-Than) character. This is needed if you | |
1699 want to get a literal copy of one of these escape sequences | |
1700 into the expansion - for example, to get <bang>, use | |
1701 <lt>bang>. | |
1702 | |
1703 *<q-args>* | |
1704 If the first two characters of an escape sequence are "q-" (for example, | |
1705 <q-args>) then the value is quoted in such a way as to make it a valid value | |
1706 for use in an expression. This uses the argument as one single value. | |
300 | 1707 When there is no argument <q-args> is an empty string. |
1088 | 1708 *<f-args>* |
7 | 1709 To allow commands to pass their arguments on to a user-defined function, there |
236 | 1710 is a special form <f-args> ("function args"). This splits the command |
1236 | 1711 arguments at spaces and tabs, quotes each argument individually, and the |
7 | 1712 <f-args> sequence is replaced by the comma-separated list of quoted arguments. |
856 | 1713 See the Mycmd example below. If no arguments are given <f-args> is removed. |
1088 | 1714 To embed whitespace into an argument of <f-args>, prepend a backslash. |
1715 <f-args> replaces every pair of backslashes (\\) with one backslash. A | |
1716 backslash followed by a character other than white space or a backslash | |
1717 remains unmodified. Overview: | |
1718 | |
1719 command <f-args> ~ | |
1720 XX ab 'ab' | |
1721 XX a\b 'a\b' | |
1722 XX a\ b 'a b' | |
1723 XX a\ b 'a ', 'b' | |
1724 XX a\\b 'a\b' | |
1725 XX a\\ b 'a\', 'b' | |
1726 XX a\\\b 'a\\b' | |
1727 XX a\\\ b 'a\ b' | |
1728 XX a\\\\b 'a\\b' | |
1729 XX a\\\\ b 'a\\', 'b' | |
7 | 1730 |
1731 Examples > | |
1732 | |
1733 " Delete everything after here to the end | |
1734 :com Ddel +,$d | |
1735 | |
1736 " Rename the current buffer | |
1737 :com -nargs=1 -bang -complete=file Ren f <args>|w<bang> | |
1738 | |
1739 " Replace a range with the contents of a file | |
1740 " (Enter this all as one line) | |
1741 :com -range -nargs=1 -complete=file | |
1742 Replace <line1>-pu_|<line1>,<line2>d|r <args>|<line1>d | |
1743 | |
1744 " Count the number of lines in the range | |
42 | 1745 :com! -range -nargs=0 Lines echo <line2> - <line1> + 1 "lines" |
7 | 1746 |
1747 " Call a user function (example of <f-args>) | |
1748 :com -nargs=* Mycmd call Myfunc(<f-args>) | |
1749 | |
1750 When executed as: > | |
1751 :Mycmd arg1 arg2 | |
1752 This will invoke: > | |
1753 :call Myfunc("arg1","arg2") | |
1754 | |
1755 :" A more substantial example | |
1756 :function Allargs(command) | |
1619 | 1757 : let i = 0 |
1758 : while i < argc() | |
1759 : if filereadable(argv(i)) | |
1760 : execute "e " . argv(i) | |
7 | 1761 : execute a:command |
1762 : endif | |
1763 : let i = i + 1 | |
1764 : endwhile | |
1765 :endfunction | |
1766 :command -nargs=+ -complete=command Allargs call Allargs(<q-args>) | |
1767 | |
1768 The command Allargs takes any Vim command(s) as argument and executes it on all | |
1769 files in the argument list. Usage example (note use of the "e" flag to ignore | |
1770 errors and the "update" command to write modified buffers): > | |
1771 :Allargs %s/foo/bar/ge|update | |
1772 This will invoke: > | |
1773 :call Allargs("%s/foo/bar/ge|update") | |
1774 < | |
23164 | 1775 If the command is defined in Vim9 script (a script that starts with |
1776 `:vim9script` and in a `:def` function) then {repl} will be executed as in Vim9 | |
1777 script. Thus this depends on where the command is defined, not where it is | |
1778 used. | |
1779 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1969
diff
changeset
|
1780 When defining a user command in a script, it will be able to call functions |
7 | 1781 local to the script and use mappings local to the script. When the user |
1782 invokes the user command, it will run in the context of the script it was | |
1783 defined in. This matters if |<SID>| is used in a command. | |
1784 | |
14421 | 1785 vim:tw=78:ts=8:noet:ft=help:norl: |