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