|
42
|
1 *map.txt* For Vim version 7.0aa. Last change: 2004 Dec 29
|
|
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|
|
|
|
13 2. Abbreviations |abbreviations|
|
|
|
14 3. Local mappings and functions |script-local|
|
|
|
15 4. User-defined commands |user-commands|
|
|
|
16
|
|
|
17 ==============================================================================
|
|
|
18 1. Key mapping *key-mapping* *mapping* *macro*
|
|
|
19
|
|
|
20 Key mapping is used to change the meaning of typed keys. The most common use
|
|
|
21 is to define a sequence commands for a function key. Example: >
|
|
|
22
|
|
|
23 :map <F2> a<C-R>=strftime("%c")<CR><Esc>
|
|
|
24
|
|
|
25 This appends the current date and time after the cursor. (in <> notation |<>|)
|
|
|
26
|
|
|
27 There are commands to enter new mappings, remove mappings and list mappings.
|
|
|
28 See |map-overview| for the various forms of "map" and their relationships with
|
|
|
29 modes.
|
|
|
30
|
|
|
31 {lhs} means left-hand-side *{lhs}*
|
|
|
32 {rhs} means right-hand-side *{rhs}*
|
|
|
33
|
|
|
34 :map {lhs} {rhs} *:map*
|
|
|
35 :nm[ap] {lhs} {rhs} *:nm* *:nmap*
|
|
|
36 :vm[ap] {lhs} {rhs} *:vm* *:vmap*
|
|
|
37 :om[ap] {lhs} {rhs} *:om* *:omap*
|
|
|
38 :map! {lhs} {rhs} *:map!*
|
|
|
39 :im[ap] {lhs} {rhs} *:im* *:imap*
|
|
|
40 :lm[ap] {lhs} {rhs} *:lm* *:lmap*
|
|
|
41 :cm[ap] {lhs} {rhs} *:cm* *:cmap*
|
|
|
42 Map the key sequence {lhs} to {rhs} for the modes
|
|
|
43 where the map command applies. The result, including
|
|
|
44 {rhs}, is then further scanned for mappings. This
|
|
|
45 allows for nested and recursive use of mappings.
|
|
|
46
|
|
|
47
|
|
|
48 :no[remap] {lhs} {rhs} *:no* *:noremap*
|
|
|
49 :nn[oremap] {lhs} {rhs} *:nn* *:nnoremap*
|
|
|
50 :vn[oremap] {lhs} {rhs} *:vn* *:vnoremap*
|
|
|
51 :ono[remap] {lhs} {rhs} *:ono* *:onoremap*
|
|
|
52 :no[remap]! {lhs} {rhs} *:no!* *:noremap!*
|
|
|
53 :ino[remap] {lhs} {rhs} *:ino* *:inoremap*
|
|
|
54 :ln[oremap] {lhs} {rhs} *:ln* *:lnoremap*
|
|
|
55 :cno[remap] {lhs} {rhs} *:cno* *:cnoremap*
|
|
|
56 Map the key sequence {lhs} to {rhs} for the modes
|
|
|
57 where the map command applies. Disallow mapping of
|
|
|
58 {rhs}, to avoid nested and recursive mappings. Often
|
|
|
59 used to redefine a command. {not in Vi}
|
|
|
60
|
|
|
61
|
|
|
62 :unm[ap] {lhs} *:unm* *:unmap*
|
|
|
63 :nun[map] {lhs} *:nun* *:nunmap*
|
|
|
64 :vu[nmap] {lhs} *:vu* *:vunmap*
|
|
|
65 :ou[nmap] {lhs} *:ou* *:ounmap*
|
|
|
66 :unm[ap]! {lhs} *:unm!* *:unmap!*
|
|
|
67 :iu[nmap] {lhs} *:iu* *:iunmap*
|
|
|
68 :lu[nmap] {lhs} *:lu* *:lunmap*
|
|
|
69 :cu[nmap] {lhs} *:cu* *:cunmap*
|
|
|
70 Remove the mapping of {lhs} for the modes where the
|
|
|
71 map command applies. The mapping may remain defined
|
|
|
72 for other modes where it applies.
|
|
|
73 Note: Trailing spaces are included in the {lhs}. This
|
|
|
74 unmap does NOT work: >
|
|
|
75 :map @@ foo
|
|
|
76 :unmap @@ | print
|
|
|
77
|
|
|
78 :mapc[lear] *:mapc* *:mapclear*
|
|
|
79 :nmapc[lear] *:nmapc* *:nmapclear*
|
|
|
80 :vmapc[lear] *:vmapc* *:vmapclear*
|
|
|
81 :omapc[lear] *:omapc* *:omapclear*
|
|
|
82 :mapc[lear]! *:mapc!* *:mapclear!*
|
|
|
83 :imapc[lear] *:imapc* *:imapclear*
|
|
|
84 :lmapc[lear] *:lmapc* *:lmapclear*
|
|
|
85 :cmapc[lear] *:cmapc* *:cmapclear*
|
|
|
86 Remove ALL mappings for the modes where the map
|
|
|
87 command applies. {not in Vi}
|
|
|
88 Warning: This also removes the default mappings.
|
|
|
89
|
|
|
90 :map
|
|
|
91 :nm[ap]
|
|
|
92 :vm[ap]
|
|
|
93 :om[ap]
|
|
|
94 :map!
|
|
|
95 :im[ap]
|
|
|
96 :lm[ap]
|
|
|
97 :cm[ap]
|
|
|
98 List all key mappings for the modes where the map
|
|
|
99 command applies. Note that ":map" and ":map!" are
|
|
|
100 used most often, because they include the other modes.
|
|
|
101
|
|
|
102 :map {lhs} *:map_l*
|
|
|
103 :nm[ap] {lhs} *:nmap_l*
|
|
|
104 :vm[ap] {lhs} *:vmap_l*
|
|
|
105 :om[ap] {lhs} *:omap_l*
|
|
|
106 :map! {lhs} *:map_l!*
|
|
|
107 :im[ap] {lhs} *:imap_l*
|
|
|
108 :lm[ap] {lhs} *:lmap_l*
|
|
|
109 :cm[ap] {lhs} *:cmap_l*
|
|
|
110 List the key mappings for the key sequences starting
|
|
|
111 with {lhs} in the modes where the map command applies.
|
|
|
112 {not in Vi}
|
|
|
113
|
|
|
114 These commands are used to map a key or key sequence to a string of
|
|
|
115 characters. You can use this to put command sequences under function keys,
|
|
|
116 translate one key into another, etc. See |:mkexrc| for how to save and
|
|
|
117 restore the current mappings.
|
|
|
118
|
|
|
119 *:map-local* *:map-<buffer>* *E224* *E225*
|
|
|
120 If the first argument to one of these commands is "<buffer>" it will apply to
|
|
|
121 mappings locally to the current buffer only. Example: >
|
|
|
122 :map <buffer> ,w /[.,;]<CR>
|
|
|
123 Then you can map ",w" to something else in another buffer: >
|
|
|
124 :map <buffer> ,w /[#&!]<CR>
|
|
|
125 The local buffer mappings are used before the global ones.
|
|
|
126 The "<buffer>" argument can also be used to clear mappings: >
|
|
|
127 :unmap <buffer> ,w
|
|
|
128 :mapclear <buffer>
|
|
|
129 Local mappings are also cleared when a buffer is deleted, but not when it is
|
|
|
130 unloaded. Just like local option values.
|
|
|
131
|
|
|
132 *:map-<silent>* *:map-silent*
|
|
|
133 To define a mapping which will not be echoed on the command line, add
|
|
|
134 "<silent>" as the first argument. Example: >
|
|
|
135 :map <silent> ,h /Header<CR>
|
|
|
136 The search string will not be echoed when using this mapping. Messages from
|
|
|
137 the executed command are still given though. To shut them up too, add a
|
|
|
138 ":silent" in the executed command: >
|
|
|
139 :map <silent> ,h :exe ":silent normal /Header\r"<CR>
|
|
|
140 Prompts will still be given, e.g., for inputdialog().
|
|
|
141 Using "<silent>" for an abbreviation is possible, but will cause redrawing of
|
|
|
142 the command line to fail.
|
|
|
143
|
|
|
144 *:map-<script>* *:map-script*
|
|
|
145 If the first argument to one of these commands is "<script>" and it is used to
|
|
|
146 define a new mapping or abbreviation, the mapping will only remap characters
|
|
|
147 in the {rhs} using mappings that were defined local to a script, starting with
|
|
|
148 "<SID>". This can be used to avoid that mappings from outside a script
|
|
|
149 interfere (e.g., when CTRL-V is remapped in mswin.vim), but do use other
|
|
|
150 mappings defined in the script.
|
|
|
151 Note: ":map <script>" and ":noremap <script>" do the same thing. The
|
|
|
152 "<script>" overrules the command name. Using ":noremap <script>" is
|
|
|
153 preferred, because it's clearer that remapping is (mostly) disabled.
|
|
|
154
|
|
|
155 *:map-<unique>* *E226* *E227*
|
|
|
156 If the first argument to one of these commands is "<unique>" and it is used to
|
|
|
157 define a new mapping or abbreviation, the command will fail if the mapping or
|
|
|
158 abbreviation already exists. Example: >
|
|
|
159 :map <unique> ,w /[#&!]<CR>
|
|
|
160 When defining a local mapping, there will also be a check if a global map
|
|
|
161 already exists which is equal.
|
|
|
162 Example of what will fail: >
|
|
|
163 :map ,w /[#&!]<CR>
|
|
|
164 :map <buffer> <unique> ,w /[.,;]<CR>
|
|
|
165
|
|
|
166 "<buffer>", "<silent>", "<script>" and "<unique>" can be used in any order.
|
|
|
167 They must appear right after the command, before any other arguments.
|
|
|
168
|
|
|
169
|
|
|
170 MAPPING AND MODES
|
|
|
171
|
|
|
172 There are five sets of mappings
|
|
|
173 - For Normal mode: When typing commands.
|
|
|
174 - For Visual mode: When typing commands while the Visual area is highlighted.
|
|
|
175 - For Operator-pending mode: When an operator is pending (after "d", "y", "c",
|
|
|
176 etc.). Example: ":omap { w" makes "y{" work like "yw" and "d{" like "dw".
|
|
|
177 - For Insert mode. These are also used in Replace mode.
|
|
|
178 - For Command-line mode: When entering a ":" or "/" command.
|
|
|
179
|
|
|
180 There are no separate mappings for Select mode. The same as for Visual mode
|
|
|
181 are used |Select-mode-mapping|.
|
|
|
182
|
|
|
183 Special case: While typing a count for a command in Normal mode, mapping zero
|
|
|
184 is disabled. This makes it possible to map zero without making it impossible
|
|
|
185 to type a count with a zero.
|
|
|
186
|
|
|
187 *map-overview* *map-modes*
|
|
|
188 Overview of which map command works in which mode:
|
|
|
189
|
|
|
190 commands: modes: ~
|
|
|
191 Normal Visual Operator-pending ~
|
|
|
192 :map :noremap :unmap :mapclear yes yes yes
|
|
|
193 :nmap :nnoremap :nunmap :nmapclear yes - -
|
|
|
194 :vmap :vnoremap :vunmap :vmapclear - yes -
|
|
|
195 :omap :onoremap :ounmap :omapclear - - yes
|
|
|
196
|
|
|
197 Insert Command-line Lang-Arg ~
|
|
|
198 :map! :noremap! :unmap! :mapclear! yes yes -
|
|
|
199 :imap :inoremap :iunmap :imapclear yes - -
|
|
|
200 :cmap :cnoremap :cunmap :cmapclear - yes -
|
|
|
201 :lmap :lnoremap :lunmap :lmapclear yes* yes* yes*
|
|
|
202
|
|
|
203 The original Vi did not have separate mappings for
|
|
|
204 Normal/Visual/Operator-pending mode and for Insert/Command-line mode.
|
|
|
205 Therefore the ":map" and ":map!" commands enter and display mappings for
|
|
|
206 several modes. In Vim you can use the ":nmap", ":vmap", ":omap", ":cmap" and
|
|
|
207 ":imap" commands to enter mappings for each mode separately.
|
|
|
208
|
|
|
209 To enter a mapping for Normal and Visual mode, but not Operator-pending mode,
|
|
|
210 first define it for all three modes, then unmap it for Operator-pending mode:
|
|
|
211 :map xx something-difficult
|
|
|
212 :ounmap xx
|
|
|
213 Likewise for a mapping for Visual and Operator-pending mode or Normal and
|
|
|
214 Operator-pending mode.
|
|
|
215
|
|
|
216 *language-mapping*
|
|
|
217 ":lmap" defines a mapping that applies to:
|
|
|
218 - Insert mode
|
|
|
219 - Command-line mode
|
|
|
220 - when entering a search pattern
|
|
|
221 - the argument of the commands that accept a text character, such as "r" and
|
|
|
222 "f"
|
|
|
223 - for the input() line
|
|
|
224 Generally: Whenever a character is to be typed that is part of the text in the
|
|
|
225 buffer, not a Vim command character. "Lang-Arg" isn't really another mode,
|
|
|
226 it's just used here for this situation.
|
|
|
227 The simplest way to load a set of related language mappings is by using the
|
|
|
228 'keymap' option. See |45.5|.
|
|
|
229 In Insert mode and in Command-line mode the mappings can be disabled with
|
|
|
230 the CTRL-^ command |i_CTRL-^| |c_CTRL-^|. When starting to enter a normal
|
|
|
231 command line (not a search pattern) the mappings are disabled until a CTRL-^
|
|
|
232 is typed. The state last used is remembered for Insert mode and Search
|
|
|
233 patterns separately. The state for Insert mode is also used when typing a
|
|
|
234 character as an argument to command like "f" or "t".
|
|
|
235 Language mappings will never be applied to already mapped characters. They
|
|
|
236 are only used for typed characters. This assumes that the language mapping
|
|
|
237 was already done when typing the mapping.
|
|
|
238
|
|
|
239 *map-multibyte*
|
|
|
240 It is possible to map multibyte characters, but only the whole character. You
|
|
|
241 cannot map the first byte only. This was done to prevent problems in this
|
|
|
242 scenario: >
|
|
|
243 :set encoding=latin1
|
|
|
244 :imap <M-C> foo
|
|
|
245 :set encoding=utf-8
|
|
|
246 The mapping for <M-C> is defined with the latin1 encoding, resulting in a 0xc3
|
|
|
247 byte. If you type the character á (0xea <M-a>) in UTF-8 encoding this is the
|
|
|
248 two bytes 0xc3 0xa1. You don't want the 0xc3 byte to be mapped then,
|
|
|
249 otherwise it would be impossible to type the á character.
|
|
|
250
|
|
|
251 *map-listing*
|
|
|
252 When listing mappings the characters in the first two columns are:
|
|
|
253
|
|
|
254 CHAR MODE ~
|
|
|
255 <Space> Normal, Visual and Operator-pending
|
|
|
256 n Normal
|
|
|
257 v Visual
|
|
|
258 o Operator-pending
|
|
|
259 ! Insert and Command-line
|
|
|
260 i Insert
|
|
|
261 l ":lmap" mappings for Insert, Command-line and Lang-Arg
|
|
|
262 c Command-line
|
|
|
263
|
|
|
264 Just before the {rhs} a special character can appear:
|
|
|
265 * indicates that it is not remappable
|
|
|
266 & indicates that only script-local mappings are remappable
|
|
|
267 @ indicates a buffer-local mapping
|
|
|
268
|
|
|
269 Everything from the first non-blank after {lhs} up to the end of the line
|
|
|
270 (or '|') is considered to be part of {rhs}. This allows the {rhs} to end
|
|
|
271 with a space.
|
|
|
272
|
|
|
273 Note: When using mappings for Visual mode, you can use the "'<" mark, which
|
|
|
274 is the start of the last selected Visual area in the current buffer |'<|.
|
|
|
275
|
|
|
276 *map_backslash*
|
|
|
277 Note that only CTRL-V is mentioned here as a special character for mappings
|
|
|
278 and abbreviations. When 'cpoptions' does not contain 'B', a backslash can
|
|
|
279 also be used like CTRL-V. The <> notation can be fully used then |<>|. But
|
|
|
280 you cannot use "<C-V>" like CTRL-V to escape the special meaning of what
|
|
|
281 follows.
|
|
|
282
|
|
|
283 To map a backslash, or use a backslash literally in the {rhs}, the special
|
|
|
284 sequence "<Bslash>" can be used. This avoids the need to double backslashes
|
|
|
285 when using nested mappings.
|
|
|
286
|
|
|
287 *map-ambiguous*
|
|
|
288 When two mappings start with the same sequence of characters, they are
|
|
|
289 ambiguous. Example: >
|
|
|
290 :imap aa foo
|
|
|
291 :imap aaa bar
|
|
|
292 When Vim has read "aa", it will need to get another character to be able to
|
|
|
293 decide if "aa" or "aaa" should be mapped. This means that after typing "aa"
|
|
|
294 that mapping won't get expanded yet, Vim is waiting for another character.
|
|
|
295 If you type a space, then "foo" will get inserted, plus the space. If you
|
|
|
296 type "a", then "bar" will get inserted.
|
|
|
297 {Vi does not allow ambiguous mappings}
|
|
|
298
|
|
|
299 *map_CTRL_C*
|
|
|
300 It's not possible to use a CTRL-C in the {lhs}. You just can't map CTRL-C.
|
|
|
301 The reason is that CTRL-C must always be available to break a running command.
|
|
|
302 Exception: When using the GUI version on MS-Windows CTRL-C can be mapped to
|
|
|
303 allow a Copy command to the clipboard. Use CTRL-Break to interrupt Vim.
|
|
|
304
|
|
|
305 *map_space_in_lhs*
|
|
|
306 To include a space in {lhs} precede it with a CTRL-V (type two CTRL-Vs for
|
|
|
307 each space).
|
|
|
308 *map_space_in_rhs*
|
|
|
309 If you want a {rhs} that starts with a space, use "<Space>". To be fully Vi
|
|
|
310 compatible (but unreadable) don't use the |<>| notation, precede {rhs} with a
|
|
|
311 single CTRL-V (you have to type CTRL-V two times).
|
|
|
312 *map_empty_rhs*
|
|
|
313 You can create an empty {rhs} by typing nothing after a single CTRL-V (you
|
|
|
314 have to type CTRL-V two times). Unfortunately, you cannot do this in a vimrc
|
|
|
315 file.
|
|
|
316 *<Nop>*
|
|
|
317 A easier way to get a mapping that doesn't produce anything, is to use "<Nop>"
|
|
|
318 for the {rhs}. This only works when the |<>| notation is enabled. For
|
|
|
319 example, to make sure that function key 8 does nothing at all: >
|
|
|
320 :map <F8> <Nop>
|
|
|
321 :map! <F8> <Nop>
|
|
|
322 <
|
|
|
323 *<Leader>* *mapleader*
|
|
|
324 To define a mapping which uses the "mapleader" variable, the special string
|
|
|
325 "<Leader>" can be used. It is replaced with the string value of "mapleader".
|
|
|
326 If "mapleader" is not set or empty, a backslash is used instead. Example: >
|
|
|
327 :map <Leader>A oanother line<Esc>
|
|
|
328 Works like: >
|
|
|
329 :map \A oanother line<Esc>
|
|
|
330 But after: >
|
|
|
331 :let mapleader = ","
|
|
|
332 It works like: >
|
|
|
333 :map ,A oanother line<Esc>
|
|
|
334
|
|
|
335 Note that the value of "mapleader" is used at the moment the mapping is
|
|
|
336 defined. Changing "mapleader" after that has no effect for already defined
|
|
|
337 mappings.
|
|
|
338
|
|
|
339 *<LocalLeader>* *maplocalleader*
|
|
|
340 Just like <Leader>, except that it uses "maplocalleader" instead of
|
|
|
341 "mapleader". <LocalLeader> is to be used for mappings which are local to a
|
|
|
342 buffer. Example: >
|
|
|
343 :map <LocalLeader>q \DoItNow
|
|
|
344 <
|
|
|
345 In a global plugin <Leader> should be used and in a filetype plugin
|
|
|
346 <LocalLeader>. "mapleader" and "maplocalleader" can be equal. Although, if
|
|
|
347 you make them different, there is a smaller chance of mappings from global
|
|
|
348 plugins to clash with mappings for filetype plugins. For example, you could
|
|
|
349 keep "mapleader" at the default backslash, and set "maplocalleader" to an
|
|
|
350 underscore.
|
|
|
351
|
|
|
352 *map-<SID>*
|
|
|
353 In a script the special key name "<SID>" can be used to define a mapping
|
|
|
354 that's local to the script. See |<SID>| for details.
|
|
|
355
|
|
|
356 *<Plug>*
|
|
|
357 The special key name "<Plug>" can be used for an internal mapping, which is
|
|
|
358 not to be matched with any key sequence. This is useful in plugins
|
|
|
359 |using-<Plug>|.
|
|
|
360
|
|
|
361 *<Char>* *<Char->*
|
|
|
362 To map a character by its decimal, octal or hexadecimal number the <Char>
|
|
|
363 construct can be used:
|
|
|
364 <Char-123> character 123
|
|
|
365 <Char-033> character 27
|
|
|
366 <Char-0x7f> character 127
|
|
|
367 This is useful to specify a (multi-byte) character in a 'keymap' file.
|
|
|
368 Upper and lowercase differences are ignored.
|
|
|
369
|
|
|
370 *map-comments*
|
|
|
371 It is not possible to put a comment after these commands, because the '"'
|
|
|
372 character is considered to be part of the {lhs} or {rhs}.
|
|
|
373
|
|
|
374 *map_bar*
|
|
|
375 Since the '|' character is used to separate a map command from the next
|
|
|
376 command, you will have to do something special to include a '|' in {rhs}.
|
|
|
377 There are three methods:
|
|
|
378 use works when example ~
|
|
|
379 <Bar> '<' is not in 'cpoptions' :map _l :!ls <Bar> more^M
|
|
|
380 \| 'b' is not in 'cpoptions' :map _l :!ls \| more^M
|
|
|
381 ^V| always, in Vim and Vi :map _l :!ls ^V| more^M
|
|
|
382
|
|
|
383 (here ^V stands for CTRL-V; to get one CTRL-V you have to type it twice; you
|
|
|
384 cannot use the <> notation "<C-V>" here).
|
|
|
385
|
|
|
386 All three work when you use the default setting for 'cpoptions'.
|
|
|
387
|
|
|
388 When 'b' is present in 'cpoptions', "\|" will be recognized as a mapping
|
|
|
389 ending in a '\' and then another command. This is Vi compatible, but
|
|
|
390 illogical when compared to other commands.
|
|
|
391
|
|
|
392 *map_return*
|
|
|
393 When you have a mapping that contains an Ex command, you need to put a line
|
|
|
394 terminator after it to have it executed. The use of <CR> is recommended for
|
|
|
395 this (see |<>|). Example: >
|
|
|
396 :map _ls :!ls -l %<CR>:echo "the end"<CR>
|
|
|
397
|
|
|
398 To avoid mapping of the characters you type in insert or Command-line mode,
|
|
|
399 type a CTRL-V first. The mapping in Insert mode is disabled if the 'paste'
|
|
|
400 option is on.
|
|
|
401
|
|
|
402 Note that when an error is encountered (that causes an error message or beep)
|
|
|
403 the rest of the mapping is not executed. This is Vi-compatible.
|
|
|
404
|
|
|
405 Note that the second character (argument) of the commands @zZtTfF[]rm'`"v
|
|
|
406 and CTRL-X is not mapped. This was done to be able to use all the named
|
|
|
407 registers and marks, even when the command with the same name has been
|
|
|
408 mapped.
|
|
|
409
|
|
|
410 *map-which-keys*
|
|
|
411 If you are going to map something, you will need to choose which key(s) to use
|
|
|
412 for the {lhs}. You will have to avoid keys that are used for Vim commands,
|
|
|
413 otherwise you would not be able to use those commands anymore. Here are a few
|
|
|
414 suggestions:
|
|
|
415 - Function keys <F2>, <F3>, etc.. Also the shifted function keys <S-F1>,
|
|
|
416 <S-F2>, etc. Note that <F1> is already used for the help command.
|
|
|
417 - Meta-keys (with the ALT key pressed).
|
|
|
418 - Use the '_' or ',' character and then any other character. The "_" and ","
|
|
|
419 commands do exist in Vim (see |_| and |,|), but you probably never use them.
|
|
|
420 - Use a key that is a synonym for another command. For example: CTRL-P and
|
|
|
421 CTRL-N. Use an extra character to allow more mappings.
|
|
|
422
|
|
|
423 See the file "index" for keys that are not used and thus can be mapped without
|
|
|
424 losing any builtin function. You can also use ":help {key}^D" to find out if
|
|
|
425 a key is used for some command. ({key} is the specific key you want to find
|
|
|
426 out about, ^D is CTRL-D).
|
|
|
427
|
|
|
428 *map-examples*
|
|
|
429 A few examples (given as you type them, for "<CR>" you type four characters;
|
|
|
430 the '<' flag must not be present in 'cpoptions' for this to work). >
|
|
|
431
|
|
|
432 :map <F3> o#include
|
|
|
433 :map <M-g> /foo<CR>cwbar<Esc>
|
|
|
434 :map _x d/END/e<CR>
|
|
|
435 :map! qq quadrillion questions
|
|
|
436 <
|
|
|
437 *map-typing*
|
|
|
438 Vim will compare what you type with the start of a mapped sequence. If there
|
|
|
439 is an incomplete match, it will get more characters until there either is a
|
|
|
440 complete match or until there is no match at all. Example: If you map! "qq",
|
|
|
441 the first 'q' will not appear on the screen until you type another
|
|
|
442 character. This is because Vim cannot know if the next character will be a
|
|
|
443 'q' or not. If the 'timeout' option is on (which is the default) Vim will
|
|
|
444 only wait for one second (or as long as specified with the 'timeoutlen'
|
|
|
445 option). After that it assumes that the 'q' is to be interpreted as such. If
|
|
|
446 you type slowly, or your system is slow, reset the 'timeout' option. Then you
|
|
|
447 might want to set the 'ttimeout' option.
|
|
|
448
|
|
|
449 *map-keys-fails*
|
|
|
450 There is one situation where key codes might not be recognized:
|
|
|
451 - Vim can only read part of the key code. Mostly this is only the first
|
|
|
452 character. This happens on some Unix versions in an xterm.
|
|
|
453 - The key code is after character(s) that are mapped. E.g., "<F1><F1>" or
|
|
|
454 "g<F1>".
|
|
|
455 The result is that the key code is not recognized in this situation, and the
|
|
|
456 mapping fails.
|
|
|
457 There are two actions needed to avoid this problem:
|
|
|
458 - Remove the 'K' flag from 'cpoptions'. This will make Vim wait for the rest
|
|
|
459 of the characters of the function key.
|
|
|
460 - When using <F1> to <F4> the actual key code generated may correspond to
|
|
|
461 <xF1> to <xF4>. There are mappings from <xF1> to <F1>, <xF2> to <F2>, etc.,
|
|
|
462 but these are not recognized after another half a mapping. Make sure the
|
|
|
463 key codes for <F1> to <F4> are correct: >
|
|
|
464 :set <F1>=<type CTRL-V><type F1>
|
|
|
465 < Type the <F1> as four characters. The part after the "=" must be done with
|
|
|
466 the actual keys, not the literal text.
|
|
|
467 Another solution is to use the actual key code in the mapping for the second
|
|
|
468 special key: >
|
|
|
469 :map <F1><Esc>OP :echo "yes"<CR>
|
|
|
470 Don't type a real <Esc>, Vim will recognize the key code and replace it with
|
|
|
471 <F1> anyway.
|
|
|
472
|
|
|
473 *recursive_mapping*
|
|
|
474 If you include the {lhs} in the {rhs} you have a recursive mapping. When
|
|
|
475 {lhs} is typed, it will be replaced with {rhs}. When the {lhs} which is
|
|
|
476 included in {rhs} is encountered it will be replaced with {rhs}, and so on.
|
|
|
477 This makes it possible to repeat a command an infinite number of times. The
|
|
|
478 only problem is that the only way to stop this is by causing an error. The
|
|
|
479 macros to solve a maze uses this, look there for an example. There is one
|
|
|
480 exception: If the {rhs} starts with {lhs}, the first character is not mapped
|
|
|
481 again (this is Vi compatible).
|
|
|
482 For example: >
|
|
|
483 :map ab abcd
|
|
|
484 will execute the "a" command and insert "bcd" in the text. The "ab" in the
|
|
|
485 {rhs} will not be mapped again.
|
|
|
486
|
|
|
487 If you want to exchange the meaning of two keys you should use the :noremap
|
|
|
488 command. For example: >
|
|
|
489 :noremap k j
|
|
|
490 :noremap j k
|
|
|
491 This will exchange the cursor up and down commands.
|
|
|
492
|
|
|
493 With the normal :map command, when the 'remap' option is on, mapping takes
|
|
|
494 place until the text is found not to be a part of a {lhs}. For example, if
|
|
|
495 you use: >
|
|
|
496 :map x y
|
|
|
497 :map y x
|
|
|
498 Vim will replace x with y, and then y with x, etc. When this has happened
|
|
|
499 'maxmapdepth' times (default 1000), Vim will give the error message
|
|
|
500 "recursive mapping".
|
|
|
501
|
|
|
502 *:map-undo*
|
|
|
503 If you include an undo command inside a mapped sequence, this will bring the
|
|
|
504 text back in the state before executing the macro. This is compatible with
|
|
|
505 the original Vi, as long as there is only one undo command in the mapped
|
|
|
506 sequence (having two undo commands in a mapped sequence did not make sense
|
|
|
507 in the original Vi, you would get back the text before the first undo).
|
|
|
508
|
|
|
509 *:map-special-keys*
|
|
|
510 There are three ways to map a special key:
|
|
|
511 1. The Vi-compatible method: Map the key code. Often this is a sequence that
|
|
|
512 starts with <Esc>. To enter a mapping like this you type ":map " and then
|
|
|
513 you have to type CTRL-V before hitting the function key. Note that when
|
|
|
514 the key code for the key is in the termcap (the t_ options), it will
|
|
|
515 automatically be translated into the internal code and become the second
|
|
|
516 way of mapping (unless the 'k' flag is included in 'cpoptions').
|
|
|
517 2. The second method is to use the internal code for the function key. To
|
|
|
518 enter such a mapping type CTRL-K and then hit the function key, or use
|
|
|
519 the form "#1", "#2", .. "#9", "#0", "<Up>", "<S-Down>", "<S-F7>", etc.
|
|
|
520 (see table of keys |key-notation|, all keys from <Up> can be used). The
|
|
|
521 first ten function keys can be defined in two ways: Just the number, like
|
|
|
522 "#2", and with "<F>", like "<F2>". Both stand for function key 2. "#0"
|
|
|
523 refers to function key 10, defined with option 't_f10', which may be
|
|
|
524 function key zero on some keyboards. The <> form cannot be used when
|
|
|
525 'cpoptions' includes the '<' flag.
|
|
|
526 3. Use the termcap entry, with the form <t_xx>, where "xx" is the name of the
|
|
|
527 termcap entry. Any string entry can be used. For example: >
|
|
|
528 :map <t_F3> G
|
|
|
529 < Maps function key 13 to "G". This does not work if 'cpoptions' includes
|
|
|
530 the '<' flag.
|
|
|
531
|
|
|
532 The advantage of the second and third method is that the mapping will work on
|
|
|
533 different terminals without modification (the function key will be
|
|
|
534 translated into the same internal code or the actual key code, no matter what
|
|
|
535 terminal you are using. The termcap must be correct for this to work, and you
|
|
|
536 must use the same mappings).
|
|
|
537
|
|
|
538 DETAIL: Vim first checks if a sequence from the keyboard is mapped. If it
|
|
|
539 isn't the terminal key codes are tried (see |terminal-options|). If a
|
|
|
540 terminal code is found it is replaced with the internal code. Then the check
|
|
|
541 for a mapping is done again (so you can map an internal code to something
|
|
|
542 else). What is written into the script file depends on what is recognized.
|
|
|
543 If the terminal key code was recognized as a mapping the key code itself is
|
|
|
544 written to the script file. If it was recognized as a terminal code the
|
|
|
545 internal code is written to the script file.
|
|
|
546
|
|
|
547 ==============================================================================
|
|
|
548 2. Abbreviations *abbreviations* *Abbreviations*
|
|
|
549
|
|
|
550 Abbreviations are used in Insert mode, Replace mode and Command-line mode.
|
|
|
551 If you enter a word that is an abbreviation, it is replaced with the word it
|
|
|
552 stands for. This can be used to save typing for often used long words. And
|
|
|
553 you can use it to automatically correct obvious spelling errors.
|
|
|
554 Examples:
|
|
|
555
|
|
|
556 :iab ms MicroSoft
|
|
|
557 :iab tihs this
|
|
|
558
|
|
|
559 There are three types of abbreviations:
|
|
|
560
|
|
|
561 full-id The "full-id" type consists entirely of keyword characters (letters
|
|
|
562 and characters from 'iskeyword' option). This is the most common
|
|
|
563 abbreviation.
|
|
|
564
|
|
|
565 Examples: "foo", "g3", "-1"
|
|
|
566
|
|
|
567 end-id The "end-id" type ends in a keyword character, but all the other
|
|
|
568 characters are not keyword characters.
|
|
|
569
|
|
|
570 Examples: "#i", "..f", "$/7"
|
|
|
571
|
|
|
572 non-id The "non-id" type ends in a non-keyword character, the other
|
|
|
573 characters may be of any type, excluding space and Tab. {this type
|
|
|
574 is not supported by Vi}
|
|
|
575
|
|
|
576 Examples: "def#", "4/7$"
|
|
|
577
|
|
|
578 Examples of strings that cannot be abbreviations: "a.b", "#def", "a b", "_$r"
|
|
|
579
|
|
|
580 An abbreviation is only recognized when you type a non-keyword character.
|
|
|
581 This can also be the <Esc> that ends insert mode or the <CR> that ends a
|
|
|
582 command. The non-keyword character which ends the abbreviation is inserted
|
|
|
583 after the expanded abbreviation. An exception to this is the character <C-]>,
|
|
|
584 which is used to expand an abbreviation without inserting any extra
|
|
|
585 characters.
|
|
|
586
|
|
|
587 Example: >
|
|
|
588 :ab hh hello
|
|
|
589 < "hh<Space>" is expanded to "hello<Space>"
|
|
|
590 "hh<C-]>" is expanded to "hello"
|
|
|
591
|
|
|
592 The characters before the cursor must match the abbreviation. Each type has
|
|
|
593 an additional rule:
|
|
|
594
|
|
|
595 full-id In front of the match is a non-keyword character, or this is where
|
|
|
596 the line or insertion starts. Exception: When the abbreviation is
|
|
|
597 only one character, it is not recognized if there is a non-keyword
|
|
|
598 character in front of it, other than a space or a <Tab>.
|
|
|
599
|
|
|
600 end-id In front of the match is a keyword character, or a space or a <Tab>,
|
|
|
601 or this is where the line or insertion starts.
|
|
|
602
|
|
|
603 non-id In front of the match is a space, <Tab> or the start of the line or
|
|
|
604 the insertion.
|
|
|
605
|
|
|
606 Examples: ({CURSOR} is where you type a non-keyword character) >
|
|
|
607 :ab foo four old otters
|
|
|
608 < " foo{CURSOR}" is expanded to " four old otters"
|
|
|
609 " foobar{CURSOR}" is not expanded
|
|
|
610 "barfoo{CURSOR}" is not expanded
|
|
|
611 >
|
|
|
612 :ab #i #include
|
|
|
613 < "#i{CURSOR}" is expanded to "#include"
|
|
|
614 ">#i{CURSOR}" is not expanded
|
|
|
615 >
|
|
42
|
616 :ab ;; <endofline>
|
|
7
|
617 < "test;;" is not expanded
|
|
|
618 "test ;;" is expanded to "test <endofline>"
|
|
|
619
|
|
|
620 To avoid the abbreviation in insert mode: Type part of the abbreviation, exit
|
|
|
621 insert mode with <Esc>, re-enter insert mode with "a" and type the rest. Or
|
|
|
622 type CTRL-V before the character after the abbreviation.
|
|
|
623 To avoid the abbreviation in Command-line mode: Type CTRL-V twice somewhere in
|
|
|
624 the abbreviation to avoid it to be replaced. A CTRL-V in front of a normal
|
|
|
625 character is mostly ignored otherwise.
|
|
|
626
|
|
|
627 It is possible to move the cursor after an abbreviation: >
|
|
|
628 :iab if if ()<Left>
|
|
|
629 This does not work if 'cpoptions' includes the '<' flag. |<>|
|
|
|
630
|
|
|
631 You can even do more complicated things. For example, to consume the space
|
|
|
632 typed after an abbreviation: >
|
|
|
633 func Eatchar(pat)
|
|
|
634 let c = nr2char(getchar())
|
|
|
635 return (c =~ a:pat) ? '' : c
|
|
|
636 endfunc
|
|
|
637 iabbr <silent> if if ()<Left><C-R>=Eatchar('\s')<CR>
|
|
|
638
|
|
|
639 There are no default abbreviations.
|
|
|
640
|
|
|
641 Abbreviations are never recursive. You can use ":ab f f-o-o" without any
|
|
|
642 problem. But abbreviations can be mapped. {some versions of Vi support
|
|
|
643 recursive abbreviations, for no apparent reason}
|
|
|
644
|
|
|
645 Abbreviations are disabled if the 'paste' option is on.
|
|
|
646
|
|
|
647 *:abbreviate-local* *:abbreviate-<buffer>*
|
|
|
648 Just like mappings, abbreviations can be local to a buffer. This is mostly
|
|
|
649 used in a |filetype-plugin| file. Example for a C plugin file: >
|
|
|
650 :abb <buffer> FF for (i = 0; i < ; ++i)
|
|
|
651 <
|
|
|
652 *:ab* *:abbreviate*
|
|
|
653 :ab[breviate] list all abbreviations. The character in the first
|
|
|
654 column indicates the mode where the abbreviation is
|
|
|
655 used: 'i' for insert mode, 'c' for Command-line
|
|
|
656 mode, '!' for both. These are the same as for
|
|
|
657 mappings, see |map-listing|.
|
|
|
658
|
|
|
659 :ab[breviate] {lhs} list the abbreviations that start with {lhs}
|
|
|
660 You may need to insert a CTRL-V (type it twice) to
|
|
|
661 avoid that a typed {lhs} is expanded, since
|
|
|
662 command-line abbreviations apply here.
|
|
|
663
|
|
|
664 :ab[breviate] {lhs} {rhs}
|
|
|
665 add abbreviation for {lhs} to {rhs}. If {lhs} already
|
|
|
666 existed it is replaced with the new {rhs}. {rhs} may
|
|
|
667 contain spaces.
|
|
|
668
|
|
|
669 *:una* *:unabbreviate*
|
|
|
670 :una[bbreviate] {lhs} Remove abbreviation for {lhs} from the list. If none
|
|
|
671 is found, remove abbreviations in which {lhs} matches
|
|
|
672 with the {rhs}. This is done so that you can even
|
|
|
673 remove abbreviations after expansion. To avoid
|
|
|
674 expansion insert a CTRL-V (type it twice).
|
|
|
675
|
|
|
676 *:norea* *:noreabbrev*
|
|
|
677 :norea[bbrev] [lhs] [rhs]
|
|
|
678 same as ":ab", but no remapping for this {rhs} {not
|
|
|
679 in Vi}
|
|
|
680
|
|
|
681 *:ca* *:cabbrev*
|
|
|
682 :ca[bbrev] [lhs] [rhs] same as ":ab", but for Command-line mode only. {not
|
|
|
683 in Vi}
|
|
|
684
|
|
|
685 *:cuna* *:cunabbrev*
|
|
|
686 :cuna[bbrev] {lhs} same as ":una", but for Command-line mode only. {not
|
|
|
687 in Vi}
|
|
|
688
|
|
|
689 *:cnorea* *:cnoreabbrev*
|
|
|
690 :cnorea[bbrev] [lhs] [rhs]
|
|
|
691 same as ":ab", but for Command-line mode only and no
|
|
|
692 remapping for this {rhs} {not in Vi}
|
|
|
693
|
|
|
694 *:ia* *:iabbrev*
|
|
|
695 :ia[bbrev] [lhs] [rhs] same as ":ab", but for Insert mode only. {not in Vi}
|
|
|
696
|
|
|
697 *:iuna* *:iunabbrev*
|
|
|
698 :iuna[bbrev] {lhs} same as ":una", but for insert mode only. {not in
|
|
|
699 Vi}
|
|
|
700
|
|
|
701 *:inorea* *:inoreabbrev*
|
|
|
702 :inorea[bbrev] [lhs] [rhs]
|
|
|
703 same as ":ab", but for Insert mode only and no
|
|
|
704 remapping for this {rhs} {not in Vi}
|
|
|
705
|
|
|
706 *:abc* *:abclear*
|
|
|
707 :abc[lear] Remove all abbreviations. {not in Vi}
|
|
|
708
|
|
|
709 *:iabc* *:iabclear*
|
|
|
710 :iabc[lear] Remove all abbreviations for Insert mode. {not in Vi}
|
|
|
711
|
|
|
712 *:cabc* *:cabclear*
|
|
|
713 :cabc[lear] Remove all abbreviations for Command-line mode. {not
|
|
|
714 in Vi}
|
|
|
715
|
|
|
716 *using_CTRL-V*
|
|
|
717 It is possible to use special characters in the rhs of an abbreviation.
|
|
|
718 CTRL-V has to be used to avoid the special meaning of most non printable
|
|
|
719 characters. How many CTRL-Vs need to be typed depends on how you enter the
|
|
|
720 abbreviation. This also applies to mappings. Let's use an example here.
|
|
|
721
|
|
|
722 Suppose you want to abbreviate "esc" to enter an <Esc> character. When you
|
|
|
723 type the ":ab" command in Vim, you have to enter this: (here ^V is a CTRL-V
|
|
|
724 and ^[ is <Esc>)
|
|
|
725
|
|
|
726 You type: ab esc ^V^V^V^V^V^[
|
|
|
727
|
|
|
728 All keyboard input is subjected to ^V quote interpretation, so
|
|
|
729 the first, third, and fifth ^V characters simply allow the second,
|
|
|
730 and fourth ^Vs, and the ^[, to be entered into the command-line.
|
|
|
731
|
|
|
732 You see: ab esc ^V^V^[
|
|
|
733
|
|
|
734 The command-line contains two actual ^Vs before the ^[. This is
|
|
|
735 how it should appear in your .exrc file, if you choose to go that
|
|
|
736 route. The first ^V is there to quote the second ^V; the :ab
|
|
|
737 command uses ^V as its own quote character, so you can include quoted
|
|
42
|
738 whitespace or the | character in the abbreviation. The :ab command
|
|
7
|
739 doesn't do anything special with the ^[ character, so it doesn't need
|
|
|
740 to be quoted. (Although quoting isn't harmful; that's why typing 7
|
|
|
741 [but not 8!] ^Vs works.)
|
|
|
742
|
|
|
743 Stored as: esc ^V^[
|
|
|
744
|
|
|
745 After parsing, the abbreviation's short form ("esc") and long form
|
|
|
746 (the two characters "^V^[") are stored in the abbreviation table.
|
|
|
747 If you give the :ab command with no arguments, this is how the
|
|
|
748 abbreviation will be displayed.
|
|
|
749
|
|
|
750 Later, when the abbreviation is expanded because the user typed in
|
|
|
751 the word "esc", the long form is subjected to the same type of
|
|
|
752 ^V interpretation as keyboard input. So the ^V protects the ^[
|
|
42
|
753 character from being interpreted as the "exit Insert mode" character.
|
|
7
|
754 Instead, the ^[ is inserted into the text.
|
|
|
755
|
|
|
756 Expands to: ^[
|
|
|
757
|
|
|
758 [example given by Steve Kirkendall]
|
|
|
759
|
|
|
760 ==============================================================================
|
|
|
761 3. Local mappings and functions *script-local*
|
|
|
762
|
|
|
763 When using several Vim script files, there is the danger that mappings and
|
|
|
764 functions used in one script use the same name as in other scripts. To avoid
|
|
|
765 this, they can be made local to the script.
|
|
|
766
|
|
|
767 *<SID>* *<SNR>* *E81*
|
|
|
768 The string "<SID>" can be used in a mapping or menu. This requires that the
|
|
|
769 '<' flag is not present in 'cpoptions'.
|
|
|
770 When executing the map command, Vim will replace "<SID>" with the special
|
|
|
771 key code <SNR>, followed by a number that's unique for the script, and an
|
|
|
772 underscore. Example: >
|
|
|
773 :map <SID>Add
|
|
|
774 could define a mapping "<SNR>23_Add".
|
|
|
775
|
|
|
776 When defining a function in a script, "s:" can be prepended to the name to
|
|
|
777 make it local to the script. But when a mapping is executed from outside of
|
|
|
778 the script, it doesn't know in which script the function was defined. To
|
|
|
779 avoid this problem, use "<SID>" instead of "s:". The same translation is done
|
|
|
780 as for mappings. This makes it possible to define a call to the function in
|
|
42
|
781 a mapping.
|
|
7
|
782
|
|
|
783 When a local function is executed, it runs in the context of the script it was
|
|
|
784 defined in. This means that new functions and mappings it defines can also
|
|
|
785 use "s:" or "<SID>" and it will use the same unique number as when the
|
|
|
786 function itself was defined. Also, the "s:var" local script variables can be
|
|
|
787 used.
|
|
|
788
|
|
|
789 When executing an autocommand or a user command, it will run in the context of
|
|
|
790 the script it was defined in. This makes it possible that the command calls a
|
|
|
791 local function or uses a local mapping.
|
|
|
792
|
|
|
793 Otherwise, using "<SID>" outside of a script context is an error.
|
|
|
794
|
|
|
795 If you need to get the script number to use in a complicated script, you can
|
|
|
796 use this trick: >
|
|
|
797 :map <SID>xx <SID>xx
|
|
|
798 :let s:sid = maparg("<SID>xx")
|
|
|
799 :unmap <SID>xx
|
|
|
800 And remove the trailing "xx".
|
|
|
801
|
|
|
802 The "<SNR>" will be shown when listing functions and mappings. This is useful
|
|
|
803 to find out what they are defined to.
|
|
|
804
|
|
|
805 The |:scriptnames| command can be used to see which scripts have been sourced
|
|
|
806 and what their <SNR> number is.
|
|
|
807
|
|
|
808 This is all {not in Vi} and {not available when compiled without the +eval
|
|
|
809 feature}.
|
|
|
810
|
|
|
811 ==============================================================================
|
|
|
812 4. User-defined commands *user-commands*
|
|
|
813
|
|
|
814 It is possible to define your own Ex commands. A user-defined command can act
|
|
|
815 just like a built-in command (it can have a range or arguments, arguments can
|
|
|
816 be completed as filenames or buffer names, etc), except that when the command
|
|
|
817 is executed, it is transformed into a normal ex command and then executed.
|
|
|
818
|
|
|
819 For starters: See section |40.2| in the user manual.
|
|
|
820
|
|
|
821 *E183* *user-cmd-ambiguous*
|
|
|
822 All user defined commands must start with an uppercase letter, to avoid
|
|
|
823 confusion with builtin commands. (There are a few builtin commands, notably
|
|
|
824 :Next, :Print and :X, which do start with an uppercase letter. The builtin
|
|
|
825 will always take precedence in these cases). The other characters of the user
|
|
|
826 command can be uppercase letters, lowercase letters or digits. When using
|
|
|
827 digits, note that other commands that take a numeric argument may become
|
|
|
828 ambiguous. For example, the command ":Cc2" could be the user command ":Cc2"
|
|
|
829 without an argument, or the command ":Cc" with argument "2". It is advised to
|
|
|
830 put a space between the command name and the argument to avoid these problems.
|
|
|
831
|
|
|
832 When using a user-defined command, the command can be abbreviated. However, if
|
|
|
833 an abbreviation is not unique, an error will be issued. Furthermore, a
|
|
|
834 built-in command will always take precedence.
|
|
|
835
|
|
|
836 Example: >
|
|
|
837 :command Rename ...
|
|
|
838 :command Renumber ...
|
|
|
839 :Rena " Means "Rename"
|
|
|
840 :Renu " Means "Renumber"
|
|
|
841 :Ren " Error - ambiguous
|
|
|
842 :command Paste ...
|
|
|
843 :P " The built-in :Print
|
|
|
844
|
|
|
845 It is recommended that full names for user-defined commands are used in
|
|
|
846 scripts.
|
|
|
847
|
|
|
848 :com[mand] *:com* *:command*
|
|
|
849 List all user-defined commands. When listing commands,
|
|
|
850 the characters in the first two columns are
|
|
|
851 ! Command has the -bang attribute
|
|
|
852 " Command has the -register attribute
|
|
|
853 b Command is local to current buffer
|
|
|
854 (see below for details on attributes)
|
|
|
855
|
|
|
856 :com[mand] {cmd} List the user-defined commands that start with {cmd}
|
|
|
857
|
|
|
858 *E174* *E182*
|
|
|
859 :com[mand][!] [{attr}...] {cmd} {rep}
|
|
|
860 Define a user command. The name of the command is
|
|
|
861 {cmd} and its replacement text is {rep}. The command's
|
|
|
862 attributes (see below) are {attr}. If the command
|
|
|
863 already exists, an error is reported, unless a ! is
|
|
|
864 specified, in which case the command is redefined.
|
|
|
865
|
|
|
866 :delc[ommand] {cmd} *:delc* *:delcommand* *E184*
|
|
|
867 Delete the user-defined command {cmd}.
|
|
|
868
|
|
|
869 :comc[lear] *:comc* *:comclear*
|
|
|
870 Delete all user-defined commands.
|
|
|
871
|
|
|
872 Command attributes
|
|
|
873
|
|
|
874 User-defined commands are treated by Vim just like any other ex commands. They
|
|
|
875 can have arguments, or have a range specified. Arguments are subject to
|
|
|
876 completion as filenames, buffers, etc. Exactly how this works depends upon the
|
|
|
877 command's attributes, which are specified when the command is defined.
|
|
|
878
|
|
|
879 There are a number of attributes, split into four categories: argument
|
|
|
880 handling, completion behavior, range handling, and special cases. The
|
|
|
881 attributes are described below, by category.
|
|
|
882
|
|
|
883 Argument handling *E175* *E176*
|
|
|
884
|
|
|
885 By default, a user defined command will take no arguments (and an error is
|
|
|
886 reported if any are supplied). However, it is possible to specify that the
|
|
|
887 command can take arguments, using the -nargs attribute. Valid cases are:
|
|
|
888
|
|
|
889 -nargs=0 No arguments are allowed (the default)
|
|
|
890 -nargs=1 Exactly one argument is required
|
|
|
891 -nargs=* Any number of arguments are allowed (0, 1, or many)
|
|
|
892 -nargs=? 0 or 1 arguments are allowed
|
|
|
893 -nargs=+ Arguments must be supplied, but any number are allowed
|
|
|
894
|
|
|
895 Arguments are considered to be separated by (unescaped) spaces or Tabs in this
|
|
|
896 context.
|
|
|
897
|
|
|
898 Note that arguments are used as text, not as expressions. Specifically,
|
|
|
899 "s:var" will use the script-local variable in the script where the command was
|
|
|
900 defined, not where it is invoked! Example:
|
|
|
901 script1.vim: >
|
|
|
902 :let s:error = "None"
|
|
|
903 :command -nargs=1 Error echoerr <args>
|
|
|
904 < script2.vim: >
|
|
|
905 :source script1.vim
|
|
|
906 :let s:error = "Wrong!"
|
|
|
907 :Error s:error
|
|
|
908 Executing script2.vim will result in "None" to be echoed. Not what you
|
|
|
909 intended! Calling a function may be an alternative.
|
|
|
910
|
|
|
911 Completion behavior *:command-completion*
|
|
|
912 *E179* *E180* *E181*
|
|
|
913 By default, the arguments of user defined commands do not undergo completion.
|
|
|
914 However, by specifying one or the other of the following attributes, argument
|
|
|
915 completion can be enabled:
|
|
|
916
|
|
|
917 -complete=augroup autocmd groups
|
|
|
918 -complete=buffer buffer names
|
|
|
919 -complete=command Ex command (and arguments)
|
|
|
920 -complete=dir directory names
|
|
|
921 -complete=environment environment variable names
|
|
|
922 -complete=event autocommand events
|
|
|
923 -complete=expression Vim expression
|
|
|
924 -complete=file file and directory names
|
|
|
925 -complete=function function name
|
|
|
926 -complete=help help subjects
|
|
|
927 -complete=highlight highlight groups
|
|
|
928 -complete=mapping mapping name
|
|
|
929 -complete=menu menus
|
|
|
930 -complete=option options
|
|
|
931 -complete=tag tags
|
|
|
932 -complete=tag_listfiles tags, file names are shown when CTRL-D is hit
|
|
|
933 -complete=var user variables
|
|
|
934 -complete=custom,{func} custom completion, defined via {func}
|
|
|
935
|
|
|
936 Custom completion *:command-completion-custom*
|
|
|
937 *E467* *E468*
|
|
|
938 It is possible to define customized completion schemes via the "custom,{func}"
|
|
|
939 completion argument. The {func} part should be a function with the following
|
|
|
940 prototype >
|
|
|
941
|
|
|
942 :function {func}(ArgLead, CmdLine, CursorPos)
|
|
|
943
|
|
|
944 The function need not use all these arguments, but it should provide the
|
|
|
945 completion candidates as the return value, one per line in a newline separated
|
|
|
946 string. The function arguments are:
|
|
|
947 ArgLead the leading portion of the argument currently being
|
|
|
948 completed on
|
|
|
949 CmdLine the entire command line
|
|
|
950 CursorPos the cursor position in it
|
|
|
951 The function may use these for determining context. It is not necessary to
|
|
|
952 filter candidates against the (implicit pattern in) ArgLead. Vim will do
|
|
|
953 filter the candidates with its regexp engine after function return, and this
|
|
|
954 is probably more efficient in most cases.
|
|
|
955
|
|
|
956 The following example lists user names to a Finger command >
|
|
|
957 :com -complete=custom,ListUsers -nargs=1 Finger !finger <args>
|
|
|
958 :fun ListUsers(A,L,P)
|
|
|
959 : return system("cut -d: -f1 /etc/passwd")
|
|
|
960 :endfun
|
|
|
961
|
|
|
962 Range handling *E177* *E178*
|
|
|
963
|
|
|
964 By default, user-defined commands do not accept a line number range. However,
|
|
|
965 it is possible to specify that the command does take a range (the -range
|
|
|
966 attribute), or that it takes an arbitrary count value, either in the line
|
|
|
967 number position (-range=N, like the |:split| command) or as a "count"
|
|
|
968 argument (-count=N, like the |:Next| command). Possible attributes are:
|
|
|
969
|
|
|
970 -range Range allowed, default is current line
|
|
|
971 -range=% Range allowed, default is whole file (1,$)
|
|
|
972 -range=N A count (default N) which is specified in the line
|
|
|
973 number position (like |:split|)
|
|
|
974 -count=N A count (default N) which is specified either in the line
|
|
|
975 number position, or as an initial argument (like |:Next|)
|
|
|
976 Specifying -count (without a default) acts like -count=0
|
|
|
977
|
|
|
978 Note that -range=N and -count=N are mutually exclusive - only one should be
|
|
|
979 specified.
|
|
|
980
|
|
|
981 Special cases
|
|
|
982
|
|
|
983 There are some special cases as well:
|
|
|
984
|
|
|
985 -bang The command can take a ! modifier (like :q or :w)
|
|
|
986 -bar The command can be followed by a "|" and another command.
|
|
|
987 A "|" inside the command argument is not allowed then.
|
|
|
988 Also checks for a " to start a comment.
|
|
|
989 -register The first argument to the command can be an optional
|
|
|
990 register name (like :del, :put, :yank).
|
|
|
991 -buffer The command will only be available in the current buffer.
|
|
|
992
|
|
|
993 In the cases of the -count and -register attributes, if the optional argument
|
|
|
994 is supplied, it is removed from the argument list and is available to the
|
|
|
995 replacement text separately.
|
|
|
996
|
|
|
997 Replacement text
|
|
|
998
|
|
|
999 The replacement text for a user defined command is scanned for special escape
|
|
|
1000 sequences, using <...> notation. Escape sequences are replaced with values
|
|
|
1001 from the entered command line, and all other text is copied unchanged. The
|
|
|
1002 resulting string is executed as an Ex command. If the initial < of an escape
|
|
|
1003 sequence is preceded by a backslash, the sequence is copied unchanged.
|
|
|
1004
|
|
|
1005 The valid escape sequences are
|
|
|
1006
|
|
|
1007 *<line1>*
|
|
|
1008 <line1> The starting line of the command range.
|
|
|
1009 *<line2>*
|
|
|
1010 <line2> The final line of the command range.
|
|
|
1011 *<count>*
|
|
|
1012 <count> Any count supplied (as described for the '-range'
|
|
|
1013 and '-count' attributes).
|
|
|
1014 *<bang>*
|
|
|
1015 <bang> (See the '-bang' attribute) Expands to a ! if the
|
|
|
1016 command was executed with a ! modifier, otherwise
|
|
|
1017 expands to nothing.
|
|
|
1018 *<reg>* *<register>*
|
|
|
1019 <reg> (See the '-register' attribute) The optional register,
|
|
|
1020 if specified. Otherwise, expands to nothing. <register>
|
|
|
1021 is a synonym for this.
|
|
|
1022 *<args>*
|
|
|
1023 <args> The command arguments, exactly as supplied (but as
|
|
|
1024 noted above, any count or register can consume some
|
|
|
1025 of the arguments, which are then not part of <args>).
|
|
|
1026 <lt> A single '<' (Less-Than) character. This is needed if you
|
|
|
1027 want to get a literal copy of one of these escape sequences
|
|
|
1028 into the expansion - for example, to get <bang>, use
|
|
|
1029 <lt>bang>.
|
|
|
1030
|
|
|
1031 *<q-args>*
|
|
|
1032 If the first two characters of an escape sequence are "q-" (for example,
|
|
|
1033 <q-args>) then the value is quoted in such a way as to make it a valid value
|
|
|
1034 for use in an expression. This uses the argument as one single value.
|
|
|
1035
|
|
|
1036 To allow commands to pass their arguments on to a user-defined function, there
|
|
|
1037 is a special form <f-args> ("function args"). This splits the command
|
|
|
1038 arguments at spaces and Tabs, quotes each argument individually, and the
|
|
|
1039 <f-args> sequence is replaced by the comma-separated list of quoted arguments.
|
|
|
1040 See the Mycmd example below. When there is no argument, <f-args> also has no
|
|
|
1041 argument.
|
|
|
1042
|
|
|
1043 Examples >
|
|
|
1044
|
|
|
1045 " Delete everything after here to the end
|
|
|
1046 :com Ddel +,$d
|
|
|
1047
|
|
|
1048 " Rename the current buffer
|
|
|
1049 :com -nargs=1 -bang -complete=file Ren f <args>|w<bang>
|
|
|
1050
|
|
|
1051 " Replace a range with the contents of a file
|
|
|
1052 " (Enter this all as one line)
|
|
|
1053 :com -range -nargs=1 -complete=file
|
|
|
1054 Replace <line1>-pu_|<line1>,<line2>d|r <args>|<line1>d
|
|
|
1055
|
|
|
1056 " Count the number of lines in the range
|
|
42
|
1057 :com! -range -nargs=0 Lines echo <line2> - <line1> + 1 "lines"
|
|
7
|
1058
|
|
|
1059 " Call a user function (example of <f-args>)
|
|
|
1060 :com -nargs=* Mycmd call Myfunc(<f-args>)
|
|
|
1061
|
|
|
1062 When executed as: >
|
|
|
1063 :Mycmd arg1 arg2
|
|
|
1064 This will invoke: >
|
|
|
1065 :call Myfunc("arg1","arg2")
|
|
|
1066
|
|
|
1067 :" A more substantial example
|
|
|
1068 :function Allargs(command)
|
|
|
1069 : let i = 0
|
|
|
1070 : while i < argc()
|
|
|
1071 : if filereadable(argv(i))
|
|
|
1072 : execute "e " . argv(i)
|
|
|
1073 : execute a:command
|
|
|
1074 : endif
|
|
|
1075 : let i = i + 1
|
|
|
1076 : endwhile
|
|
|
1077 :endfunction
|
|
|
1078 :command -nargs=+ -complete=command Allargs call Allargs(<q-args>)
|
|
|
1079
|
|
|
1080 The command Allargs takes any Vim command(s) as argument and executes it on all
|
|
|
1081 files in the argument list. Usage example (note use of the "e" flag to ignore
|
|
|
1082 errors and the "update" command to write modified buffers): >
|
|
|
1083 :Allargs %s/foo/bar/ge|update
|
|
|
1084 This will invoke: >
|
|
|
1085 :call Allargs("%s/foo/bar/ge|update")
|
|
|
1086 <
|
|
|
1087 When defining an user command in a script, it will be able to call functions
|
|
|
1088 local to the script and use mappings local to the script. When the user
|
|
|
1089 invokes the user command, it will run in the context of the script it was
|
|
|
1090 defined in. This matters if |<SID>| is used in a command.
|
|
|
1091
|
|
|
1092 vim:tw=78:ts=8:ft=help:norl:
|
