Mercurial > vim
annotate runtime/doc/insert.txt @ 34200:039c18333d5e v9.1.0050
patch 9.1.0050: Win32 Keyboard handling is sub-optimal
Commit: https://github.com/vim/vim/commit/68d9472c65ec75725a0b431048bebe036921331c
Author: Anton Sharonov <anton.sharonov@gmail.com>
Date: Tue Jan 23 23:19:02 2024 +0100
patch 9.1.0050: Win32 Keyboard handling is sub-optimal
Problem: Win32 Keyboard handling is sub-optimal and has
many issues with international keyboards
(risa2000) (after v8.2.4807)
Solution: soft-rollback the change, allow the user to select
a suitable key-translation strategy
(Anton Sharonov)
Read about the details in the help:
:h w32-experimental-keycode-trans-strategy
fixes: #10615
fixes: #12595
closes: #12752
Signed-off-by: Anton Sharonov <anton.sharonov@gmail.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>
author | Christian Brabandt <cb@256bit.org> |
---|---|
date | Tue, 23 Jan 2024 23:30:03 +0100 |
parents | 429644dfc975 |
children | 1202b136e3e5 |
rev | line source |
---|---|
34096
429644dfc975
patch 9.1.0015: i_CTRL-R- no longer works in replace mode
Christian Brabandt <cb@256bit.org>
parents:
34057
diff
changeset
|
1 *insert.txt* For Vim version 9.1. Last change: 2024 Jan 04 |
7 | 2 |
3 | |
4 VIM REFERENCE MANUAL by Bram Moolenaar | |
5 | |
6 | |
7 *Insert* *Insert-mode* | |
8 Inserting and replacing text *mode-ins-repl* | |
9 | |
10 Most of this file is about Insert and Replace mode. At the end are a few | |
11 commands for inserting text in other ways. | |
12 | |
13 An overview of the most often used commands can be found in chapter 24 of the | |
14 user manual |usr_24.txt|. | |
15 | |
16 1. Special keys |ins-special-keys| | |
17 2. Special special keys |ins-special-special| | |
18 3. 'textwidth' and 'wrapmargin' options |ins-textwidth| | |
19 4. 'expandtab', 'smarttab' and 'softtabstop' options |ins-expandtab| | |
20 5. Replace mode |Replace-mode| | |
21 6. Virtual Replace mode |Virtual-Replace-mode| | |
22 7. Insert mode completion |ins-completion| | |
23 8. Insert mode commands |inserting| | |
24 9. Ex insert commands |inserting-ex| | |
25 10. Inserting a file |inserting-file| | |
26 | |
27 Also see 'virtualedit', for moving the cursor to positions where there is no | |
28 character. Useful for editing a table. | |
29 | |
30 ============================================================================== | |
31 1. Special keys *ins-special-keys* | |
32 | |
33 In Insert and Replace mode, the following characters have a special meaning; | |
34 other characters are inserted directly. To insert one of these special | |
35 characters into the buffer, precede it with CTRL-V. To insert a <Nul> | |
36 character use "CTRL-V CTRL-@" or "CTRL-V 000". On some systems, you have to | |
37 use "CTRL-V 003" to insert a CTRL-C. Note: When CTRL-V is mapped you can | |
38 often use CTRL-Q instead |i_CTRL-Q|. | |
39 | |
40 If you are working in a special language mode when inserting text, see the | |
41 'langmap' option, |'langmap'|, on how to avoid switching this mode on and off | |
42 all the time. | |
43 | |
44 If you have 'insertmode' set, <Esc> and a few other keys get another meaning. | |
45 See |'insertmode'|. | |
46 | |
47 char action ~ | |
48 ----------------------------------------------------------------------- | |
49 *i_CTRL-[* *i_<Esc>* | |
50 <Esc> or CTRL-[ End insert or Replace mode, go back to Normal mode. Finish | |
51 abbreviation. | |
52 Note: If your <Esc> key is hard to hit on your keyboard, train | |
53 yourself to use CTRL-[. | |
6153 | 54 If Esc doesn't work and you are using a Mac, try CTRL-Esc. |
55 Or disable Listening under Accessibility preferences. | |
7 | 56 *i_CTRL-C* |
57 CTRL-C Quit insert mode, go back to Normal mode. Do not check for | |
140 | 58 abbreviations. Does not trigger the |InsertLeave| autocommand |
59 event. | |
7 | 60 |
61 *i_CTRL-@* | |
16610 | 62 CTRL-@ Insert previously inserted text and stop insert. |
63 | |
7 | 64 *i_CTRL-A* |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
65 CTRL-A Insert previously inserted text. |
7 | 66 |
67 *i_CTRL-H* *i_<BS>* *i_BS* | |
68 <BS> or CTRL-H Delete the character before the cursor (see |i_backspacing| | |
69 about joining lines). | |
70 See |:fixdel| if your <BS> key does not do what you want. | |
16610 | 71 |
7 | 72 *i_<Del>* *i_DEL* |
73 <Del> Delete the character under the cursor. If the cursor is at | |
74 the end of the line, and the 'backspace' option includes | |
75 "eol", delete the <EOL>; the next line is appended after the | |
76 current one. | |
77 See |:fixdel| if your <Del> key does not do what you want. | |
78 *i_CTRL-W* | |
79 CTRL-W Delete the word before the cursor (see |i_backspacing| about | |
80 joining lines). See the section "word motions", | |
81 |word-motions|, for the definition of a word. | |
82 *i_CTRL-U* | |
6823 | 83 CTRL-U Delete all entered characters before the cursor in the current |
6884 | 84 line. If there are no newly entered characters and |
85 'backspace' is not empty, delete all characters before the | |
6823 | 86 cursor in the current line. |
26847 | 87 If C-indenting is enabled the indent will be adjusted if the |
88 line becomes blank. | |
6823 | 89 See |i_backspacing| about joining lines. |
7 | 90 *i_CTRL-I* *i_<Tab>* *i_Tab* |
91 <Tab> or CTRL-I Insert a tab. If the 'expandtab' option is on, the | |
92 equivalent number of spaces is inserted (use CTRL-V <Tab> to | |
93 avoid the expansion; use CTRL-Q <Tab> if CTRL-V is mapped | |
94 |i_CTRL-Q|). See also the 'smarttab' option and | |
95 |ins-expandtab|. | |
96 *i_CTRL-J* *i_<NL>* | |
97 <NL> or CTRL-J Begin new line. | |
98 *i_CTRL-M* *i_<CR>* | |
99 <CR> or CTRL-M Begin new line. | |
100 *i_CTRL-K* | |
101 CTRL-K {char1} [char2] | |
102 Enter digraph (see |digraphs|). When {char1} is a special | |
103 key, the code for that key is inserted in <> form. For | |
104 example, the string "<S-Space>" can be entered by typing | |
105 <C-K><S-Space> (two keys). Neither char is considered for | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
106 mapping. |
7 | 107 |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
108 CTRL-N Find next keyword (see |i_CTRL-N|). |
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
109 CTRL-P Find previous keyword (see |i_CTRL-P|). |
7 | 110 |
18186 | 111 CTRL-R {register} *i_CTRL-R* |
7 | 112 Insert the contents of a register. Between typing CTRL-R and |
113 the second character, '"' will be displayed to indicate that | |
114 you are expected to enter the name of a register. | |
115 The text is inserted as if you typed it, but mappings and | |
116 abbreviations are not used. If you have options like | |
117 'textwidth', 'formatoptions', or 'autoindent' set, this will | |
118 influence what will be inserted. This is different from what | |
119 happens with the "p" command and pasting with the mouse. | |
120 Special registers: | |
121 '"' the unnamed register, containing the text of | |
122 the last delete or yank | |
123 '%' the current file name | |
124 '#' the alternate file name | |
125 '*' the clipboard contents (X11: primary selection) | |
126 '+' the clipboard contents | |
127 '/' the last search pattern | |
128 ':' the last command-line | |
129 '.' the last inserted text | |
33223
def9fc5c92d1
patch 9.0.1886: Various Typos
Christian Brabandt <cb@256bit.org>
parents:
33055
diff
changeset
|
130 *i_CTRL-R_-* |
7 | 131 '-' the last small (less than a line) delete |
33055
e6dcdc2f95f5
runtime(doc): mention special case of i_CTRL-R_-
Christian Brabandt <cb@256bit.org>
parents:
32004
diff
changeset
|
132 register. This is repeatable using |.| since |
e6dcdc2f95f5
runtime(doc): mention special case of i_CTRL-R_-
Christian Brabandt <cb@256bit.org>
parents:
32004
diff
changeset
|
133 it remembers the register to put instead of |
e6dcdc2f95f5
runtime(doc): mention special case of i_CTRL-R_-
Christian Brabandt <cb@256bit.org>
parents:
32004
diff
changeset
|
134 the literal text to insert. |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
135 *i_CTRL-R_=* |
7 | 136 '=' the expression register: you are prompted to |
137 enter an expression (see |expression|) | |
36 | 138 Note that 0x80 (128 decimal) is used for |
667 | 139 special keys. E.g., you can use this to move |
140 the cursor up: | |
141 CTRL-R ="\<Up>" | |
142 Use CTRL-R CTRL-R to insert text literally. | |
714 | 143 When the result is a |List| the items are used |
144 as lines. They can have line breaks inside | |
145 too. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
146 When the result is a Float it's automatically |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
147 converted to a String. |
5130
71e066e10a47
updated for version 7.3.1308
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
148 When append() or setline() is invoked the undo |
71e066e10a47
updated for version 7.3.1308
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
149 sequence will be broken. |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
150 See |registers| about registers. |
7 | 151 |
18186 | 152 CTRL-R CTRL-R {register} *i_CTRL-R_CTRL-R* |
7 | 153 Insert the contents of a register. Works like using a single |
154 CTRL-R, but the text is inserted literally, not as if typed. | |
155 This differs when the register contains characters like <BS>. | |
156 Example, where register a contains "ab^Hc": > | |
157 CTRL-R a results in "ac". | |
158 CTRL-R CTRL-R a results in "ab^Hc". | |
159 < Options 'textwidth', 'formatoptions', etc. still apply. If | |
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
160 you also want to avoid these, use CTRL-R CTRL-O, see below. |
7 | 161 The '.' register (last inserted text) is still inserted as |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
162 typed. |
19968 | 163 After this command, the '.' register contains the text from |
164 the register as if it was inserted by typing it. | |
7 | 165 |
18186 | 166 CTRL-R CTRL-O {register} *i_CTRL-R_CTRL-O* |
7 | 167 Insert the contents of a register literally and don't |
168 auto-indent. Does the same as pasting with the mouse | |
11347 | 169 |<MiddleMouse>|. When the register is linewise this will |
170 insert the text above the current line, like with `P`. | |
7 | 171 The '.' register (last inserted text) is still inserted as |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
172 typed. |
19968 | 173 After this command, the '.' register contains the command |
174 typed and not the text. I.e., the literals "^R^O" and not the | |
175 text from the register. | |
34096
429644dfc975
patch 9.1.0015: i_CTRL-R- no longer works in replace mode
Christian Brabandt <cb@256bit.org>
parents:
34057
diff
changeset
|
176 Does not replace characters in |Replace-mode|! |
7 | 177 |
18186 | 178 CTRL-R CTRL-P {register} *i_CTRL-R_CTRL-P* |
7 | 179 Insert the contents of a register literally and fix the |
180 indent, like |[<MiddleMouse>|. | |
181 The '.' register (last inserted text) is still inserted as | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
182 typed. |
19968 | 183 After this command, the '.' register contains the command |
184 typed and not the text. I.e., the literals "^R^P" and not the | |
185 text from the register. | |
34096
429644dfc975
patch 9.1.0015: i_CTRL-R- no longer works in replace mode
Christian Brabandt <cb@256bit.org>
parents:
34057
diff
changeset
|
186 Does not replace characters in |Replace-mode|! |
7 | 187 |
188 *i_CTRL-T* | |
189 CTRL-T Insert one shiftwidth of indent at the start of the current | |
190 line. The indent is always rounded to a 'shiftwidth' (this is | |
16610 | 191 vi compatible). |
7 | 192 *i_CTRL-D* |
193 CTRL-D Delete one shiftwidth of indent at the start of the current | |
194 line. The indent is always rounded to a 'shiftwidth' (this is | |
16610 | 195 vi compatible). |
7 | 196 *i_0_CTRL-D* |
16610 | 197 0 CTRL-D Delete all indent in the current line. |
198 | |
7 | 199 *i_^_CTRL-D* |
200 ^ CTRL-D Delete all indent in the current line. The indent is | |
201 restored in the next line. This is useful when inserting a | |
16610 | 202 label. |
7 | 203 |
204 *i_CTRL-V* | |
205 CTRL-V Insert next non-digit literally. For special keys, the | |
206 terminal code is inserted. It's also possible to enter the | |
207 decimal, octal or hexadecimal value of a character | |
208 |i_CTRL-V_digit|. | |
209 The characters typed right after CTRL-V are not considered for | |
16610 | 210 mapping. |
7 | 211 Note: When CTRL-V is mapped (e.g., to paste text) you can |
212 often use CTRL-Q instead |i_CTRL-Q|. | |
18717
14d2a210fab1
patch 8.1.2350: other text for CTRL-V in Insert mode with modifyOtherKeys
Bram Moolenaar <Bram@vim.org>
parents:
18396
diff
changeset
|
213 When |modifyOtherKeys| is enabled then special Escape sequence |
14d2a210fab1
patch 8.1.2350: other text for CTRL-V in Insert mode with modifyOtherKeys
Bram Moolenaar <Bram@vim.org>
parents:
18396
diff
changeset
|
214 is converted back to what it was without |modifyOtherKeys|, |
14d2a210fab1
patch 8.1.2350: other text for CTRL-V in Insert mode with modifyOtherKeys
Bram Moolenaar <Bram@vim.org>
parents:
18396
diff
changeset
|
215 unless the Shift key is also pressed. |
14d2a210fab1
patch 8.1.2350: other text for CTRL-V in Insert mode with modifyOtherKeys
Bram Moolenaar <Bram@vim.org>
parents:
18396
diff
changeset
|
216 |
7 | 217 *i_CTRL-Q* |
218 CTRL-Q Same as CTRL-V. | |
219 Note: Some terminal connections may eat CTRL-Q, it doesn't | |
220 work then. It does work in the GUI. | |
221 | |
19116 | 222 CTRL-SHIFT-V *i_CTRL-SHIFT-V* *i_CTRL-SHIFT-Q* |
223 CTRL-SHIFT-Q Works just like CTRL-V, unless |modifyOtherKeys| is active, | |
224 then it inserts the Escape sequence for a key with modifiers. | |
225 | |
7 | 226 CTRL-X Enter CTRL-X mode. This is a sub-mode where commands can |
236 | 227 be given to complete words or scroll the window. See |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
228 |i_CTRL-X| and |ins-completion|. |
7 | 229 |
230 *i_CTRL-E* | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
231 CTRL-E Insert the character which is below the cursor. |
7 | 232 *i_CTRL-Y* |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
233 CTRL-Y Insert the character which is above the cursor. |
7 | 234 Note that for CTRL-E and CTRL-Y 'textwidth' is not used, to be |
235 able to copy characters from a long line. | |
236 | |
237 *i_CTRL-_* | |
238 CTRL-_ Switch between languages, as follows: | |
239 - When in a rightleft window, revins and nohkmap are toggled, | |
240 since English will likely be inserted in this case. | |
241 - When in a norightleft window, revins and hkmap are toggled, | |
242 since Hebrew will likely be inserted in this case. | |
243 | |
244 CTRL-_ moves the cursor to the end of the typed text. | |
245 | |
246 This command is only available when the 'allowrevins' option | |
247 is set. | |
248 Please refer to |rileft.txt| for more information about | |
249 right-to-left mode. | |
1121 | 250 Only if compiled with the |+rightleft| feature. |
251 | |
7 | 252 *i_CTRL-^* |
253 CTRL-^ Toggle the use of typing language characters. | |
254 When language |:lmap| mappings are defined: | |
255 - If 'iminsert' is 1 (langmap mappings used) it becomes 0 (no | |
256 langmap mappings used). | |
257 - If 'iminsert' has another value it becomes 1, thus langmap | |
258 mappings are enabled. | |
259 When no language mappings are defined: | |
260 - If 'iminsert' is 2 (Input Method used) it becomes 0 (no | |
261 Input Method used). | |
262 - If 'iminsert' has another value it becomes 2, thus the Input | |
263 Method is enabled. | |
264 When set to 1, the value of the "b:keymap_name" variable, the | |
265 'keymap' option or "<lang>" appears in the status line. | |
266 The language mappings are normally used to type characters | |
267 that are different from what the keyboard produces. The | |
268 'keymap' option can be used to install a whole number of them. | |
269 | |
270 *i_CTRL-]* | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
271 CTRL-] Trigger abbreviation, without inserting a character. |
7 | 272 |
273 *i_<Insert>* | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
274 <Insert> Toggle between Insert and Replace mode. |
7 | 275 ----------------------------------------------------------------------- |
276 | |
277 *i_backspacing* | |
278 The effect of the <BS>, CTRL-W, and CTRL-U depend on the 'backspace' option | |
28379 | 279 (unless 'revins' is set). This is a comma-separated list of items: |
7 | 280 |
281 item action ~ | |
282 indent allow backspacing over autoindent | |
283 eol allow backspacing over end-of-line (join lines) | |
284 start allow backspacing over the start position of insert; CTRL-W and | |
285 CTRL-U stop once at the start position | |
286 | |
287 When 'backspace' is empty, Vi compatible backspacing is used. You cannot | |
288 backspace over autoindent, before column 1 or before where insert started. | |
289 | |
28010 | 290 For backwards compatibility the values "0", "1", "2" and "3" are also allowed, |
291 see |'backspace'|. | |
7 | 292 |
293 If the 'backspace' option does contain "eol" and the cursor is in column 1 | |
294 when one of the three keys is used, the current line is joined with the | |
295 previous line. This effectively deletes the <EOL> in front of the cursor. | |
296 | |
297 *i_CTRL-V_digit* | |
298 With CTRL-V the decimal, octal or hexadecimal value of a character can be | |
299 entered directly. This way you can enter any character, except a line break | |
300 (<NL>, value 10). There are five ways to enter the character value: | |
301 | |
302 first char mode max nr of chars max value ~ | |
303 (none) decimal 3 255 | |
236 | 304 o or O octal 3 377 (255) |
7 | 305 x or X hexadecimal 2 ff (255) |
306 u hexadecimal 4 ffff (65535) | |
307 U hexadecimal 8 7fffffff (2147483647) | |
308 | |
309 Normally you would type the maximum number of characters. Thus to enter a | |
310 space (value 32) you would type <C-V>032. You can omit the leading zero, in | |
311 which case the character typed after the number must be a non-digit. This | |
312 happens for the other modes as well: As soon as you type a character that is | |
313 invalid for the mode, the value before it will be used and the "invalid" | |
314 character is dealt with in the normal way. | |
315 | |
316 If you enter a value of 10, it will end up in the file as a 0. The 10 is a | |
317 <NL>, which is used internally to represent the <Nul> character. When writing | |
318 the buffer to a file, the <NL> character is translated into <Nul>. The <NL> | |
319 character is written at the end of each line. Thus if you want to insert a | |
320 <NL> character in a file you will have to make a line break. | |
22723 | 321 Also see 'fileformat'. |
7 | 322 |
323 *i_CTRL-X* *insert_expand* | |
324 CTRL-X enters a sub-mode where several commands can be used. Most of these | |
17809
59f8948b7590
patch 8.1.1901: the +insert_expand feature is not always available
Bram Moolenaar <Bram@vim.org>
parents:
17771
diff
changeset
|
325 commands do keyword completion; see |ins-completion|. |
7 | 326 |
327 Two commands can be used to scroll the window up or down, without exiting | |
328 insert mode: | |
329 | |
330 *i_CTRL-X_CTRL-E* | |
331 CTRL-X CTRL-E scroll window one line up. | |
816 | 332 When doing completion look here: |complete_CTRL-E| |
7 | 333 |
334 *i_CTRL-X_CTRL-Y* | |
335 CTRL-X CTRL-Y scroll window one line down. | |
816 | 336 When doing completion look here: |complete_CTRL-Y| |
7 | 337 |
338 After CTRL-X is pressed, each CTRL-E (CTRL-Y) scrolls the window up (down) by | |
339 one line unless that would cause the cursor to move from its current position | |
340 in the file. As soon as another key is pressed, CTRL-X mode is exited and | |
341 that key is interpreted as in Insert mode. | |
342 | |
343 | |
344 ============================================================================== | |
345 2. Special special keys *ins-special-special* | |
346 | |
347 The following keys are special. They stop the current insert, do something, | |
348 and then restart insertion. This means you can do something without getting | |
349 out of Insert mode. This is very handy if you prefer to use the Insert mode | |
350 all the time, just like editors that don't have a separate Normal mode. You | |
351 may also want to set the 'backspace' option to "indent,eol,start" and set the | |
352 'insertmode' option. You can use CTRL-O if you want to map a function key to | |
353 a command. | |
354 | |
355 The changes (inserted or deleted characters) before and after these keys can | |
356 be undone separately. Only the last change can be redone and always behaves | |
357 like an "i" command. | |
358 | |
359 char action ~ | |
360 ----------------------------------------------------------------------- | |
361 <Up> cursor one line up *i_<Up>* | |
362 <Down> cursor one line down *i_<Down>* | |
363 CTRL-G <Up> cursor one line up, insert start column *i_CTRL-G_<Up>* | |
364 CTRL-G k cursor one line up, insert start column *i_CTRL-G_k* | |
365 CTRL-G CTRL-K cursor one line up, insert start column *i_CTRL-G_CTRL-K* | |
366 CTRL-G <Down> cursor one line down, insert start column *i_CTRL-G_<Down>* | |
367 CTRL-G j cursor one line down, insert start column *i_CTRL-G_j* | |
368 CTRL-G CTRL-J cursor one line down, insert start column *i_CTRL-G_CTRL-J* | |
369 <Left> cursor one character left *i_<Left>* | |
370 <Right> cursor one character right *i_<Right>* | |
371 <S-Left> cursor one word back (like "b" command) *i_<S-Left>* | |
372 <C-Left> cursor one word back (like "b" command) *i_<C-Left>* | |
373 <S-Right> cursor one word forward (like "w" command) *i_<S-Right>* | |
374 <C-Right> cursor one word forward (like "w" command) *i_<C-Right>* | |
375 <Home> cursor to first char in the line *i_<Home>* | |
376 <End> cursor to after last char in the line *i_<End>* | |
377 <C-Home> cursor to first char in the file *i_<C-Home>* | |
378 <C-End> cursor to after last char in the file *i_<C-End>* | |
379 <LeftMouse> cursor to position of mouse click *i_<LeftMouse>* | |
380 <S-Up> move window one page up *i_<S-Up>* | |
381 <PageUp> move window one page up *i_<PageUp>* | |
382 <S-Down> move window one page down *i_<S-Down>* | |
383 <PageDown> move window one page down *i_<PageDown>* | |
2409
0ca06a92adfb
Add support for horizontal scroll wheel. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
384 <ScrollWheelDown> move window three lines down *i_<ScrollWheelDown>* |
0ca06a92adfb
Add support for horizontal scroll wheel. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
385 <S-ScrollWheelDown> move window one page down *i_<S-ScrollWheelDown>* |
0ca06a92adfb
Add support for horizontal scroll wheel. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
386 <ScrollWheelUp> move window three lines up *i_<ScrollWheelUp>* |
0ca06a92adfb
Add support for horizontal scroll wheel. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
387 <S-ScrollWheelUp> move window one page up *i_<S-ScrollWheelUp>* |
0ca06a92adfb
Add support for horizontal scroll wheel. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
388 <ScrollWheelLeft> move window six columns left *i_<ScrollWheelLeft>* |
0ca06a92adfb
Add support for horizontal scroll wheel. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
389 <S-ScrollWheelLeft> move window one page left *i_<S-ScrollWheelLeft>* |
0ca06a92adfb
Add support for horizontal scroll wheel. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
390 <ScrollWheelRight> move window six columns right *i_<ScrollWheelRight>* |
0ca06a92adfb
Add support for horizontal scroll wheel. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
391 <S-ScrollWheelRight> move window one page right *i_<S-ScrollWheelRight>* |
7 | 392 CTRL-O execute one command, return to Insert mode *i_CTRL-O* |
625 | 393 CTRL-\ CTRL-O like CTRL-O but don't move the cursor *i_CTRL-\_CTRL-O* |
477 | 394 CTRL-L when 'insertmode' is set: go to Normal mode *i_CTRL-L* |
29450 | 395 CTRL-G u close undo sequence, start new change *i_CTRL-G_u* |
396 CTRL-G U don't start a new undo block with the next *i_CTRL-G_U* | |
397 left/right cursor movement, if the cursor | |
398 stays within the same line | |
7 | 399 ----------------------------------------------------------------------- |
400 | |
401 Note: If the cursor keys take you out of Insert mode, check the 'noesckeys' | |
402 option. | |
403 | |
404 The CTRL-O command sometimes has a side effect: If the cursor was beyond the | |
405 end of the line, it will be put on the last character in the line. In | |
406 mappings it's often better to use <Esc> (first put an "x" in the text, <Esc> | |
477 | 407 will then always put the cursor on it). Or use CTRL-\ CTRL-O, but then |
4073 | 408 beware of the cursor possibly being beyond the end of the line. Note that the |
409 command following CTRL-\ CTRL-O can still move the cursor, it is not restored | |
410 to its original position. | |
7 | 411 |
2625 | 412 The CTRL-O command takes you to Normal mode. If you then use a command enter |
3492 | 413 Insert mode again it normally doesn't nest. Thus when typing "a<C-O>a" and |
414 then <Esc> takes you back to Normal mode, you do not need to type <Esc> twice. | |
415 An exception is when not typing the command, e.g. when executing a mapping or | |
416 sourcing a script. This makes mappings work that briefly switch to Insert | |
417 mode. | |
2625 | 418 |
7 | 419 The shifted cursor keys are not available on all terminals. |
420 | |
421 Another side effect is that a count specified before the "i" or "a" command is | |
422 ignored. That is because repeating the effect of the command after CTRL-O is | |
423 too complicated. | |
424 | |
425 An example for using CTRL-G u: > | |
426 | |
427 :inoremap <C-H> <C-G>u<C-H> | |
428 | |
429 This redefines the backspace key to start a new undo sequence. You can now | |
430 undo the effect of the backspace key, without changing what you typed before | |
3456 | 431 that, with CTRL-O u. Another example: > |
432 | |
433 :inoremap <CR> <C-]><C-G>u<CR> | |
434 | |
29450 | 435 This starts a new undo block at each line break. It also expands |
436 abbreviations before this. | |
7 | 437 |
7074
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
438 An example for using CTRL-G U: > |
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
439 |
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
440 inoremap <Left> <C-G>U<Left> |
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
441 inoremap <Right> <C-G>U<Right> |
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
442 inoremap <expr> <Home> col('.') == match(getline('.'), '\S') + 1 ? |
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
443 \ repeat('<C-G>U<Left>', col('.') - 1) : |
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
444 \ (col('.') < match(getline('.'), '\S') ? |
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
445 \ repeat('<C-G>U<Right>', match(getline('.'), '\S') + 0) : |
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
446 \ repeat('<C-G>U<Left>', col('.') - 1 - match(getline('.'), '\S'))) |
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
447 inoremap <expr> <End> repeat('<C-G>U<Right>', col('$') - col('.')) |
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
448 inoremap ( ()<C-G>U<Left> |
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
449 |
29450 | 450 This makes it possible to use the cursor keys in Insert mode, without starting |
451 a new undo block and therefore using |.| (redo) will work as expected. Also | |
452 entering a text like (with the "(" mapping from above): | |
7074
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
453 |
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
454 Lorem ipsum (dolor |
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
455 |
14123 | 456 will be repeatable by using |.| to the expected |
7074
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
457 |
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
458 Lorem ipsum (dolor) |
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
459 |
10 | 460 Using CTRL-O splits undo: the text typed before and after it is undone |
461 separately. If you want to avoid this (e.g., in a mapping) you might be able | |
462 to use CTRL-R = |i_CTRL-R|. E.g., to call a function: > | |
463 :imap <F2> <C-R>=MyFunc()<CR> | |
464 | |
7 | 465 When the 'whichwrap' option is set appropriately, the <Left> and <Right> |
466 keys on the first/last character in the line make the cursor wrap to the | |
467 previous/next line. | |
468 | |
469 The CTRL-G j and CTRL-G k commands can be used to insert text in front of a | |
470 column. Example: > | |
471 int i; | |
472 int j; | |
236 | 473 Position the cursor on the first "int", type "istatic <C-G>j ". The |
7 | 474 result is: > |
475 static int i; | |
476 int j; | |
477 When inserting the same text in front of the column in every line, use the | |
478 Visual blockwise command "I" |v_b_I|. | |
479 | |
480 ============================================================================== | |
481 3. 'textwidth' and 'wrapmargin' options *ins-textwidth* | |
482 | |
483 The 'textwidth' option can be used to automatically break a line before it | |
484 gets too long. Set the 'textwidth' option to the desired maximum line | |
485 length. If you then type more characters (not spaces or tabs), the | |
486 last word will be put on a new line (unless it is the only word on the | |
487 line). If you set 'textwidth' to 0, this feature is disabled. | |
488 | |
489 The 'wrapmargin' option does almost the same. The difference is that | |
490 'textwidth' has a fixed width while 'wrapmargin' depends on the width of the | |
491 screen. When using 'wrapmargin' this is equal to using 'textwidth' with a | |
492 value equal to (columns - 'wrapmargin'), where columns is the width of the | |
493 screen. | |
494 | |
495 When 'textwidth' and 'wrapmargin' are both set, 'textwidth' is used. | |
496 | |
497 If you don't really want to break the line, but view the line wrapped at a | |
498 convenient place, see the 'linebreak' option. | |
499 | |
667 | 500 The line is only broken automatically when using Insert mode, or when |
7 | 501 appending to a line. When in replace mode and the line length is not |
502 changed, the line will not be broken. | |
503 | |
504 Long lines are broken if you enter a non-white character after the margin. | |
505 The situations where a line will be broken can be restricted by adding | |
506 characters to the 'formatoptions' option: | |
507 "l" Only break a line if it was not longer than 'textwidth' when the insert | |
508 started. | |
509 "v" Only break at a white character that has been entered during the | |
510 current insert command. This is mostly Vi-compatible. | |
511 "lv" Only break if the line was not longer than 'textwidth' when the insert | |
512 started and only at a white character that has been entered during the | |
513 current insert command. Only differs from "l" when entering non-white | |
514 characters while crossing the 'textwidth' boundary. | |
515 | |
667 | 516 Normally an internal function will be used to decide where to break the line. |
517 If you want to do it in a different way set the 'formatexpr' option to an | |
518 expression that will take care of the line break. | |
519 | |
7 | 520 If you want to format a block of text, you can use the "gq" operator. Type |
521 "gq" and a movement command to move the cursor to the end of the block. In | |
522 many cases, the command "gq}" will do what you want (format until the end of | |
523 paragraph). Alternatively, you can use "gqap", which will format the whole | |
524 paragraph, no matter where the cursor currently is. Or you can use Visual | |
525 mode: hit "v", move to the end of the block, and type "gq". See also |gq|. | |
526 | |
527 ============================================================================== | |
528 4. 'expandtab', 'smarttab' and 'softtabstop' options *ins-expandtab* | |
529 | |
530 If the 'expandtab' option is on, spaces will be used to fill the amount of | |
531 whitespace of the tab. If you want to enter a real <Tab>, type CTRL-V first | |
532 (use CTRL-Q when CTRL-V is mapped |i_CTRL-Q|). | |
533 The 'expandtab' option is off by default. Note that in Replace mode, a single | |
534 character is replaced with several spaces. The result of this is that the | |
535 number of characters in the line increases. Backspacing will delete one | |
536 space at a time. The original character will be put back for only one space | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
537 that you backspace over (the last one). |
7 | 538 |
539 *ins-smarttab* | |
540 When the 'smarttab' option is on, a <Tab> inserts 'shiftwidth' positions at | |
541 the beginning of a line and 'tabstop' positions in other places. This means | |
3682 | 542 that often spaces instead of a <Tab> character are inserted. When 'smarttab' |
7 | 543 is off, a <Tab> always inserts 'tabstop' positions, and 'shiftwidth' is only |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
544 used for ">>" and the like. |
7 | 545 |
546 *ins-softtabstop* | |
547 When the 'softtabstop' option is non-zero, a <Tab> inserts 'softtabstop' | |
548 positions, and a <BS> used to delete white space, will delete 'softtabstop' | |
549 positions. This feels like 'tabstop' was set to 'softtabstop', but a real | |
550 <Tab> character still takes 'tabstop' positions, so your file will still look | |
551 correct when used by other applications. | |
552 | |
553 If 'softtabstop' is non-zero, a <BS> will try to delete as much white space to | |
554 move to the previous 'softtabstop' position, except when the previously | |
555 inserted character is a space, then it will only delete the character before | |
556 the cursor. Otherwise you cannot always delete a single character before the | |
557 cursor. You will have to delete 'softtabstop' characters first, and then type | |
558 extra spaces to get where you want to be. | |
559 | |
560 ============================================================================== | |
561 5. Replace mode *Replace* *Replace-mode* *mode-replace* | |
562 | |
563 Enter Replace mode with the "R" command in normal mode. | |
564 | |
565 In Replace mode, one character in the line is deleted for every character you | |
566 type. If there is no character to delete (at the end of the line), the | |
567 typed character is appended (as in Insert mode). Thus the number of | |
568 characters in a line stays the same until you get to the end of the line. | |
569 If a <NL> is typed, a line break is inserted and no character is deleted. | |
570 | |
571 Be careful with <Tab> characters. If you type a normal printing character in | |
572 its place, the number of characters is still the same, but the number of | |
573 columns will become smaller. | |
574 | |
575 If you delete characters in Replace mode (with <BS>, CTRL-W, or CTRL-U), what | |
576 happens is that you delete the changes. The characters that were replaced | |
577 are restored. If you had typed past the existing text, the characters you | |
578 added are deleted. This is effectively a character-at-a-time undo. | |
579 | |
580 If the 'expandtab' option is on, a <Tab> will replace one character with | |
581 several spaces. The result of this is that the number of characters in the | |
582 line increases. Backspacing will delete one space at a time. The original | |
583 character will be put back for only one space that you backspace over (the | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
584 last one). |
7 | 585 |
586 ============================================================================== | |
587 6. Virtual Replace mode *vreplace-mode* *Virtual-Replace-mode* | |
588 | |
589 Enter Virtual Replace mode with the "gR" command in normal mode. | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
590 {not available when compiled without the |+vreplace| feature} |
7 | 591 |
592 Virtual Replace mode is similar to Replace mode, but instead of replacing | |
593 actual characters in the file, you are replacing screen real estate, so that | |
594 characters further on in the file never appear to move. | |
595 | |
596 So if you type a <Tab> it may replace several normal characters, and if you | |
597 type a letter on top of a <Tab> it may not replace anything at all, since the | |
598 <Tab> will still line up to the same place as before. | |
599 | |
600 Typing a <NL> still doesn't cause characters later in the file to appear to | |
601 move. The rest of the current line will be replaced by the <NL> (that is, | |
602 they are deleted), and replacing continues on the next line. A new line is | |
603 NOT inserted unless you go past the end of the file. | |
604 | |
605 Interesting effects are seen when using CTRL-T and CTRL-D. The characters | |
606 before the cursor are shifted sideways as normal, but characters later in the | |
607 line still remain still. CTRL-T will hide some of the old line under the | |
608 shifted characters, but CTRL-D will reveal them again. | |
609 | |
610 As with Replace mode, using <BS> etc will bring back the characters that were | |
611 replaced. This still works in conjunction with 'smartindent', CTRL-T and | |
612 CTRL-D, 'expandtab', 'smarttab', 'softtabstop', etc. | |
613 | |
614 In 'list' mode, Virtual Replace mode acts as if it was not in 'list' mode, | |
615 unless "L" is in 'cpoptions'. | |
616 | |
2581 | 617 Note that the only situations for which characters beyond the cursor should |
618 appear to move are in List mode |'list'|, and occasionally when 'wrap' is set | |
619 (and the line changes length to become shorter or wider than the width of the | |
620 screen). In other cases spaces may be inserted to avoid following characters | |
621 to move. | |
7 | 622 |
623 This mode is very useful for editing <Tab> separated columns in tables, for | |
624 entering new data while keeping all the columns aligned. | |
625 | |
626 ============================================================================== | |
627 7. Insert mode completion *ins-completion* | |
628 | |
449 | 629 In Insert and Replace mode, there are several commands to complete part of a |
7 | 630 keyword or line that has been typed. This is useful if you are using |
631 complicated keywords (e.g., function names with capitals and underscores). | |
632 | |
633 Completion can be done for: | |
634 | |
635 1. Whole lines |i_CTRL-X_CTRL-L| | |
636 2. keywords in the current file |i_CTRL-X_CTRL-N| | |
637 3. keywords in 'dictionary' |i_CTRL-X_CTRL-K| | |
638 4. keywords in 'thesaurus', thesaurus-style |i_CTRL-X_CTRL-T| | |
639 5. keywords in the current and included files |i_CTRL-X_CTRL-I| | |
640 6. tags |i_CTRL-X_CTRL-]| | |
641 7. file names |i_CTRL-X_CTRL-F| | |
642 8. definitions or macros |i_CTRL-X_CTRL-D| | |
643 9. Vim command-line |i_CTRL-X_CTRL-V| | |
449 | 644 10. User defined completion |i_CTRL-X_CTRL-U| |
523 | 645 11. omni completion |i_CTRL-X_CTRL-O| |
477 | 646 12. Spelling suggestions |i_CTRL-X_s| |
11473 | 647 13. keywords in 'complete' |i_CTRL-N| |i_CTRL-P| |
7 | 648 |
25707
31db9c6df4e3
patch 8.2.3389: cannot stop insert mode completion without side effects
Bram Moolenaar <Bram@vim.org>
parents:
25700
diff
changeset
|
649 Additionally, |i_CTRL-X_CTRL-Z| stops completion without changing the text. |
31db9c6df4e3
patch 8.2.3389: cannot stop insert mode completion without side effects
Bram Moolenaar <Bram@vim.org>
parents:
25700
diff
changeset
|
650 |
11473 | 651 All these, except CTRL-N and CTRL-P, are done in CTRL-X mode. This is a |
652 sub-mode of Insert and Replace modes. You enter CTRL-X mode by typing CTRL-X | |
653 and one of the CTRL-X commands. You exit CTRL-X mode by typing a key that is | |
654 not a valid CTRL-X mode command. Valid keys are the CTRL-X command itself, | |
655 CTRL-N (next), and CTRL-P (previous). | |
7 | 656 |
16127
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
657 To get the current completion information, |complete_info()| can be used. |
7 | 658 Also see the 'infercase' option if you want to adjust the case of the match. |
659 | |
816 | 660 *complete_CTRL-E* |
661 When completion is active you can use CTRL-E to stop it and go back to the | |
843 | 662 originally typed text. The CTRL-E will not be inserted. |
816 | 663 |
664 *complete_CTRL-Y* | |
665 When the popup menu is displayed you can use CTRL-Y to stop completion and | |
666 accept the currently selected entry. The CTRL-Y is not inserted. Typing a | |
667 space, Enter, or some other unprintable character will leave completion mode | |
668 and insert that typed character. | |
669 | |
829 | 670 When the popup menu is displayed there are a few more special keys, see |
671 |popupmenu-keys|. | |
672 | |
7 | 673 Note: The keys that are valid in CTRL-X mode are not mapped. This allows for |
30634 | 674 `:map <C-F> <C-X><C-F>` to work (assuming "<" is not in 'cpo'). The key that |
7 | 675 ends CTRL-X mode (any key that is not a valid CTRL-X mode command) is mapped. |
676 Also, when doing completion with 'complete' mappings apply as usual. | |
677 | |
29014
45c182c4f7e9
patch 8.2.5029: "textlock" is always zero
Bram Moolenaar <Bram@vim.org>
parents:
28379
diff
changeset
|
678 *E565* |
20118
252d2bb90394
patch 8.2.0614: get ml_get error when deleting a line in 'completefunc'
Bram Moolenaar <Bram@vim.org>
parents:
19968
diff
changeset
|
679 Note: While completion is active Insert mode can't be used recursively and |
252d2bb90394
patch 8.2.0614: get ml_get error when deleting a line in 'completefunc'
Bram Moolenaar <Bram@vim.org>
parents:
19968
diff
changeset
|
680 buffer text cannot be changed. Mappings that somehow invoke ":normal i.." |
252d2bb90394
patch 8.2.0614: get ml_get error when deleting a line in 'completefunc'
Bram Moolenaar <Bram@vim.org>
parents:
19968
diff
changeset
|
681 will generate an E565 error. |
844 | 682 |
7 | 683 The following mappings are suggested to make typing the completion commands |
30634 | 684 a bit easier (although they will hide other commands; this requires "<" is not |
685 in 'cpo'): > | |
686 :inoremap <C-]> <C-X><C-]> | |
687 :inoremap <C-F> <C-X><C-F> | |
688 :inoremap <C-D> <C-X><C-D> | |
689 :inoremap <C-L> <C-X><C-L> | |
7 | 690 |
691 As a special case, typing CTRL-R to perform register insertion (see | |
692 |i_CTRL-R|) will not exit CTRL-X mode. This is primarily to allow the use of | |
693 the '=' register to call some function to determine the next operation. If | |
694 the contents of the register (or result of the '=' register evaluation) are | |
695 not valid CTRL-X mode keys, then CTRL-X mode will be exited as if those keys | |
696 had been typed. | |
697 | |
698 For example, the following will map <Tab> to either actually insert a <Tab> if | |
699 the current line is currently only whitespace, or start/continue a CTRL-N | |
700 completion operation: > | |
701 | |
702 function! CleverTab() | |
703 if strpart( getline('.'), 0, col('.')-1 ) =~ '^\s*$' | |
704 return "\<Tab>" | |
705 else | |
706 return "\<C-N>" | |
2120
f63ace015c63
Updated runtime and language files.
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
707 endif |
7 | 708 endfunction |
709 inoremap <Tab> <C-R>=CleverTab()<CR> | |
710 | |
711 | |
712 | |
713 Completing whole lines *compl-whole-line* | |
714 | |
715 *i_CTRL-X_CTRL-L* | |
716 CTRL-X CTRL-L Search backwards for a line that starts with the | |
459 | 717 same characters as those in the current line before |
718 the cursor. Indent is ignored. The matching line is | |
7 | 719 inserted in front of the cursor. |
459 | 720 The 'complete' option is used to decide which buffers |
667 | 721 are searched for a match. Both loaded and unloaded |
722 buffers are used. | |
7 | 723 CTRL-L or |
724 CTRL-P Search backwards for next matching line. This line | |
725 replaces the previous matching line. | |
726 | |
727 CTRL-N Search forward for next matching line. This line | |
728 replaces the previous matching line. | |
729 | |
730 CTRL-X CTRL-L After expanding a line you can additionally get the | |
731 line next to it by typing CTRL-X CTRL-L again, unless | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
732 a double CTRL-X is used. Only works for loaded |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
733 buffers. |
7 | 734 |
735 Completing keywords in current file *compl-current* | |
736 | |
737 *i_CTRL-X_CTRL-P* | |
738 *i_CTRL-X_CTRL-N* | |
739 CTRL-X CTRL-N Search forwards for words that start with the keyword | |
740 in front of the cursor. The found keyword is inserted | |
741 in front of the cursor. | |
742 | |
743 CTRL-X CTRL-P Search backwards for words that start with the keyword | |
744 in front of the cursor. The found keyword is inserted | |
745 in front of the cursor. | |
746 | |
747 CTRL-N Search forward for next matching keyword. This | |
748 keyword replaces the previous matching keyword. | |
749 | |
750 CTRL-P Search backwards for next matching keyword. This | |
751 keyword replaces the previous matching keyword. | |
752 | |
753 CTRL-X CTRL-N or | |
754 CTRL-X CTRL-P Further use of CTRL-X CTRL-N or CTRL-X CTRL-P will | |
755 copy the words following the previous expansion in | |
756 other contexts unless a double CTRL-X is used. | |
757 | |
758 If there is a keyword in front of the cursor (a name made out of alphabetic | |
759 characters and characters in 'iskeyword'), it is used as the search pattern, | |
760 with "\<" prepended (meaning: start of a word). Otherwise "\<\k\k" is used | |
761 as search pattern (start of any keyword of at least two characters). | |
762 | |
763 In Replace mode, the number of characters that are replaced depends on the | |
764 length of the matched string. This works like typing the characters of the | |
765 matched string in Replace mode. | |
766 | |
767 If there is not a valid keyword character before the cursor, any keyword of | |
768 at least two characters is matched. | |
769 e.g., to get: | |
770 printf("(%g, %g, %g)", vector[0], vector[1], vector[2]); | |
771 just type: | |
772 printf("(%g, %g, %g)", vector[0], ^P[1], ^P[2]); | |
773 | |
523 | 774 The search wraps around the end of the file, the value of 'wrapscan' is not |
775 used here. | |
776 | |
7 | 777 Multiple repeats of the same completion are skipped; thus a different match |
778 will be inserted at each CTRL-N and CTRL-P (unless there is only one | |
779 matching keyword). | |
780 | |
781 Single character matches are never included, as they usually just get in | |
782 the way of what you were really after. | |
783 e.g., to get: | |
784 printf("name = %s\n", name); | |
785 just type: | |
786 printf("name = %s\n", n^P); | |
787 or even: | |
788 printf("name = %s\n", ^P); | |
789 The 'n' in '\n' is skipped. | |
790 | |
791 After expanding a word, you can use CTRL-X CTRL-P or CTRL-X CTRL-N to get the | |
792 word following the expansion in other contexts. These sequences search for | |
793 the text just expanded and further expand by getting an extra word. This is | |
794 useful if you need to repeat a sequence of complicated words. Although CTRL-P | |
795 and CTRL-N look just for strings of at least two characters, CTRL-X CTRL-P and | |
796 CTRL-X CTRL-N can be used to expand words of just one character. | |
797 e.g., to get: | |
798 México | |
799 you can type: | |
800 M^N^P^X^P^X^P | |
801 CTRL-N starts the expansion and then CTRL-P takes back the single character | |
802 "M", the next two CTRL-X CTRL-P's get the words "é" and ";xico". | |
803 | |
804 If the previous expansion was split, because it got longer than 'textwidth', | |
805 then just the text in the current line will be used. | |
806 | |
807 If the match found is at the end of a line, then the first word in the next | |
28246 | 808 line will be inserted and the message "Word from other line" displayed, if |
7 | 809 this word is accepted the next CTRL-X CTRL-P or CTRL-X CTRL-N will search |
810 for those lines starting with this word. | |
811 | |
812 | |
813 Completing keywords in 'dictionary' *compl-dictionary* | |
814 | |
815 *i_CTRL-X_CTRL-K* | |
816 CTRL-X CTRL-K Search the files given with the 'dictionary' option | |
817 for words that start with the keyword in front of the | |
818 cursor. This is like CTRL-N, but only the dictionary | |
819 files are searched, not the current file. The found | |
820 keyword is inserted in front of the cursor. This | |
821 could potentially be pretty slow, since all matches | |
822 are found before the first match is used. By default, | |
823 the 'dictionary' option is empty. | |
824 For suggestions where to find a list of words, see the | |
825 'dictionary' option. | |
28010 | 826 'ignorecase', 'smartcase' and 'infercase' apply. |
7 | 827 |
828 CTRL-K or | |
829 CTRL-N Search forward for next matching keyword. This | |
830 keyword replaces the previous matching keyword. | |
831 | |
832 CTRL-P Search backwards for next matching keyword. This | |
833 keyword replaces the previous matching keyword. | |
834 | |
25990
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
835 |
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
836 Completing words in 'thesaurus' *compl-thesaurus* |
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
837 |
7 | 838 *i_CTRL-X_CTRL-T* |
236 | 839 CTRL-X CTRL-T Works as CTRL-X CTRL-K, but in a special way. It uses |
7 | 840 the 'thesaurus' option instead of 'dictionary'. If a |
841 match is found in the thesaurus file, all the | |
842 remaining words on the same line are included as | |
843 matches, even though they don't complete the word. | |
844 Thus a word can be completely replaced. | |
845 | |
846 CTRL-T or | |
847 CTRL-N Search forward for next matching keyword. This | |
848 keyword replaces the previous matching keyword. | |
849 | |
850 CTRL-P Search backwards for next matching keyword. This | |
851 keyword replaces the previous matching keyword. | |
852 | |
25990
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
853 In the file used by the 'thesaurus' option each line in the file should |
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
854 contain words with similar meaning, separated by non-keyword characters (white |
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
855 space is preferred). Maximum line length is 510 bytes. |
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
856 |
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
857 For an example, imagine the 'thesaurus' file has a line like this: > |
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
858 angry furious mad enraged |
27036 | 859 Placing the cursor after the letters "ang" and typing CTRL-X CTRL-T would |
25990
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
860 complete the word "angry"; subsequent presses would change the word to |
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
861 "furious", "mad" etc. |
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
862 |
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
863 Other uses include translation between two languages, or grouping API |
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
864 functions by keyword. |
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
865 |
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
866 An English word list was added to this github issue: |
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
867 https://github.com/vim/vim/issues/629#issuecomment-443293282 |
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
868 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g. |
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
869 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file name. |
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
870 |
27036 | 871 |
25990
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
872 Completing keywords with 'thesaurusfunc' *compl-thesaurusfunc* |
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
873 |
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
874 If the 'thesaurusfunc' option is set, then the user specified function is |
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
875 invoked to get the list of completion matches and the 'thesaurus' option is |
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
876 not used. See |complete-functions| for an explanation of how the function is |
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
877 invoked and what it should return. |
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
878 |
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
879 Here is an example that uses the "aiksaurus" command (provided by Magnus |
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
880 Groß): > |
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
881 |
26100 | 882 func Thesaur(findstart, base) |
883 if a:findstart | |
32004 | 884 return searchpos('\<', 'bnW', line('.'))[1] - 1 |
26100 | 885 endif |
886 let res = [] | |
887 let h = '' | |
27903 | 888 for l in systemlist('aiksaurus ' .. shellescape(a:base)) |
26100 | 889 if l[:3] == '=== ' |
27903 | 890 let h = '(' .. substitute(l[4:], ' =*$', ')', '') |
26100 | 891 elseif l ==# 'Alphabetically similar known words are: ' |
892 let h = "\U0001f52e" | |
893 elseif l[0] =~ '\a' || (h ==# "\U0001f52e" && l[0] ==# "\t") | |
894 call extend(res, map(split(substitute(l, '^\t', '', ''), ', '), {_, val -> {'word': val, 'menu': h}})) | |
25990
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
895 endif |
26100 | 896 endfor |
897 return res | |
898 endfunc | |
31200 | 899 |
26100 | 900 if exists('+thesaurusfunc') |
901 set thesaurusfunc=Thesaur | |
902 endif | |
25990
ac330e2fecc4
patch 8.2.3528: 'thesaurus' and 'thesaurusfunc' do not have the same scope
Bram Moolenaar <Bram@vim.org>
parents:
25974
diff
changeset
|
903 |
7 | 904 |
905 Completing keywords in the current and included files *compl-keyword* | |
906 | |
907 The 'include' option is used to specify a line that contains an include file | |
908 name. The 'path' option is used to search for include files. | |
909 | |
910 *i_CTRL-X_CTRL-I* | |
911 CTRL-X CTRL-I Search for the first keyword in the current and | |
912 included files that starts with the same characters | |
913 as those before the cursor. The matched keyword is | |
914 inserted in front of the cursor. | |
915 | |
916 CTRL-N Search forwards for next matching keyword. This | |
917 keyword replaces the previous matching keyword. | |
918 Note: CTRL-I is the same as <Tab>, which is likely to | |
919 be typed after a successful completion, therefore | |
920 CTRL-I is not used for searching for the next match. | |
921 | |
922 CTRL-P Search backward for previous matching keyword. This | |
923 keyword replaces the previous matching keyword. | |
924 | |
925 CTRL-X CTRL-I Further use of CTRL-X CTRL-I will copy the words | |
926 following the previous expansion in other contexts | |
927 unless a double CTRL-X is used. | |
928 | |
929 Completing tags *compl-tag* | |
930 *i_CTRL-X_CTRL-]* | |
931 CTRL-X CTRL-] Search for the first tag that starts with the same | |
932 characters as before the cursor. The matching tag is | |
933 inserted in front of the cursor. Alphabetic | |
934 characters and characters in 'iskeyword' are used | |
935 to decide which characters are included in the tag | |
936 name (same as for a keyword). See also |CTRL-]|. | |
937 The 'showfulltag' option can be used to add context | |
938 from around the tag definition. | |
939 CTRL-] or | |
940 CTRL-N Search forwards for next matching tag. This tag | |
941 replaces the previous matching tag. | |
942 | |
943 CTRL-P Search backward for previous matching tag. This tag | |
944 replaces the previous matching tag. | |
945 | |
946 | |
947 Completing file names *compl-filename* | |
948 *i_CTRL-X_CTRL-F* | |
949 CTRL-X CTRL-F Search for the first file name that starts with the | |
950 same characters as before the cursor. The matching | |
951 file name is inserted in front of the cursor. | |
952 Alphabetic characters and characters in 'isfname' | |
953 are used to decide which characters are included in | |
954 the file name. Note: the 'path' option is not used | |
955 here (yet). | |
956 CTRL-F or | |
957 CTRL-N Search forwards for next matching file name. This | |
958 file name replaces the previous matching file name. | |
959 | |
960 CTRL-P Search backward for previous matching file name. | |
961 This file name replaces the previous matching file | |
962 name. | |
963 | |
964 | |
965 Completing definitions or macros *compl-define* | |
966 | |
967 The 'define' option is used to specify a line that contains a definition. | |
968 The 'include' option is used to specify a line that contains an include file | |
969 name. The 'path' option is used to search for include files. | |
970 | |
971 *i_CTRL-X_CTRL-D* | |
972 CTRL-X CTRL-D Search in the current and included files for the | |
973 first definition (or macro) name that starts with | |
974 the same characters as before the cursor. The found | |
975 definition name is inserted in front of the cursor. | |
976 CTRL-D or | |
977 CTRL-N Search forwards for next matching macro name. This | |
978 macro name replaces the previous matching macro | |
979 name. | |
980 | |
981 CTRL-P Search backward for previous matching macro name. | |
982 This macro name replaces the previous matching macro | |
983 name. | |
984 | |
985 CTRL-X CTRL-D Further use of CTRL-X CTRL-D will copy the words | |
986 following the previous expansion in other contexts | |
987 unless a double CTRL-X is used. | |
988 | |
989 | |
990 Completing Vim commands *compl-vim* | |
991 | |
992 Completion is context-sensitive. It works like on the Command-line. It | |
449 | 993 completes an Ex command as well as its arguments. This is useful when writing |
994 a Vim script. | |
7 | 995 |
996 *i_CTRL-X_CTRL-V* | |
997 CTRL-X CTRL-V Guess what kind of item is in front of the cursor and | |
998 find the first match for it. | |
999 Note: When CTRL-V is mapped you can often use CTRL-Q | |
1620 | 1000 instead of |i_CTRL-Q|. |
7 | 1001 CTRL-V or |
1002 CTRL-N Search forwards for next match. This match replaces | |
1003 the previous one. | |
1004 | |
1620 | 1005 CTRL-P Search backwards for previous match. This match |
7 | 1006 replaces the previous one. |
1007 | |
1008 CTRL-X CTRL-V Further use of CTRL-X CTRL-V will do the same as | |
1009 CTRL-V. This allows mapping a key to do Vim command | |
1010 completion, for example: > | |
1011 :imap <Tab> <C-X><C-V> | |
1012 | |
449 | 1013 User defined completion *compl-function* |
12 | 1014 |
1015 Completion is done by a function that can be defined by the user with the | |
648 | 1016 'completefunc' option. See below for how the function is called and an |
1017 example |complete-functions|. | |
12 | 1018 |
1019 *i_CTRL-X_CTRL-U* | |
1020 CTRL-X CTRL-U Guess what kind of item is in front of the cursor and | |
1021 find the first match for it. | |
1022 CTRL-U or | |
1023 CTRL-N Use the next match. This match replaces the previous | |
1024 one. | |
1025 | |
1026 CTRL-P Use the previous match. This match replaces the | |
1027 previous one. | |
1028 | |
1029 | |
523 | 1030 Omni completion *compl-omni* |
449 | 1031 |
502 | 1032 Completion is done by a function that can be defined by the user with the |
523 | 1033 'omnifunc' option. This is to be used for filetype-specific completion. |
502 | 1034 |
648 | 1035 See below for how the function is called and an example |complete-functions|. |
523 | 1036 For remarks about specific filetypes see |compl-omni-filetypes|. |
859 | 1037 More completion scripts will appear, check www.vim.org. Currently there is a |
1038 first version for C++. | |
449 | 1039 |
1040 *i_CTRL-X_CTRL-O* | |
1041 CTRL-X CTRL-O Guess what kind of item is in front of the cursor and | |
1042 find the first match for it. | |
1043 CTRL-O or | |
1044 CTRL-N Use the next match. This match replaces the previous | |
1045 one. | |
1046 | |
1047 CTRL-P Use the previous match. This match replaces the | |
1048 previous one. | |
1049 | |
1050 | |
477 | 1051 Spelling suggestions *compl-spelling* |
1052 | |
483 | 1053 A word before or at the cursor is located and correctly spelled words are |
1054 suggested to replace it. If there is a badly spelled word in the line, before | |
1055 or under the cursor, the cursor is moved to after it. Otherwise the word just | |
1056 before the cursor is used for suggestions, even though it isn't badly spelled. | |
1057 | |
477 | 1058 NOTE: CTRL-S suspends display in many Unix terminals. Use 's' instead. Type |
1059 CTRL-Q to resume displaying. | |
1060 | |
1061 *i_CTRL-X_CTRL-S* *i_CTRL-X_s* | |
1062 CTRL-X CTRL-S or | |
1063 CTRL-X s Locate the word in front of the cursor and find the | |
1064 first spell suggestion for it. | |
1065 CTRL-S or | |
1066 CTRL-N Use the next suggestion. This replaces the previous | |
1067 one. Note that you can't use 's' here. | |
1068 | |
1069 CTRL-P Use the previous suggestion. This replaces the | |
1070 previous one. | |
1071 | |
1072 | |
7 | 1073 Completing keywords from different sources *compl-generic* |
1074 | |
1075 *i_CTRL-N* | |
1076 CTRL-N Find next match for words that start with the | |
1077 keyword in front of the cursor, looking in places | |
1078 specified with the 'complete' option. The found | |
1079 keyword is inserted in front of the cursor. | |
1080 | |
1081 *i_CTRL-P* | |
1082 CTRL-P Find previous match for words that start with the | |
1083 keyword in front of the cursor, looking in places | |
1084 specified with the 'complete' option. The found | |
1085 keyword is inserted in front of the cursor. | |
1086 | |
1087 CTRL-N Search forward for next matching keyword. This | |
1088 keyword replaces the previous matching keyword. | |
1089 | |
1090 CTRL-P Search backwards for next matching keyword. This | |
1091 keyword replaces the previous matching keyword. | |
1092 | |
1093 CTRL-X CTRL-N or | |
1094 CTRL-X CTRL-P Further use of CTRL-X CTRL-N or CTRL-X CTRL-P will | |
1095 copy the words following the previous expansion in | |
1096 other contexts unless a double CTRL-X is used. | |
1097 | |
519 | 1098 |
25707
31db9c6df4e3
patch 8.2.3389: cannot stop insert mode completion without side effects
Bram Moolenaar <Bram@vim.org>
parents:
25700
diff
changeset
|
1099 Stop completion *compl-stop* |
31db9c6df4e3
patch 8.2.3389: cannot stop insert mode completion without side effects
Bram Moolenaar <Bram@vim.org>
parents:
25700
diff
changeset
|
1100 |
31db9c6df4e3
patch 8.2.3389: cannot stop insert mode completion without side effects
Bram Moolenaar <Bram@vim.org>
parents:
25700
diff
changeset
|
1101 *i_CTRL-X_CTRL-Z* |
31db9c6df4e3
patch 8.2.3389: cannot stop insert mode completion without side effects
Bram Moolenaar <Bram@vim.org>
parents:
25700
diff
changeset
|
1102 CTRL-X CTRL-Z Stop completion without changing the text. |
31db9c6df4e3
patch 8.2.3389: cannot stop insert mode completion without side effects
Bram Moolenaar <Bram@vim.org>
parents:
25700
diff
changeset
|
1103 |
31db9c6df4e3
patch 8.2.3389: cannot stop insert mode completion without side effects
Bram Moolenaar <Bram@vim.org>
parents:
25700
diff
changeset
|
1104 |
648 | 1105 FUNCTIONS FOR FINDING COMPLETIONS *complete-functions* |
1106 | |
25974
416237f1de22
patch 8.2.3520: cannot define a function for thesaurus completion
Bram Moolenaar <Bram@vim.org>
parents:
25773
diff
changeset
|
1107 This applies to 'completefunc', 'thesaurusfunc' and 'omnifunc'. |
648 | 1108 |
659 | 1109 The function is called in two different ways: |
1110 - First the function is called to find the start of the text to be completed. | |
1111 - Later the function is called to actually find the matches. | |
648 | 1112 |
1113 On the first invocation the arguments are: | |
1114 a:findstart 1 | |
1115 a:base empty | |
1116 | |
659 | 1117 The function must return the column where the completion starts. It must be a |
1118 number between zero and the cursor column "col('.')". This involves looking | |
1119 at the characters just before the cursor and including those characters that | |
1120 could be part of the completed item. The text between this column and the | |
14637 | 1121 cursor column will be replaced with the matches. If the returned value is |
1122 larger than the cursor column, the cursor column is used. | |
3526
dd6c2497c997
Fix more 'cpo' issues in runtime files.
Bram Moolenaar <bram@vim.org>
parents:
3492
diff
changeset
|
1123 |
14637 | 1124 Negative return values: |
32004 | 1125 -2 To cancel silently and stay in completion mode. |
1126 -3 To cancel silently and leave completion mode. | |
14637 | 1127 Another negative value: completion starts at the cursor column |
648 | 1128 |
1129 On the second invocation the arguments are: | |
1130 a:findstart 0 | |
659 | 1131 a:base the text with which matches should match; the text that was |
648 | 1132 located in the first call (can be empty) |
1133 | |
1134 The function must return a List with the matching words. These matches | |
1135 usually include the "a:base" text. When there are no matches return an empty | |
25161 | 1136 List. Note that the cursor may have moved since the first invocation, the |
1137 text may have been changed. | |
3082 | 1138 |
1139 In order to return more information than the matching words, return a Dict | |
1140 that contains the List. The Dict can have these items: | |
1141 words The List of matching words (mandatory). | |
1142 refresh A string to control re-invocation of the function | |
1143 (optional). | |
1144 The only value currently recognized is "always", the | |
1145 effect is that the function is called whenever the | |
1146 leading text is changed. | |
15416
5f8ddd2a7b92
patch 8.1.0716: get warning message when 'completefunc' returns nothing
Bram Moolenaar <Bram@vim.org>
parents:
14637
diff
changeset
|
1147 |
5f8ddd2a7b92
patch 8.1.0716: get warning message when 'completefunc' returns nothing
Bram Moolenaar <Bram@vim.org>
parents:
14637
diff
changeset
|
1148 If you want to suppress the warning message for an empty result, return |
15729 | 1149 |v:none|. This is useful to implement asynchronous completion with |
1150 |complete()|. | |
15416
5f8ddd2a7b92
patch 8.1.0716: get warning message when 'completefunc' returns nothing
Bram Moolenaar <Bram@vim.org>
parents:
14637
diff
changeset
|
1151 |
3082 | 1152 Other items are ignored. |
1153 | |
19303 | 1154 For acting upon end of completion, see the |CompleteDonePre| and |
1155 |CompleteDone| autocommand event. | |
3682 | 1156 |
3082 | 1157 For example, the function can contain this: > |
1158 let matches = ... list of words ... | |
1159 return {'words': matches, 'refresh': 'always'} | |
1160 < | |
723 | 1161 *complete-items* |
659 | 1162 Each list item can either be a string or a Dictionary. When it is a string it |
1163 is used as the completion. When it is a Dictionary it can contain these | |
1164 items: | |
819 | 1165 word the text that will be inserted, mandatory |
1166 abbr abbreviation of "word"; when not empty it is used in | |
1167 the menu instead of "word" | |
820 | 1168 menu extra text for the popup menu, displayed after "word" |
1169 or "abbr" | |
819 | 1170 info more information about the item, can be displayed in a |
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
1171 preview or popup window |
659 | 1172 kind single letter indicating the type of completion |
867 | 1173 icase when non-zero case is to be ignored when comparing |
1174 items to be equal; when omitted zero is used, thus | |
1175 items that only differ in case are added | |
16237
56451a2677dc
patch 8.1.1123: no way to avoid filtering for autocomplete function
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
1176 equal when non-zero, always treat this item to be equal when |
56451a2677dc
patch 8.1.1123: no way to avoid filtering for autocomplete function
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
1177 comparing. Which means, "equal=1" disables filtering |
56451a2677dc
patch 8.1.1123: no way to avoid filtering for autocomplete function
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
1178 of this item. |
841 | 1179 dup when non-zero this match will be added even when an |
1180 item with the same word is already present. | |
2642 | 1181 empty when non-zero this match will be added even when it is |
1182 an empty string | |
32004 | 1183 user_data custom data which is associated with the item and |
19047
a3fce2763e83
patch 8.2.0084: complete item "user_data" can only be a string
Bram Moolenaar <Bram@vim.org>
parents:
18972
diff
changeset
|
1184 available in |v:completed_item|; it can be any type; |
a3fce2763e83
patch 8.2.0084: complete item "user_data" can only be a string
Bram Moolenaar <Bram@vim.org>
parents:
18972
diff
changeset
|
1185 defaults to an empty string |
659 | 1186 |
16237
56451a2677dc
patch 8.1.1123: no way to avoid filtering for autocomplete function
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
1187 All of these except "icase", "equal", "dup" and "empty" must be a string. If |
56451a2677dc
patch 8.1.1123: no way to avoid filtering for autocomplete function
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
1188 an item does not meet these requirements then an error message is given and |
56451a2677dc
patch 8.1.1123: no way to avoid filtering for autocomplete function
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
1189 further items in the list are not used. You can mix string and Dictionary |
56451a2677dc
patch 8.1.1123: no way to avoid filtering for autocomplete function
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
1190 items in the returned list. |
659 | 1191 |
1192 The "menu" item is used in the popup menu and may be truncated, thus it should | |
728 | 1193 be relatively short. The "info" item can be longer, it will be displayed in |
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
1194 the preview window when "preview" appears in 'completeopt' or in a popup |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
1195 window when "popup" appears in 'completeopt'. In the preview window the |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
1196 "info" item will also remain displayed after the popup menu has been removed. |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
1197 This is useful for function arguments. Use a single space for "info" to |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
1198 remove existing text in the preview window. The size of the preview window is |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
1199 three lines, but 'previewheight' is used when it has a value of 1 or 2. |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
1200 |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
1201 *complete-popup* |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
1202 When "popup" is in 'completeopt' a popup window is used to display the "info". |
17909 | 1203 Then the 'completepopup' option specifies the properties of the popup. This |
28379 | 1204 is used when the info popup is created. The option is a comma-separated list |
17909 | 1205 of values: |
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
1206 height maximum height of the popup |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
1207 width maximum width of the popup |
18053 | 1208 highlight highlight group of the popup (default is PmenuSel) |
17815
9ec2526c04c5
patch 8.1.1904: cannot have an info popup align with the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17809
diff
changeset
|
1209 align "item" (default) or "menu" |
9ec2526c04c5
patch 8.1.1904: cannot have an info popup align with the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17809
diff
changeset
|
1210 border "on" (default) or "off" |
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
1211 Example: > |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
1212 :set completepopup=height:10,width:60,highlight:InfoPopup |
659 | 1213 |
17909 | 1214 When the "align" value is "item" then the popup is positioned close to the |
17815
9ec2526c04c5
patch 8.1.1904: cannot have an info popup align with the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17809
diff
changeset
|
1215 selected item. Changing the selection will also move the popup. When "align" |
9ec2526c04c5
patch 8.1.1904: cannot have an info popup align with the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17809
diff
changeset
|
1216 is "menu" then the popup is aligned with the top of the menu if the menu is |
9ec2526c04c5
patch 8.1.1904: cannot have an info popup align with the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17809
diff
changeset
|
1217 below the text, and the bottom of the menu otherwise. |
9ec2526c04c5
patch 8.1.1904: cannot have an info popup align with the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17809
diff
changeset
|
1218 |
17909 | 1219 After the info popup is created it can be found with |popup_findinfo()| and |
1220 properties can be changed with |popup_setoptions()|. | |
1221 | |
18396
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1222 *complete-popuphidden* |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1223 If the information for the popup is obtained asynchronously, use "popuphidden" |
18750 | 1224 in 'completeopt'. The info popup will then be initially hidden and |
18396
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1225 |popup_show()| must be called once it has been filled with the info. This can |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1226 be done with a |CompleteChanged| autocommand, something like this: > |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1227 set completeopt+=popuphidden |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1228 au CompleteChanged * call UpdateCompleteInfo() |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1229 func UpdateCompleteInfo() |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1230 " Cancel any pending info fetch |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1231 let item = v:event.completed_item |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1232 " Start fetching info for the item then call ShowCompleteInfo(info) |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1233 endfunc |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1234 func ShowCompleteInfo(info) |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1235 let id = popup_findinfo() |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1236 if id |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1237 call popup_settext(id, 'async info: ' .. a:info) |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1238 call popup_show(id) |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1239 endif |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1240 endfunc |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1241 |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1242 < *complete-item-kind* |
659 | 1243 The "kind" item uses a single letter to indicate the kind of completion. This |
1244 may be used to show the completion differently (different color or icon). | |
1245 Currently these types can be used: | |
1246 v variable | |
1247 f function or method | |
728 | 1248 m member of a struct or class |
1249 t typedef | |
1250 d #define or macro | |
648 | 1251 |
1252 When searching for matches takes some time call |complete_add()| to add each | |
1253 match to the total list. These matches should then not appear in the returned | |
1254 list! Call |complete_check()| now and then to allow the user to press a key | |
1255 while still searching for matches. Stop searching when it returns non-zero. | |
1256 | |
25619 | 1257 *E840* |
2642 | 1258 The function is allowed to move the cursor, it is restored afterwards. |
1259 The function is not allowed to move to another window or delete text. | |
648 | 1260 |
1261 An example that completes the names of the months: > | |
1262 fun! CompleteMonths(findstart, base) | |
1263 if a:findstart | |
1264 " locate the start of the word | |
1265 let line = getline('.') | |
1266 let start = col('.') - 1 | |
1267 while start > 0 && line[start - 1] =~ '\a' | |
1268 let start -= 1 | |
1269 endwhile | |
1270 return start | |
1271 else | |
1272 " find months matching with "a:base" | |
1273 let res = [] | |
1274 for m in split("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec") | |
27903 | 1275 if m =~ '^' .. a:base |
648 | 1276 call add(res, m) |
1277 endif | |
1278 endfor | |
1279 return res | |
1280 endif | |
1281 endfun | |
1282 set completefunc=CompleteMonths | |
1283 < | |
1284 The same, but now pretending searching for matches is slow: > | |
1285 fun! CompleteMonths(findstart, base) | |
1286 if a:findstart | |
1287 " locate the start of the word | |
1288 let line = getline('.') | |
1289 let start = col('.') - 1 | |
1290 while start > 0 && line[start - 1] =~ '\a' | |
1291 let start -= 1 | |
1292 endwhile | |
1293 return start | |
1294 else | |
1295 " find months matching with "a:base" | |
1296 for m in split("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec") | |
27903 | 1297 if m =~ '^' .. a:base |
648 | 1298 call complete_add(m) |
1299 endif | |
1300 sleep 300m " simulate searching for next match | |
1301 if complete_check() | |
1302 break | |
1303 endif | |
1304 endfor | |
1305 return [] | |
1306 endif | |
1307 endfun | |
1308 set completefunc=CompleteMonths | |
1309 < | |
1310 | |
540 | 1311 INSERT COMPLETION POPUP MENU *ins-completion-menu* |
620 | 1312 *popupmenu-completion* |
540 | 1313 Vim can display the matches in a simplistic popup menu. |
1314 | |
1315 The menu is used when: | |
715 | 1316 - The 'completeopt' option contains "menu" or "menuone". |
540 | 1317 - The terminal supports at least 8 colors. |
857 | 1318 - There are at least two matches. One if "menuone" is used. |
540 | 1319 |
765 | 1320 The 'pumheight' option can be used to set a maximum height. The default is to |
1321 use all space available. | |
13238
e0dcfd3dbb52
patch 8.0.1493: completion items cannot be annotated
Christian Brabandt <cb@256bit.org>
parents:
13125
diff
changeset
|
1322 The 'pumwidth' option can be used to set a minimum width. The default is 15 |
e0dcfd3dbb52
patch 8.0.1493: completion items cannot be annotated
Christian Brabandt <cb@256bit.org>
parents:
13125
diff
changeset
|
1323 characters. |
765 | 1324 |
825 | 1325 There are three states: |
1326 1. A complete match has been inserted, e.g., after using CTRL-N or CTRL-P. | |
1327 2. A cursor key has been used to select another match. The match was not | |
1328 inserted then, only the entry in the popup menu is highlighted. | |
1329 3. Only part of a match has been inserted and characters were typed or the | |
1330 backspace key was used. The list of matches was then adjusted for what is | |
1331 in front of the cursor. | |
667 | 1332 |
682 | 1333 You normally start in the first state, with the first match being inserted. |
667 | 1334 When "longest" is in 'completeopt' and there is more than one match you start |
825 | 1335 in the third state. |
665 | 1336 |
825 | 1337 If you select another match, e.g., with CTRL-N or CTRL-P, you go to the first |
1338 state. This doesn't change the list of matches. | |
682 | 1339 |
825 | 1340 When you are back at the original text then you are in the third state. To |
715 | 1341 get there right away you can use a mapping that uses CTRL-P right after |
1342 starting the completion: > | |
1343 :imap <F7> <C-N><C-P> | |
793 | 1344 < |
1345 *popupmenu-keys* | |
667 | 1346 In the first state these keys have a special meaning: |
1347 <BS> and CTRL-H Delete one character, find the matches for the word before | |
1348 the cursor. This reduces the list of matches, often to one | |
682 | 1349 entry, and switches to the second state. |
825 | 1350 Any non-special character: |
1351 Stop completion without changing the match and insert the | |
1352 typed character. | |
665 | 1353 |
825 | 1354 In the second and third state these keys have a special meaning: |
659 | 1355 <BS> and CTRL-H Delete one character, find the matches for the shorter word |
1356 before the cursor. This may find more matches. | |
1357 CTRL-L Add one character from the current match, may reduce the | |
667 | 1358 number of matches. |
682 | 1359 any printable, non-white character: |
1360 Add this character and reduce the number of matches. | |
667 | 1361 |
825 | 1362 In all three states these can be used: |
816 | 1363 CTRL-Y Yes: Accept the currently selected match and stop completion. |
1121 | 1364 CTRL-E End completion, go back to what was there before selecting a |
1365 match (what was typed or longest common string). | |
682 | 1366 <PageUp> Select a match several entries back, but don't insert it. |
1367 <PageDown> Select a match several entries further, but don't insert it. | |
665 | 1368 <Up> Select the previous match, as if CTRL-P was used, but don't |
682 | 1369 insert it. |
665 | 1370 <Down> Select the next match, as if CTRL-N was used, but don't |
682 | 1371 insert it. |
1121 | 1372 <Space> or <Tab> Stop completion without changing the match and insert the |
825 | 1373 typed character. |
1374 | |
1203 | 1375 The behavior of the <Enter> key depends on the state you are in: |
825 | 1376 first state: Use the text as it is and insert a line break. |
1377 second state: Insert the currently selected match. | |
1378 third state: Use the text as it is and insert a line break. | |
1379 | |
1380 In other words: If you used the cursor keys to select another entry in the | |
1203 | 1381 list of matches then the <Enter> key inserts that match. If you typed |
1382 something else then <Enter> inserts a line break. | |
667 | 1383 |
540 | 1384 |
1385 The colors of the menu can be changed with these highlight groups: | |
1386 Pmenu normal item |hl-Pmenu| | |
1387 PmenuSel selected item |hl-PmenuSel| | |
1388 PmenuSbar scrollbar |hl-PmenuSbar| | |
1389 PmenuThumb thumb of the scrollbar |hl-PmenuThumb| | |
1390 | |
667 | 1391 There are no special mappings for when the popup menu is visible. However, |
1392 you can use an Insert mode mapping that checks the |pumvisible()| function to | |
1393 do something different. Example: > | |
1394 :inoremap <Down> <C-R>=pumvisible() ? "\<lt>C-N>" : "\<lt>Down>"<CR> | |
540 | 1395 |
723 | 1396 You can use of <expr> in mapping to have the popup menu used when typing a |
1397 character and some condition is met. For example, for typing a dot: > | |
1398 inoremap <expr> . MayComplete() | |
1399 func MayComplete() | |
1400 if (can complete) | |
1401 return ".\<C-X>\<C-O>" | |
1402 endif | |
1403 return '.' | |
1404 endfunc | |
1405 | |
1406 See |:map-<expr>| for more info. | |
1407 | |
667 | 1408 |
1409 FILETYPE-SPECIFIC REMARKS FOR OMNI COMPLETION *compl-omni-filetypes* | |
1410 | |
1411 The file used for {filetype} should be autoload/{filetype}complete.vim | |
1412 in 'runtimepath'. Thus for "java" it is autoload/javacomplete.vim. | |
519 | 1413 |
557 | 1414 |
523 | 1415 C *ft-c-omni* |
519 | 1416 |
28141 | 1417 Completion of C code requires a tags file. You should use Universal/ |
1418 Exuberant ctags, because it adds extra information that is needed for | |
1419 completion. You can find it here: | |
1420 Universal Ctags: https://ctags.io | |
1421 Exuberant Ctags: http://ctags.sourceforge.net | |
1121 | 1422 |
28141 | 1423 Universal Ctags is preferred, Exuberant Ctags is no longer being developed. |
1424 | |
1425 For Exuberant ctags, version 5.6 or later is recommended. For version 5.5.4 | |
1426 you should add a patch that adds the "typename:" field: | |
711 | 1427 ftp://ftp.vim.org/pub/vim/unstable/patches/ctags-5.5.4.patch |
659 | 1428 A compiled .exe for MS-Windows can be found at: |
12968 | 1429 http://ctags.sourceforge.net/ |
1430 https://github.com/universal-ctags/ctags-win32 | |
519 | 1431 |
1432 If you want to complete system functions you can do something like this. Use | |
1433 ctags to generate a tags file for all the system header files: > | |
1434 % ctags -R -f ~/.vim/systags /usr/include /usr/local/include | |
1435 In your vimrc file add this tags file to the 'tags' option: > | |
1436 set tags+=~/.vim/systags | |
1437 | |
1438 When using CTRL-X CTRL-O after a name without any "." or "->" it is completed | |
1439 from the tags file directly. This works for any identifier, also function | |
1440 names. If you want to complete a local variable name, which does not appear | |
1441 in the tags file, use CTRL-P instead. | |
1442 | |
1443 When using CTRL-X CTRL-O after something that has "." or "->" Vim will attempt | |
1444 to recognize the type of the variable and figure out what members it has. | |
1445 This means only members valid for the variable will be listed. | |
1446 | |
523 | 1447 When a member name already was complete, CTRL-X CTRL-O will add a "." or |
1448 "->" for composite types. | |
1449 | |
519 | 1450 Vim doesn't include a C compiler, only the most obviously formatted |
1451 declarations are recognized. Preprocessor stuff may cause confusion. | |
1452 When the same structure name appears in multiple places all possible members | |
1453 are included. | |
1454 | |
529 | 1455 |
625 | 1456 CSS *ft-css-omni* |
557 | 1457 |
1458 Complete properties and their appropriate values according to CSS 2.1 | |
818 | 1459 specification. |
557 | 1460 |
1461 | |
818 | 1462 HTML *ft-html-omni* |
1463 XHTML *ft-xhtml-omni* | |
529 | 1464 |
667 | 1465 CTRL-X CTRL-O provides completion of various elements of (X)HTML files. It is |
6051 | 1466 designed to support writing of XHTML 1.0 Strict files but will also work for |
667 | 1467 other versions of HTML. Features: |
529 | 1468 |
667 | 1469 - after "<" complete tag name depending on context (no div suggestion inside |
1470 of an a tag); '/>' indicates empty tags | |
1471 - inside of tag complete proper attributes (no width attribute for an a tag); | |
1472 show also type of attribute; '*' indicates required attributes | |
1473 - when attribute has limited number of possible values help to complete them | |
557 | 1474 - complete names of entities |
532 | 1475 - complete values of "class" and "id" attributes with data obtained from |
667 | 1476 <style> tag and included CSS files |
659 | 1477 - when completing value of "style" attribute or working inside of "style" tag |
532 | 1478 switch to |ft-css-omni| completion |
667 | 1479 - when completing values of events attributes or working inside of "script" |
1480 tag switch to |ft-javascript-omni| completion | |
532 | 1481 - when used after "</" CTRL-X CTRL-O will close the last opened tag |
529 | 1482 |
557 | 1483 Note: When used first time completion menu will be shown with little delay |
818 | 1484 - this is time needed for loading of data file. |
659 | 1485 Note: Completion may fail in badly formatted documents. In such case try to |
1486 run |:make| command to detect formatting problems. | |
557 | 1487 |
1488 | |
836 | 1489 HTML flavor *html-flavor* |
1490 | |
859 | 1491 The default HTML completion depends on the filetype. For HTML files it is |
1492 HTML 4.01 Transitional ('filetype' is "html"), for XHTML it is XHTML 1.0 | |
1493 Strict ('filetype' is "xhtml"). | |
836 | 1494 |
859 | 1495 When doing completion outside of any other tag you will have possibility to |
1496 choose DOCTYPE and the appropriate data file will be loaded and used for all | |
1497 next completions. | |
836 | 1498 |
859 | 1499 More about format of data file in |xml-omni-datafile|. Some of the data files |
1500 may be found on the Vim website (|www|). | |
836 | 1501 |
859 | 1502 Note that b:html_omni_flavor may point to a file with any XML data. This |
1503 makes possible to mix PHP (|ft-php-omni|) completion with any XML dialect | |
1504 (assuming you have data file for it). Without setting that variable XHTML 1.0 | |
1505 Strict will be used. | |
836 | 1506 |
1507 | |
818 | 1508 JAVASCRIPT *ft-javascript-omni* |
649 | 1509 |
659 | 1510 Completion of most elements of JavaScript language and DOM elements. |
649 | 1511 |
1512 Complete: | |
1513 | |
1514 - variables | |
667 | 1515 - function name; show function arguments |
649 | 1516 - function arguments |
1517 - properties of variables trying to detect type of variable | |
659 | 1518 - complete DOM objects and properties depending on context |
649 | 1519 - keywords of language |
1520 | |
659 | 1521 Completion works in separate JavaScript files (&ft==javascript), inside of |
1522 <script> tag of (X)HTML and in values of event attributes (including scanning | |
5220 | 1523 of external files). |
818 | 1524 |
649 | 1525 DOM compatibility |
1526 | |
1527 At the moment (beginning of 2006) there are two main browsers - MS Internet | |
1528 Explorer and Mozilla Firefox. These two applications are covering over 90% of | |
1529 market. Theoretically standards are created by W3C organisation | |
1530 (http://www.w3c.org) but they are not always followed/implemented. | |
1531 | |
818 | 1532 IE FF W3C Omni completion ~ |
1533 +/- +/- + + ~ | |
1534 + + - + ~ | |
1535 + - - - ~ | |
1536 - + - - ~ | |
649 | 1537 |
1538 Regardless from state of implementation in browsers but if element is defined | |
1539 in standards, completion plugin will place element in suggestion list. When | |
1540 both major engines implemented element, even if this is not in standards it | |
1541 will be suggested. All other elements are not placed in suggestion list. | |
1542 | |
1543 | |
818 | 1544 PHP *ft-php-omni* |
714 | 1545 |
1121 | 1546 Completion of PHP code requires a tags file for completion of data from |
28141 | 1547 external files and for class aware completion. You should use Universal/ |
1548 Exuberant ctags version 5.5.4 or newer. You can find it here: | |
1549 | |
1550 Universal Ctags: https://ctags.io | |
1551 Exuberant Ctags: http://ctags.sourceforge.net | |
714 | 1552 |
1553 Script completes: | |
1554 | |
1555 - after $ variables name | |
728 | 1556 - if variable was declared as object add "->", if tags file is available show |
1557 name of class | |
819 | 1558 - after "->" complete only function and variable names specific for given |
1559 class. To find class location and contents tags file is required. Because | |
1560 PHP isn't strongly typed language user can use @var tag to declare class: > | |
1561 | |
856 | 1562 /* @var $myVar myClass */ |
819 | 1563 $myVar-> |
1564 < | |
1565 Still, to find myClass contents tags file is required. | |
728 | 1566 |
843 | 1567 - function names with additional info: |
728 | 1568 - in case of built-in functions list of possible arguments and after | type |
1569 data returned by function | |
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1570 - in case of user function arguments and name of file where function was |
728 | 1571 defined (if it is not current file) |
1572 | |
1573 - constants names | |
1574 - class names after "new" declaration | |
1575 | |
714 | 1576 |
1577 Note: when doing completion first time Vim will load all necessary data into | |
1578 memory. It may take several seconds. After next use of completion delay | |
728 | 1579 should not be noticeable. |
714 | 1580 |
1581 Script detects if cursor is inside <?php ?> tags. If it is outside it will | |
1582 automatically switch to HTML/CSS/JavaScript completion. Note: contrary to | |
1583 original HTML files completion of tags (and only tags) isn't context aware. | |
1584 | |
1585 | |
856 | 1586 RUBY *ft-ruby-omni* |
838 | 1587 |
1588 Completion of Ruby code requires that vim be built with |+ruby|. | |
1589 | |
1590 Ruby completion will parse your buffer on demand in order to provide a list of | |
1591 completions. These completions will be drawn from modules loaded by 'require' | |
1592 and modules defined in the current buffer. | |
1593 | |
1594 The completions provided by CTRL-X CTRL-O are sensitive to the context: | |
1595 | |
856 | 1596 CONTEXT COMPLETIONS PROVIDED ~ |
838 | 1597 |
1598 1. Not inside a class definition Classes, constants and globals | |
1599 | |
856 | 1600 2. Inside a class definition Methods or constants defined in the class |
838 | 1601 |
856 | 1602 3. After '.', '::' or ':' Methods applicable to the object being |
1603 dereferenced | |
838 | 1604 |
856 | 1605 4. After ':' or ':foo' Symbol name (beginning with 'foo') |
838 | 1606 |
1607 Notes: | |
1608 - Vim will load/evaluate code in order to provide completions. This may | |
13125 | 1609 cause some code execution, which may be a concern. This is no longer |
1121 | 1610 enabled by default, to enable this feature add > |
1611 let g:rubycomplete_buffer_loading = 1 | |
1612 <- In context 1 above, Vim can parse the entire buffer to add a list of | |
843 | 1613 classes to the completion results. This feature is turned off by default, |
1614 to enable it add > | |
1615 let g:rubycomplete_classes_in_global = 1 | |
1616 < to your vimrc | |
838 | 1617 - In context 2 above, anonymous classes are not supported. |
1618 - In context 3 above, Vim will attempt to determine the methods supported by | |
1619 the object. | |
1620 - Vim can detect and load the Rails environment for files within a rails | |
1621 project. The feature is disabled by default, to enable it add > | |
843 | 1622 let g:rubycomplete_rails = 1 |
1623 < to your vimrc | |
838 | 1624 |
1625 | |
625 | 1626 SYNTAX *ft-syntax-omni* |
1627 | |
1121 | 1628 Vim has the ability to color syntax highlight nearly 500 languages. Part of |
1629 this highlighting includes knowing what keywords are part of a language. Many | |
1630 filetypes already have custom completion scripts written for them, the | |
1631 syntaxcomplete plugin provides basic completion for all other filetypes. It | |
1632 does this by populating the omni completion list with the text Vim already | |
1633 knows how to color highlight. It can be used for any filetype and provides a | |
1634 minimal language-sensitive completion. | |
625 | 1635 |
702 | 1636 To enable syntax code completion you can run: > |
4869 | 1637 setlocal omnifunc=syntaxcomplete#Complete |
702 | 1638 |
4869 | 1639 You can automate this by placing the following in your |.vimrc| (after any |
702 | 1640 ":filetype" command): > |
1641 if has("autocmd") && exists("+omnifunc") | |
818 | 1642 autocmd Filetype * |
1643 \ if &omnifunc == "" | | |
1644 \ setlocal omnifunc=syntaxcomplete#Complete | | |
1645 \ endif | |
702 | 1646 endif |
1647 | |
1648 The above will set completion to this script only if a specific plugin does | |
1649 not already exist for that filetype. | |
1650 | |
1651 Each filetype can have a wide range of syntax items. The plugin allows you to | |
1652 customize which syntax groups to include or exclude from the list. Let's have | |
1653 a look at the PHP filetype to see how this works. | |
1654 | |
1655 If you edit a file called, index.php, run the following command: > | |
4869 | 1656 syntax list |
625 | 1657 |
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1658 The first thing you will notice is that there are many different syntax groups. |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1659 The PHP language can include elements from different languages like HTML, |
702 | 1660 JavaScript and many more. The syntax plugin will only include syntax groups |
1661 that begin with the filetype, "php", in this case. For example these syntax | |
1662 groups are included by default with the PHP: phpEnvVar, phpIntVar, | |
1663 phpFunctions. | |
1664 | |
13125 | 1665 If you wish non-filetype syntax items to also be included, you can use a |
1666 regular expression syntax (added in version 13.0 of | |
14249
4543777545a3
Updated runtime and language files.
Christian Brabandt <cb@256bit.org>
parents:
14123
diff
changeset
|
1667 autoload/syntaxcomplete.vim) to add items. Looking at the output from |
13125 | 1668 ":syntax list" while editing a PHP file I can see some of these entries: > |
4869 | 1669 htmlArg,htmlTag,htmlTagName,javaScriptStatement,javaScriptGlobalObjects |
625 | 1670 |
4869 | 1671 To pick up any JavaScript and HTML keyword syntax groups while editing a PHP |
13125 | 1672 file, you can use 3 different regexs, one for each language. Or you can |
1673 simply restrict the include groups to a particular value, without using | |
4869 | 1674 a regex string: > |
1675 let g:omni_syntax_group_include_php = 'php\w\+,javaScript\w\+,html\w\+' | |
1676 let g:omni_syntax_group_include_php = 'phpFunctions,phpMethods' | |
1677 < | |
1678 The basic form of this variable is: > | |
1679 let g:omni_syntax_group_include_{filetype} = 'regex,comma,separated' | |
1680 | |
1681 The PHP language has an enormous number of items which it knows how to syntax | |
5220 | 1682 highlight. These items will be available within the omni completion list. |
4869 | 1683 |
1684 Some people may find this list unwieldy or are only interested in certain | |
1685 items. There are two ways to prune this list (if necessary). If you find | |
13125 | 1686 certain syntax groups you do not wish displayed you can use two different |
1687 methods to identify these groups. The first specifically lists the syntax | |
1688 groups by name. The second uses a regular expression to identify both | |
4869 | 1689 syntax groups. Simply add one the following to your vimrc: > |
1690 let g:omni_syntax_group_exclude_php = 'phpCoreConstant,phpConstant' | |
1691 let g:omni_syntax_group_exclude_php = 'php\w*Constant' | |
702 | 1692 |
1693 Add as many syntax groups to this list by comma separating them. The basic | |
1694 form of this variable is: > | |
4869 | 1695 let g:omni_syntax_group_exclude_{filetype} = 'regex,comma,separated' |
702 | 1696 |
1697 You can create as many of these variables as you need, varying only the | |
1698 filetype at the end of the variable name. | |
625 | 1699 |
1121 | 1700 The plugin uses the isKeyword option to determine where word boundaries are |
1701 for the syntax items. For example, in the Scheme language completion should | |
1702 include the "-", call-with-output-file. Depending on your filetype, this may | |
1703 not provide the words you are expecting. Setting the | |
1704 g:omni_syntax_use_iskeyword option to 0 will force the syntax plugin to break | |
1705 on word characters. This can be controlled adding the following to your | |
1706 vimrc: > | |
1707 let g:omni_syntax_use_iskeyword = 0 | |
1708 | |
2439 | 1709 For plugin developers, the plugin exposes a public function OmniSyntaxList. |
1710 This function can be used to request a List of syntax items. When editing a | |
13125 | 1711 SQL file (:e syntax.sql) you can use the ":syntax list" command to see the |
2439 | 1712 various groups and syntax items. For example: > |
13125 | 1713 syntax list |
2439 | 1714 |
13125 | 1715 Yields data similar to this: |
1716 sqlOperator xxx some prior all like and any escape exists in is not ~ | |
1717 or intersect minus between distinct ~ | |
1718 links to Operator ~ | |
1719 sqlType xxx varbit varchar nvarchar bigint int uniqueidentifier ~ | |
1720 date money long tinyint unsigned xml text smalldate ~ | |
1721 double datetime nchar smallint numeric time bit char ~ | |
1722 varbinary binary smallmoney ~ | |
1723 image float integer timestamp real decimal ~ | |
2439 | 1724 |
1725 There are two syntax groups listed here: sqlOperator and sqlType. To retrieve | |
13125 | 1726 a List of syntax items you can call OmniSyntaxList a number of different |
2439 | 1727 ways. To retrieve all syntax items regardless of syntax group: > |
1728 echo OmniSyntaxList( [] ) | |
1729 | |
1730 To retrieve only the syntax items for the sqlOperator syntax group: > | |
1731 echo OmniSyntaxList( ['sqlOperator'] ) | |
1732 | |
1733 To retrieve all syntax items for both the sqlOperator and sqlType groups: > | |
1734 echo OmniSyntaxList( ['sqlOperator', 'sqlType'] ) | |
1735 | |
4869 | 1736 A regular expression can also be used: > |
1737 echo OmniSyntaxList( ['sql\w\+'] ) | |
1738 | |
2439 | 1739 From within a plugin, you would typically assign the output to a List: > |
1740 let myKeywords = [] | |
1741 let myKeywords = OmniSyntaxList( ['sqlKeyword'] ) | |
1742 | |
625 | 1743 |
818 | 1744 SQL *ft-sql-omni* |
1745 | |
1746 Completion for the SQL language includes statements, functions, keywords. | |
1747 It will also dynamically complete tables, procedures, views and column lists | |
1748 with data pulled directly from within a database. For detailed instructions | |
1749 and a tutorial see |omni-sql-completion|. | |
1750 | |
819 | 1751 The SQL completion plugin can be used in conjunction with other completion |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1752 plugins. For example, the PHP filetype has its own completion plugin. |
819 | 1753 Since PHP is often used to generate dynamic website by accessing a database, |
1754 the SQL completion plugin can also be enabled. This allows you to complete | |
1755 PHP code and SQL code at the same time. | |
1756 | |
818 | 1757 |
625 | 1758 XML *ft-xml-omni* |
557 | 1759 |
859 | 1760 Vim 7 provides a mechanism for context aware completion of XML files. It |
1761 depends on a special |xml-omni-datafile| and two commands: |:XMLns| and | |
1762 |:XMLent|. Features are: | |
557 | 1763 |
859 | 1764 - after "<" complete the tag name, depending on context |
1765 - inside of a tag complete proper attributes | |
1766 - when an attribute has a limited number of possible values help to complete | |
557 | 1767 them |
859 | 1768 - complete names of entities (defined in |xml-omni-datafile| and in the |
1769 current file with "<!ENTITY" declarations) | |
557 | 1770 - when used after "</" CTRL-X CTRL-O will close the last opened tag |
1771 | |
625 | 1772 Format of XML data file *xml-omni-datafile* |
557 | 1773 |
859 | 1774 XML data files are stored in the "autoload/xml" directory in 'runtimepath'. |
1775 Vim distribution provides examples of data files in the | |
1776 "$VIMRUNTIME/autoload/xml" directory. They have a meaningful name which will | |
1777 be used in commands. It should be a unique name which will not create | |
1778 conflicts. For example, the name xhtml10s.vim means it is the data file for | |
1779 XHTML 1.0 Strict. | |
557 | 1780 |
859 | 1781 Each file contains a variable with a name like g:xmldata_xhtml10s . It is |
1782 a compound from two parts: | |
557 | 1783 |
859 | 1784 1. "g:xmldata_" general prefix, constant for all data files |
1785 2. "xhtml10s" the name of the file and the name of the described XML | |
1786 dialect; it will be used as an argument for the |:XMLns| | |
1787 command | |
557 | 1788 |
1789 Part two must be exactly the same as name of file. | |
1790 | |
859 | 1791 The variable is a |Dictionary|. Keys are tag names and each value is a two |
1792 element |List|. The first element of the List is also a List with the names | |
1793 of possible children. The second element is a |Dictionary| with the names of | |
1794 attributes as keys and the possible values of attributes as values. Example: > | |
557 | 1795 |
859 | 1796 let g:xmldata_crippled = { |
1797 \ "vimxmlentities": ["amp", "lt", "gt", "apos", "quot"], | |
1798 \ 'vimxmlroot': ['tag1'], | |
1799 \ 'tag1': | |
1800 \ [ ['childoftag1a', 'childoftag1b'], {'attroftag1a': [], | |
1801 \ 'attroftag1b': ['valueofattr1', 'valueofattr2']}], | |
1802 \ 'childoftag1a': | |
1803 \ [ [], {'attrofchild': ['attrofchild']}], | |
1804 \ 'childoftag1b': | |
1805 \ [ ['childoftag1a'], {'attrofchild': []}], | |
667 | 1806 \ "vimxmltaginfo": { |
859 | 1807 \ 'tag1': ['Menu info', 'Long information visible in preview window']}, |
1808 \ 'vimxmlattrinfo': { | |
1809 \ 'attrofchild': ['Menu info', 'Long information visible in preview window']}} | |
557 | 1810 |
859 | 1811 This example would be put in the "autoload/xml/crippled.vim" file and could |
1812 help to write this file: > | |
557 | 1813 |
859 | 1814 <tag1 attroftag1b="valueofattr1"> |
1815 <childoftag1a attrofchild> | |
1816 & < | |
1817 </childoftag1a> | |
1818 <childoftag1b attrofchild="5"> | |
1819 <childoftag1a> | |
1820 > ' " | |
1821 </childoftag1a> | |
1822 </childoftag1b> | |
1823 </tag1> | |
1824 | |
1825 In the example four special elements are visible: | |
1826 | |
1827 1. "vimxmlentities" - a special key with List containing entities of this XML | |
557 | 1828 dialect. |
859 | 1829 2. If the list containing possible values of attributes has one element and |
1830 this element is equal to the name of the attribute this attribute will be | |
1831 treated as boolean and inserted as 'attrname' and not as 'attrname="' | |
1832 3. "vimxmltaginfo" - a special key with a Dictionary containing tag | |
1833 names as keys and two element List as values, for additional menu info and | |
1834 the long description. | |
1835 4. "vimxmlattrinfo" - special key with Dictionary containing attribute names | |
1836 as keys and two element List as values, for additional menu info and long | |
667 | 1837 description. |
557 | 1838 |
859 | 1839 Note: Tag names in the data file MUST not contain a namespace description. |
1840 Check xsl.vim for an example. | |
1841 Note: All data and functions are publicly available as global | |
1842 variables/functions and can be used for personal editing functions. | |
557 | 1843 |
667 | 1844 |
856 | 1845 DTD -> Vim *dtd2vim* |
836 | 1846 |
859 | 1847 On |www| is the script |dtd2vim| which parses DTD and creates an XML data file |
836 | 1848 for Vim XML omni completion. |
1849 | |
1850 dtd2vim: http://www.vim.org/scripts/script.php?script_id=1462 | |
1851 | |
859 | 1852 Check the beginning of that file for usage details. |
1853 The script requires perl and: | |
836 | 1854 |
1855 perlSGML: http://savannah.nongnu.org/projects/perlsgml | |
1856 | |
1857 | |
557 | 1858 Commands |
1859 | |
625 | 1860 :XMLns {name} [{namespace}] *:XMLns* |
557 | 1861 |
859 | 1862 Vim has to know which data file should be used and with which namespace. For |
1863 loading of the data file and connecting data with the proper namespace use | |
1864 |:XMLns| command. The first (obligatory) argument is the name of the data | |
1865 (xhtml10s, xsl). The second argument is the code of namespace (h, xsl). When | |
1866 used without a second argument the dialect will be used as default - without | |
1867 namespace declaration. For example to use XML completion in .xsl files: > | |
557 | 1868 |
1869 :XMLns xhtml10s | |
1870 :XMLns xsl xsl | |
1871 | |
1872 | |
625 | 1873 :XMLent {name} *:XMLent* |
557 | 1874 |
859 | 1875 By default entities will be completed from the data file of the default |
1876 namespace. The XMLent command should be used in case when there is no default | |
1877 namespace: > | |
557 | 1878 |
625 | 1879 :XMLent xhtml10s |
557 | 1880 |
1881 Usage | |
1882 | |
859 | 1883 While used in this situation (after declarations from previous part, | is |
557 | 1884 cursor position): > |
1885 | |
625 | 1886 <| |
557 | 1887 |
859 | 1888 Will complete to an appropriate XHTML tag, and in this situation: > |
557 | 1889 |
625 | 1890 <xsl:| |
557 | 1891 |
859 | 1892 Will complete to an appropriate XSL tag. |
1893 | |
557 | 1894 |
859 | 1895 The script xmlcomplete.vim, provided through the |autoload| mechanism, |
1896 has the xmlcomplete#GetLastOpenTag() function which can be used in XML files | |
1897 to get the name of the last open tag (b:unaryTagsStack has to be defined): > | |
529 | 1898 |
625 | 1899 :echo xmlcomplete#GetLastOpenTag("b:unaryTagsStack") |
531 | 1900 |
529 | 1901 |
532 | 1902 |
7 | 1903 ============================================================================== |
1904 8. Insert mode commands *inserting* | |
1905 | |
1906 The following commands can be used to insert new text into the buffer. They | |
1907 can all be undone and repeated with the "." command. | |
1908 | |
1909 *a* | |
1910 a Append text after the cursor [count] times. If the | |
1911 cursor is in the first column of an empty line Insert | |
1912 starts there. But not when 'virtualedit' is set! | |
1913 | |
1914 *A* | |
1915 A Append text at the end of the line [count] times. | |
22328 | 1916 For using "A" in Visual block mode see |v_b_A|. |
7 | 1917 |
1918 <insert> or *i* *insert* *<Insert>* | |
1919 i Insert text before the cursor [count] times. | |
1920 When using CTRL-O in Insert mode |i_CTRL-O| the count | |
1921 is not supported. | |
1922 | |
1923 *I* | |
1924 I Insert text before the first non-blank in the line | |
1925 [count] times. | |
164 | 1926 When the 'H' flag is present in 'cpoptions' and the |
1927 line only contains blanks, insert start just before | |
1928 the last blank. | |
22328 | 1929 For using "I" in Visual block mode see |v_b_I|. |
7 | 1930 |
1931 *gI* | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
1932 gI Insert text in column 1 [count] times. |
7 | 1933 |
1934 *gi* | |
1935 gi Insert text in the same position as where Insert mode | |
1936 was stopped last time in the current buffer. | |
1937 This uses the |'^| mark. It's different from "`^i" | |
1938 when the mark is past the end of the line. | |
1939 The position is corrected for inserted/deleted lines, | |
1940 but NOT for inserted/deleted characters. | |
1941 When the |:keepjumps| command modifier is used the |'^| | |
9 | 1942 mark won't be changed. |
7 | 1943 |
1944 *o* | |
1945 o Begin a new line below the cursor and insert text, | |
16610 | 1946 repeat [count] times. |
164 | 1947 When the '#' flag is in 'cpoptions' the count is |
1948 ignored. | |
7 | 1949 |
1950 *O* | |
1951 O Begin a new line above the cursor and insert text, | |
16610 | 1952 repeat [count] times. |
164 | 1953 When the '#' flag is in 'cpoptions' the count is |
1954 ignored. | |
7 | 1955 |
1956 These commands are used to start inserting text. You can end insert mode with | |
1957 <Esc>. See |mode-ins-repl| for the other special characters in Insert mode. | |
1958 The effect of [count] takes place after Insert mode is exited. | |
1959 | |
1960 When 'autoindent' is on, the indent for a new line is obtained from the | |
1961 previous line. When 'smartindent' or 'cindent' is on, the indent for a line | |
1962 is automatically adjusted for C programs. | |
1963 | |
26847 | 1964 'formatoptions' can be set to copy the comment leader when opening a new |
1965 line. | |
1966 | |
7 | 1967 'textwidth' can be set to the maximum width for a line. When a line becomes |
1968 too long when appending characters a line break is automatically inserted. | |
1969 | |
1970 | |
1971 ============================================================================== | |
1972 9. Ex insert commands *inserting-ex* | |
1973 | |
1974 *:a* *:append* | |
167 | 1975 :{range}a[ppend][!] Insert several lines of text below the specified |
7 | 1976 line. If the {range} is missing, the text will be |
1977 inserted after the current line. | |
167 | 1978 Adding [!] toggles 'autoindent' for the time this |
1979 command is executed. | |
26779 | 1980 This command is not supported in |Vim9| script, |
1981 because it is too easily confused with a variable | |
1982 name. | |
7 | 1983 |
1984 *:i* *:in* *:insert* | |
167 | 1985 :{range}i[nsert][!] Insert several lines of text above the specified |
7 | 1986 line. If the {range} is missing, the text will be |
1987 inserted before the current line. | |
167 | 1988 Adding [!] toggles 'autoindent' for the time this |
1989 command is executed. | |
26779 | 1990 This command is not supported in |Vim9| script, |
1991 because it is too easily confused with a variable | |
1992 name. | |
7 | 1993 |
1994 These two commands will keep on asking for lines, until you type a line | |
1995 containing only a ".". Watch out for lines starting with a backslash, see | |
1996 |line-continuation|. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1997 |
2596 | 1998 When in Ex mode (see |-e|) a backslash at the end of the line can be used to |
1999 insert a NUL character. To be able to have a line ending in a backslash use | |
2000 two backslashes. This means that the number of backslashes is halved, but | |
2001 only at the end of the line. | |
2002 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2003 NOTE: These commands cannot be used with |:global| or |:vglobal|. |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
2004 ":append" and ":insert" don't work properly in between ":if" and |
74 | 2005 ":endif", ":for" and ":endfor", ":while" and ":endwhile". |
7 | 2006 |
2007 *:start* *:startinsert* | |
2008 :star[tinsert][!] Start Insert mode just after executing this command. | |
2009 Works like typing "i" in Normal mode. When the ! is | |
2010 included it works like "A", append to the line. | |
2011 Otherwise insertion starts at the cursor position. | |
2012 Note that when using this command in a function or | |
2013 script, the insertion only starts after the function | |
2014 or script is finished. | |
446 | 2015 This command does not work from |:normal|. |
7 | 2016 |
2017 *:stopi* *:stopinsert* | |
2018 :stopi[nsert] Stop Insert mode as soon as possible. Works like | |
2019 typing <Esc> in Insert mode. | |
2020 Can be used in an autocommand, example: > | |
2021 :au BufEnter scratch stopinsert | |
14 | 2022 < |
2023 *replacing-ex* *:startreplace* | |
2024 :startr[eplace][!] Start Replace mode just after executing this command. | |
2025 Works just like typing "R" in Normal mode. When the | |
2026 ! is included it acts just like "$R" had been typed | |
2027 (ie. begin replace mode at the end-of-line). Other- | |
2028 wise replacement begins at the cursor position. | |
2029 Note that when using this command in a function or | |
2030 script that the replacement will only start after | |
2031 the function or script is finished. | |
7 | 2032 |
599 | 2033 *:startgreplace* |
2034 :startg[replace][!] Just like |:startreplace|, but use Virtual Replace | |
2035 mode, like with |gR|. | |
2036 | |
7 | 2037 ============================================================================== |
2038 10. Inserting a file *inserting-file* | |
2039 | |
2040 *:r* *:re* *:read* | |
819 | 2041 :r[ead] [++opt] [name] |
2042 Insert the file [name] (default: current file) below | |
7 | 2043 the cursor. |
819 | 2044 See |++opt| for the possible values of [++opt]. |
7 | 2045 |
819 | 2046 :{range}r[ead] [++opt] [name] |
2047 Insert the file [name] (default: current file) below | |
7 | 2048 the specified line. |
819 | 2049 See |++opt| for the possible values of [++opt]. |
7 | 2050 |
2051 *:r!* *:read!* | |
4278 | 2052 :[range]r[ead] [++opt] !{cmd} |
2053 Execute {cmd} and insert its standard output below | |
1121 | 2054 the cursor or the specified line. A temporary file is |
2055 used to store the output of the command which is then | |
2056 read into the buffer. 'shellredir' is used to save | |
2057 the output of the command, which can be set to include | |
2058 stderr or not. {cmd} is executed like with ":!{cmd}", | |
2059 any '!' is replaced with the previous command |:!|. | |
4278 | 2060 See |++opt| for the possible values of [++opt]. |
7 | 2061 |
2062 These commands insert the contents of a file, or the output of a command, | |
2063 into the buffer. They can be undone. They cannot be repeated with the "." | |
2064 command. They work on a line basis, insertion starts below the line in which | |
2065 the cursor is, or below the specified line. To insert text above the first | |
2066 line use the command ":0r {name}". | |
2067 | |
2068 After the ":read" command, the cursor is left on the first non-blank in the | |
2069 first new line. Unless in Ex mode, then the cursor is left on the last new | |
2070 line (sorry, this is Vi compatible). | |
2071 | |
2072 If a file name is given with ":r", it becomes the alternate file. This can be | |
2073 used, for example, when you want to edit that file instead: ":e! #". This can | |
2074 be switched off by removing the 'a' flag from the 'cpoptions' option. | |
2075 | |
819 | 2076 Of the [++opt] arguments one is specifically for ":read", the ++edit argument. |
2077 This is useful when the ":read" command is actually used to read a file into | |
2078 the buffer as if editing that file. Use this command in an empty buffer: > | |
2079 :read ++edit filename | |
2080 The effect is that the 'fileformat', 'fileencoding', 'bomb', etc. options are | |
2081 set to what has been detected for "filename". Note that a single empty line | |
2082 remains, you may want to delete it. | |
2083 | |
7 | 2084 *file-read* |
2085 The 'fileformat' option sets the <EOL> style for a file: | |
2086 'fileformat' characters name ~ | |
2087 "dos" <CR><NL> or <NL> DOS format | |
2088 "unix" <NL> Unix format | |
2089 "mac" <CR> Mac format | |
2090 Previously 'textmode' was used. It is obsolete now. | |
2091 | |
2092 If 'fileformat' is "dos", a <CR> in front of an <NL> is ignored and a CTRL-Z | |
2093 at the end of the file is ignored. | |
2094 | |
2095 If 'fileformat' is "mac", a <NL> in the file is internally represented by a | |
2096 <CR>. This is to avoid confusion with a <NL> which is used to represent a | |
2097 <NUL>. See |CR-used-for-NL|. | |
2098 | |
2099 If the 'fileformats' option is not empty Vim tries to recognize the type of | |
2100 <EOL> (see |file-formats|). However, the 'fileformat' option will not be | |
2101 changed, the detected format is only used while reading the file. | |
2102 A similar thing happens with 'fileencodings'. | |
2103 | |
19116 | 2104 On non-Win32 systems the message "[dos format]" is shown if a file is read in |
2105 DOS format, to remind you that something unusual is done. | |
18972 | 2106 On Macintosh and Win32 the message "[unix format]" is shown if a file is read |
2107 in Unix format. | |
19116 | 2108 On non-Macintosh systems, the message "[mac format]" is shown if a file is |
7 | 2109 read in Mac format. |
2110 | |
2111 An example on how to use ":r !": > | |
2112 :r !uuencode binfile binfile | |
2113 This command reads "binfile", uuencodes it and reads it into the current | |
2114 buffer. Useful when you are editing e-mail and want to include a binary | |
2115 file. | |
2116 | |
2117 *read-messages* | |
2118 When reading a file Vim will display a message with information about the read | |
2119 file. In the table is an explanation for some of the items. The others are | |
2120 self explanatory. Using the long or the short version depends on the | |
2121 'shortmess' option. | |
2122 | |
2123 long short meaning ~ | |
2124 [readonly] {RO} the file is write protected | |
2125 [fifo/socket] using a stream | |
2126 [fifo] using a fifo stream | |
2127 [socket] using a socket stream | |
2128 [CR missing] reading with "dos" 'fileformat' and a | |
2129 NL without a preceding CR was found. | |
2130 [NL found] reading with "mac" 'fileformat' and a | |
2131 NL was found (could be "unix" format) | |
2132 [long lines split] at least one line was split in two | |
2133 [NOT converted] conversion from 'fileencoding' to | |
2134 'encoding' was desired but not | |
2135 possible | |
2136 [converted] conversion from 'fileencoding' to | |
2137 'encoding' done | |
2138 [crypted] file was decrypted | |
2139 [READ ERRORS] not all of the file could be read | |
2140 | |
2141 | |
14421 | 2142 vim:tw=78:ts=8:noet:ft=help:norl: |