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