| blob | f3fb7581f0e9daa7bb759c36d38605814cc0ba28 |
1 *insert.txt* For Vim version 7.2. Last change: 2010 Mar 17
4 VIM REFERENCE MANUAL by Bram Moolenaar
7 *Insert* *Insert-mode*
8 Inserting and replacing text *mode-ins-repl*
10 Most of this file is about Insert and Replace mode. At the end are a few
11 commands for inserting text in other ways.
13 An overview of the most often used commands can be found in chapter 24 of the
14 user manual |usr_24.txt|.
16 1. Special keys |ins-special-keys|
17 2. Special special keys |ins-special-special|
18 3. 'textwidth' and 'wrapmargin' options |ins-textwidth|
19 4. 'expandtab', 'smarttab' and 'softtabstop' options |ins-expandtab|
20 5. Replace mode |Replace-mode|
21 6. Virtual Replace mode |Virtual-Replace-mode|
22 7. Insert mode completion |ins-completion|
23 8. Insert mode commands |inserting|
24 9. Ex insert commands |inserting-ex|
25 10. Inserting a file |inserting-file|
27 Also see 'virtualedit', for moving the cursor to positions where there is no
28 character. Useful for editing a table.
30 ==============================================================================
31 1. Special keys *ins-special-keys*
33 In Insert and Replace mode, the following characters have a special meaning;
34 other characters are inserted directly. To insert one of these special
35 characters into the buffer, precede it with CTRL-V. To insert a <Nul>
36 character use "CTRL-V CTRL-@" or "CTRL-V 000". On some systems, you have to
37 use "CTRL-V 003" to insert a CTRL-C. Note: When CTRL-V is mapped you can
38 often use CTRL-Q instead |i_CTRL-Q|.
40 If you are working in a special language mode when inserting text, see the
41 'langmap' option, |'langmap'|, on how to avoid switching this mode on and off
42 all the time.
44 If you have 'insertmode' set, <Esc> and a few other keys get another meaning.
45 See |'insertmode'|.
47 char action ~
48 -----------------------------------------------------------------------
49 *i_CTRL-[* *i_<Esc>*
50 <Esc> or CTRL-[ End insert or Replace mode, go back to Normal mode. Finish
51 abbreviation.
52 Note: If your <Esc> key is hard to hit on your keyboard, train
53 yourself to use CTRL-[.
54 *i_CTRL-C*
55 CTRL-C Quit insert mode, go back to Normal mode. Do not check for
56 abbreviations. Does not trigger the |InsertLeave| autocommand
57 event.
59 *i_CTRL-@*
60 CTRL-@ Insert previously inserted text and stop insert. {Vi: only
61 when typed as first char, only up to 128 chars}
62 *i_CTRL-A*
63 CTRL-A Insert previously inserted text. {not in Vi}
65 *i_CTRL-H* *i_<BS>* *i_BS*
66 <BS> or CTRL-H Delete the character before the cursor (see |i_backspacing|
67 about joining lines).
68 See |:fixdel| if your <BS> key does not do what you want.
69 {Vi: does not delete autoindents}
70 *i_<Del>* *i_DEL*
71 <Del> Delete the character under the cursor. If the cursor is at
72 the end of the line, and the 'backspace' option includes
73 "eol", delete the <EOL>; the next line is appended after the
74 current one.
75 See |:fixdel| if your <Del> key does not do what you want.
76 {not in Vi}
77 *i_CTRL-W*
78 CTRL-W Delete the word before the cursor (see |i_backspacing| about
79 joining lines). See the section "word motions",
80 |word-motions|, for the definition of a word.
81 *i_CTRL-U*
82 CTRL-U Delete all entered characters in the current line (see
83 |i_backspacing| about joining lines).
85 *i_CTRL-I* *i_<Tab>* *i_Tab*
86 <Tab> or CTRL-I Insert a tab. If the 'expandtab' option is on, the
87 equivalent number of spaces is inserted (use CTRL-V <Tab> to
88 avoid the expansion; use CTRL-Q <Tab> if CTRL-V is mapped
89 |i_CTRL-Q|). See also the 'smarttab' option and
90 |ins-expandtab|.
91 *i_CTRL-J* *i_<NL>*
92 <NL> or CTRL-J Begin new line.
93 *i_CTRL-M* *i_<CR>*
94 <CR> or CTRL-M Begin new line.
95 *i_CTRL-K*
96 CTRL-K {char1} [char2]
97 Enter digraph (see |digraphs|). When {char1} is a special
98 key, the code for that key is inserted in <> form. For
99 example, the string "<S-Space>" can be entered by typing
100 <C-K><S-Space> (two keys). Neither char is considered for
101 mapping. {not in Vi}
103 CTRL-N Find next keyword (see |i_CTRL-N|). {not in Vi}
104 CTRL-P Find previous keyword (see |i_CTRL-P|). {not in Vi}
106 CTRL-R {0-9a-z"%#*+:.-=} *i_CTRL-R*
107 Insert the contents of a register. Between typing CTRL-R and
108 the second character, '"' will be displayed to indicate that
109 you are expected to enter the name of a register.
110 The text is inserted as if you typed it, but mappings and
111 abbreviations are not used. If you have options like
112 'textwidth', 'formatoptions', or 'autoindent' set, this will
113 influence what will be inserted. This is different from what
114 happens with the "p" command and pasting with the mouse.
115 Special registers:
116 '"' the unnamed register, containing the text of
117 the last delete or yank
118 '%' the current file name
119 '#' the alternate file name
120 '*' the clipboard contents (X11: primary selection)
121 '+' the clipboard contents
122 '/' the last search pattern
123 ':' the last command-line
124 '.' the last inserted text
125 '-' the last small (less than a line) delete
126 *i_CTRL-R_=*
127 '=' the expression register: you are prompted to
128 enter an expression (see |expression|)
129 Note that 0x80 (128 decimal) is used for
130 special keys. E.g., you can use this to move
131 the cursor up:
132 CTRL-R ="\<Up>"
133 Use CTRL-R CTRL-R to insert text literally.
134 When the result is a |List| the items are used
135 as lines. They can have line breaks inside
136 too.
137 When the result is a Float it's automatically
138 converted to a String.
139 See |registers| about registers. {not in Vi}
141 CTRL-R CTRL-R {0-9a-z"%#*+/:.-=} *i_CTRL-R_CTRL-R*
142 Insert the contents of a register. Works like using a single
143 CTRL-R, but the text is inserted literally, not as if typed.
144 This differs when the register contains characters like <BS>.
145 Example, where register a contains "ab^Hc": >
146 CTRL-R a results in "ac".
147 CTRL-R CTRL-R a results in "ab^Hc".
148 < Options 'textwidth', 'formatoptions', etc. still apply. If
149 you also want to avoid these, use "<C-R><C-O>r", see below.
150 The '.' register (last inserted text) is still inserted as
151 typed. {not in Vi}
153 CTRL-R CTRL-O {0-9a-z"%#*+/:.-=} *i_CTRL-R_CTRL-O*
154 Insert the contents of a register literally and don't
155 auto-indent. Does the same as pasting with the mouse
156 |<MiddleMouse>|.
157 Does not replace characters!
158 The '.' register (last inserted text) is still inserted as
159 typed. {not in Vi}
161 CTRL-R CTRL-P {0-9a-z"%#*+/:.-=} *i_CTRL-R_CTRL-P*
162 Insert the contents of a register literally and fix the
163 indent, like |[<MiddleMouse>|.
164 Does not replace characters!
165 The '.' register (last inserted text) is still inserted as
166 typed. {not in Vi}
168 *i_CTRL-T*
169 CTRL-T Insert one shiftwidth of indent at the start of the current
170 line. The indent is always rounded to a 'shiftwidth' (this is
171 vi compatible). {Vi: only when in indent}
172 *i_CTRL-D*
173 CTRL-D Delete one shiftwidth of indent at the start of the current
174 line. The indent is always rounded to a 'shiftwidth' (this is
175 vi compatible). {Vi: CTRL-D works only when used after
176 autoindent}
177 *i_0_CTRL-D*
178 0 CTRL-D Delete all indent in the current line. {Vi: CTRL-D works
179 only when used after autoindent}
180 *i_^_CTRL-D*
181 ^ CTRL-D Delete all indent in the current line. The indent is
182 restored in the next line. This is useful when inserting a
183 label. {Vi: CTRL-D works only when used after autoindent}
185 *i_CTRL-V*
186 CTRL-V Insert next non-digit literally. For special keys, the
187 terminal code is inserted. It's also possible to enter the
188 decimal, octal or hexadecimal value of a character
189 |i_CTRL-V_digit|.
190 The characters typed right after CTRL-V are not considered for
191 mapping. {Vi: no decimal byte entry}
192 Note: When CTRL-V is mapped (e.g., to paste text) you can
193 often use CTRL-Q instead |i_CTRL-Q|.
195 *i_CTRL-Q*
196 CTRL-Q Same as CTRL-V.
197 Note: Some terminal connections may eat CTRL-Q, it doesn't
198 work then. It does work in the GUI.
200 CTRL-X Enter CTRL-X mode. This is a sub-mode where commands can
201 be given to complete words or scroll the window. See
202 |i_CTRL-X| and |ins-completion|. {not in Vi}
204 *i_CTRL-E*
205 CTRL-E Insert the character which is below the cursor. {not in Vi}
206 *i_CTRL-Y*
207 CTRL-Y Insert the character which is above the cursor. {not in Vi}
208 Note that for CTRL-E and CTRL-Y 'textwidth' is not used, to be
209 able to copy characters from a long line.
211 *i_CTRL-_*
212 CTRL-_ Switch between languages, as follows:
213 - When in a rightleft window, revins and nohkmap are toggled,
214 since English will likely be inserted in this case.
215 - When in a norightleft window, revins and hkmap are toggled,
216 since Hebrew will likely be inserted in this case.
218 CTRL-_ moves the cursor to the end of the typed text.
220 This command is only available when the 'allowrevins' option
221 is set.
222 Please refer to |rileft.txt| for more information about
223 right-to-left mode.
224 {not in Vi}
225 Only if compiled with the |+rightleft| feature.
227 *i_CTRL-^*
228 CTRL-^ Toggle the use of typing language characters.
229 When language |:lmap| mappings are defined:
230 - If 'iminsert' is 1 (langmap mappings used) it becomes 0 (no
231 langmap mappings used).
232 - If 'iminsert' has another value it becomes 1, thus langmap
233 mappings are enabled.
234 When no language mappings are defined:
235 - If 'iminsert' is 2 (Input Method used) it becomes 0 (no
236 Input Method used).
237 - If 'iminsert' has another value it becomes 2, thus the Input
238 Method is enabled.
239 When set to 1, the value of the "b:keymap_name" variable, the
240 'keymap' option or "<lang>" appears in the status line.
241 The language mappings are normally used to type characters
242 that are different from what the keyboard produces. The
243 'keymap' option can be used to install a whole number of them.
244 {not in Vi}
246 *i_CTRL-]*
247 CTRL-] Trigger abbreviation, without inserting a character. {not in
248 Vi}
250 *i_<Insert>*
251 <Insert> Toggle between Insert and Replace mode. {not in Vi}
252 -----------------------------------------------------------------------
254 *i_backspacing*
255 The effect of the <BS>, CTRL-W, and CTRL-U depend on the 'backspace' option
256 (unless 'revins' is set). This is a comma separated list of items:
258 item action ~
259 indent allow backspacing over autoindent
260 eol allow backspacing over end-of-line (join lines)
261 start allow backspacing over the start position of insert; CTRL-W and
262 CTRL-U stop once at the start position
264 When 'backspace' is empty, Vi compatible backspacing is used. You cannot
265 backspace over autoindent, before column 1 or before where insert started.
267 For backwards compatibility the values "0", "1" and "2" are also allowed, see
268 |'backspace'|.
270 If the 'backspace' option does contain "eol" and the cursor is in column 1
271 when one of the three keys is used, the current line is joined with the
272 previous line. This effectively deletes the <EOL> in front of the cursor.
273 {Vi: does not cross lines, does not delete past start position of insert}
275 *i_CTRL-V_digit*
276 With CTRL-V the decimal, octal or hexadecimal value of a character can be
277 entered directly. This way you can enter any character, except a line break
278 (<NL>, value 10). There are five ways to enter the character value:
280 first char mode max nr of chars max value ~
281 (none) decimal 3 255
282 o or O octal 3 377 (255)
283 x or X hexadecimal 2 ff (255)
284 u hexadecimal 4 ffff (65535)
285 U hexadecimal 8 7fffffff (2147483647)
287 Normally you would type the maximum number of characters. Thus to enter a
288 space (value 32) you would type <C-V>032. You can omit the leading zero, in
289 which case the character typed after the number must be a non-digit. This
290 happens for the other modes as well: As soon as you type a character that is
291 invalid for the mode, the value before it will be used and the "invalid"
292 character is dealt with in the normal way.
294 If you enter a value of 10, it will end up in the file as a 0. The 10 is a
295 <NL>, which is used internally to represent the <Nul> character. When writing
296 the buffer to a file, the <NL> character is translated into <Nul>. The <NL>
297 character is written at the end of each line. Thus if you want to insert a
298 <NL> character in a file you will have to make a line break.
300 *i_CTRL-X* *insert_expand*
301 CTRL-X enters a sub-mode where several commands can be used. Most of these
302 commands do keyword completion; see |ins-completion|. These are not available
303 when Vim was compiled without the |+insert_expand| feature.
305 Two commands can be used to scroll the window up or down, without exiting
306 insert mode:
308 *i_CTRL-X_CTRL-E*
309 CTRL-X CTRL-E scroll window one line up.
310 When doing completion look here: |complete_CTRL-E|
312 *i_CTRL-X_CTRL-Y*
313 CTRL-X CTRL-Y scroll window one line down.
314 When doing completion look here: |complete_CTRL-Y|
316 After CTRL-X is pressed, each CTRL-E (CTRL-Y) scrolls the window up (down) by
317 one line unless that would cause the cursor to move from its current position
318 in the file. As soon as another key is pressed, CTRL-X mode is exited and
319 that key is interpreted as in Insert mode.
322 ==============================================================================
323 2. Special special keys *ins-special-special*
325 The following keys are special. They stop the current insert, do something,
326 and then restart insertion. This means you can do something without getting
327 out of Insert mode. This is very handy if you prefer to use the Insert mode
328 all the time, just like editors that don't have a separate Normal mode. You
329 may also want to set the 'backspace' option to "indent,eol,start" and set the
330 'insertmode' option. You can use CTRL-O if you want to map a function key to
331 a command.
333 The changes (inserted or deleted characters) before and after these keys can
334 be undone separately. Only the last change can be redone and always behaves
335 like an "i" command.
337 char action ~
338 -----------------------------------------------------------------------
339 <Up> cursor one line up *i_<Up>*
340 <Down> cursor one line down *i_<Down>*
341 CTRL-G <Up> cursor one line up, insert start column *i_CTRL-G_<Up>*
342 CTRL-G k cursor one line up, insert start column *i_CTRL-G_k*
343 CTRL-G CTRL-K cursor one line up, insert start column *i_CTRL-G_CTRL-K*
344 CTRL-G <Down> cursor one line down, insert start column *i_CTRL-G_<Down>*
345 CTRL-G j cursor one line down, insert start column *i_CTRL-G_j*
346 CTRL-G CTRL-J cursor one line down, insert start column *i_CTRL-G_CTRL-J*
347 <Left> cursor one character left *i_<Left>*
348 <Right> cursor one character right *i_<Right>*
349 <S-Left> cursor one word back (like "b" command) *i_<S-Left>*
350 <C-Left> cursor one word back (like "b" command) *i_<C-Left>*
351 <S-Right> cursor one word forward (like "w" command) *i_<S-Right>*
352 <C-Right> cursor one word forward (like "w" command) *i_<C-Right>*
353 <Home> cursor to first char in the line *i_<Home>*
354 <End> cursor to after last char in the line *i_<End>*
355 <C-Home> cursor to first char in the file *i_<C-Home>*
356 <C-End> cursor to after last char in the file *i_<C-End>*
357 <LeftMouse> cursor to position of mouse click *i_<LeftMouse>*
358 <S-Up> move window one page up *i_<S-Up>*
359 <PageUp> move window one page up *i_<PageUp>*
360 <S-Down> move window one page down *i_<S-Down>*
361 <PageDown> move window one page down *i_<PageDown>*
362 <MouseDown> scroll three lines down *i_<MouseDown>*
363 <S-MouseDown> scroll a full page down *i_<S-MouseDown>*
364 <MouseUp> scroll three lines up *i_<MouseUp>*
365 <S-MouseUp> scroll a full page up *i_<S-MouseUp>*
366 CTRL-O execute one command, return to Insert mode *i_CTRL-O*
367 CTRL-\ CTRL-O like CTRL-O but don't move the cursor *i_CTRL-\_CTRL-O*
368 CTRL-L when 'insertmode' is set: go to Normal mode *i_CTRL-L*
369 CTRL-G u break undo sequence, start new change *i_CTRL-G_u*
370 -----------------------------------------------------------------------
372 Note: If the cursor keys take you out of Insert mode, check the 'noesckeys'
373 option.
375 The CTRL-O command sometimes has a side effect: If the cursor was beyond the
376 end of the line, it will be put on the last character in the line. In
377 mappings it's often better to use <Esc> (first put an "x" in the text, <Esc>
378 will then always put the cursor on it). Or use CTRL-\ CTRL-O, but then
379 beware of the cursor possibly being beyond the end of the line.
381 The shifted cursor keys are not available on all terminals.
383 Another side effect is that a count specified before the "i" or "a" command is
384 ignored. That is because repeating the effect of the command after CTRL-O is
385 too complicated.
387 An example for using CTRL-G u: >
389 :inoremap <C-H> <C-G>u<C-H>
391 This redefines the backspace key to start a new undo sequence. You can now
392 undo the effect of the backspace key, without changing what you typed before
393 that, with CTRL-O u.
395 Using CTRL-O splits undo: the text typed before and after it is undone
396 separately. If you want to avoid this (e.g., in a mapping) you might be able
397 to use CTRL-R = |i_CTRL-R|. E.g., to call a function: >
398 :imap <F2> <C-R>=MyFunc()<CR>
400 When the 'whichwrap' option is set appropriately, the <Left> and <Right>
401 keys on the first/last character in the line make the cursor wrap to the
402 previous/next line.
404 The CTRL-G j and CTRL-G k commands can be used to insert text in front of a
405 column. Example: >
406 int i;
407 int j;
408 Position the cursor on the first "int", type "istatic <C-G>j ". The
409 result is: >
410 static int i;
411 int j;
412 When inserting the same text in front of the column in every line, use the
413 Visual blockwise command "I" |v_b_I|.
415 ==============================================================================
416 3. 'textwidth' and 'wrapmargin' options *ins-textwidth*
418 The 'textwidth' option can be used to automatically break a line before it
419 gets too long. Set the 'textwidth' option to the desired maximum line
420 length. If you then type more characters (not spaces or tabs), the
421 last word will be put on a new line (unless it is the only word on the
422 line). If you set 'textwidth' to 0, this feature is disabled.
424 The 'wrapmargin' option does almost the same. The difference is that
425 'textwidth' has a fixed width while 'wrapmargin' depends on the width of the
426 screen. When using 'wrapmargin' this is equal to using 'textwidth' with a
427 value equal to (columns - 'wrapmargin'), where columns is the width of the
428 screen.
430 When 'textwidth' and 'wrapmargin' are both set, 'textwidth' is used.
432 If you don't really want to break the line, but view the line wrapped at a
433 convenient place, see the 'linebreak' option.
435 The line is only broken automatically when using Insert mode, or when
436 appending to a line. When in replace mode and the line length is not
437 changed, the line will not be broken.
439 Long lines are broken if you enter a non-white character after the margin.
440 The situations where a line will be broken can be restricted by adding
441 characters to the 'formatoptions' option:
442 "l" Only break a line if it was not longer than 'textwidth' when the insert
443 started.
444 "v" Only break at a white character that has been entered during the
445 current insert command. This is mostly Vi-compatible.
446 "lv" Only break if the line was not longer than 'textwidth' when the insert
447 started and only at a white character that has been entered during the
448 current insert command. Only differs from "l" when entering non-white
449 characters while crossing the 'textwidth' boundary.
451 Normally an internal function will be used to decide where to break the line.
452 If you want to do it in a different way set the 'formatexpr' option to an
453 expression that will take care of the line break.
455 If you want to format a block of text, you can use the "gq" operator. Type
456 "gq" and a movement command to move the cursor to the end of the block. In
457 many cases, the command "gq}" will do what you want (format until the end of
458 paragraph). Alternatively, you can use "gqap", which will format the whole
459 paragraph, no matter where the cursor currently is. Or you can use Visual
460 mode: hit "v", move to the end of the block, and type "gq". See also |gq|.
462 ==============================================================================
463 4. 'expandtab', 'smarttab' and 'softtabstop' options *ins-expandtab*
465 If the 'expandtab' option is on, spaces will be used to fill the amount of
466 whitespace of the tab. If you want to enter a real <Tab>, type CTRL-V first
467 (use CTRL-Q when CTRL-V is mapped |i_CTRL-Q|).
468 The 'expandtab' option is off by default. Note that in Replace mode, a single
469 character is replaced with several spaces. The result of this is that the
470 number of characters in the line increases. Backspacing will delete one
471 space at a time. The original character will be put back for only one space
472 that you backspace over (the last one). {Vi does not have the 'expandtab'
473 option}
475 *ins-smarttab*
476 When the 'smarttab' option is on, a <Tab> inserts 'shiftwidth' positions at
477 the beginning of a line and 'tabstop' positions in other places. This means
478 that often spaces instead of a <Tab> character are inserted. When 'smarttab
479 is off, a <Tab> always inserts 'tabstop' positions, and 'shiftwidth' is only
480 used for ">>" and the like. {not in Vi}
482 *ins-softtabstop*
483 When the 'softtabstop' option is non-zero, a <Tab> inserts 'softtabstop'
484 positions, and a <BS> used to delete white space, will delete 'softtabstop'
485 positions. This feels like 'tabstop' was set to 'softtabstop', but a real
486 <Tab> character still takes 'tabstop' positions, so your file will still look
487 correct when used by other applications.
489 If 'softtabstop' is non-zero, a <BS> will try to delete as much white space to
490 move to the previous 'softtabstop' position, except when the previously
491 inserted character is a space, then it will only delete the character before
492 the cursor. Otherwise you cannot always delete a single character before the
493 cursor. You will have to delete 'softtabstop' characters first, and then type
494 extra spaces to get where you want to be.
496 ==============================================================================
497 5. Replace mode *Replace* *Replace-mode* *mode-replace*
499 Enter Replace mode with the "R" command in normal mode.
501 In Replace mode, one character in the line is deleted for every character you
502 type. If there is no character to delete (at the end of the line), the
503 typed character is appended (as in Insert mode). Thus the number of
504 characters in a line stays the same until you get to the end of the line.
505 If a <NL> is typed, a line break is inserted and no character is deleted.
507 Be careful with <Tab> characters. If you type a normal printing character in
508 its place, the number of characters is still the same, but the number of
509 columns will become smaller.
511 If you delete characters in Replace mode (with <BS>, CTRL-W, or CTRL-U), what
512 happens is that you delete the changes. The characters that were replaced
513 are restored. If you had typed past the existing text, the characters you
514 added are deleted. This is effectively a character-at-a-time undo.
516 If the 'expandtab' option is on, a <Tab> will replace one character with
517 several spaces. The result of this is that the number of characters in the
518 line increases. Backspacing will delete one space at a time. The original
519 character will be put back for only one space that you backspace over (the
520 last one). {Vi does not have the 'expandtab' option}
522 ==============================================================================
523 6. Virtual Replace mode *vreplace-mode* *Virtual-Replace-mode*
525 Enter Virtual Replace mode with the "gR" command in normal mode.
526 {not available when compiled without the +vreplace feature}
527 {Vi does not have Virtual Replace mode}
529 Virtual Replace mode is similar to Replace mode, but instead of replacing
530 actual characters in the file, you are replacing screen real estate, so that
531 characters further on in the file never appear to move.
533 So if you type a <Tab> it may replace several normal characters, and if you
534 type a letter on top of a <Tab> it may not replace anything at all, since the
535 <Tab> will still line up to the same place as before.
537 Typing a <NL> still doesn't cause characters later in the file to appear to
538 move. The rest of the current line will be replaced by the <NL> (that is,
539 they are deleted), and replacing continues on the next line. A new line is
540 NOT inserted unless you go past the end of the file.
542 Interesting effects are seen when using CTRL-T and CTRL-D. The characters
543 before the cursor are shifted sideways as normal, but characters later in the
544 line still remain still. CTRL-T will hide some of the old line under the
545 shifted characters, but CTRL-D will reveal them again.
547 As with Replace mode, using <BS> etc will bring back the characters that were
548 replaced. This still works in conjunction with 'smartindent', CTRL-T and
549 CTRL-D, 'expandtab', 'smarttab', 'softtabstop', etc.
551 In 'list' mode, Virtual Replace mode acts as if it was not in 'list' mode,
552 unless "L" is in 'cpoptions'.
554 Note that the only times characters beyond the cursor should appear to move
555 are in 'list' mode, and occasionally when 'wrap' is set (and the line changes
556 length to become shorter or wider than the width of the screen), or
557 momentarily when typing over a CTRL character. A CTRL character takes up two
558 screen spaces. When replacing it with two normal characters, the first will
559 be inserted and the second will replace the CTRL character.
561 This mode is very useful for editing <Tab> separated columns in tables, for
562 entering new data while keeping all the columns aligned.
564 ==============================================================================
565 7. Insert mode completion *ins-completion*
567 In Insert and Replace mode, there are several commands to complete part of a
568 keyword or line that has been typed. This is useful if you are using
569 complicated keywords (e.g., function names with capitals and underscores).
571 These commands are not available when the |+insert_expand| feature was
572 disabled at compile time.
574 Completion can be done for:
576 1. Whole lines |i_CTRL-X_CTRL-L|
577 2. keywords in the current file |i_CTRL-X_CTRL-N|
578 3. keywords in 'dictionary' |i_CTRL-X_CTRL-K|
579 4. keywords in 'thesaurus', thesaurus-style |i_CTRL-X_CTRL-T|
580 5. keywords in the current and included files |i_CTRL-X_CTRL-I|
581 6. tags |i_CTRL-X_CTRL-]|
582 7. file names |i_CTRL-X_CTRL-F|
583 8. definitions or macros |i_CTRL-X_CTRL-D|
584 9. Vim command-line |i_CTRL-X_CTRL-V|
585 10. User defined completion |i_CTRL-X_CTRL-U|
586 11. omni completion |i_CTRL-X_CTRL-O|
587 12. Spelling suggestions |i_CTRL-X_s|
588 13. keywords in 'complete' |i_CTRL-N|
590 All these (except 2) are done in CTRL-X mode. This is a sub-mode of Insert
591 and Replace modes. You enter CTRL-X mode by typing CTRL-X and one of the
592 CTRL-X commands. You exit CTRL-X mode by typing a key that is not a valid
593 CTRL-X mode command. Valid keys are the CTRL-X command itself, CTRL-N (next),
594 and CTRL-P (previous).
596 Also see the 'infercase' option if you want to adjust the case of the match.
598 *complete_CTRL-E*
599 When completion is active you can use CTRL-E to stop it and go back to the
600 originally typed text. The CTRL-E will not be inserted.
602 *complete_CTRL-Y*
603 When the popup menu is displayed you can use CTRL-Y to stop completion and
604 accept the currently selected entry. The CTRL-Y is not inserted. Typing a
605 space, Enter, or some other unprintable character will leave completion mode
606 and insert that typed character.
608 When the popup menu is displayed there are a few more special keys, see
609 |popupmenu-keys|.
611 Note: The keys that are valid in CTRL-X mode are not mapped. This allows for
612 ":map ^F ^X^F" to work (where ^F is CTRL-F and ^X is CTRL-X). The key that
613 ends CTRL-X mode (any key that is not a valid CTRL-X mode command) is mapped.
614 Also, when doing completion with 'complete' mappings apply as usual.
616 Note: While completion is active Insert mode can't be used recursively.
617 Mappings that somehow invoke ":normal i.." will generate an E523 error.
619 The following mappings are suggested to make typing the completion commands
620 a bit easier (although they will hide other commands): >
621 :inoremap ^] ^X^]
622 :inoremap ^F ^X^F
623 :inoremap ^D ^X^D
624 :inoremap ^L ^X^L
626 As a special case, typing CTRL-R to perform register insertion (see
627 |i_CTRL-R|) will not exit CTRL-X mode. This is primarily to allow the use of
628 the '=' register to call some function to determine the next operation. If
629 the contents of the register (or result of the '=' register evaluation) are
630 not valid CTRL-X mode keys, then CTRL-X mode will be exited as if those keys
631 had been typed.
633 For example, the following will map <Tab> to either actually insert a <Tab> if
634 the current line is currently only whitespace, or start/continue a CTRL-N
635 completion operation: >
637 function! CleverTab()
638 if strpart( getline('.'), 0, col('.')-1 ) =~ '^\s*$'
639 return "\<Tab>"
640 else
641 return "\<C-N>"
642 endif
643 endfunction
644 inoremap <Tab> <C-R>=CleverTab()<CR>
648 Completing whole lines *compl-whole-line*
650 *i_CTRL-X_CTRL-L*
651 CTRL-X CTRL-L Search backwards for a line that starts with the
652 same characters as those in the current line before
653 the cursor. Indent is ignored. The matching line is
654 inserted in front of the cursor.
655 The 'complete' option is used to decide which buffers
656 are searched for a match. Both loaded and unloaded
657 buffers are used.
658 CTRL-L or
659 CTRL-P Search backwards for next matching line. This line
660 replaces the previous matching line.
662 CTRL-N Search forward for next matching line. This line
663 replaces the previous matching line.
665 CTRL-X CTRL-L After expanding a line you can additionally get the
666 line next to it by typing CTRL-X CTRL-L again, unless
667 a double CTRL-X is used. Only works for loaded
668 buffers.
670 Completing keywords in current file *compl-current*
672 *i_CTRL-X_CTRL-P*
673 *i_CTRL-X_CTRL-N*
674 CTRL-X CTRL-N Search forwards for words that start with the keyword
675 in front of the cursor. The found keyword is inserted
676 in front of the cursor.
678 CTRL-X CTRL-P Search backwards for words that start with the keyword
679 in front of the cursor. The found keyword is inserted
680 in front of the cursor.
682 CTRL-N Search forward for next matching keyword. This
683 keyword replaces the previous matching keyword.
685 CTRL-P Search backwards for next matching keyword. This
686 keyword replaces the previous matching keyword.
688 CTRL-X CTRL-N or
689 CTRL-X CTRL-P Further use of CTRL-X CTRL-N or CTRL-X CTRL-P will
690 copy the words following the previous expansion in
691 other contexts unless a double CTRL-X is used.
693 If there is a keyword in front of the cursor (a name made out of alphabetic
694 characters and characters in 'iskeyword'), it is used as the search pattern,
695 with "\<" prepended (meaning: start of a word). Otherwise "\<\k\k" is used
696 as search pattern (start of any keyword of at least two characters).
698 In Replace mode, the number of characters that are replaced depends on the
699 length of the matched string. This works like typing the characters of the
700 matched string in Replace mode.
702 If there is not a valid keyword character before the cursor, any keyword of
703 at least two characters is matched.
704 e.g., to get:
705 printf("(%g, %g, %g)", vector[0], vector[1], vector[2]);
706 just type:
707 printf("(%g, %g, %g)", vector[0], ^P[1], ^P[2]);
709 The search wraps around the end of the file, the value of 'wrapscan' is not
710 used here.
712 Multiple repeats of the same completion are skipped; thus a different match
713 will be inserted at each CTRL-N and CTRL-P (unless there is only one
714 matching keyword).
716 Single character matches are never included, as they usually just get in
717 the way of what you were really after.
718 e.g., to get:
719 printf("name = %s\n", name);
720 just type:
721 printf("name = %s\n", n^P);
722 or even:
723 printf("name = %s\n", ^P);
724 The 'n' in '\n' is skipped.
726 After expanding a word, you can use CTRL-X CTRL-P or CTRL-X CTRL-N to get the
727 word following the expansion in other contexts. These sequences search for
728 the text just expanded and further expand by getting an extra word. This is
729 useful if you need to repeat a sequence of complicated words. Although CTRL-P
730 and CTRL-N look just for strings of at least two characters, CTRL-X CTRL-P and
731 CTRL-X CTRL-N can be used to expand words of just one character.
732 e.g., to get:
733 México
734 you can type:
735 M^N^P^X^P^X^P
736 CTRL-N starts the expansion and then CTRL-P takes back the single character
737 "M", the next two CTRL-X CTRL-P's get the words "é" and ";xico".
739 If the previous expansion was split, because it got longer than 'textwidth',
740 then just the text in the current line will be used.
742 If the match found is at the end of a line, then the first word in the next
743 line will be inserted and the message "word from next line" displayed, if
744 this word is accepted the next CTRL-X CTRL-P or CTRL-X CTRL-N will search
745 for those lines starting with this word.
748 Completing keywords in 'dictionary' *compl-dictionary*
750 *i_CTRL-X_CTRL-K*
751 CTRL-X CTRL-K Search the files given with the 'dictionary' option
752 for words that start with the keyword in front of the
753 cursor. This is like CTRL-N, but only the dictionary
754 files are searched, not the current file. The found
755 keyword is inserted in front of the cursor. This
756 could potentially be pretty slow, since all matches
757 are found before the first match is used. By default,
758 the 'dictionary' option is empty.
759 For suggestions where to find a list of words, see the
760 'dictionary' option.
762 CTRL-K or
763 CTRL-N Search forward for next matching keyword. This
764 keyword replaces the previous matching keyword.
766 CTRL-P Search backwards for next matching keyword. This
767 keyword replaces the previous matching keyword.
769 *i_CTRL-X_CTRL-T*
770 CTRL-X CTRL-T Works as CTRL-X CTRL-K, but in a special way. It uses
771 the 'thesaurus' option instead of 'dictionary'. If a
772 match is found in the thesaurus file, all the
773 remaining words on the same line are included as
774 matches, even though they don't complete the word.
775 Thus a word can be completely replaced.
777 For an example, imagine the 'thesaurus' file has a
778 line like this: >
779 angry furious mad enraged
780 < Placing the cursor after the letters "ang" and typing
781 CTRL-X CTRL-T would complete the word "angry";
782 subsequent presses would change the word to "furious",
783 "mad" etc.
784 Other uses include translation between two languages,
785 or grouping API functions by keyword.
787 CTRL-T or
788 CTRL-N Search forward for next matching keyword. This
789 keyword replaces the previous matching keyword.
791 CTRL-P Search backwards for next matching keyword. This
792 keyword replaces the previous matching keyword.
795 Completing keywords in the current and included files *compl-keyword*
797 The 'include' option is used to specify a line that contains an include file
798 name. The 'path' option is used to search for include files.
800 *i_CTRL-X_CTRL-I*
801 CTRL-X CTRL-I Search for the first keyword in the current and
802 included files that starts with the same characters
803 as those before the cursor. The matched keyword is
804 inserted in front of the cursor.
806 CTRL-N Search forwards for next matching keyword. This
807 keyword replaces the previous matching keyword.
808 Note: CTRL-I is the same as <Tab>, which is likely to
809 be typed after a successful completion, therefore
810 CTRL-I is not used for searching for the next match.
812 CTRL-P Search backward for previous matching keyword. This
813 keyword replaces the previous matching keyword.
815 CTRL-X CTRL-I Further use of CTRL-X CTRL-I will copy the words
816 following the previous expansion in other contexts
817 unless a double CTRL-X is used.
819 Completing tags *compl-tag*
820 *i_CTRL-X_CTRL-]*
821 CTRL-X CTRL-] Search for the first tag that starts with the same
822 characters as before the cursor. The matching tag is
823 inserted in front of the cursor. Alphabetic
824 characters and characters in 'iskeyword' are used
825 to decide which characters are included in the tag
826 name (same as for a keyword). See also |CTRL-]|.
827 The 'showfulltag' option can be used to add context
828 from around the tag definition.
829 CTRL-] or
830 CTRL-N Search forwards for next matching tag. This tag
831 replaces the previous matching tag.
833 CTRL-P Search backward for previous matching tag. This tag
834 replaces the previous matching tag.
837 Completing file names *compl-filename*
838 *i_CTRL-X_CTRL-F*
839 CTRL-X CTRL-F Search for the first file name that starts with the
840 same characters as before the cursor. The matching
841 file name is inserted in front of the cursor.
842 Alphabetic characters and characters in 'isfname'
843 are used to decide which characters are included in
844 the file name. Note: the 'path' option is not used
845 here (yet).
846 CTRL-F or
847 CTRL-N Search forwards for next matching file name. This
848 file name replaces the previous matching file name.
850 CTRL-P Search backward for previous matching file name.
851 This file name replaces the previous matching file
852 name.
855 Completing definitions or macros *compl-define*
857 The 'define' option is used to specify a line that contains a definition.
858 The 'include' option is used to specify a line that contains an include file
859 name. The 'path' option is used to search for include files.
861 *i_CTRL-X_CTRL-D*
862 CTRL-X CTRL-D Search in the current and included files for the
863 first definition (or macro) name that starts with
864 the same characters as before the cursor. The found
865 definition name is inserted in front of the cursor.
866 CTRL-D or
867 CTRL-N Search forwards for next matching macro name. This
868 macro name replaces the previous matching macro
869 name.
871 CTRL-P Search backward for previous matching macro name.
872 This macro name replaces the previous matching macro
873 name.
875 CTRL-X CTRL-D Further use of CTRL-X CTRL-D will copy the words
876 following the previous expansion in other contexts
877 unless a double CTRL-X is used.
880 Completing Vim commands *compl-vim*
882 Completion is context-sensitive. It works like on the Command-line. It
883 completes an Ex command as well as its arguments. This is useful when writing
884 a Vim script.
886 *i_CTRL-X_CTRL-V*
887 CTRL-X CTRL-V Guess what kind of item is in front of the cursor and
888 find the first match for it.
889 Note: When CTRL-V is mapped you can often use CTRL-Q
890 instead of |i_CTRL-Q|.
891 CTRL-V or
892 CTRL-N Search forwards for next match. This match replaces
893 the previous one.
895 CTRL-P Search backwards for previous match. This match
896 replaces the previous one.
898 CTRL-X CTRL-V Further use of CTRL-X CTRL-V will do the same as
899 CTRL-V. This allows mapping a key to do Vim command
900 completion, for example: >
901 :imap <Tab> <C-X><C-V>
903 User defined completion *compl-function*
905 Completion is done by a function that can be defined by the user with the
906 'completefunc' option. See below for how the function is called and an
907 example |complete-functions|.
909 *i_CTRL-X_CTRL-U*
910 CTRL-X CTRL-U Guess what kind of item is in front of the cursor and
911 find the first match for it.
912 CTRL-U or
913 CTRL-N Use the next match. This match replaces the previous
914 one.
916 CTRL-P Use the previous match. This match replaces the
917 previous one.
920 Omni completion *compl-omni*
922 Completion is done by a function that can be defined by the user with the
923 'omnifunc' option. This is to be used for filetype-specific completion.
925 See below for how the function is called and an example |complete-functions|.
926 For remarks about specific filetypes see |compl-omni-filetypes|.
927 More completion scripts will appear, check www.vim.org. Currently there is a
928 first version for C++.
930 *i_CTRL-X_CTRL-O*
931 CTRL-X CTRL-O Guess what kind of item is in front of the cursor and
932 find the first match for it.
933 CTRL-O or
934 CTRL-N Use the next match. This match replaces the previous
935 one.
937 CTRL-P Use the previous match. This match replaces the
938 previous one.
941 Spelling suggestions *compl-spelling*
943 A word before or at the cursor is located and correctly spelled words are
944 suggested to replace it. If there is a badly spelled word in the line, before
945 or under the cursor, the cursor is moved to after it. Otherwise the word just
946 before the cursor is used for suggestions, even though it isn't badly spelled.
948 NOTE: CTRL-S suspends display in many Unix terminals. Use 's' instead. Type
949 CTRL-Q to resume displaying.
951 *i_CTRL-X_CTRL-S* *i_CTRL-X_s*
952 CTRL-X CTRL-S or
953 CTRL-X s Locate the word in front of the cursor and find the
954 first spell suggestion for it.
955 CTRL-S or
956 CTRL-N Use the next suggestion. This replaces the previous
957 one. Note that you can't use 's' here.
959 CTRL-P Use the previous suggestion. This replaces the
960 previous one.
963 Completing keywords from different sources *compl-generic*
965 *i_CTRL-N*
966 CTRL-N Find next match for words that start with the
967 keyword in front of the cursor, looking in places
968 specified with the 'complete' option. The found
969 keyword is inserted in front of the cursor.
971 *i_CTRL-P*
972 CTRL-P Find previous match for words that start with the
973 keyword in front of the cursor, looking in places
974 specified with the 'complete' option. The found
975 keyword is inserted in front of the cursor.
977 CTRL-N Search forward for next matching keyword. This
978 keyword replaces the previous matching keyword.
980 CTRL-P Search backwards for next matching keyword. This
981 keyword replaces the previous matching keyword.
983 CTRL-X CTRL-N or
984 CTRL-X CTRL-P Further use of CTRL-X CTRL-N or CTRL-X CTRL-P will
985 copy the words following the previous expansion in
986 other contexts unless a double CTRL-X is used.
989 FUNCTIONS FOR FINDING COMPLETIONS *complete-functions*
991 This applies to 'completefunc' and 'omnifunc'.
993 The function is called in two different ways:
994 - First the function is called to find the start of the text to be completed.
995 - Later the function is called to actually find the matches.
997 On the first invocation the arguments are:
998 a:findstart 1
999 a:base empty
1001 The function must return the column where the completion starts. It must be a
1002 number between zero and the cursor column "col('.')". This involves looking
1003 at the characters just before the cursor and including those characters that
1004 could be part of the completed item. The text between this column and the
1005 cursor column will be replaced with the matches. Return -1 if no completion
1006 can be done.
1008 On the second invocation the arguments are:
1009 a:findstart 0
1010 a:base the text with which matches should match; the text that was
1011 located in the first call (can be empty)
1013 The function must return a List with the matching words. These matches
1014 usually include the "a:base" text. When there are no matches return an empty
1015 List.
1016 *complete-items*
1017 Each list item can either be a string or a Dictionary. When it is a string it
1018 is used as the completion. When it is a Dictionary it can contain these
1019 items:
1020 word the text that will be inserted, mandatory
1021 abbr abbreviation of "word"; when not empty it is used in
1022 the menu instead of "word"
1023 menu extra text for the popup menu, displayed after "word"
1024 or "abbr"
1025 info more information about the item, can be displayed in a
1026 preview window
1027 kind single letter indicating the type of completion
1028 icase when non-zero case is to be ignored when comparing
1029 items to be equal; when omitted zero is used, thus
1030 items that only differ in case are added
1031 dup when non-zero this match will be added even when an
1032 item with the same word is already present.
1034 All of these except 'icase' must be a string. If an item does not meet these
1035 requirements then an error message is given and further items in the list are
1036 not used. You can mix string and Dictionary items in the returned list.
1038 The "menu" item is used in the popup menu and may be truncated, thus it should
1039 be relatively short. The "info" item can be longer, it will be displayed in
1040 the preview window when "preview" appears in 'completeopt'. The "info" item
1041 will also remain displayed after the popup menu has been removed. This is
1042 useful for function arguments. Use a single space for "info" to remove
1043 existing text in the preview window.
1045 The "kind" item uses a single letter to indicate the kind of completion. This
1046 may be used to show the completion differently (different color or icon).
1047 Currently these types can be used:
1048 v variable
1049 f function or method
1050 m member of a struct or class
1051 t typedef
1052 d #define or macro
1054 When searching for matches takes some time call |complete_add()| to add each
1055 match to the total list. These matches should then not appear in the returned
1056 list! Call |complete_check()| now and then to allow the user to press a key
1057 while still searching for matches. Stop searching when it returns non-zero.
1059 The function is allowed to move the cursor, it is restored afterwards. This
1060 option cannot be set from a |modeline| or in the |sandbox|, for security
1061 reasons.
1063 An example that completes the names of the months: >
1064 fun! CompleteMonths(findstart, base)
1065 if a:findstart
1066 " locate the start of the word
1067 let line = getline('.')
1068 let start = col('.') - 1
1069 while start > 0 && line[start - 1] =~ '\a'
1070 let start -= 1
1071 endwhile
1072 return start
1073 else
1074 " find months matching with "a:base"
1075 let res = []
1076 for m in split("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec")
1077 if m =~ '^' . a:base
1078 call add(res, m)
1079 endif
1080 endfor
1081 return res
1082 endif
1083 endfun
1084 set completefunc=CompleteMonths
1085 <
1086 The same, but now pretending searching for matches is slow: >
1087 fun! CompleteMonths(findstart, base)
1088 if a:findstart
1089 " locate the start of the word
1090 let line = getline('.')
1091 let start = col('.') - 1
1092 while start > 0 && line[start - 1] =~ '\a'
1093 let start -= 1
1094 endwhile
1095 return start
1096 else
1097 " find months matching with "a:base"
1098 for m in split("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec")
1099 if m =~ '^' . a:base
1100 call complete_add(m)
1101 endif
1102 sleep 300m " simulate searching for next match
1103 if complete_check()
1104 break
1105 endif
1106 endfor
1107 return []
1108 endif
1109 endfun
1110 set completefunc=CompleteMonths
1111 <
1113 INSERT COMPLETION POPUP MENU *ins-completion-menu*
1114 *popupmenu-completion*
1115 Vim can display the matches in a simplistic popup menu.
1117 The menu is used when:
1118 - The 'completeopt' option contains "menu" or "menuone".
1119 - The terminal supports at least 8 colors.
1120 - There are at least two matches. One if "menuone" is used.
1122 The 'pumheight' option can be used to set a maximum height. The default is to
1123 use all space available.
1125 There are three states:
1126 1. A complete match has been inserted, e.g., after using CTRL-N or CTRL-P.
1127 2. A cursor key has been used to select another match. The match was not
1128 inserted then, only the entry in the popup menu is highlighted.
1129 3. Only part of a match has been inserted and characters were typed or the
1130 backspace key was used. The list of matches was then adjusted for what is
1131 in front of the cursor.
1133 You normally start in the first state, with the first match being inserted.
1134 When "longest" is in 'completeopt' and there is more than one match you start
1135 in the third state.
1137 If you select another match, e.g., with CTRL-N or CTRL-P, you go to the first
1138 state. This doesn't change the list of matches.
1140 When you are back at the original text then you are in the third state. To
1141 get there right away you can use a mapping that uses CTRL-P right after
1142 starting the completion: >
1143 :imap <F7> <C-N><C-P>
1144 <
1145 *popupmenu-keys*
1146 In the first state these keys have a special meaning:
1147 <BS> and CTRL-H Delete one character, find the matches for the word before
1148 the cursor. This reduces the list of matches, often to one
1149 entry, and switches to the second state.
1150 Any non-special character:
1151 Stop completion without changing the match and insert the
1152 typed character.
1154 In the second and third state these keys have a special meaning:
1155 <BS> and CTRL-H Delete one character, find the matches for the shorter word
1156 before the cursor. This may find more matches.
1157 CTRL-L Add one character from the current match, may reduce the
1158 number of matches.
1159 any printable, non-white character:
1160 Add this character and reduce the number of matches.
1162 In all three states these can be used:
1163 CTRL-Y Yes: Accept the currently selected match and stop completion.
1164 CTRL-E End completion, go back to what was there before selecting a
1165 match (what was typed or longest common string).
1166 <PageUp> Select a match several entries back, but don't insert it.
1167 <PageDown> Select a match several entries further, but don't insert it.
1168 <Up> Select the previous match, as if CTRL-P was used, but don't
1169 insert it.
1170 <Down> Select the next match, as if CTRL-N was used, but don't
1171 insert it.
1172 <Space> or <Tab> Stop completion without changing the match and insert the
1173 typed character.
1175 The behavior of the <Enter> key depends on the state you are in:
1176 first state: Use the text as it is and insert a line break.
1177 second state: Insert the currently selected match.
1178 third state: Use the text as it is and insert a line break.
1180 In other words: If you used the cursor keys to select another entry in the
1181 list of matches then the <Enter> key inserts that match. If you typed
1182 something else then <Enter> inserts a line break.
1185 The colors of the menu can be changed with these highlight groups:
1186 Pmenu normal item |hl-Pmenu|
1187 PmenuSel selected item |hl-PmenuSel|
1188 PmenuSbar scrollbar |hl-PmenuSbar|
1189 PmenuThumb thumb of the scrollbar |hl-PmenuThumb|
1191 There are no special mappings for when the popup menu is visible. However,
1192 you can use an Insert mode mapping that checks the |pumvisible()| function to
1193 do something different. Example: >
1194 :inoremap <Down> <C-R>=pumvisible() ? "\<lt>C-N>" : "\<lt>Down>"<CR>
1196 You can use of <expr> in mapping to have the popup menu used when typing a
1197 character and some condition is met. For example, for typing a dot: >
1198 inoremap <expr> . MayComplete()
1199 func MayComplete()
1200 if (can complete)
1201 return ".\<C-X>\<C-O>"
1202 endif
1203 return '.'
1204 endfunc
1206 See |:map-<expr>| for more info.
1209 FILETYPE-SPECIFIC REMARKS FOR OMNI COMPLETION *compl-omni-filetypes*
1211 The file used for {filetype} should be autoload/{filetype}complete.vim
1212 in 'runtimepath'. Thus for "java" it is autoload/javacomplete.vim.
1215 C *ft-c-omni*
1217 Completion of C code requires a tags file. You should use Exuberant ctags,
1218 because it adds extra information that is needed for completion. You can find
1219 it here: http://ctags.sourceforge.net/ Version 5.6 or later is recommended.
1221 For version 5.5.4 you should add a patch that adds the "typename:" field:
1222 ftp://ftp.vim.org/pub/vim/unstable/patches/ctags-5.5.4.patch
1223 A compiled .exe for MS-Windows can be found at:
1224 http://georgevreilly.com/vim/ctags.html
1226 If you want to complete system functions you can do something like this. Use
1227 ctags to generate a tags file for all the system header files: >
1228 % ctags -R -f ~/.vim/systags /usr/include /usr/local/include
1229 In your vimrc file add this tags file to the 'tags' option: >
1230 set tags+=~/.vim/systags
1232 When using CTRL-X CTRL-O after a name without any "." or "->" it is completed
1233 from the tags file directly. This works for any identifier, also function
1234 names. If you want to complete a local variable name, which does not appear
1235 in the tags file, use CTRL-P instead.
1237 When using CTRL-X CTRL-O after something that has "." or "->" Vim will attempt
1238 to recognize the type of the variable and figure out what members it has.
1239 This means only members valid for the variable will be listed.
1241 When a member name already was complete, CTRL-X CTRL-O will add a "." or
1242 "->" for composite types.
1244 Vim doesn't include a C compiler, only the most obviously formatted
1245 declarations are recognized. Preprocessor stuff may cause confusion.
1246 When the same structure name appears in multiple places all possible members
1247 are included.
1250 CSS *ft-css-omni*
1252 Complete properties and their appropriate values according to CSS 2.1
1253 specification.
1256 HTML *ft-html-omni*
1257 XHTML *ft-xhtml-omni*
1259 CTRL-X CTRL-O provides completion of various elements of (X)HTML files. It is
1260 designed to support writing of XHTML 1.0 Strict files but will also works for
1261 other versions of HTML. Features:
1263 - after "<" complete tag name depending on context (no div suggestion inside
1264 of an a tag); '/>' indicates empty tags
1265 - inside of tag complete proper attributes (no width attribute for an a tag);
1266 show also type of attribute; '*' indicates required attributes
1267 - when attribute has limited number of possible values help to complete them
1268 - complete names of entities
1269 - complete values of "class" and "id" attributes with data obtained from
1270 <style> tag and included CSS files
1271 - when completing value of "style" attribute or working inside of "style" tag
1272 switch to |ft-css-omni| completion
1273 - when completing values of events attributes or working inside of "script"
1274 tag switch to |ft-javascript-omni| completion
1275 - when used after "</" CTRL-X CTRL-O will close the last opened tag
1277 Note: When used first time completion menu will be shown with little delay
1278 - this is time needed for loading of data file.
1279 Note: Completion may fail in badly formatted documents. In such case try to
1280 run |:make| command to detect formatting problems.
1283 HTML flavor *html-flavor*
1285 The default HTML completion depends on the filetype. For HTML files it is
1286 HTML 4.01 Transitional ('filetype' is "html"), for XHTML it is XHTML 1.0
1287 Strict ('filetype' is "xhtml").
1289 When doing completion outside of any other tag you will have possibility to
1290 choose DOCTYPE and the appropriate data file will be loaded and used for all
1291 next completions.
1293 More about format of data file in |xml-omni-datafile|. Some of the data files
1294 may be found on the Vim website (|www|).
1296 Note that b:html_omni_flavor may point to a file with any XML data. This
1297 makes possible to mix PHP (|ft-php-omni|) completion with any XML dialect
1298 (assuming you have data file for it). Without setting that variable XHTML 1.0
1299 Strict will be used.
1302 JAVASCRIPT *ft-javascript-omni*
1304 Completion of most elements of JavaScript language and DOM elements.
1306 Complete:
1308 - variables
1309 - function name; show function arguments
1310 - function arguments
1311 - properties of variables trying to detect type of variable
1312 - complete DOM objects and properties depending on context
1313 - keywords of language
1315 Completion works in separate JavaScript files (&ft==javascript), inside of
1316 <script> tag of (X)HTML and in values of event attributes (including scanning
1317 of external files.
1319 DOM compatibility
1321 At the moment (beginning of 2006) there are two main browsers - MS Internet
1322 Explorer and Mozilla Firefox. These two applications are covering over 90% of
1323 market. Theoretically standards are created by W3C organisation
1324 (http://www.w3c.org) but they are not always followed/implemented.
1326 IE FF W3C Omni completion ~
1327 +/- +/- + + ~
1328 + + - + ~
1329 + - - - ~
1330 - + - - ~
1332 Regardless from state of implementation in browsers but if element is defined
1333 in standards, completion plugin will place element in suggestion list. When
1334 both major engines implemented element, even if this is not in standards it
1335 will be suggested. All other elements are not placed in suggestion list.
1338 PHP *ft-php-omni*
1340 Completion of PHP code requires a tags file for completion of data from
1341 external files and for class aware completion. You should use Exuberant ctags
1342 version 5.5.4 or newer. You can find it here: http://ctags.sourceforge.net/
1344 Script completes:
1346 - after $ variables name
1347 - if variable was declared as object add "->", if tags file is available show
1348 name of class
1349 - after "->" complete only function and variable names specific for given
1350 class. To find class location and contents tags file is required. Because
1351 PHP isn't strongly typed language user can use @var tag to declare class: >
1353 /* @var $myVar myClass */
1354 $myVar->
1355 <
1356 Still, to find myClass contents tags file is required.
1358 - function names with additional info:
1359 - in case of built-in functions list of possible arguments and after | type
1360 data returned by function
1361 - in case of user function arguments and name of file were function was
1362 defined (if it is not current file)
1364 - constants names
1365 - class names after "new" declaration
1368 Note: when doing completion first time Vim will load all necessary data into
1369 memory. It may take several seconds. After next use of completion delay
1370 should not be noticeable.
1372 Script detects if cursor is inside <?php ?> tags. If it is outside it will
1373 automatically switch to HTML/CSS/JavaScript completion. Note: contrary to
1374 original HTML files completion of tags (and only tags) isn't context aware.
1377 RUBY *ft-ruby-omni*
1379 Completion of Ruby code requires that vim be built with |+ruby|.
1381 Ruby completion will parse your buffer on demand in order to provide a list of
1382 completions. These completions will be drawn from modules loaded by 'require'
1383 and modules defined in the current buffer.
1385 The completions provided by CTRL-X CTRL-O are sensitive to the context:
1387 CONTEXT COMPLETIONS PROVIDED ~
1389 1. Not inside a class definition Classes, constants and globals
1391 2. Inside a class definition Methods or constants defined in the class
1393 3. After '.', '::' or ':' Methods applicable to the object being
1394 dereferenced
1396 4. After ':' or ':foo' Symbol name (beginning with 'foo')
1398 Notes:
1399 - Vim will load/evaluate code in order to provide completions. This may
1400 cause some code execution, which may be a concern. This is no longer
1401 enabled by default, to enable this feature add >
1402 let g:rubycomplete_buffer_loading = 1
1403 <- In context 1 above, Vim can parse the entire buffer to add a list of
1404 classes to the completion results. This feature is turned off by default,
1405 to enable it add >
1406 let g:rubycomplete_classes_in_global = 1
1407 < to your vimrc
1408 - In context 2 above, anonymous classes are not supported.
1409 - In context 3 above, Vim will attempt to determine the methods supported by
1410 the object.
1411 - Vim can detect and load the Rails environment for files within a rails
1412 project. The feature is disabled by default, to enable it add >
1413 let g:rubycomplete_rails = 1
1414 < to your vimrc
1417 SYNTAX *ft-syntax-omni*
1419 Vim has the ability to color syntax highlight nearly 500 languages. Part of
1420 this highlighting includes knowing what keywords are part of a language. Many
1421 filetypes already have custom completion scripts written for them, the
1422 syntaxcomplete plugin provides basic completion for all other filetypes. It
1423 does this by populating the omni completion list with the text Vim already
1424 knows how to color highlight. It can be used for any filetype and provides a
1425 minimal language-sensitive completion.
1427 To enable syntax code completion you can run: >
1428 setlocal omnifunc=syntaxcomplete#Complete
1430 You can automate this by placing the following in your vimrc (after any
1431 ":filetype" command): >
1432 if has("autocmd") && exists("+omnifunc")
1433 autocmd Filetype *
1434 \ if &omnifunc == "" |
1435 \ setlocal omnifunc=syntaxcomplete#Complete |
1436 \ endif
1437 endif
1439 The above will set completion to this script only if a specific plugin does
1440 not already exist for that filetype.
1442 Each filetype can have a wide range of syntax items. The plugin allows you to
1443 customize which syntax groups to include or exclude from the list. Let's have
1444 a look at the PHP filetype to see how this works.
1446 If you edit a file called, index.php, run the following command: >
1447 :syntax list
1449 First thing you will notice is there are many different syntax groups. The
1450 PHP language can include elements from different languages like HTML,
1451 JavaScript and many more. The syntax plugin will only include syntax groups
1452 that begin with the filetype, "php", in this case. For example these syntax
1453 groups are included by default with the PHP: phpEnvVar, phpIntVar,
1454 phpFunctions.
1456 The PHP language has an enormous number of items which it knows how to syntax
1457 highlight. This means these items will be available within the omni
1458 completion list. Some people may find this list unwieldy or are only
1459 interested in certain items.
1461 There are two ways to prune this list (if necessary). If you find certain
1462 syntax groups you do not wish displayed you can add the following to your
1463 vimrc: >
1464 let g:omni_syntax_group_exclude_php = 'phpCoreConstant,phpConstant'
1466 Add as many syntax groups to this list by comma separating them. The basic
1467 form of this variable is: >
1468 let g:omni_syntax_group_exclude_{filetype} = 'comma,separated,list'
1470 For completeness the opposite is also true. Creating this variable in your
1471 vimrc will only include the items in the phpFunctions and phpMethods syntax
1472 groups: >
1473 let g:omni_syntax_group_include_php = 'phpFunctions,phpMethods'
1475 You can create as many of these variables as you need, varying only the
1476 filetype at the end of the variable name.
1478 The plugin uses the isKeyword option to determine where word boundaries are
1479 for the syntax items. For example, in the Scheme language completion should
1480 include the "-", call-with-output-file. Depending on your filetype, this may
1481 not provide the words you are expecting. Setting the
1482 g:omni_syntax_use_iskeyword option to 0 will force the syntax plugin to break
1483 on word characters. This can be controlled adding the following to your
1484 vimrc: >
1485 let g:omni_syntax_use_iskeyword = 0
1488 SQL *ft-sql-omni*
1490 Completion for the SQL language includes statements, functions, keywords.
1491 It will also dynamically complete tables, procedures, views and column lists
1492 with data pulled directly from within a database. For detailed instructions
1493 and a tutorial see |omni-sql-completion|.
1495 The SQL completion plugin can be used in conjunction with other completion
1496 plugins. For example, the PHP filetype has its own completion plugin.
1497 Since PHP is often used to generate dynamic website by accessing a database,
1498 the SQL completion plugin can also be enabled. This allows you to complete
1499 PHP code and SQL code at the same time.
1502 XML *ft-xml-omni*
1504 Vim 7 provides a mechanism for context aware completion of XML files. It
1505 depends on a special |xml-omni-datafile| and two commands: |:XMLns| and
1506 |:XMLent|. Features are:
1508 - after "<" complete the tag name, depending on context
1509 - inside of a tag complete proper attributes
1510 - when an attribute has a limited number of possible values help to complete
1511 them
1512 - complete names of entities (defined in |xml-omni-datafile| and in the
1513 current file with "<!ENTITY" declarations)
1514 - when used after "</" CTRL-X CTRL-O will close the last opened tag
1516 Format of XML data file *xml-omni-datafile*
1518 XML data files are stored in the "autoload/xml" directory in 'runtimepath'.
1519 Vim distribution provides examples of data files in the
1520 "$VIMRUNTIME/autoload/xml" directory. They have a meaningful name which will
1521 be used in commands. It should be a unique name which will not create
1522 conflicts. For example, the name xhtml10s.vim means it is the data file for
1523 XHTML 1.0 Strict.
1525 Each file contains a variable with a name like g:xmldata_xhtml10s . It is
1526 a compound from two parts:
1528 1. "g:xmldata_" general prefix, constant for all data files
1529 2. "xhtml10s" the name of the file and the name of the described XML
1530 dialect; it will be used as an argument for the |:XMLns|
1531 command
1533 Part two must be exactly the same as name of file.
1535 The variable is a |Dictionary|. Keys are tag names and each value is a two
1536 element |List|. The first element of the List is also a List with the names
1537 of possible children. The second element is a |Dictionary| with the names of
1538 attributes as keys and the possible values of attributes as values. Example: >
1540 let g:xmldata_crippled = {
1541 \ "vimxmlentities": ["amp", "lt", "gt", "apos", "quot"],
1542 \ 'vimxmlroot': ['tag1'],
1543 \ 'tag1':
1544 \ [ ['childoftag1a', 'childoftag1b'], {'attroftag1a': [],
1545 \ 'attroftag1b': ['valueofattr1', 'valueofattr2']}],
1546 \ 'childoftag1a':
1547 \ [ [], {'attrofchild': ['attrofchild']}],
1548 \ 'childoftag1b':
1549 \ [ ['childoftag1a'], {'attrofchild': []}],
1550 \ "vimxmltaginfo": {
1551 \ 'tag1': ['Menu info', 'Long information visible in preview window']},
1552 \ 'vimxmlattrinfo': {
1553 \ 'attrofchild': ['Menu info', 'Long information visible in preview window']}}
1555 This example would be put in the "autoload/xml/crippled.vim" file and could
1556 help to write this file: >
1558 <tag1 attroftag1b="valueofattr1">
1559 <childoftag1a attrofchild>
1560 & <
1561 </childoftag1a>
1562 <childoftag1b attrofchild="5">
1563 <childoftag1a>
1564 > ' "
1565 </childoftag1a>
1566 </childoftag1b>
1567 </tag1>
1569 In the example four special elements are visible:
1571 1. "vimxmlentities" - a special key with List containing entities of this XML
1572 dialect.
1573 2. If the list containing possible values of attributes has one element and
1574 this element is equal to the name of the attribute this attribute will be
1575 treated as boolean and inserted as 'attrname' and not as 'attrname="'
1576 3. "vimxmltaginfo" - a special key with a Dictionary containing tag
1577 names as keys and two element List as values, for additional menu info and
1578 the long description.
1579 4. "vimxmlattrinfo" - special key with Dictionary containing attribute names
1580 as keys and two element List as values, for additional menu info and long
1581 description.
1583 Note: Tag names in the data file MUST not contain a namespace description.
1584 Check xsl.vim for an example.
1585 Note: All data and functions are publicly available as global
1586 variables/functions and can be used for personal editing functions.
1589 DTD -> Vim *dtd2vim*
1591 On |www| is the script |dtd2vim| which parses DTD and creates an XML data file
1592 for Vim XML omni completion.
1594 dtd2vim: http://www.vim.org/scripts/script.php?script_id=1462
1596 Check the beginning of that file for usage details.
1597 The script requires perl and:
1599 perlSGML: http://savannah.nongnu.org/projects/perlsgml
1602 Commands
1604 :XMLns {name} [{namespace}] *:XMLns*
1606 Vim has to know which data file should be used and with which namespace. For
1607 loading of the data file and connecting data with the proper namespace use
1608 |:XMLns| command. The first (obligatory) argument is the name of the data
1609 (xhtml10s, xsl). The second argument is the code of namespace (h, xsl). When
1610 used without a second argument the dialect will be used as default - without
1611 namespace declaration. For example to use XML completion in .xsl files: >
1613 :XMLns xhtml10s
1614 :XMLns xsl xsl
1617 :XMLent {name} *:XMLent*
1619 By default entities will be completed from the data file of the default
1620 namespace. The XMLent command should be used in case when there is no default
1621 namespace: >
1623 :XMLent xhtml10s
1625 Usage
1627 While used in this situation (after declarations from previous part, | is
1628 cursor position): >
1630 <|
1632 Will complete to an appropriate XHTML tag, and in this situation: >
1634 <xsl:|
1636 Will complete to an appropriate XSL tag.
1639 The script xmlcomplete.vim, provided through the |autoload| mechanism,
1640 has the xmlcomplete#GetLastOpenTag() function which can be used in XML files
1641 to get the name of the last open tag (b:unaryTagsStack has to be defined): >
1643 :echo xmlcomplete#GetLastOpenTag("b:unaryTagsStack")
1647 ==============================================================================
1648 8. Insert mode commands *inserting*
1650 The following commands can be used to insert new text into the buffer. They
1651 can all be undone and repeated with the "." command.
1653 *a*
1654 a Append text after the cursor [count] times. If the
1655 cursor is in the first column of an empty line Insert
1656 starts there. But not when 'virtualedit' is set!
1658 *A*
1659 A Append text at the end of the line [count] times.
1661 <insert> or *i* *insert* *<Insert>*
1662 i Insert text before the cursor [count] times.
1663 When using CTRL-O in Insert mode |i_CTRL-O| the count
1664 is not supported.
1666 *I*
1667 I Insert text before the first non-blank in the line
1668 [count] times.
1669 When the 'H' flag is present in 'cpoptions' and the
1670 line only contains blanks, insert start just before
1671 the last blank.
1673 *gI*
1674 gI Insert text in column 1 [count] times. {not in Vi}
1676 *gi*
1677 gi Insert text in the same position as where Insert mode
1678 was stopped last time in the current buffer.
1679 This uses the |'^| mark. It's different from "`^i"
1680 when the mark is past the end of the line.
1681 The position is corrected for inserted/deleted lines,
1682 but NOT for inserted/deleted characters.
1683 When the |:keepjumps| command modifier is used the |'^|
1684 mark won't be changed.
1685 {not in Vi}
1687 *o*
1688 o Begin a new line below the cursor and insert text,
1689 repeat [count] times. {Vi: blank [count] screen
1690 lines}
1691 When the '#' flag is in 'cpoptions' the count is
1692 ignored.
1694 *O*
1695 O Begin a new line above the cursor and insert text,
1696 repeat [count] times. {Vi: blank [count] screen
1697 lines}
1698 When the '#' flag is in 'cpoptions' the count is
1699 ignored.
1701 These commands are used to start inserting text. You can end insert mode with
1702 <Esc>. See |mode-ins-repl| for the other special characters in Insert mode.
1703 The effect of [count] takes place after Insert mode is exited.
1705 When 'autoindent' is on, the indent for a new line is obtained from the
1706 previous line. When 'smartindent' or 'cindent' is on, the indent for a line
1707 is automatically adjusted for C programs.
1709 'textwidth' can be set to the maximum width for a line. When a line becomes
1710 too long when appending characters a line break is automatically inserted.
1713 ==============================================================================
1714 9. Ex insert commands *inserting-ex*
1716 *:a* *:append*
1717 :{range}a[ppend][!] Insert several lines of text below the specified
1718 line. If the {range} is missing, the text will be
1719 inserted after the current line.
1720 Adding [!] toggles 'autoindent' for the time this
1721 command is executed.
1723 *:i* *:in* *:insert*
1724 :{range}i[nsert][!] Insert several lines of text above the specified
1725 line. If the {range} is missing, the text will be
1726 inserted before the current line.
1727 Adding [!] toggles 'autoindent' for the time this
1728 command is executed.
1730 These two commands will keep on asking for lines, until you type a line
1731 containing only a ".". Watch out for lines starting with a backslash, see
1732 |line-continuation|.
1734 NOTE: These commands cannot be used with |:global| or |:vglobal|.
1735 ":append" and ":insert" don't work properly in between ":if" and
1736 ":endif", ":for" and ":endfor", ":while" and ":endwhile".
1738 *:start* *:startinsert*
1739 :star[tinsert][!] Start Insert mode just after executing this command.
1740 Works like typing "i" in Normal mode. When the ! is
1741 included it works like "A", append to the line.
1742 Otherwise insertion starts at the cursor position.
1743 Note that when using this command in a function or
1744 script, the insertion only starts after the function
1745 or script is finished.
1746 This command does not work from |:normal|.
1747 {not in Vi}
1748 {not available when compiled without the +ex_extra
1749 feature}
1751 *:stopi* *:stopinsert*
1752 :stopi[nsert] Stop Insert mode as soon as possible. Works like
1753 typing <Esc> in Insert mode.
1754 Can be used in an autocommand, example: >
1755 :au BufEnter scratch stopinsert
1756 <
1757 *replacing-ex* *:startreplace*
1758 :startr[eplace][!] Start Replace mode just after executing this command.
1759 Works just like typing "R" in Normal mode. When the
1760 ! is included it acts just like "$R" had been typed
1761 (ie. begin replace mode at the end-of-line). Other-
1762 wise replacement begins at the cursor position.
1763 Note that when using this command in a function or
1764 script that the replacement will only start after
1765 the function or script is finished.
1766 {not in Vi}
1767 {not available when compiled without the +ex_extra
1768 feature}
1770 *:startgreplace*
1771 :startg[replace][!] Just like |:startreplace|, but use Virtual Replace
1772 mode, like with |gR|.
1773 {not in Vi}
1774 {not available when compiled without the +ex_extra
1775 feature}
1777 ==============================================================================
1778 10. Inserting a file *inserting-file*
1780 *:r* *:re* *:read*
1781 :r[ead] [++opt] [name]
1782 Insert the file [name] (default: current file) below
1783 the cursor.
1784 See |++opt| for the possible values of [++opt].
1786 :{range}r[ead] [++opt] [name]
1787 Insert the file [name] (default: current file) below
1788 the specified line.
1789 See |++opt| for the possible values of [++opt].
1791 *:r!* *:read!*
1792 :[range]r[ead] !{cmd} Execute {cmd} and insert its standard output below
1793 the cursor or the specified line. A temporary file is
1794 used to store the output of the command which is then
1795 read into the buffer. 'shellredir' is used to save
1796 the output of the command, which can be set to include
1797 stderr or not. {cmd} is executed like with ":!{cmd}",
1798 any '!' is replaced with the previous command |:!|.
1800 These commands insert the contents of a file, or the output of a command,
1801 into the buffer. They can be undone. They cannot be repeated with the "."
1802 command. They work on a line basis, insertion starts below the line in which
1803 the cursor is, or below the specified line. To insert text above the first
1804 line use the command ":0r {name}".
1806 After the ":read" command, the cursor is left on the first non-blank in the
1807 first new line. Unless in Ex mode, then the cursor is left on the last new
1808 line (sorry, this is Vi compatible).
1810 If a file name is given with ":r", it becomes the alternate file. This can be
1811 used, for example, when you want to edit that file instead: ":e! #". This can
1812 be switched off by removing the 'a' flag from the 'cpoptions' option.
1814 Of the [++opt] arguments one is specifically for ":read", the ++edit argument.
1815 This is useful when the ":read" command is actually used to read a file into
1816 the buffer as if editing that file. Use this command in an empty buffer: >
1817 :read ++edit filename
1818 The effect is that the 'fileformat', 'fileencoding', 'bomb', etc. options are
1819 set to what has been detected for "filename". Note that a single empty line
1820 remains, you may want to delete it.
1822 *file-read*
1823 The 'fileformat' option sets the <EOL> style for a file:
1824 'fileformat' characters name ~
1825 "dos" <CR><NL> or <NL> DOS format
1826 "unix" <NL> Unix format
1827 "mac" <CR> Mac format
1828 Previously 'textmode' was used. It is obsolete now.
1830 If 'fileformat' is "dos", a <CR> in front of an <NL> is ignored and a CTRL-Z
1831 at the end of the file is ignored.
1833 If 'fileformat' is "mac", a <NL> in the file is internally represented by a
1834 <CR>. This is to avoid confusion with a <NL> which is used to represent a
1835 <NUL>. See |CR-used-for-NL|.
1837 If the 'fileformats' option is not empty Vim tries to recognize the type of
1838 <EOL> (see |file-formats|). However, the 'fileformat' option will not be
1839 changed, the detected format is only used while reading the file.
1840 A similar thing happens with 'fileencodings'.
1842 On non-MS-DOS, Win32, and OS/2 systems the message "[dos format]" is shown if
1843 a file is read in DOS format, to remind you that something unusual is done.
1844 On Macintosh, MS-DOS, Win32, and OS/2 the message "[unix format]" is shown if
1845 a file is read in Unix format.
1846 On non-Macintosh systems, the message "[Mac format]" is shown if a file is
1847 read in Mac format.
1849 An example on how to use ":r !": >
1850 :r !uuencode binfile binfile
1851 This command reads "binfile", uuencodes it and reads it into the current
1852 buffer. Useful when you are editing e-mail and want to include a binary
1853 file.
1855 *read-messages*
1856 When reading a file Vim will display a message with information about the read
1857 file. In the table is an explanation for some of the items. The others are
1858 self explanatory. Using the long or the short version depends on the
1859 'shortmess' option.
1861 long short meaning ~
1862 [readonly] {RO} the file is write protected
1863 [fifo/socket] using a stream
1864 [fifo] using a fifo stream
1865 [socket] using a socket stream
1866 [CR missing] reading with "dos" 'fileformat' and a
1867 NL without a preceding CR was found.
1868 [NL found] reading with "mac" 'fileformat' and a
1869 NL was found (could be "unix" format)
1870 [long lines split] at least one line was split in two
1871 [NOT converted] conversion from 'fileencoding' to
1872 'encoding' was desired but not
1873 possible
1874 [converted] conversion from 'fileencoding' to
1875 'encoding' done
1876 [crypted] file was decrypted
1877 [READ ERRORS] not all of the file could be read
1880 vim:tw=78:ts=8:ft=help:norl: