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