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