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