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