blob: 45dc58ef176cbe061872d78481a0d4dadec1333a [file] [log] [blame]
Bram Moolenaarf2571c62015-06-09 19:44:55 +02001*insert.txt* For Vim version 7.4. Last change: 2015 May 22
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7 *Insert* *Insert-mode*
8Inserting and replacing text *mode-ins-repl*
9
10Most of this file is about Insert and Replace mode. At the end are a few
11commands for inserting text in other ways.
12
13An overview of the most often used commands can be found in chapter 24 of the
14user manual |usr_24.txt|.
15
161. Special keys |ins-special-keys|
172. Special special keys |ins-special-special|
183. 'textwidth' and 'wrapmargin' options |ins-textwidth|
194. 'expandtab', 'smarttab' and 'softtabstop' options |ins-expandtab|
205. Replace mode |Replace-mode|
216. Virtual Replace mode |Virtual-Replace-mode|
227. Insert mode completion |ins-completion|
238. Insert mode commands |inserting|
249. Ex insert commands |inserting-ex|
2510. Inserting a file |inserting-file|
26
27Also see 'virtualedit', for moving the cursor to positions where there is no
28character. Useful for editing a table.
29
30==============================================================================
311. Special keys *ins-special-keys*
32
33In Insert and Replace mode, the following characters have a special meaning;
34other characters are inserted directly. To insert one of these special
35characters into the buffer, precede it with CTRL-V. To insert a <Nul>
36character use "CTRL-V CTRL-@" or "CTRL-V 000". On some systems, you have to
37use "CTRL-V 003" to insert a CTRL-C. Note: When CTRL-V is mapped you can
38often use CTRL-Q instead |i_CTRL-Q|.
39
40If 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
42all the time.
43
44If you have 'insertmode' set, <Esc> and a few other keys get another meaning.
45See |'insertmode'|.
46
47char 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-[.
Bram Moolenaarfb539272014-08-22 19:21:47 +020054 If Esc doesn't work and you are using a Mac, try CTRL-Esc.
55 Or disable Listening under Accessibility preferences.
Bram Moolenaar071d4272004-06-13 20:20:40 +000056 *i_CTRL-C*
57CTRL-C Quit insert mode, go back to Normal mode. Do not check for
Bram Moolenaar677ee682005-01-27 14:41:15 +000058 abbreviations. Does not trigger the |InsertLeave| autocommand
59 event.
Bram Moolenaar071d4272004-06-13 20:20:40 +000060
61 *i_CTRL-@*
62CTRL-@ Insert previously inserted text and stop insert. {Vi: only
63 when typed as first char, only up to 128 chars}
64 *i_CTRL-A*
65CTRL-A Insert previously inserted text. {not in Vi}
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.
71 {Vi: does not delete autoindents}
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 {not in Vi}
79 *i_CTRL-W*
80CTRL-W Delete the word before the cursor (see |i_backspacing| about
81 joining lines). See the section "word motions",
82 |word-motions|, for the definition of a word.
83 *i_CTRL-U*
Bram Moolenaarf2571c62015-06-09 19:44:55 +020084CTRL-U Delete all entered characters before the cursor in the current
85 line. If there are no newly entereed characters and
86 'backspace'is not empty, delete all characters before the
87 cursor in the current line.
88 See |i_backspacing| about joining lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +000089 *i_CTRL-I* *i_<Tab>* *i_Tab*
90<Tab> or CTRL-I Insert a tab. If the 'expandtab' option is on, the
91 equivalent number of spaces is inserted (use CTRL-V <Tab> to
92 avoid the expansion; use CTRL-Q <Tab> if CTRL-V is mapped
93 |i_CTRL-Q|). See also the 'smarttab' option and
94 |ins-expandtab|.
95 *i_CTRL-J* *i_<NL>*
96<NL> or CTRL-J Begin new line.
97 *i_CTRL-M* *i_<CR>*
98<CR> or CTRL-M Begin new line.
99 *i_CTRL-K*
100CTRL-K {char1} [char2]
101 Enter digraph (see |digraphs|). When {char1} is a special
102 key, the code for that key is inserted in <> form. For
103 example, the string "<S-Space>" can be entered by typing
104 <C-K><S-Space> (two keys). Neither char is considered for
105 mapping. {not in Vi}
106
107CTRL-N Find next keyword (see |i_CTRL-N|). {not in Vi}
108CTRL-P Find previous keyword (see |i_CTRL-P|). {not in Vi}
109
110CTRL-R {0-9a-z"%#*+:.-=} *i_CTRL-R*
111 Insert the contents of a register. Between typing CTRL-R and
112 the second character, '"' will be displayed to indicate that
113 you are expected to enter the name of a register.
114 The text is inserted as if you typed it, but mappings and
115 abbreviations are not used. If you have options like
116 'textwidth', 'formatoptions', or 'autoindent' set, this will
117 influence what will be inserted. This is different from what
118 happens with the "p" command and pasting with the mouse.
119 Special registers:
120 '"' the unnamed register, containing the text of
121 the last delete or yank
122 '%' the current file name
123 '#' the alternate file name
124 '*' the clipboard contents (X11: primary selection)
125 '+' the clipboard contents
126 '/' the last search pattern
127 ':' the last command-line
128 '.' the last inserted text
129 '-' the last small (less than a line) delete
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100130 *i_CTRL-R_=*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000131 '=' the expression register: you are prompted to
132 enter an expression (see |expression|)
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000133 Note that 0x80 (128 decimal) is used for
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000134 special keys. E.g., you can use this to move
135 the cursor up:
136 CTRL-R ="\<Up>"
137 Use CTRL-R CTRL-R to insert text literally.
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000138 When the result is a |List| the items are used
139 as lines. They can have line breaks inside
140 too.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100141 When the result is a Float it's automatically
142 converted to a String.
Bram Moolenaar94f76b72013-07-04 22:50:40 +0200143 When append() or setline() is invoked the undo
144 sequence will be broken.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000145 See |registers| about registers. {not in Vi}
146
147CTRL-R CTRL-R {0-9a-z"%#*+/:.-=} *i_CTRL-R_CTRL-R*
148 Insert the contents of a register. Works like using a single
149 CTRL-R, but the text is inserted literally, not as if typed.
150 This differs when the register contains characters like <BS>.
151 Example, where register a contains "ab^Hc": >
152 CTRL-R a results in "ac".
153 CTRL-R CTRL-R a results in "ab^Hc".
154< Options 'textwidth', 'formatoptions', etc. still apply. If
155 you also want to avoid these, use "<C-R><C-O>r", see below.
156 The '.' register (last inserted text) is still inserted as
157 typed. {not in Vi}
158
159CTRL-R CTRL-O {0-9a-z"%#*+/:.-=} *i_CTRL-R_CTRL-O*
160 Insert the contents of a register literally and don't
161 auto-indent. Does the same as pasting with the mouse
162 |<MiddleMouse>|.
163 Does not replace characters!
164 The '.' register (last inserted text) is still inserted as
165 typed. {not in Vi}
166
167CTRL-R CTRL-P {0-9a-z"%#*+/:.-=} *i_CTRL-R_CTRL-P*
168 Insert the contents of a register literally and fix the
169 indent, like |[<MiddleMouse>|.
170 Does not replace characters!
171 The '.' register (last inserted text) is still inserted as
172 typed. {not in Vi}
173
174 *i_CTRL-T*
175CTRL-T Insert one shiftwidth of indent at the start of the current
176 line. The indent is always rounded to a 'shiftwidth' (this is
177 vi compatible). {Vi: only when in indent}
178 *i_CTRL-D*
179CTRL-D Delete one shiftwidth of indent at the start of the current
180 line. The indent is always rounded to a 'shiftwidth' (this is
181 vi compatible). {Vi: CTRL-D works only when used after
182 autoindent}
183 *i_0_CTRL-D*
1840 CTRL-D Delete all indent in the current line. {Vi: CTRL-D works
185 only when used after autoindent}
186 *i_^_CTRL-D*
187^ CTRL-D Delete all indent in the current line. The indent is
188 restored in the next line. This is useful when inserting a
189 label. {Vi: CTRL-D works only when used after autoindent}
190
191 *i_CTRL-V*
192CTRL-V Insert next non-digit literally. For special keys, the
193 terminal code is inserted. It's also possible to enter the
194 decimal, octal or hexadecimal value of a character
195 |i_CTRL-V_digit|.
196 The characters typed right after CTRL-V are not considered for
197 mapping. {Vi: no decimal byte entry}
198 Note: When CTRL-V is mapped (e.g., to paste text) you can
199 often use CTRL-Q instead |i_CTRL-Q|.
200
201 *i_CTRL-Q*
202CTRL-Q Same as CTRL-V.
203 Note: Some terminal connections may eat CTRL-Q, it doesn't
204 work then. It does work in the GUI.
205
206CTRL-X Enter CTRL-X mode. This is a sub-mode where commands can
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000207 be given to complete words or scroll the window. See
Bram Moolenaar071d4272004-06-13 20:20:40 +0000208 |i_CTRL-X| and |ins-completion|. {not in Vi}
209
210 *i_CTRL-E*
211CTRL-E Insert the character which is below the cursor. {not in Vi}
212 *i_CTRL-Y*
213CTRL-Y Insert the character which is above the cursor. {not in Vi}
214 Note that for CTRL-E and CTRL-Y 'textwidth' is not used, to be
215 able to copy characters from a long line.
216
217 *i_CTRL-_*
218CTRL-_ Switch between languages, as follows:
219 - When in a rightleft window, revins and nohkmap are toggled,
220 since English will likely be inserted in this case.
221 - When in a norightleft window, revins and hkmap are toggled,
222 since Hebrew will likely be inserted in this case.
223
224 CTRL-_ moves the cursor to the end of the typed text.
225
226 This command is only available when the 'allowrevins' option
227 is set.
228 Please refer to |rileft.txt| for more information about
229 right-to-left mode.
230 {not in Vi}
Bram Moolenaar9964e462007-05-05 17:54:07 +0000231 Only if compiled with the |+rightleft| feature.
232
Bram Moolenaar071d4272004-06-13 20:20:40 +0000233 *i_CTRL-^*
234CTRL-^ Toggle the use of typing language characters.
235 When language |:lmap| mappings are defined:
236 - If 'iminsert' is 1 (langmap mappings used) it becomes 0 (no
237 langmap mappings used).
238 - If 'iminsert' has another value it becomes 1, thus langmap
239 mappings are enabled.
240 When no language mappings are defined:
241 - If 'iminsert' is 2 (Input Method used) it becomes 0 (no
242 Input Method used).
243 - If 'iminsert' has another value it becomes 2, thus the Input
244 Method is enabled.
245 When set to 1, the value of the "b:keymap_name" variable, the
246 'keymap' option or "<lang>" appears in the status line.
247 The language mappings are normally used to type characters
248 that are different from what the keyboard produces. The
249 'keymap' option can be used to install a whole number of them.
250 {not in Vi}
251
252 *i_CTRL-]*
253CTRL-] Trigger abbreviation, without inserting a character. {not in
254 Vi}
255
256 *i_<Insert>*
257<Insert> Toggle between Insert and Replace mode. {not in Vi}
258-----------------------------------------------------------------------
259
260 *i_backspacing*
261The effect of the <BS>, CTRL-W, and CTRL-U depend on the 'backspace' option
262(unless 'revins' is set). This is a comma separated list of items:
263
264item action ~
265indent allow backspacing over autoindent
266eol allow backspacing over end-of-line (join lines)
267start allow backspacing over the start position of insert; CTRL-W and
268 CTRL-U stop once at the start position
269
270When 'backspace' is empty, Vi compatible backspacing is used. You cannot
271backspace over autoindent, before column 1 or before where insert started.
272
273For backwards compatibility the values "0", "1" and "2" are also allowed, see
274|'backspace'|.
275
276If the 'backspace' option does contain "eol" and the cursor is in column 1
277when one of the three keys is used, the current line is joined with the
278previous line. This effectively deletes the <EOL> in front of the cursor.
279{Vi: does not cross lines, does not delete past start position of insert}
280
281 *i_CTRL-V_digit*
282With CTRL-V the decimal, octal or hexadecimal value of a character can be
283entered directly. This way you can enter any character, except a line break
284(<NL>, value 10). There are five ways to enter the character value:
285
286first char mode max nr of chars max value ~
287(none) decimal 3 255
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000288o or O octal 3 377 (255)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000289x or X hexadecimal 2 ff (255)
290u hexadecimal 4 ffff (65535)
291U hexadecimal 8 7fffffff (2147483647)
292
293Normally you would type the maximum number of characters. Thus to enter a
294space (value 32) you would type <C-V>032. You can omit the leading zero, in
295which case the character typed after the number must be a non-digit. This
296happens for the other modes as well: As soon as you type a character that is
297invalid for the mode, the value before it will be used and the "invalid"
298character is dealt with in the normal way.
299
300If you enter a value of 10, it will end up in the file as a 0. The 10 is a
301<NL>, which is used internally to represent the <Nul> character. When writing
302the buffer to a file, the <NL> character is translated into <Nul>. The <NL>
303character is written at the end of each line. Thus if you want to insert a
304<NL> character in a file you will have to make a line break.
305
306 *i_CTRL-X* *insert_expand*
307CTRL-X enters a sub-mode where several commands can be used. Most of these
308commands do keyword completion; see |ins-completion|. These are not available
309when Vim was compiled without the |+insert_expand| feature.
310
311Two commands can be used to scroll the window up or down, without exiting
312insert mode:
313
314 *i_CTRL-X_CTRL-E*
315CTRL-X CTRL-E scroll window one line up.
Bram Moolenaard2cec5b2006-03-28 21:08:56 +0000316 When doing completion look here: |complete_CTRL-E|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000317
318 *i_CTRL-X_CTRL-Y*
319CTRL-X CTRL-Y scroll window one line down.
Bram Moolenaard2cec5b2006-03-28 21:08:56 +0000320 When doing completion look here: |complete_CTRL-Y|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000321
322After CTRL-X is pressed, each CTRL-E (CTRL-Y) scrolls the window up (down) by
323one line unless that would cause the cursor to move from its current position
324in the file. As soon as another key is pressed, CTRL-X mode is exited and
325that key is interpreted as in Insert mode.
326
327
328==============================================================================
3292. Special special keys *ins-special-special*
330
331The following keys are special. They stop the current insert, do something,
332and then restart insertion. This means you can do something without getting
333out of Insert mode. This is very handy if you prefer to use the Insert mode
334all the time, just like editors that don't have a separate Normal mode. You
335may also want to set the 'backspace' option to "indent,eol,start" and set the
336'insertmode' option. You can use CTRL-O if you want to map a function key to
337a command.
338
339The changes (inserted or deleted characters) before and after these keys can
340be undone separately. Only the last change can be redone and always behaves
341like an "i" command.
342
343char action ~
344-----------------------------------------------------------------------
345<Up> cursor one line up *i_<Up>*
346<Down> cursor one line down *i_<Down>*
347CTRL-G <Up> cursor one line up, insert start column *i_CTRL-G_<Up>*
348CTRL-G k cursor one line up, insert start column *i_CTRL-G_k*
349CTRL-G CTRL-K cursor one line up, insert start column *i_CTRL-G_CTRL-K*
350CTRL-G <Down> cursor one line down, insert start column *i_CTRL-G_<Down>*
351CTRL-G j cursor one line down, insert start column *i_CTRL-G_j*
352CTRL-G CTRL-J cursor one line down, insert start column *i_CTRL-G_CTRL-J*
353<Left> cursor one character left *i_<Left>*
354<Right> cursor one character right *i_<Right>*
355<S-Left> cursor one word back (like "b" command) *i_<S-Left>*
356<C-Left> cursor one word back (like "b" command) *i_<C-Left>*
357<S-Right> cursor one word forward (like "w" command) *i_<S-Right>*
358<C-Right> cursor one word forward (like "w" command) *i_<C-Right>*
359<Home> cursor to first char in the line *i_<Home>*
360<End> cursor to after last char in the line *i_<End>*
361<C-Home> cursor to first char in the file *i_<C-Home>*
362<C-End> cursor to after last char in the file *i_<C-End>*
363<LeftMouse> cursor to position of mouse click *i_<LeftMouse>*
364<S-Up> move window one page up *i_<S-Up>*
365<PageUp> move window one page up *i_<PageUp>*
366<S-Down> move window one page down *i_<S-Down>*
367<PageDown> move window one page down *i_<PageDown>*
Bram Moolenaar8d9b40e2010-07-25 15:49:07 +0200368<ScrollWheelDown> move window three lines down *i_<ScrollWheelDown>*
369<S-ScrollWheelDown> move window one page down *i_<S-ScrollWheelDown>*
370<ScrollWheelUp> move window three lines up *i_<ScrollWheelUp>*
371<S-ScrollWheelUp> move window one page up *i_<S-ScrollWheelUp>*
372<ScrollWheelLeft> move window six columns left *i_<ScrollWheelLeft>*
373<S-ScrollWheelLeft> move window one page left *i_<S-ScrollWheelLeft>*
374<ScrollWheelRight> move window six columns right *i_<ScrollWheelRight>*
375<S-ScrollWheelRight> move window one page right *i_<S-ScrollWheelRight>*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000376CTRL-O execute one command, return to Insert mode *i_CTRL-O*
Bram Moolenaar4770d092006-01-12 23:22:24 +0000377CTRL-\ CTRL-O like CTRL-O but don't move the cursor *i_CTRL-\_CTRL-O*
Bram Moolenaar488c6512005-08-11 20:09:58 +0000378CTRL-L when 'insertmode' is set: go to Normal mode *i_CTRL-L*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000379CTRL-G u break undo sequence, start new change *i_CTRL-G_u*
380-----------------------------------------------------------------------
381
382Note: If the cursor keys take you out of Insert mode, check the 'noesckeys'
383option.
384
385The CTRL-O command sometimes has a side effect: If the cursor was beyond the
386end of the line, it will be put on the last character in the line. In
387mappings it's often better to use <Esc> (first put an "x" in the text, <Esc>
Bram Moolenaar488c6512005-08-11 20:09:58 +0000388will then always put the cursor on it). Or use CTRL-\ CTRL-O, but then
Bram Moolenaara3e6bc92013-01-30 14:18:00 +0100389beware of the cursor possibly being beyond the end of the line. Note that the
390command following CTRL-\ CTRL-O can still move the cursor, it is not restored
391to its original position.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000392
Bram Moolenaar05365702010-10-27 18:34:44 +0200393The CTRL-O command takes you to Normal mode. If you then use a command enter
Bram Moolenaard38b0552012-04-25 19:07:41 +0200394Insert mode again it normally doesn't nest. Thus when typing "a<C-O>a" and
395then <Esc> takes you back to Normal mode, you do not need to type <Esc> twice.
396An exception is when not typing the command, e.g. when executing a mapping or
397sourcing a script. This makes mappings work that briefly switch to Insert
398mode.
Bram Moolenaar05365702010-10-27 18:34:44 +0200399
Bram Moolenaar071d4272004-06-13 20:20:40 +0000400The shifted cursor keys are not available on all terminals.
401
402Another side effect is that a count specified before the "i" or "a" command is
403ignored. That is because repeating the effect of the command after CTRL-O is
404too complicated.
405
406An example for using CTRL-G u: >
407
408 :inoremap <C-H> <C-G>u<C-H>
409
410This redefines the backspace key to start a new undo sequence. You can now
411undo the effect of the backspace key, without changing what you typed before
Bram Moolenaar5b435d62012-04-05 17:33:26 +0200412that, with CTRL-O u. Another example: >
413
414 :inoremap <CR> <C-]><C-G>u<CR>
415
416This breaks undo at each line break. It also expands abbreviations before
417this.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000418
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000419Using CTRL-O splits undo: the text typed before and after it is undone
420separately. If you want to avoid this (e.g., in a mapping) you might be able
421to use CTRL-R = |i_CTRL-R|. E.g., to call a function: >
422 :imap <F2> <C-R>=MyFunc()<CR>
423
Bram Moolenaar071d4272004-06-13 20:20:40 +0000424When the 'whichwrap' option is set appropriately, the <Left> and <Right>
425keys on the first/last character in the line make the cursor wrap to the
426previous/next line.
427
428The CTRL-G j and CTRL-G k commands can be used to insert text in front of a
429column. Example: >
430 int i;
431 int j;
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000432Position the cursor on the first "int", type "istatic <C-G>j ". The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000433result is: >
434 static int i;
435 int j;
436When inserting the same text in front of the column in every line, use the
437Visual blockwise command "I" |v_b_I|.
438
439==============================================================================
4403. 'textwidth' and 'wrapmargin' options *ins-textwidth*
441
442The 'textwidth' option can be used to automatically break a line before it
443gets too long. Set the 'textwidth' option to the desired maximum line
444length. If you then type more characters (not spaces or tabs), the
445last word will be put on a new line (unless it is the only word on the
446line). If you set 'textwidth' to 0, this feature is disabled.
447
448The 'wrapmargin' option does almost the same. The difference is that
449'textwidth' has a fixed width while 'wrapmargin' depends on the width of the
450screen. When using 'wrapmargin' this is equal to using 'textwidth' with a
451value equal to (columns - 'wrapmargin'), where columns is the width of the
452screen.
453
454When 'textwidth' and 'wrapmargin' are both set, 'textwidth' is used.
455
456If you don't really want to break the line, but view the line wrapped at a
457convenient place, see the 'linebreak' option.
458
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000459The line is only broken automatically when using Insert mode, or when
Bram Moolenaar071d4272004-06-13 20:20:40 +0000460appending to a line. When in replace mode and the line length is not
461changed, the line will not be broken.
462
463Long lines are broken if you enter a non-white character after the margin.
464The situations where a line will be broken can be restricted by adding
465characters to the 'formatoptions' option:
466"l" Only break a line if it was not longer than 'textwidth' when the insert
467 started.
468"v" Only break at a white character that has been entered during the
469 current insert command. This is mostly Vi-compatible.
470"lv" Only break if the line was not longer than 'textwidth' when the insert
471 started and only at a white character that has been entered during the
472 current insert command. Only differs from "l" when entering non-white
473 characters while crossing the 'textwidth' boundary.
474
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000475Normally an internal function will be used to decide where to break the line.
476If you want to do it in a different way set the 'formatexpr' option to an
477expression that will take care of the line break.
478
Bram Moolenaar071d4272004-06-13 20:20:40 +0000479If you want to format a block of text, you can use the "gq" operator. Type
480"gq" and a movement command to move the cursor to the end of the block. In
481many cases, the command "gq}" will do what you want (format until the end of
482paragraph). Alternatively, you can use "gqap", which will format the whole
483paragraph, no matter where the cursor currently is. Or you can use Visual
484mode: hit "v", move to the end of the block, and type "gq". See also |gq|.
485
486==============================================================================
4874. 'expandtab', 'smarttab' and 'softtabstop' options *ins-expandtab*
488
489If the 'expandtab' option is on, spaces will be used to fill the amount of
490whitespace of the tab. If you want to enter a real <Tab>, type CTRL-V first
491(use CTRL-Q when CTRL-V is mapped |i_CTRL-Q|).
492The 'expandtab' option is off by default. Note that in Replace mode, a single
493character is replaced with several spaces. The result of this is that the
494number of characters in the line increases. Backspacing will delete one
495space at a time. The original character will be put back for only one space
496that you backspace over (the last one). {Vi does not have the 'expandtab'
497option}
498
499 *ins-smarttab*
500When the 'smarttab' option is on, a <Tab> inserts 'shiftwidth' positions at
501the beginning of a line and 'tabstop' positions in other places. This means
Bram Moolenaar30b65812012-07-12 22:01:11 +0200502that often spaces instead of a <Tab> character are inserted. When 'smarttab'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000503is off, a <Tab> always inserts 'tabstop' positions, and 'shiftwidth' is only
504used for ">>" and the like. {not in Vi}
505
506 *ins-softtabstop*
507When the 'softtabstop' option is non-zero, a <Tab> inserts 'softtabstop'
508positions, and a <BS> used to delete white space, will delete 'softtabstop'
509positions. This feels like 'tabstop' was set to 'softtabstop', but a real
510<Tab> character still takes 'tabstop' positions, so your file will still look
511correct when used by other applications.
512
513If 'softtabstop' is non-zero, a <BS> will try to delete as much white space to
514move to the previous 'softtabstop' position, except when the previously
515inserted character is a space, then it will only delete the character before
516the cursor. Otherwise you cannot always delete a single character before the
517cursor. You will have to delete 'softtabstop' characters first, and then type
518extra spaces to get where you want to be.
519
520==============================================================================
5215. Replace mode *Replace* *Replace-mode* *mode-replace*
522
523Enter Replace mode with the "R" command in normal mode.
524
525In Replace mode, one character in the line is deleted for every character you
526type. If there is no character to delete (at the end of the line), the
527typed character is appended (as in Insert mode). Thus the number of
528characters in a line stays the same until you get to the end of the line.
529If a <NL> is typed, a line break is inserted and no character is deleted.
530
531Be careful with <Tab> characters. If you type a normal printing character in
532its place, the number of characters is still the same, but the number of
533columns will become smaller.
534
535If you delete characters in Replace mode (with <BS>, CTRL-W, or CTRL-U), what
536happens is that you delete the changes. The characters that were replaced
537are restored. If you had typed past the existing text, the characters you
538added are deleted. This is effectively a character-at-a-time undo.
539
540If the 'expandtab' option is on, a <Tab> will replace one character with
541several spaces. The result of this is that the number of characters in the
542line increases. Backspacing will delete one space at a time. The original
543character will be put back for only one space that you backspace over (the
544last one). {Vi does not have the 'expandtab' option}
545
546==============================================================================
5476. Virtual Replace mode *vreplace-mode* *Virtual-Replace-mode*
548
549Enter Virtual Replace mode with the "gR" command in normal mode.
Bram Moolenaardb84e452010-08-15 13:50:43 +0200550{not available when compiled without the |+vreplace| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000551{Vi does not have Virtual Replace mode}
552
553Virtual Replace mode is similar to Replace mode, but instead of replacing
554actual characters in the file, you are replacing screen real estate, so that
555characters further on in the file never appear to move.
556
557So if you type a <Tab> it may replace several normal characters, and if you
558type a letter on top of a <Tab> it may not replace anything at all, since the
559<Tab> will still line up to the same place as before.
560
561Typing a <NL> still doesn't cause characters later in the file to appear to
562move. The rest of the current line will be replaced by the <NL> (that is,
563they are deleted), and replacing continues on the next line. A new line is
564NOT inserted unless you go past the end of the file.
565
566Interesting effects are seen when using CTRL-T and CTRL-D. The characters
567before the cursor are shifted sideways as normal, but characters later in the
568line still remain still. CTRL-T will hide some of the old line under the
569shifted characters, but CTRL-D will reveal them again.
570
571As with Replace mode, using <BS> etc will bring back the characters that were
572replaced. This still works in conjunction with 'smartindent', CTRL-T and
573CTRL-D, 'expandtab', 'smarttab', 'softtabstop', etc.
574
575In 'list' mode, Virtual Replace mode acts as if it was not in 'list' mode,
576unless "L" is in 'cpoptions'.
577
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +0200578Note that the only situations for which characters beyond the cursor should
579appear to move are in List mode |'list'|, and occasionally when 'wrap' is set
580(and the line changes length to become shorter or wider than the width of the
581screen). In other cases spaces may be inserted to avoid following characters
582to move.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000583
584This mode is very useful for editing <Tab> separated columns in tables, for
585entering new data while keeping all the columns aligned.
586
587==============================================================================
5887. Insert mode completion *ins-completion*
589
Bram Moolenaar4be06f92005-07-29 22:36:03 +0000590In Insert and Replace mode, there are several commands to complete part of a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000591keyword or line that has been typed. This is useful if you are using
592complicated keywords (e.g., function names with capitals and underscores).
593
594These commands are not available when the |+insert_expand| feature was
595disabled at compile time.
596
597Completion can be done for:
598
5991. Whole lines |i_CTRL-X_CTRL-L|
6002. keywords in the current file |i_CTRL-X_CTRL-N|
6013. keywords in 'dictionary' |i_CTRL-X_CTRL-K|
6024. keywords in 'thesaurus', thesaurus-style |i_CTRL-X_CTRL-T|
6035. keywords in the current and included files |i_CTRL-X_CTRL-I|
6046. tags |i_CTRL-X_CTRL-]|
6057. file names |i_CTRL-X_CTRL-F|
6068. definitions or macros |i_CTRL-X_CTRL-D|
6079. Vim command-line |i_CTRL-X_CTRL-V|
Bram Moolenaar4be06f92005-07-29 22:36:03 +000060810. User defined completion |i_CTRL-X_CTRL-U|
Bram Moolenaarf75a9632005-09-13 21:20:47 +000060911. omni completion |i_CTRL-X_CTRL-O|
Bram Moolenaar488c6512005-08-11 20:09:58 +000061012. Spelling suggestions |i_CTRL-X_s|
61113. keywords in 'complete' |i_CTRL-N|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000612
613All these (except 2) are done in CTRL-X mode. This is a sub-mode of Insert
614and Replace modes. You enter CTRL-X mode by typing CTRL-X and one of the
615CTRL-X commands. You exit CTRL-X mode by typing a key that is not a valid
616CTRL-X mode command. Valid keys are the CTRL-X command itself, CTRL-N (next),
617and CTRL-P (previous).
618
619Also see the 'infercase' option if you want to adjust the case of the match.
620
Bram Moolenaard2cec5b2006-03-28 21:08:56 +0000621 *complete_CTRL-E*
622When completion is active you can use CTRL-E to stop it and go back to the
Bram Moolenaar551dbcc2006-04-25 22:13:59 +0000623originally typed text. The CTRL-E will not be inserted.
Bram Moolenaard2cec5b2006-03-28 21:08:56 +0000624
625 *complete_CTRL-Y*
626When the popup menu is displayed you can use CTRL-Y to stop completion and
627accept the currently selected entry. The CTRL-Y is not inserted. Typing a
628space, Enter, or some other unprintable character will leave completion mode
629and insert that typed character.
630
Bram Moolenaar9e54a0e2006-04-14 20:42:25 +0000631When the popup menu is displayed there are a few more special keys, see
632|popupmenu-keys|.
633
Bram Moolenaar071d4272004-06-13 20:20:40 +0000634Note: The keys that are valid in CTRL-X mode are not mapped. This allows for
635":map ^F ^X^F" to work (where ^F is CTRL-F and ^X is CTRL-X). The key that
636ends CTRL-X mode (any key that is not a valid CTRL-X mode command) is mapped.
637Also, when doing completion with 'complete' mappings apply as usual.
638
Bram Moolenaarf193fff2006-04-27 00:02:13 +0000639Note: While completion is active Insert mode can't be used recursively.
640Mappings that somehow invoke ":normal i.." will generate an E523 error.
641
Bram Moolenaar071d4272004-06-13 20:20:40 +0000642The following mappings are suggested to make typing the completion commands
643a bit easier (although they will hide other commands): >
644 :inoremap ^] ^X^]
645 :inoremap ^F ^X^F
646 :inoremap ^D ^X^D
647 :inoremap ^L ^X^L
648
649As a special case, typing CTRL-R to perform register insertion (see
650|i_CTRL-R|) will not exit CTRL-X mode. This is primarily to allow the use of
651the '=' register to call some function to determine the next operation. If
652the contents of the register (or result of the '=' register evaluation) are
653not valid CTRL-X mode keys, then CTRL-X mode will be exited as if those keys
654had been typed.
655
656For example, the following will map <Tab> to either actually insert a <Tab> if
657the current line is currently only whitespace, or start/continue a CTRL-N
658completion operation: >
659
660 function! CleverTab()
661 if strpart( getline('.'), 0, col('.')-1 ) =~ '^\s*$'
662 return "\<Tab>"
663 else
664 return "\<C-N>"
Bram Moolenaarb52073a2010-03-17 20:02:06 +0100665 endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000666 endfunction
667 inoremap <Tab> <C-R>=CleverTab()<CR>
668
669
670
671Completing whole lines *compl-whole-line*
672
673 *i_CTRL-X_CTRL-L*
674CTRL-X CTRL-L Search backwards for a line that starts with the
Bram Moolenaar83bab712005-08-01 21:58:57 +0000675 same characters as those in the current line before
676 the cursor. Indent is ignored. The matching line is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000677 inserted in front of the cursor.
Bram Moolenaar83bab712005-08-01 21:58:57 +0000678 The 'complete' option is used to decide which buffers
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000679 are searched for a match. Both loaded and unloaded
680 buffers are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000681 CTRL-L or
682 CTRL-P Search backwards for next matching line. This line
683 replaces the previous matching line.
684
685 CTRL-N Search forward for next matching line. This line
686 replaces the previous matching line.
687
688 CTRL-X CTRL-L After expanding a line you can additionally get the
689 line next to it by typing CTRL-X CTRL-L again, unless
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100690 a double CTRL-X is used. Only works for loaded
691 buffers.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000692
693Completing keywords in current file *compl-current*
694
695 *i_CTRL-X_CTRL-P*
696 *i_CTRL-X_CTRL-N*
697CTRL-X CTRL-N Search forwards for words that start with the keyword
698 in front of the cursor. The found keyword is inserted
699 in front of the cursor.
700
701CTRL-X CTRL-P Search backwards for words that start with the keyword
702 in front of the cursor. The found keyword is inserted
703 in front of the cursor.
704
705 CTRL-N Search forward for next matching keyword. This
706 keyword replaces the previous matching keyword.
707
708 CTRL-P Search backwards for next matching keyword. This
709 keyword replaces the previous matching keyword.
710
711 CTRL-X CTRL-N or
712 CTRL-X CTRL-P Further use of CTRL-X CTRL-N or CTRL-X CTRL-P will
713 copy the words following the previous expansion in
714 other contexts unless a double CTRL-X is used.
715
716If there is a keyword in front of the cursor (a name made out of alphabetic
717characters and characters in 'iskeyword'), it is used as the search pattern,
718with "\<" prepended (meaning: start of a word). Otherwise "\<\k\k" is used
719as search pattern (start of any keyword of at least two characters).
720
721In Replace mode, the number of characters that are replaced depends on the
722length of the matched string. This works like typing the characters of the
723matched string in Replace mode.
724
725If there is not a valid keyword character before the cursor, any keyword of
726at least two characters is matched.
727 e.g., to get:
728 printf("(%g, %g, %g)", vector[0], vector[1], vector[2]);
729 just type:
730 printf("(%g, %g, %g)", vector[0], ^P[1], ^P[2]);
731
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000732The search wraps around the end of the file, the value of 'wrapscan' is not
733used here.
734
Bram Moolenaar071d4272004-06-13 20:20:40 +0000735Multiple repeats of the same completion are skipped; thus a different match
736will be inserted at each CTRL-N and CTRL-P (unless there is only one
737matching keyword).
738
739Single character matches are never included, as they usually just get in
740the way of what you were really after.
741 e.g., to get:
742 printf("name = %s\n", name);
743 just type:
744 printf("name = %s\n", n^P);
745 or even:
746 printf("name = %s\n", ^P);
747The 'n' in '\n' is skipped.
748
749After expanding a word, you can use CTRL-X CTRL-P or CTRL-X CTRL-N to get the
750word following the expansion in other contexts. These sequences search for
751the text just expanded and further expand by getting an extra word. This is
752useful if you need to repeat a sequence of complicated words. Although CTRL-P
753and CTRL-N look just for strings of at least two characters, CTRL-X CTRL-P and
754CTRL-X CTRL-N can be used to expand words of just one character.
755 e.g., to get:
756 M&eacute;xico
757 you can type:
758 M^N^P^X^P^X^P
759CTRL-N starts the expansion and then CTRL-P takes back the single character
760"M", the next two CTRL-X CTRL-P's get the words "&eacute" and ";xico".
761
762If the previous expansion was split, because it got longer than 'textwidth',
763then just the text in the current line will be used.
764
765If the match found is at the end of a line, then the first word in the next
766line will be inserted and the message "word from next line" displayed, if
767this word is accepted the next CTRL-X CTRL-P or CTRL-X CTRL-N will search
768for those lines starting with this word.
769
770
771Completing keywords in 'dictionary' *compl-dictionary*
772
773 *i_CTRL-X_CTRL-K*
774CTRL-X CTRL-K Search the files given with the 'dictionary' option
775 for words that start with the keyword in front of the
776 cursor. This is like CTRL-N, but only the dictionary
777 files are searched, not the current file. The found
778 keyword is inserted in front of the cursor. This
779 could potentially be pretty slow, since all matches
780 are found before the first match is used. By default,
781 the 'dictionary' option is empty.
782 For suggestions where to find a list of words, see the
783 'dictionary' option.
784
785 CTRL-K or
786 CTRL-N Search forward for next matching keyword. This
787 keyword replaces the previous matching keyword.
788
789 CTRL-P Search backwards for next matching keyword. This
790 keyword replaces the previous matching keyword.
791
792 *i_CTRL-X_CTRL-T*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +0000793CTRL-X CTRL-T Works as CTRL-X CTRL-K, but in a special way. It uses
Bram Moolenaar071d4272004-06-13 20:20:40 +0000794 the 'thesaurus' option instead of 'dictionary'. If a
795 match is found in the thesaurus file, all the
796 remaining words on the same line are included as
797 matches, even though they don't complete the word.
798 Thus a word can be completely replaced.
799
800 For an example, imagine the 'thesaurus' file has a
801 line like this: >
802 angry furious mad enraged
803< Placing the cursor after the letters "ang" and typing
804 CTRL-X CTRL-T would complete the word "angry";
805 subsequent presses would change the word to "furious",
806 "mad" etc.
807 Other uses include translation between two languages,
808 or grouping API functions by keyword.
809
810 CTRL-T or
811 CTRL-N Search forward for next matching keyword. This
812 keyword replaces the previous matching keyword.
813
814 CTRL-P Search backwards for next matching keyword. This
815 keyword replaces the previous matching keyword.
816
817
818Completing keywords in the current and included files *compl-keyword*
819
820The 'include' option is used to specify a line that contains an include file
821name. The 'path' option is used to search for include files.
822
823 *i_CTRL-X_CTRL-I*
824CTRL-X CTRL-I Search for the first keyword in the current and
825 included files that starts with the same characters
826 as those before the cursor. The matched keyword is
827 inserted in front of the cursor.
828
829 CTRL-N Search forwards for next matching keyword. This
830 keyword replaces the previous matching keyword.
831 Note: CTRL-I is the same as <Tab>, which is likely to
832 be typed after a successful completion, therefore
833 CTRL-I is not used for searching for the next match.
834
835 CTRL-P Search backward for previous matching keyword. This
836 keyword replaces the previous matching keyword.
837
838 CTRL-X CTRL-I Further use of CTRL-X CTRL-I will copy the words
839 following the previous expansion in other contexts
840 unless a double CTRL-X is used.
841
842Completing tags *compl-tag*
843 *i_CTRL-X_CTRL-]*
844CTRL-X CTRL-] Search for the first tag that starts with the same
845 characters as before the cursor. The matching tag is
846 inserted in front of the cursor. Alphabetic
847 characters and characters in 'iskeyword' are used
848 to decide which characters are included in the tag
849 name (same as for a keyword). See also |CTRL-]|.
850 The 'showfulltag' option can be used to add context
851 from around the tag definition.
852 CTRL-] or
853 CTRL-N Search forwards for next matching tag. This tag
854 replaces the previous matching tag.
855
856 CTRL-P Search backward for previous matching tag. This tag
857 replaces the previous matching tag.
858
859
860Completing file names *compl-filename*
861 *i_CTRL-X_CTRL-F*
862CTRL-X CTRL-F Search for the first file name that starts with the
863 same characters as before the cursor. The matching
864 file name is inserted in front of the cursor.
865 Alphabetic characters and characters in 'isfname'
866 are used to decide which characters are included in
867 the file name. Note: the 'path' option is not used
868 here (yet).
869 CTRL-F or
870 CTRL-N Search forwards for next matching file name. This
871 file name replaces the previous matching file name.
872
873 CTRL-P Search backward for previous matching file name.
874 This file name replaces the previous matching file
875 name.
876
877
878Completing definitions or macros *compl-define*
879
880The 'define' option is used to specify a line that contains a definition.
881The 'include' option is used to specify a line that contains an include file
882name. The 'path' option is used to search for include files.
883
884 *i_CTRL-X_CTRL-D*
885CTRL-X CTRL-D Search in the current and included files for the
886 first definition (or macro) name that starts with
887 the same characters as before the cursor. The found
888 definition name is inserted in front of the cursor.
889 CTRL-D or
890 CTRL-N Search forwards for next matching macro name. This
891 macro name replaces the previous matching macro
892 name.
893
894 CTRL-P Search backward for previous matching macro name.
895 This macro name replaces the previous matching macro
896 name.
897
898 CTRL-X CTRL-D Further use of CTRL-X CTRL-D will copy the words
899 following the previous expansion in other contexts
900 unless a double CTRL-X is used.
901
902
903Completing Vim commands *compl-vim*
904
905Completion is context-sensitive. It works like on the Command-line. It
Bram Moolenaar4be06f92005-07-29 22:36:03 +0000906completes an Ex command as well as its arguments. This is useful when writing
907a Vim script.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000908
909 *i_CTRL-X_CTRL-V*
910CTRL-X CTRL-V Guess what kind of item is in front of the cursor and
911 find the first match for it.
912 Note: When CTRL-V is mapped you can often use CTRL-Q
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000913 instead of |i_CTRL-Q|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000914 CTRL-V or
915 CTRL-N Search forwards for next match. This match replaces
916 the previous one.
917
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000918 CTRL-P Search backwards for previous match. This match
Bram Moolenaar071d4272004-06-13 20:20:40 +0000919 replaces the previous one.
920
921 CTRL-X CTRL-V Further use of CTRL-X CTRL-V will do the same as
922 CTRL-V. This allows mapping a key to do Vim command
923 completion, for example: >
924 :imap <Tab> <C-X><C-V>
925
Bram Moolenaar4be06f92005-07-29 22:36:03 +0000926User defined completion *compl-function*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000927
928Completion is done by a function that can be defined by the user with the
Bram Moolenaar280f1262006-01-30 00:14:18 +0000929'completefunc' option. See below for how the function is called and an
930example |complete-functions|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +0000931
932 *i_CTRL-X_CTRL-U*
933CTRL-X CTRL-U Guess what kind of item is in front of the cursor and
934 find the first match for it.
935 CTRL-U or
936 CTRL-N Use the next match. This match replaces the previous
937 one.
938
939 CTRL-P Use the previous match. This match replaces the
940 previous one.
941
942
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000943Omni completion *compl-omni*
Bram Moolenaar4be06f92005-07-29 22:36:03 +0000944
Bram Moolenaare344bea2005-09-01 20:46:49 +0000945Completion is done by a function that can be defined by the user with the
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000946'omnifunc' option. This is to be used for filetype-specific completion.
Bram Moolenaare344bea2005-09-01 20:46:49 +0000947
Bram Moolenaar280f1262006-01-30 00:14:18 +0000948See below for how the function is called and an example |complete-functions|.
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000949For remarks about specific filetypes see |compl-omni-filetypes|.
Bram Moolenaar9c102382006-05-03 21:26:49 +0000950More completion scripts will appear, check www.vim.org. Currently there is a
951first version for C++.
Bram Moolenaar4be06f92005-07-29 22:36:03 +0000952
953 *i_CTRL-X_CTRL-O*
954CTRL-X CTRL-O Guess what kind of item is in front of the cursor and
955 find the first match for it.
956 CTRL-O or
957 CTRL-N Use the next match. This match replaces the previous
958 one.
959
960 CTRL-P Use the previous match. This match replaces the
961 previous one.
962
963
Bram Moolenaar488c6512005-08-11 20:09:58 +0000964Spelling suggestions *compl-spelling*
965
Bram Moolenaar5195e452005-08-19 20:32:47 +0000966A word before or at the cursor is located and correctly spelled words are
967suggested to replace it. If there is a badly spelled word in the line, before
968or under the cursor, the cursor is moved to after it. Otherwise the word just
969before the cursor is used for suggestions, even though it isn't badly spelled.
970
Bram Moolenaar488c6512005-08-11 20:09:58 +0000971NOTE: CTRL-S suspends display in many Unix terminals. Use 's' instead. Type
972CTRL-Q to resume displaying.
973
974 *i_CTRL-X_CTRL-S* *i_CTRL-X_s*
975CTRL-X CTRL-S or
976CTRL-X s Locate the word in front of the cursor and find the
977 first spell suggestion for it.
978 CTRL-S or
979 CTRL-N Use the next suggestion. This replaces the previous
980 one. Note that you can't use 's' here.
981
982 CTRL-P Use the previous suggestion. This replaces the
983 previous one.
984
985
Bram Moolenaar071d4272004-06-13 20:20:40 +0000986Completing keywords from different sources *compl-generic*
987
988 *i_CTRL-N*
989CTRL-N Find next match for words that start with the
990 keyword in front of the cursor, looking in places
991 specified with the 'complete' option. The found
992 keyword is inserted in front of the cursor.
993
994 *i_CTRL-P*
995CTRL-P Find previous match for words that start with the
996 keyword in front of the cursor, looking in places
997 specified with the 'complete' option. The found
998 keyword is inserted in front of the cursor.
999
1000 CTRL-N Search forward for next matching keyword. This
1001 keyword replaces the previous matching keyword.
1002
1003 CTRL-P Search backwards for next matching keyword. This
1004 keyword replaces the previous matching keyword.
1005
1006 CTRL-X CTRL-N or
1007 CTRL-X CTRL-P Further use of CTRL-X CTRL-N or CTRL-X CTRL-P will
1008 copy the words following the previous expansion in
1009 other contexts unless a double CTRL-X is used.
1010
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001011
Bram Moolenaar280f1262006-01-30 00:14:18 +00001012FUNCTIONS FOR FINDING COMPLETIONS *complete-functions*
1013
1014This applies to 'completefunc' and 'omnifunc'.
1015
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00001016The function is called in two different ways:
1017- First the function is called to find the start of the text to be completed.
1018- Later the function is called to actually find the matches.
Bram Moolenaar280f1262006-01-30 00:14:18 +00001019
1020On the first invocation the arguments are:
1021 a:findstart 1
1022 a:base empty
1023
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00001024The function must return the column where the completion starts. It must be a
1025number between zero and the cursor column "col('.')". This involves looking
1026at the characters just before the cursor and including those characters that
1027could be part of the completed item. The text between this column and the
Bram Moolenaar8e52a592012-05-18 21:49:28 +02001028cursor column will be replaced with the matches.
1029
1030Special return values:
1031 -1 If no completion can be done, the completion will be cancelled with an
1032 error message.
1033 -2 To cancel silently and stay in completion mode.
1034 -3 To cancel silently and leave completion mode.
Bram Moolenaar280f1262006-01-30 00:14:18 +00001035
1036On the second invocation the arguments are:
1037 a:findstart 0
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00001038 a:base the text with which matches should match; the text that was
Bram Moolenaar280f1262006-01-30 00:14:18 +00001039 located in the first call (can be empty)
1040
1041The function must return a List with the matching words. These matches
1042usually include the "a:base" text. When there are no matches return an empty
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00001043List.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02001044
1045In order to return more information than the matching words, return a Dict
1046that contains the List. The Dict can have these items:
1047 words The List of matching words (mandatory).
1048 refresh A string to control re-invocation of the function
1049 (optional).
1050 The only value currently recognized is "always", the
1051 effect is that the function is called whenever the
1052 leading text is changed.
1053Other items are ignored.
1054
Bram Moolenaar30b65812012-07-12 22:01:11 +02001055For acting upon end of completion, see the |CompleteDone| autocommand event.
1056
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02001057For example, the function can contain this: >
1058 let matches = ... list of words ...
1059 return {'words': matches, 'refresh': 'always'}
1060<
Bram Moolenaar5c4bab02006-03-10 21:37:46 +00001061 *complete-items*
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00001062Each list item can either be a string or a Dictionary. When it is a string it
1063is used as the completion. When it is a Dictionary it can contain these
1064items:
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001065 word the text that will be inserted, mandatory
1066 abbr abbreviation of "word"; when not empty it is used in
1067 the menu instead of "word"
Bram Moolenaar8dff8182006-04-06 20:18:50 +00001068 menu extra text for the popup menu, displayed after "word"
1069 or "abbr"
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001070 info more information about the item, can be displayed in a
1071 preview window
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00001072 kind single letter indicating the type of completion
Bram Moolenaar91170f82006-05-05 21:15:17 +00001073 icase when non-zero case is to be ignored when comparing
1074 items to be equal; when omitted zero is used, thus
1075 items that only differ in case are added
Bram Moolenaar4a85b412006-04-23 22:40:29 +00001076 dup when non-zero this match will be added even when an
1077 item with the same word is already present.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001078 empty when non-zero this match will be added even when it is
1079 an empty string
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00001080
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02001081All of these except 'icase', 'dup' and 'empty' must be a string. If an item
1082does not meet these requirements then an error message is given and further
1083items in the list are not used. You can mix string and Dictionary items in
1084the returned list.
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00001085
1086The "menu" item is used in the popup menu and may be truncated, thus it should
Bram Moolenaar0b598c22006-03-11 21:22:53 +00001087be relatively short. The "info" item can be longer, it will be displayed in
1088the preview window when "preview" appears in 'completeopt'. The "info" item
1089will also remain displayed after the popup menu has been removed. This is
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00001090useful for function arguments. Use a single space for "info" to remove
Bram Moolenaar05365702010-10-27 18:34:44 +02001091existing text in the preview window. The size of the preview window is three
1092lines, but 'previewheight' is used when it has a value of 1 or 2.
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00001093
1094The "kind" item uses a single letter to indicate the kind of completion. This
1095may be used to show the completion differently (different color or icon).
1096Currently these types can be used:
1097 v variable
1098 f function or method
Bram Moolenaar0b598c22006-03-11 21:22:53 +00001099 m member of a struct or class
1100 t typedef
1101 d #define or macro
Bram Moolenaar280f1262006-01-30 00:14:18 +00001102
1103When searching for matches takes some time call |complete_add()| to add each
1104match to the total list. These matches should then not appear in the returned
1105list! Call |complete_check()| now and then to allow the user to press a key
1106while still searching for matches. Stop searching when it returns non-zero.
1107
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001108 *E839* *E840*
1109The function is allowed to move the cursor, it is restored afterwards.
1110The function is not allowed to move to another window or delete text.
Bram Moolenaar280f1262006-01-30 00:14:18 +00001111
1112An example that completes the names of the months: >
1113 fun! CompleteMonths(findstart, base)
1114 if a:findstart
1115 " locate the start of the word
1116 let line = getline('.')
1117 let start = col('.') - 1
1118 while start > 0 && line[start - 1] =~ '\a'
1119 let start -= 1
1120 endwhile
1121 return start
1122 else
1123 " find months matching with "a:base"
1124 let res = []
1125 for m in split("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec")
1126 if m =~ '^' . a:base
1127 call add(res, m)
1128 endif
1129 endfor
1130 return res
1131 endif
1132 endfun
1133 set completefunc=CompleteMonths
1134<
1135The same, but now pretending searching for matches is slow: >
1136 fun! CompleteMonths(findstart, base)
1137 if a:findstart
1138 " locate the start of the word
1139 let line = getline('.')
1140 let start = col('.') - 1
1141 while start > 0 && line[start - 1] =~ '\a'
1142 let start -= 1
1143 endwhile
1144 return start
1145 else
1146 " find months matching with "a:base"
1147 for m in split("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec")
1148 if m =~ '^' . a:base
1149 call complete_add(m)
1150 endif
1151 sleep 300m " simulate searching for next match
1152 if complete_check()
1153 break
1154 endif
1155 endfor
1156 return []
1157 endif
1158 endfun
1159 set completefunc=CompleteMonths
1160<
1161
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001162INSERT COMPLETION POPUP MENU *ins-completion-menu*
Bram Moolenaarebefac62005-12-28 22:39:57 +00001163 *popupmenu-completion*
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001164Vim can display the matches in a simplistic popup menu.
1165
1166The menu is used when:
Bram Moolenaara2031822006-03-07 22:29:51 +00001167- The 'completeopt' option contains "menu" or "menuone".
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001168- The terminal supports at least 8 colors.
Bram Moolenaard68071d2006-05-02 22:08:30 +00001169- There are at least two matches. One if "menuone" is used.
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001170
Bram Moolenaar56718732006-03-15 22:53:57 +00001171The 'pumheight' option can be used to set a maximum height. The default is to
1172use all space available.
1173
Bram Moolenaar779b74b2006-04-10 14:55:34 +00001174There are three states:
11751. A complete match has been inserted, e.g., after using CTRL-N or CTRL-P.
11762. A cursor key has been used to select another match. The match was not
1177 inserted then, only the entry in the popup menu is highlighted.
11783. Only part of a match has been inserted and characters were typed or the
1179 backspace key was used. The list of matches was then adjusted for what is
1180 in front of the cursor.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001181
Bram Moolenaar80a94a52006-02-23 21:26:58 +00001182You normally start in the first state, with the first match being inserted.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001183When "longest" is in 'completeopt' and there is more than one match you start
Bram Moolenaar779b74b2006-04-10 14:55:34 +00001184in the third state.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001185
Bram Moolenaar779b74b2006-04-10 14:55:34 +00001186If you select another match, e.g., with CTRL-N or CTRL-P, you go to the first
1187state. This doesn't change the list of matches.
Bram Moolenaar80a94a52006-02-23 21:26:58 +00001188
Bram Moolenaar779b74b2006-04-10 14:55:34 +00001189When you are back at the original text then you are in the third state. To
Bram Moolenaara2031822006-03-07 22:29:51 +00001190get there right away you can use a mapping that uses CTRL-P right after
1191starting the completion: >
1192 :imap <F7> <C-N><C-P>
Bram Moolenaar76916e62006-03-21 21:23:25 +00001193<
1194 *popupmenu-keys*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001195In the first state these keys have a special meaning:
1196<BS> and CTRL-H Delete one character, find the matches for the word before
1197 the cursor. This reduces the list of matches, often to one
Bram Moolenaar80a94a52006-02-23 21:26:58 +00001198 entry, and switches to the second state.
Bram Moolenaar779b74b2006-04-10 14:55:34 +00001199Any non-special character:
1200 Stop completion without changing the match and insert the
1201 typed character.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001202
Bram Moolenaar779b74b2006-04-10 14:55:34 +00001203In the second and third state these keys have a special meaning:
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00001204<BS> and CTRL-H Delete one character, find the matches for the shorter word
1205 before the cursor. This may find more matches.
1206CTRL-L Add one character from the current match, may reduce the
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001207 number of matches.
Bram Moolenaar80a94a52006-02-23 21:26:58 +00001208any printable, non-white character:
1209 Add this character and reduce the number of matches.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001210
Bram Moolenaar779b74b2006-04-10 14:55:34 +00001211In all three states these can be used:
Bram Moolenaard2cec5b2006-03-28 21:08:56 +00001212CTRL-Y Yes: Accept the currently selected match and stop completion.
Bram Moolenaar9964e462007-05-05 17:54:07 +00001213CTRL-E End completion, go back to what was there before selecting a
1214 match (what was typed or longest common string).
Bram Moolenaar80a94a52006-02-23 21:26:58 +00001215<PageUp> Select a match several entries back, but don't insert it.
1216<PageDown> Select a match several entries further, but don't insert it.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001217<Up> Select the previous match, as if CTRL-P was used, but don't
Bram Moolenaar80a94a52006-02-23 21:26:58 +00001218 insert it.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001219<Down> Select the next match, as if CTRL-N was used, but don't
Bram Moolenaar80a94a52006-02-23 21:26:58 +00001220 insert it.
Bram Moolenaar9964e462007-05-05 17:54:07 +00001221<Space> or <Tab> Stop completion without changing the match and insert the
Bram Moolenaar779b74b2006-04-10 14:55:34 +00001222 typed character.
1223
Bram Moolenaar044b68f2007-05-10 17:39:52 +00001224The behavior of the <Enter> key depends on the state you are in:
Bram Moolenaar779b74b2006-04-10 14:55:34 +00001225first state: Use the text as it is and insert a line break.
1226second state: Insert the currently selected match.
1227third state: Use the text as it is and insert a line break.
1228
1229In other words: If you used the cursor keys to select another entry in the
Bram Moolenaar044b68f2007-05-10 17:39:52 +00001230list of matches then the <Enter> key inserts that match. If you typed
1231something else then <Enter> inserts a line break.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001232
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001233
1234The colors of the menu can be changed with these highlight groups:
1235Pmenu normal item |hl-Pmenu|
1236PmenuSel selected item |hl-PmenuSel|
1237PmenuSbar scrollbar |hl-PmenuSbar|
1238PmenuThumb thumb of the scrollbar |hl-PmenuThumb|
1239
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001240There are no special mappings for when the popup menu is visible. However,
1241you can use an Insert mode mapping that checks the |pumvisible()| function to
1242do something different. Example: >
1243 :inoremap <Down> <C-R>=pumvisible() ? "\<lt>C-N>" : "\<lt>Down>"<CR>
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001244
Bram Moolenaar5c4bab02006-03-10 21:37:46 +00001245You can use of <expr> in mapping to have the popup menu used when typing a
1246character and some condition is met. For example, for typing a dot: >
1247 inoremap <expr> . MayComplete()
1248 func MayComplete()
1249 if (can complete)
1250 return ".\<C-X>\<C-O>"
1251 endif
1252 return '.'
1253 endfunc
1254
1255See |:map-<expr>| for more info.
1256
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001257
1258FILETYPE-SPECIFIC REMARKS FOR OMNI COMPLETION *compl-omni-filetypes*
1259
1260The file used for {filetype} should be autoload/{filetype}complete.vim
1261in 'runtimepath'. Thus for "java" it is autoload/javacomplete.vim.
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001262
Bram Moolenaara5792f52005-11-23 21:25:05 +00001263
Bram Moolenaarf75a9632005-09-13 21:20:47 +00001264C *ft-c-omni*
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001265
Bram Moolenaarf75a9632005-09-13 21:20:47 +00001266Completion of C code requires a tags file. You should use Exuberant ctags,
1267because it adds extra information that is needed for completion. You can find
Bram Moolenaar9964e462007-05-05 17:54:07 +00001268it here: http://ctags.sourceforge.net/ Version 5.6 or later is recommended.
1269
Bram Moolenaarf75a9632005-09-13 21:20:47 +00001270For version 5.5.4 you should add a patch that adds the "typename:" field:
Bram Moolenaar36fc5352006-03-04 21:49:37 +00001271 ftp://ftp.vim.org/pub/vim/unstable/patches/ctags-5.5.4.patch
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00001272A compiled .exe for MS-Windows can be found at:
Bram Moolenaar36fc5352006-03-04 21:49:37 +00001273 http://georgevreilly.com/vim/ctags.html
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001274
1275If you want to complete system functions you can do something like this. Use
1276ctags to generate a tags file for all the system header files: >
1277 % ctags -R -f ~/.vim/systags /usr/include /usr/local/include
1278In your vimrc file add this tags file to the 'tags' option: >
1279 set tags+=~/.vim/systags
1280
1281When using CTRL-X CTRL-O after a name without any "." or "->" it is completed
1282from the tags file directly. This works for any identifier, also function
1283names. If you want to complete a local variable name, which does not appear
1284in the tags file, use CTRL-P instead.
1285
1286When using CTRL-X CTRL-O after something that has "." or "->" Vim will attempt
1287to recognize the type of the variable and figure out what members it has.
1288This means only members valid for the variable will be listed.
1289
Bram Moolenaarf75a9632005-09-13 21:20:47 +00001290When a member name already was complete, CTRL-X CTRL-O will add a "." or
1291"->" for composite types.
1292
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001293Vim doesn't include a C compiler, only the most obviously formatted
1294declarations are recognized. Preprocessor stuff may cause confusion.
1295When the same structure name appears in multiple places all possible members
1296are included.
1297
Bram Moolenaar6b730e12005-09-16 21:47:57 +00001298
Bram Moolenaar4770d092006-01-12 23:22:24 +00001299CSS *ft-css-omni*
Bram Moolenaara5792f52005-11-23 21:25:05 +00001300
1301Complete properties and their appropriate values according to CSS 2.1
Bram Moolenaare2f98b92006-03-29 21:18:24 +00001302specification.
Bram Moolenaara5792f52005-11-23 21:25:05 +00001303
1304
Bram Moolenaare2f98b92006-03-29 21:18:24 +00001305HTML *ft-html-omni*
1306XHTML *ft-xhtml-omni*
Bram Moolenaar6b730e12005-09-16 21:47:57 +00001307
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001308CTRL-X CTRL-O provides completion of various elements of (X)HTML files. It is
Bram Moolenaardb6ea062014-07-10 22:01:47 +02001309designed to support writing of XHTML 1.0 Strict files but will also work for
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001310other versions of HTML. Features:
Bram Moolenaar6b730e12005-09-16 21:47:57 +00001311
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001312- after "<" complete tag name depending on context (no div suggestion inside
1313 of an a tag); '/>' indicates empty tags
1314- inside of tag complete proper attributes (no width attribute for an a tag);
1315 show also type of attribute; '*' indicates required attributes
1316- when attribute has limited number of possible values help to complete them
Bram Moolenaara5792f52005-11-23 21:25:05 +00001317- complete names of entities
Bram Moolenaar1e015462005-09-25 22:16:38 +00001318- complete values of "class" and "id" attributes with data obtained from
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001319 <style> tag and included CSS files
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00001320- when completing value of "style" attribute or working inside of "style" tag
Bram Moolenaar1e015462005-09-25 22:16:38 +00001321 switch to |ft-css-omni| completion
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001322- when completing values of events attributes or working inside of "script"
1323 tag switch to |ft-javascript-omni| completion
Bram Moolenaar1e015462005-09-25 22:16:38 +00001324- when used after "</" CTRL-X CTRL-O will close the last opened tag
Bram Moolenaar6b730e12005-09-16 21:47:57 +00001325
Bram Moolenaara5792f52005-11-23 21:25:05 +00001326Note: When used first time completion menu will be shown with little delay
Bram Moolenaare2f98b92006-03-29 21:18:24 +00001327- this is time needed for loading of data file.
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00001328Note: Completion may fail in badly formatted documents. In such case try to
1329run |:make| command to detect formatting problems.
Bram Moolenaara5792f52005-11-23 21:25:05 +00001330
1331
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001332HTML flavor *html-flavor*
1333
Bram Moolenaar9c102382006-05-03 21:26:49 +00001334The default HTML completion depends on the filetype. For HTML files it is
1335HTML 4.01 Transitional ('filetype' is "html"), for XHTML it is XHTML 1.0
1336Strict ('filetype' is "xhtml").
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001337
Bram Moolenaar9c102382006-05-03 21:26:49 +00001338When doing completion outside of any other tag you will have possibility to
1339choose DOCTYPE and the appropriate data file will be loaded and used for all
1340next completions.
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001341
Bram Moolenaar9c102382006-05-03 21:26:49 +00001342More about format of data file in |xml-omni-datafile|. Some of the data files
1343may be found on the Vim website (|www|).
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001344
Bram Moolenaar9c102382006-05-03 21:26:49 +00001345Note that b:html_omni_flavor may point to a file with any XML data. This
1346makes possible to mix PHP (|ft-php-omni|) completion with any XML dialect
1347(assuming you have data file for it). Without setting that variable XHTML 1.0
1348Strict will be used.
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001349
1350
Bram Moolenaare2f98b92006-03-29 21:18:24 +00001351JAVASCRIPT *ft-javascript-omni*
Bram Moolenaarb8a7b562006-02-01 21:47:16 +00001352
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00001353Completion of most elements of JavaScript language and DOM elements.
Bram Moolenaarb8a7b562006-02-01 21:47:16 +00001354
1355Complete:
1356
1357- variables
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001358- function name; show function arguments
Bram Moolenaarb8a7b562006-02-01 21:47:16 +00001359- function arguments
1360- properties of variables trying to detect type of variable
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00001361- complete DOM objects and properties depending on context
Bram Moolenaarb8a7b562006-02-01 21:47:16 +00001362- keywords of language
1363
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00001364Completion works in separate JavaScript files (&ft==javascript), inside of
1365<script> tag of (X)HTML and in values of event attributes (including scanning
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02001366of external files).
Bram Moolenaare2f98b92006-03-29 21:18:24 +00001367
Bram Moolenaarb8a7b562006-02-01 21:47:16 +00001368DOM compatibility
1369
1370At the moment (beginning of 2006) there are two main browsers - MS Internet
1371Explorer and Mozilla Firefox. These two applications are covering over 90% of
1372market. Theoretically standards are created by W3C organisation
1373(http://www.w3c.org) but they are not always followed/implemented.
1374
Bram Moolenaare2f98b92006-03-29 21:18:24 +00001375 IE FF W3C Omni completion ~
1376 +/- +/- + + ~
1377 + + - + ~
1378 + - - - ~
1379 - + - - ~
Bram Moolenaarb8a7b562006-02-01 21:47:16 +00001380
1381Regardless from state of implementation in browsers but if element is defined
1382in standards, completion plugin will place element in suggestion list. When
1383both major engines implemented element, even if this is not in standards it
1384will be suggested. All other elements are not placed in suggestion list.
1385
1386
Bram Moolenaare2f98b92006-03-29 21:18:24 +00001387PHP *ft-php-omni*
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001388
Bram Moolenaar9964e462007-05-05 17:54:07 +00001389Completion of PHP code requires a tags file for completion of data from
1390external files and for class aware completion. You should use Exuberant ctags
1391version 5.5.4 or newer. You can find it here: http://ctags.sourceforge.net/
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001392
1393Script completes:
1394
1395- after $ variables name
Bram Moolenaar0b598c22006-03-11 21:22:53 +00001396 - if variable was declared as object add "->", if tags file is available show
1397 name of class
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001398 - after "->" complete only function and variable names specific for given
1399 class. To find class location and contents tags file is required. Because
1400 PHP isn't strongly typed language user can use @var tag to declare class: >
1401
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001402 /* @var $myVar myClass */
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001403 $myVar->
1404<
1405 Still, to find myClass contents tags file is required.
Bram Moolenaar0b598c22006-03-11 21:22:53 +00001406
Bram Moolenaar551dbcc2006-04-25 22:13:59 +00001407- function names with additional info:
Bram Moolenaar0b598c22006-03-11 21:22:53 +00001408 - in case of built-in functions list of possible arguments and after | type
1409 data returned by function
Bram Moolenaar06b5d512010-05-22 15:37:44 +02001410 - in case of user function arguments and name of file where function was
Bram Moolenaar0b598c22006-03-11 21:22:53 +00001411 defined (if it is not current file)
1412
1413- constants names
1414- class names after "new" declaration
1415
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001416
1417Note: when doing completion first time Vim will load all necessary data into
1418memory. It may take several seconds. After next use of completion delay
Bram Moolenaar0b598c22006-03-11 21:22:53 +00001419should not be noticeable.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001420
1421Script detects if cursor is inside <?php ?> tags. If it is outside it will
1422automatically switch to HTML/CSS/JavaScript completion. Note: contrary to
1423original HTML files completion of tags (and only tags) isn't context aware.
1424
1425
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001426RUBY *ft-ruby-omni*
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00001427
1428Completion of Ruby code requires that vim be built with |+ruby|.
1429
1430Ruby completion will parse your buffer on demand in order to provide a list of
1431completions. These completions will be drawn from modules loaded by 'require'
1432and modules defined in the current buffer.
1433
1434The completions provided by CTRL-X CTRL-O are sensitive to the context:
1435
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001436 CONTEXT COMPLETIONS PROVIDED ~
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00001437
1438 1. Not inside a class definition Classes, constants and globals
1439
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001440 2. Inside a class definition Methods or constants defined in the class
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00001441
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001442 3. After '.', '::' or ':' Methods applicable to the object being
1443 dereferenced
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00001444
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001445 4. After ':' or ':foo' Symbol name (beginning with 'foo')
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00001446
1447Notes:
1448 - Vim will load/evaluate code in order to provide completions. This may
Bram Moolenaar9964e462007-05-05 17:54:07 +00001449 cause some code execution, which may be a concern. This is no longer
1450 enabled by default, to enable this feature add >
1451 let g:rubycomplete_buffer_loading = 1
1452<- In context 1 above, Vim can parse the entire buffer to add a list of
Bram Moolenaar551dbcc2006-04-25 22:13:59 +00001453 classes to the completion results. This feature is turned off by default,
1454 to enable it add >
1455 let g:rubycomplete_classes_in_global = 1
1456< to your vimrc
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00001457 - In context 2 above, anonymous classes are not supported.
1458 - In context 3 above, Vim will attempt to determine the methods supported by
1459 the object.
1460 - Vim can detect and load the Rails environment for files within a rails
1461 project. The feature is disabled by default, to enable it add >
Bram Moolenaar551dbcc2006-04-25 22:13:59 +00001462 let g:rubycomplete_rails = 1
1463< to your vimrc
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00001464
1465
Bram Moolenaar4770d092006-01-12 23:22:24 +00001466SYNTAX *ft-syntax-omni*
1467
Bram Moolenaar9964e462007-05-05 17:54:07 +00001468Vim has the ability to color syntax highlight nearly 500 languages. Part of
1469this highlighting includes knowing what keywords are part of a language. Many
1470filetypes already have custom completion scripts written for them, the
1471syntaxcomplete plugin provides basic completion for all other filetypes. It
1472does this by populating the omni completion list with the text Vim already
1473knows how to color highlight. It can be used for any filetype and provides a
1474minimal language-sensitive completion.
Bram Moolenaar4770d092006-01-12 23:22:24 +00001475
Bram Moolenaarc06ac342006-03-02 22:43:39 +00001476To enable syntax code completion you can run: >
Bram Moolenaarec7944a2013-06-12 21:29:15 +02001477 setlocal omnifunc=syntaxcomplete#Complete
Bram Moolenaar4770d092006-01-12 23:22:24 +00001478
Bram Moolenaarec7944a2013-06-12 21:29:15 +02001479You can automate this by placing the following in your |.vimrc| (after any
Bram Moolenaarc06ac342006-03-02 22:43:39 +00001480":filetype" command): >
1481 if has("autocmd") && exists("+omnifunc")
Bram Moolenaare2f98b92006-03-29 21:18:24 +00001482 autocmd Filetype *
1483 \ if &omnifunc == "" |
1484 \ setlocal omnifunc=syntaxcomplete#Complete |
1485 \ endif
Bram Moolenaarc06ac342006-03-02 22:43:39 +00001486 endif
Bram Moolenaar4770d092006-01-12 23:22:24 +00001487
Bram Moolenaarc06ac342006-03-02 22:43:39 +00001488The above will set completion to this script only if a specific plugin does
1489not already exist for that filetype.
1490
1491Each filetype can have a wide range of syntax items. The plugin allows you to
1492customize which syntax groups to include or exclude from the list. Let's have
1493a look at the PHP filetype to see how this works.
1494
1495If you edit a file called, index.php, run the following command: >
Bram Moolenaarec7944a2013-06-12 21:29:15 +02001496 syntax list
Bram Moolenaarc06ac342006-03-02 22:43:39 +00001497
Bram Moolenaar06b5d512010-05-22 15:37:44 +02001498The first thing you will notice is that there are many different syntax groups.
1499The PHP language can include elements from different languages like HTML,
Bram Moolenaarc06ac342006-03-02 22:43:39 +00001500JavaScript and many more. The syntax plugin will only include syntax groups
1501that begin with the filetype, "php", in this case. For example these syntax
1502groups are included by default with the PHP: phpEnvVar, phpIntVar,
1503phpFunctions.
1504
Bram Moolenaarec7944a2013-06-12 21:29:15 +02001505If you wish non-filetype syntax items to also be included, you can use a
1506regular expression syntax (added in version 13.0 of autoload\syntaxcomplete.vim)
1507to add items. Looking at the output from ":syntax list" while editing a PHP file
1508I can see some of these entries: >
1509 htmlArg,htmlTag,htmlTagName,javaScriptStatement,javaScriptGlobalObjects
Bram Moolenaarc06ac342006-03-02 22:43:39 +00001510
Bram Moolenaarec7944a2013-06-12 21:29:15 +02001511To pick up any JavaScript and HTML keyword syntax groups while editing a PHP
1512file, you can use 3 different regexs, one for each language. Or you can
1513simply restrict the include groups to a particular value, without using
1514a regex string: >
1515 let g:omni_syntax_group_include_php = 'php\w\+,javaScript\w\+,html\w\+'
1516 let g:omni_syntax_group_include_php = 'phpFunctions,phpMethods'
1517<
1518The basic form of this variable is: >
1519 let g:omni_syntax_group_include_{filetype} = 'regex,comma,separated'
1520
1521The PHP language has an enormous number of items which it knows how to syntax
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02001522highlight. These items will be available within the omni completion list.
Bram Moolenaarec7944a2013-06-12 21:29:15 +02001523
1524Some people may find this list unwieldy or are only interested in certain
1525items. There are two ways to prune this list (if necessary). If you find
1526certain syntax groups you do not wish displayed you can use two different
1527methods to identify these groups. The first specifically lists the syntax
1528groups by name. The second uses a regular expression to identify both
1529syntax groups. Simply add one the following to your vimrc: >
1530 let g:omni_syntax_group_exclude_php = 'phpCoreConstant,phpConstant'
1531 let g:omni_syntax_group_exclude_php = 'php\w*Constant'
Bram Moolenaarc06ac342006-03-02 22:43:39 +00001532
1533Add as many syntax groups to this list by comma separating them. The basic
1534form of this variable is: >
Bram Moolenaarec7944a2013-06-12 21:29:15 +02001535 let g:omni_syntax_group_exclude_{filetype} = 'regex,comma,separated'
Bram Moolenaarc06ac342006-03-02 22:43:39 +00001536
1537You can create as many of these variables as you need, varying only the
1538filetype at the end of the variable name.
Bram Moolenaar4770d092006-01-12 23:22:24 +00001539
Bram Moolenaar9964e462007-05-05 17:54:07 +00001540The plugin uses the isKeyword option to determine where word boundaries are
1541for the syntax items. For example, in the Scheme language completion should
1542include the "-", call-with-output-file. Depending on your filetype, this may
1543not provide the words you are expecting. Setting the
1544g:omni_syntax_use_iskeyword option to 0 will force the syntax plugin to break
1545on word characters. This can be controlled adding the following to your
1546vimrc: >
1547 let g:omni_syntax_use_iskeyword = 0
1548
Bram Moolenaar8b682772010-07-30 21:49:40 +02001549For plugin developers, the plugin exposes a public function OmniSyntaxList.
1550This function can be used to request a List of syntax items. When editing a
1551SQL file (:e syntax.sql) you can use the ":syntax list" command to see the
1552various groups and syntax items. For example: >
1553 syntax list
1554
1555Yields data similar to this: >
1556 sqlOperator xxx some prior all like and any escape exists in is not
1557 or intersect minus between distinct
1558 links to Operator
1559 sqlType xxx varbit varchar nvarchar bigint int uniqueidentifier
1560 date money long tinyint unsigned xml text smalldate
1561 double datetime nchar smallint numeric time bit char
1562 varbinary binary smallmoney
1563 image float integer timestamp real decimal
1564
1565There are two syntax groups listed here: sqlOperator and sqlType. To retrieve
1566a List of syntax items you can call OmniSyntaxList a number of different
1567ways. To retrieve all syntax items regardless of syntax group: >
1568 echo OmniSyntaxList( [] )
1569
1570To retrieve only the syntax items for the sqlOperator syntax group: >
1571 echo OmniSyntaxList( ['sqlOperator'] )
1572
1573To retrieve all syntax items for both the sqlOperator and sqlType groups: >
1574 echo OmniSyntaxList( ['sqlOperator', 'sqlType'] )
1575
Bram Moolenaarec7944a2013-06-12 21:29:15 +02001576A regular expression can also be used: >
1577 echo OmniSyntaxList( ['sql\w\+'] )
1578
Bram Moolenaar8b682772010-07-30 21:49:40 +02001579From within a plugin, you would typically assign the output to a List: >
1580 let myKeywords = []
1581 let myKeywords = OmniSyntaxList( ['sqlKeyword'] )
1582
1583
Bram Moolenaar4770d092006-01-12 23:22:24 +00001584
Bram Moolenaare2f98b92006-03-29 21:18:24 +00001585SQL *ft-sql-omni*
1586
1587Completion for the SQL language includes statements, functions, keywords.
1588It will also dynamically complete tables, procedures, views and column lists
1589with data pulled directly from within a database. For detailed instructions
1590and a tutorial see |omni-sql-completion|.
1591
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001592The SQL completion plugin can be used in conjunction with other completion
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001593plugins. For example, the PHP filetype has its own completion plugin.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001594Since PHP is often used to generate dynamic website by accessing a database,
1595the SQL completion plugin can also be enabled. This allows you to complete
1596PHP code and SQL code at the same time.
1597
Bram Moolenaare2f98b92006-03-29 21:18:24 +00001598
Bram Moolenaar4770d092006-01-12 23:22:24 +00001599XML *ft-xml-omni*
Bram Moolenaara5792f52005-11-23 21:25:05 +00001600
Bram Moolenaar9c102382006-05-03 21:26:49 +00001601Vim 7 provides a mechanism for context aware completion of XML files. It
1602depends on a special |xml-omni-datafile| and two commands: |:XMLns| and
1603|:XMLent|. Features are:
Bram Moolenaara5792f52005-11-23 21:25:05 +00001604
Bram Moolenaar9c102382006-05-03 21:26:49 +00001605- after "<" complete the tag name, depending on context
1606- inside of a tag complete proper attributes
1607- when an attribute has a limited number of possible values help to complete
Bram Moolenaara5792f52005-11-23 21:25:05 +00001608 them
Bram Moolenaar9c102382006-05-03 21:26:49 +00001609- complete names of entities (defined in |xml-omni-datafile| and in the
1610 current file with "<!ENTITY" declarations)
Bram Moolenaara5792f52005-11-23 21:25:05 +00001611- when used after "</" CTRL-X CTRL-O will close the last opened tag
1612
Bram Moolenaar4770d092006-01-12 23:22:24 +00001613Format of XML data file *xml-omni-datafile*
Bram Moolenaara5792f52005-11-23 21:25:05 +00001614
Bram Moolenaar9c102382006-05-03 21:26:49 +00001615XML data files are stored in the "autoload/xml" directory in 'runtimepath'.
1616Vim distribution provides examples of data files in the
1617"$VIMRUNTIME/autoload/xml" directory. They have a meaningful name which will
1618be used in commands. It should be a unique name which will not create
1619conflicts. For example, the name xhtml10s.vim means it is the data file for
1620XHTML 1.0 Strict.
Bram Moolenaara5792f52005-11-23 21:25:05 +00001621
Bram Moolenaar9c102382006-05-03 21:26:49 +00001622Each file contains a variable with a name like g:xmldata_xhtml10s . It is
1623a compound from two parts:
Bram Moolenaara5792f52005-11-23 21:25:05 +00001624
Bram Moolenaar9c102382006-05-03 21:26:49 +000016251. "g:xmldata_" general prefix, constant for all data files
16262. "xhtml10s" the name of the file and the name of the described XML
1627 dialect; it will be used as an argument for the |:XMLns|
1628 command
Bram Moolenaara5792f52005-11-23 21:25:05 +00001629
1630Part two must be exactly the same as name of file.
1631
Bram Moolenaar9c102382006-05-03 21:26:49 +00001632The variable is a |Dictionary|. Keys are tag names and each value is a two
1633element |List|. The first element of the List is also a List with the names
1634of possible children. The second element is a |Dictionary| with the names of
1635attributes as keys and the possible values of attributes as values. Example: >
Bram Moolenaara5792f52005-11-23 21:25:05 +00001636
Bram Moolenaar9c102382006-05-03 21:26:49 +00001637 let g:xmldata_crippled = {
1638 \ "vimxmlentities": ["amp", "lt", "gt", "apos", "quot"],
1639 \ 'vimxmlroot': ['tag1'],
1640 \ 'tag1':
1641 \ [ ['childoftag1a', 'childoftag1b'], {'attroftag1a': [],
1642 \ 'attroftag1b': ['valueofattr1', 'valueofattr2']}],
1643 \ 'childoftag1a':
1644 \ [ [], {'attrofchild': ['attrofchild']}],
1645 \ 'childoftag1b':
1646 \ [ ['childoftag1a'], {'attrofchild': []}],
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001647 \ "vimxmltaginfo": {
Bram Moolenaar9c102382006-05-03 21:26:49 +00001648 \ 'tag1': ['Menu info', 'Long information visible in preview window']},
1649 \ 'vimxmlattrinfo': {
1650 \ 'attrofchild': ['Menu info', 'Long information visible in preview window']}}
Bram Moolenaara5792f52005-11-23 21:25:05 +00001651
Bram Moolenaar9c102382006-05-03 21:26:49 +00001652This example would be put in the "autoload/xml/crippled.vim" file and could
1653help to write this file: >
Bram Moolenaara5792f52005-11-23 21:25:05 +00001654
Bram Moolenaar9c102382006-05-03 21:26:49 +00001655 <tag1 attroftag1b="valueofattr1">
1656 <childoftag1a attrofchild>
1657 &amp; &lt;
1658 </childoftag1a>
1659 <childoftag1b attrofchild="5">
1660 <childoftag1a>
1661 &gt; &apos; &quot;
1662 </childoftag1a>
1663 </childoftag1b>
1664 </tag1>
Bram Moolenaara5792f52005-11-23 21:25:05 +00001665
Bram Moolenaar9c102382006-05-03 21:26:49 +00001666In the example four special elements are visible:
1667
16681. "vimxmlentities" - a special key with List containing entities of this XML
Bram Moolenaara5792f52005-11-23 21:25:05 +00001669 dialect.
Bram Moolenaar9c102382006-05-03 21:26:49 +000016702. If the list containing possible values of attributes has one element and
1671 this element is equal to the name of the attribute this attribute will be
1672 treated as boolean and inserted as 'attrname' and not as 'attrname="'
16733. "vimxmltaginfo" - a special key with a Dictionary containing tag
1674 names as keys and two element List as values, for additional menu info and
1675 the long description.
16764. "vimxmlattrinfo" - special key with Dictionary containing attribute names
1677 as keys and two element List as values, for additional menu info and long
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001678 description.
Bram Moolenaara5792f52005-11-23 21:25:05 +00001679
Bram Moolenaar9c102382006-05-03 21:26:49 +00001680Note: Tag names in the data file MUST not contain a namespace description.
1681Check xsl.vim for an example.
1682Note: All data and functions are publicly available as global
1683variables/functions and can be used for personal editing functions.
Bram Moolenaara5792f52005-11-23 21:25:05 +00001684
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00001685
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001686DTD -> Vim *dtd2vim*
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001687
Bram Moolenaar9c102382006-05-03 21:26:49 +00001688On |www| is the script |dtd2vim| which parses DTD and creates an XML data file
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001689for Vim XML omni completion.
1690
1691 dtd2vim: http://www.vim.org/scripts/script.php?script_id=1462
1692
Bram Moolenaar9c102382006-05-03 21:26:49 +00001693Check the beginning of that file for usage details.
1694The script requires perl and:
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001695
1696 perlSGML: http://savannah.nongnu.org/projects/perlsgml
1697
1698
Bram Moolenaara5792f52005-11-23 21:25:05 +00001699Commands
1700
Bram Moolenaar4770d092006-01-12 23:22:24 +00001701:XMLns {name} [{namespace}] *:XMLns*
Bram Moolenaara5792f52005-11-23 21:25:05 +00001702
Bram Moolenaar9c102382006-05-03 21:26:49 +00001703Vim has to know which data file should be used and with which namespace. For
1704loading of the data file and connecting data with the proper namespace use
1705|:XMLns| command. The first (obligatory) argument is the name of the data
1706(xhtml10s, xsl). The second argument is the code of namespace (h, xsl). When
1707used without a second argument the dialect will be used as default - without
1708namespace declaration. For example to use XML completion in .xsl files: >
Bram Moolenaara5792f52005-11-23 21:25:05 +00001709
1710 :XMLns xhtml10s
1711 :XMLns xsl xsl
1712
1713
Bram Moolenaar4770d092006-01-12 23:22:24 +00001714:XMLent {name} *:XMLent*
Bram Moolenaara5792f52005-11-23 21:25:05 +00001715
Bram Moolenaar9c102382006-05-03 21:26:49 +00001716By default entities will be completed from the data file of the default
1717namespace. The XMLent command should be used in case when there is no default
1718namespace: >
Bram Moolenaara5792f52005-11-23 21:25:05 +00001719
Bram Moolenaar4770d092006-01-12 23:22:24 +00001720 :XMLent xhtml10s
Bram Moolenaara5792f52005-11-23 21:25:05 +00001721
1722Usage
1723
Bram Moolenaar9c102382006-05-03 21:26:49 +00001724While used in this situation (after declarations from previous part, | is
Bram Moolenaara5792f52005-11-23 21:25:05 +00001725cursor position): >
1726
Bram Moolenaar4770d092006-01-12 23:22:24 +00001727 <|
Bram Moolenaara5792f52005-11-23 21:25:05 +00001728
Bram Moolenaar9c102382006-05-03 21:26:49 +00001729Will complete to an appropriate XHTML tag, and in this situation: >
Bram Moolenaara5792f52005-11-23 21:25:05 +00001730
Bram Moolenaar4770d092006-01-12 23:22:24 +00001731 <xsl:|
Bram Moolenaara5792f52005-11-23 21:25:05 +00001732
Bram Moolenaar9c102382006-05-03 21:26:49 +00001733Will complete to an appropriate XSL tag.
Bram Moolenaara5792f52005-11-23 21:25:05 +00001734
Bram Moolenaar9c102382006-05-03 21:26:49 +00001735
1736The script xmlcomplete.vim, provided through the |autoload| mechanism,
1737has the xmlcomplete#GetLastOpenTag() function which can be used in XML files
1738to get the name of the last open tag (b:unaryTagsStack has to be defined): >
Bram Moolenaar6b730e12005-09-16 21:47:57 +00001739
Bram Moolenaar4770d092006-01-12 23:22:24 +00001740 :echo xmlcomplete#GetLastOpenTag("b:unaryTagsStack")
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00001741
Bram Moolenaar6b730e12005-09-16 21:47:57 +00001742
Bram Moolenaar1e015462005-09-25 22:16:38 +00001743
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744==============================================================================
17458. Insert mode commands *inserting*
1746
1747The following commands can be used to insert new text into the buffer. They
1748can all be undone and repeated with the "." command.
1749
1750 *a*
1751a Append text after the cursor [count] times. If the
1752 cursor is in the first column of an empty line Insert
1753 starts there. But not when 'virtualedit' is set!
1754
1755 *A*
1756A Append text at the end of the line [count] times.
1757
1758<insert> or *i* *insert* *<Insert>*
1759i Insert text before the cursor [count] times.
1760 When using CTRL-O in Insert mode |i_CTRL-O| the count
1761 is not supported.
1762
1763 *I*
1764I Insert text before the first non-blank in the line
1765 [count] times.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001766 When the 'H' flag is present in 'cpoptions' and the
1767 line only contains blanks, insert start just before
1768 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001769
1770 *gI*
1771gI Insert text in column 1 [count] times. {not in Vi}
1772
1773 *gi*
1774gi Insert text in the same position as where Insert mode
1775 was stopped last time in the current buffer.
1776 This uses the |'^| mark. It's different from "`^i"
1777 when the mark is past the end of the line.
1778 The position is corrected for inserted/deleted lines,
1779 but NOT for inserted/deleted characters.
1780 When the |:keepjumps| command modifier is used the |'^|
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00001781 mark won't be changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001782 {not in Vi}
1783
1784 *o*
1785o Begin a new line below the cursor and insert text,
1786 repeat [count] times. {Vi: blank [count] screen
1787 lines}
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001788 When the '#' flag is in 'cpoptions' the count is
1789 ignored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001790
1791 *O*
1792O Begin a new line above the cursor and insert text,
1793 repeat [count] times. {Vi: blank [count] screen
1794 lines}
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001795 When the '#' flag is in 'cpoptions' the count is
1796 ignored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001797
1798These commands are used to start inserting text. You can end insert mode with
1799<Esc>. See |mode-ins-repl| for the other special characters in Insert mode.
1800The effect of [count] takes place after Insert mode is exited.
1801
1802When 'autoindent' is on, the indent for a new line is obtained from the
1803previous line. When 'smartindent' or 'cindent' is on, the indent for a line
1804is automatically adjusted for C programs.
1805
1806'textwidth' can be set to the maximum width for a line. When a line becomes
1807too long when appending characters a line break is automatically inserted.
1808
1809
1810==============================================================================
18119. Ex insert commands *inserting-ex*
1812
1813 *:a* *:append*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001814:{range}a[ppend][!] Insert several lines of text below the specified
Bram Moolenaar071d4272004-06-13 20:20:40 +00001815 line. If the {range} is missing, the text will be
1816 inserted after the current line.
Bram Moolenaardf177f62005-02-22 08:39:57 +00001817 Adding [!] toggles 'autoindent' for the time this
1818 command is executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001819
1820 *:i* *:in* *:insert*
Bram Moolenaardf177f62005-02-22 08:39:57 +00001821:{range}i[nsert][!] Insert several lines of text above the specified
Bram Moolenaar071d4272004-06-13 20:20:40 +00001822 line. If the {range} is missing, the text will be
1823 inserted before the current line.
Bram Moolenaardf177f62005-02-22 08:39:57 +00001824 Adding [!] toggles 'autoindent' for the time this
1825 command is executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001826
1827These two commands will keep on asking for lines, until you type a line
1828containing only a ".". Watch out for lines starting with a backslash, see
1829|line-continuation|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001830
Bram Moolenaar4a748032010-09-30 21:47:56 +02001831When in Ex mode (see |-e|) a backslash at the end of the line can be used to
1832insert a NUL character. To be able to have a line ending in a backslash use
1833two backslashes. This means that the number of backslashes is halved, but
1834only at the end of the line.
1835
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001836NOTE: These commands cannot be used with |:global| or |:vglobal|.
1837":append" and ":insert" don't work properly in between ":if" and
Bram Moolenaar06fb4352005-01-05 22:10:30 +00001838":endif", ":for" and ":endfor", ":while" and ":endwhile".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001839
1840 *:start* *:startinsert*
1841:star[tinsert][!] Start Insert mode just after executing this command.
1842 Works like typing "i" in Normal mode. When the ! is
1843 included it works like "A", append to the line.
1844 Otherwise insertion starts at the cursor position.
1845 Note that when using this command in a function or
1846 script, the insertion only starts after the function
1847 or script is finished.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001848 This command does not work from |:normal|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001849 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001850 {not available when compiled without the |+ex_extra|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001851 feature}
1852
1853 *:stopi* *:stopinsert*
1854:stopi[nsert] Stop Insert mode as soon as possible. Works like
1855 typing <Esc> in Insert mode.
1856 Can be used in an autocommand, example: >
1857 :au BufEnter scratch stopinsert
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001858<
1859 *replacing-ex* *:startreplace*
1860:startr[eplace][!] Start Replace mode just after executing this command.
1861 Works just like typing "R" in Normal mode. When the
1862 ! is included it acts just like "$R" had been typed
1863 (ie. begin replace mode at the end-of-line). Other-
1864 wise replacement begins at the cursor position.
1865 Note that when using this command in a function or
1866 script that the replacement will only start after
1867 the function or script is finished.
1868 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001869 {not available when compiled without the |+ex_extra|
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001870 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001871
Bram Moolenaar61da4982005-12-14 22:02:18 +00001872 *:startgreplace*
1873:startg[replace][!] Just like |:startreplace|, but use Virtual Replace
1874 mode, like with |gR|.
1875 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001876 {not available when compiled without the |+ex_extra|
Bram Moolenaar61da4982005-12-14 22:02:18 +00001877 feature}
1878
Bram Moolenaar071d4272004-06-13 20:20:40 +00001879==============================================================================
188010. Inserting a file *inserting-file*
1881
1882 *:r* *:re* *:read*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001883:r[ead] [++opt] [name]
1884 Insert the file [name] (default: current file) below
Bram Moolenaar071d4272004-06-13 20:20:40 +00001885 the cursor.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001886 See |++opt| for the possible values of [++opt].
Bram Moolenaar071d4272004-06-13 20:20:40 +00001887
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001888:{range}r[ead] [++opt] [name]
1889 Insert the file [name] (default: current file) below
Bram Moolenaar071d4272004-06-13 20:20:40 +00001890 the specified line.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001891 See |++opt| for the possible values of [++opt].
Bram Moolenaar071d4272004-06-13 20:20:40 +00001892
1893 *:r!* *:read!*
Bram Moolenaar0187ca02013-04-12 15:09:51 +02001894:[range]r[ead] [++opt] !{cmd}
1895 Execute {cmd} and insert its standard output below
Bram Moolenaar9964e462007-05-05 17:54:07 +00001896 the cursor or the specified line. A temporary file is
1897 used to store the output of the command which is then
1898 read into the buffer. 'shellredir' is used to save
1899 the output of the command, which can be set to include
1900 stderr or not. {cmd} is executed like with ":!{cmd}",
1901 any '!' is replaced with the previous command |:!|.
Bram Moolenaar0187ca02013-04-12 15:09:51 +02001902 See |++opt| for the possible values of [++opt].
Bram Moolenaar071d4272004-06-13 20:20:40 +00001903
1904These commands insert the contents of a file, or the output of a command,
1905into the buffer. They can be undone. They cannot be repeated with the "."
1906command. They work on a line basis, insertion starts below the line in which
1907the cursor is, or below the specified line. To insert text above the first
1908line use the command ":0r {name}".
1909
1910After the ":read" command, the cursor is left on the first non-blank in the
1911first new line. Unless in Ex mode, then the cursor is left on the last new
1912line (sorry, this is Vi compatible).
1913
1914If a file name is given with ":r", it becomes the alternate file. This can be
1915used, for example, when you want to edit that file instead: ":e! #". This can
1916be switched off by removing the 'a' flag from the 'cpoptions' option.
1917
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001918Of the [++opt] arguments one is specifically for ":read", the ++edit argument.
1919This is useful when the ":read" command is actually used to read a file into
1920the buffer as if editing that file. Use this command in an empty buffer: >
1921 :read ++edit filename
1922The effect is that the 'fileformat', 'fileencoding', 'bomb', etc. options are
1923set to what has been detected for "filename". Note that a single empty line
1924remains, you may want to delete it.
1925
Bram Moolenaar071d4272004-06-13 20:20:40 +00001926 *file-read*
1927The 'fileformat' option sets the <EOL> style for a file:
1928'fileformat' characters name ~
1929 "dos" <CR><NL> or <NL> DOS format
1930 "unix" <NL> Unix format
1931 "mac" <CR> Mac format
1932Previously 'textmode' was used. It is obsolete now.
1933
1934If 'fileformat' is "dos", a <CR> in front of an <NL> is ignored and a CTRL-Z
1935at the end of the file is ignored.
1936
1937If 'fileformat' is "mac", a <NL> in the file is internally represented by a
1938<CR>. This is to avoid confusion with a <NL> which is used to represent a
1939<NUL>. See |CR-used-for-NL|.
1940
1941If the 'fileformats' option is not empty Vim tries to recognize the type of
1942<EOL> (see |file-formats|). However, the 'fileformat' option will not be
1943changed, the detected format is only used while reading the file.
1944A similar thing happens with 'fileencodings'.
1945
1946On non-MS-DOS, Win32, and OS/2 systems the message "[dos format]" is shown if
1947a file is read in DOS format, to remind you that something unusual is done.
1948On Macintosh, MS-DOS, Win32, and OS/2 the message "[unix format]" is shown if
1949a file is read in Unix format.
1950On non-Macintosh systems, the message "[Mac format]" is shown if a file is
1951read in Mac format.
1952
1953An example on how to use ":r !": >
1954 :r !uuencode binfile binfile
1955This command reads "binfile", uuencodes it and reads it into the current
1956buffer. Useful when you are editing e-mail and want to include a binary
1957file.
1958
1959 *read-messages*
1960When reading a file Vim will display a message with information about the read
1961file. In the table is an explanation for some of the items. The others are
1962self explanatory. Using the long or the short version depends on the
1963'shortmess' option.
1964
1965 long short meaning ~
1966 [readonly] {RO} the file is write protected
1967 [fifo/socket] using a stream
1968 [fifo] using a fifo stream
1969 [socket] using a socket stream
1970 [CR missing] reading with "dos" 'fileformat' and a
1971 NL without a preceding CR was found.
1972 [NL found] reading with "mac" 'fileformat' and a
1973 NL was found (could be "unix" format)
1974 [long lines split] at least one line was split in two
1975 [NOT converted] conversion from 'fileencoding' to
1976 'encoding' was desired but not
1977 possible
1978 [converted] conversion from 'fileencoding' to
1979 'encoding' done
1980 [crypted] file was decrypted
1981 [READ ERRORS] not all of the file could be read
1982
1983
1984 vim:tw=78:ts=8:ft=help:norl: