| blob | 61360a4aa7e0be686e9d984b1a12e4af0b31382f |
1 *insert.txt* For Vim version 7.2. Last change: 2009 Jul 14
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 endfunction
643 inoremap <Tab> <C-R>=CleverTab()<CR>
647 Completing whole lines *compl-whole-line*
649 *i_CTRL-X_CTRL-L*
650 CTRL-X CTRL-L Search backwards for a line that starts with the
651 same characters as those in the current line before
652 the cursor. Indent is ignored. The matching line is
653 inserted in front of the cursor.
654 The 'complete' option is used to decide which buffers
655 are searched for a match. Both loaded and unloaded
656 buffers are used.
657 CTRL-L or
658 CTRL-P Search backwards for next matching line. This line
659 replaces the previous matching line.
661 CTRL-N Search forward for next matching line. This line
662 replaces the previous matching line.
664 CTRL-X CTRL-L After expanding a line you can additionally get the
665 line next to it by typing CTRL-X CTRL-L again, unless
666 a double CTRL-X is used. Only works for loaded
667 buffers.
669 Completing keywords in current file *compl-current*
671 *i_CTRL-X_CTRL-P*
672 *i_CTRL-X_CTRL-N*
673 CTRL-X CTRL-N Search forwards for words that start with the keyword
674 in front of the cursor. The found keyword is inserted
675 in front of the cursor.
677 CTRL-X CTRL-P Search backwards for words that start with the keyword
678 in front of the cursor. The found keyword is inserted
679 in front of the cursor.
681 CTRL-N Search forward for next matching keyword. This
682 keyword replaces the previous matching keyword.
684 CTRL-P Search backwards for next matching keyword. This
685 keyword replaces the previous matching keyword.
687 CTRL-X CTRL-N or
688 CTRL-X CTRL-P Further use of CTRL-X CTRL-N or CTRL-X CTRL-P will
689 copy the words following the previous expansion in
690 other contexts unless a double CTRL-X is used.
692 If there is a keyword in front of the cursor (a name made out of alphabetic
693 characters and characters in 'iskeyword'), it is used as the search pattern,
694 with "\<" prepended (meaning: start of a word). Otherwise "\<\k\k" is used
695 as search pattern (start of any keyword of at least two characters).
697 In Replace mode, the number of characters that are replaced depends on the
698 length of the matched string. This works like typing the characters of the
699 matched string in Replace mode.
701 If there is not a valid keyword character before the cursor, any keyword of
702 at least two characters is matched.
703 e.g., to get:
704 printf("(%g, %g, %g)", vector[0], vector[1], vector[2]);
705 just type:
706 printf("(%g, %g, %g)", vector[0], ^P[1], ^P[2]);
708 The search wraps around the end of the file, the value of 'wrapscan' is not
709 used here.
711 Multiple repeats of the same completion are skipped; thus a different match
712 will be inserted at each CTRL-N and CTRL-P (unless there is only one
713 matching keyword).
715 Single character matches are never included, as they usually just get in
716 the way of what you were really after.
717 e.g., to get:
718 printf("name = %s\n", name);
719 just type:
720 printf("name = %s\n", n^P);
721 or even:
722 printf("name = %s\n", ^P);
723 The 'n' in '\n' is skipped.
725 After expanding a word, you can use CTRL-X CTRL-P or CTRL-X CTRL-N to get the
726 word following the expansion in other contexts. These sequences search for
727 the text just expanded and further expand by getting an extra word. This is
728 useful if you need to repeat a sequence of complicated words. Although CTRL-P
729 and CTRL-N look just for strings of at least two characters, CTRL-X CTRL-P and
730 CTRL-X CTRL-N can be used to expand words of just one character.
731 e.g., to get:
732 México
733 you can type:
734 M^N^P^X^P^X^P
735 CTRL-N starts the expansion and then CTRL-P takes back the single character
736 "M", the next two CTRL-X CTRL-P's get the words "é" and ";xico".
738 If the previous expansion was split, because it got longer than 'textwidth',
739 then just the text in the current line will be used.
741 If the match found is at the end of a line, then the first word in the next
742 line will be inserted and the message "word from next line" displayed, if
743 this word is accepted the next CTRL-X CTRL-P or CTRL-X CTRL-N will search
744 for those lines starting with this word.
747 Completing keywords in 'dictionary' *compl-dictionary*
749 *i_CTRL-X_CTRL-K*
750 CTRL-X CTRL-K Search the files given with the 'dictionary' option
751 for words that start with the keyword in front of the
752 cursor. This is like CTRL-N, but only the dictionary
753 files are searched, not the current file. The found
754 keyword is inserted in front of the cursor. This
755 could potentially be pretty slow, since all matches
756 are found before the first match is used. By default,
757 the 'dictionary' option is empty.
758 For suggestions where to find a list of words, see the
759 'dictionary' option.
761 CTRL-K or
762 CTRL-N Search forward for next matching keyword. This
763 keyword replaces the previous matching keyword.
765 CTRL-P Search backwards for next matching keyword. This
766 keyword replaces the previous matching keyword.
768 *i_CTRL-X_CTRL-T*
769 CTRL-X CTRL-T Works as CTRL-X CTRL-K, but in a special way. It uses
770 the 'thesaurus' option instead of 'dictionary'. If a
771 match is found in the thesaurus file, all the
772 remaining words on the same line are included as
773 matches, even though they don't complete the word.
774 Thus a word can be completely replaced.
776 For an example, imagine the 'thesaurus' file has a
777 line like this: >
778 angry furious mad enraged
779 < Placing the cursor after the letters "ang" and typing
780 CTRL-X CTRL-T would complete the word "angry";
781 subsequent presses would change the word to "furious",
782 "mad" etc.
783 Other uses include translation between two languages,
784 or grouping API functions by keyword.
786 CTRL-T or
787 CTRL-N Search forward for next matching keyword. This
788 keyword replaces the previous matching keyword.
790 CTRL-P Search backwards for next matching keyword. This
791 keyword replaces the previous matching keyword.
794 Completing keywords in the current and included files *compl-keyword*
796 The 'include' option is used to specify a line that contains an include file
797 name. The 'path' option is used to search for include files.
799 *i_CTRL-X_CTRL-I*
800 CTRL-X CTRL-I Search for the first keyword in the current and
801 included files that starts with the same characters
802 as those before the cursor. The matched keyword is
803 inserted in front of the cursor.
805 CTRL-N Search forwards for next matching keyword. This
806 keyword replaces the previous matching keyword.
807 Note: CTRL-I is the same as <Tab>, which is likely to
808 be typed after a successful completion, therefore
809 CTRL-I is not used for searching for the next match.
811 CTRL-P Search backward for previous matching keyword. This
812 keyword replaces the previous matching keyword.
814 CTRL-X CTRL-I Further use of CTRL-X CTRL-I will copy the words
815 following the previous expansion in other contexts
816 unless a double CTRL-X is used.
818 Completing tags *compl-tag*
819 *i_CTRL-X_CTRL-]*
820 CTRL-X CTRL-] Search for the first tag that starts with the same
821 characters as before the cursor. The matching tag is
822 inserted in front of the cursor. Alphabetic
823 characters and characters in 'iskeyword' are used
824 to decide which characters are included in the tag
825 name (same as for a keyword). See also |CTRL-]|.
826 The 'showfulltag' option can be used to add context
827 from around the tag definition.
828 CTRL-] or
829 CTRL-N Search forwards for next matching tag. This tag
830 replaces the previous matching tag.
832 CTRL-P Search backward for previous matching tag. This tag
833 replaces the previous matching tag.
836 Completing file names *compl-filename*
837 *i_CTRL-X_CTRL-F*
838 CTRL-X CTRL-F Search for the first file name that starts with the
839 same characters as before the cursor. The matching
840 file name is inserted in front of the cursor.
841 Alphabetic characters and characters in 'isfname'
842 are used to decide which characters are included in
843 the file name. Note: the 'path' option is not used
844 here (yet).
845 CTRL-F or
846 CTRL-N Search forwards for next matching file name. This
847 file name replaces the previous matching file name.
849 CTRL-P Search backward for previous matching file name.
850 This file name replaces the previous matching file
851 name.
854 Completing definitions or macros *compl-define*
856 The 'define' option is used to specify a line that contains a definition.
857 The 'include' option is used to specify a line that contains an include file
858 name. The 'path' option is used to search for include files.
860 *i_CTRL-X_CTRL-D*
861 CTRL-X CTRL-D Search in the current and included files for the
862 first definition (or macro) name that starts with
863 the same characters as before the cursor. The found
864 definition name is inserted in front of the cursor.
865 CTRL-D or
866 CTRL-N Search forwards for next matching macro name. This
867 macro name replaces the previous matching macro
868 name.
870 CTRL-P Search backward for previous matching macro name.
871 This macro name replaces the previous matching macro
872 name.
874 CTRL-X CTRL-D Further use of CTRL-X CTRL-D will copy the words
875 following the previous expansion in other contexts
876 unless a double CTRL-X is used.
879 Completing Vim commands *compl-vim*
881 Completion is context-sensitive. It works like on the Command-line. It
882 completes an Ex command as well as its arguments. This is useful when writing
883 a Vim script.
885 *i_CTRL-X_CTRL-V*
886 CTRL-X CTRL-V Guess what kind of item is in front of the cursor and
887 find the first match for it.
888 Note: When CTRL-V is mapped you can often use CTRL-Q
889 instead of |i_CTRL-Q|.
890 CTRL-V or
891 CTRL-N Search forwards for next match. This match replaces
892 the previous one.
894 CTRL-P Search backwards for previous match. This match
895 replaces the previous one.
897 CTRL-X CTRL-V Further use of CTRL-X CTRL-V will do the same as
898 CTRL-V. This allows mapping a key to do Vim command
899 completion, for example: >
900 :imap <Tab> <C-X><C-V>
902 User defined completion *compl-function*
904 Completion is done by a function that can be defined by the user with the
905 'completefunc' option. See below for how the function is called and an
906 example |complete-functions|.
908 *i_CTRL-X_CTRL-U*
909 CTRL-X CTRL-U Guess what kind of item is in front of the cursor and
910 find the first match for it.
911 CTRL-U or
912 CTRL-N Use the next match. This match replaces the previous
913 one.
915 CTRL-P Use the previous match. This match replaces the
916 previous one.
919 Omni completion *compl-omni*
921 Completion is done by a function that can be defined by the user with the
922 'omnifunc' option. This is to be used for filetype-specific completion.
924 See below for how the function is called and an example |complete-functions|.
925 For remarks about specific filetypes see |compl-omni-filetypes|.
926 More completion scripts will appear, check www.vim.org. Currently there is a
927 first version for C++.
929 *i_CTRL-X_CTRL-O*
930 CTRL-X CTRL-O Guess what kind of item is in front of the cursor and
931 find the first match for it.
932 CTRL-O or
933 CTRL-N Use the next match. This match replaces the previous
934 one.
936 CTRL-P Use the previous match. This match replaces the
937 previous one.
940 Spelling suggestions *compl-spelling*
942 A word before or at the cursor is located and correctly spelled words are
943 suggested to replace it. If there is a badly spelled word in the line, before
944 or under the cursor, the cursor is moved to after it. Otherwise the word just
945 before the cursor is used for suggestions, even though it isn't badly spelled.
947 NOTE: CTRL-S suspends display in many Unix terminals. Use 's' instead. Type
948 CTRL-Q to resume displaying.
950 *i_CTRL-X_CTRL-S* *i_CTRL-X_s*
951 CTRL-X CTRL-S or
952 CTRL-X s Locate the word in front of the cursor and find the
953 first spell suggestion for it.
954 CTRL-S or
955 CTRL-N Use the next suggestion. This replaces the previous
956 one. Note that you can't use 's' here.
958 CTRL-P Use the previous suggestion. This replaces the
959 previous one.
962 Completing keywords from different sources *compl-generic*
964 *i_CTRL-N*
965 CTRL-N Find next match for words that start with the
966 keyword in front of the cursor, looking in places
967 specified with the 'complete' option. The found
968 keyword is inserted in front of the cursor.
970 *i_CTRL-P*
971 CTRL-P Find previous match for words that start with the
972 keyword in front of the cursor, looking in places
973 specified with the 'complete' option. The found
974 keyword is inserted in front of the cursor.
976 CTRL-N Search forward for next matching keyword. This
977 keyword replaces the previous matching keyword.
979 CTRL-P Search backwards for next matching keyword. This
980 keyword replaces the previous matching keyword.
982 CTRL-X CTRL-N or
983 CTRL-X CTRL-P Further use of CTRL-X CTRL-N or CTRL-X CTRL-P will
984 copy the words following the previous expansion in
985 other contexts unless a double CTRL-X is used.
988 FUNCTIONS FOR FINDING COMPLETIONS *complete-functions*
990 This applies to 'completefunc' and 'omnifunc'.
992 The function is called in two different ways:
993 - First the function is called to find the start of the text to be completed.
994 - Later the function is called to actually find the matches.
996 On the first invocation the arguments are:
997 a:findstart 1
998 a:base empty
1000 The function must return the column where the completion starts. It must be a
1001 number between zero and the cursor column "col('.')". This involves looking
1002 at the characters just before the cursor and including those characters that
1003 could be part of the completed item. The text between this column and the
1004 cursor column will be replaced with the matches. Return -1 if no completion
1005 can be done.
1007 On the second invocation the arguments are:
1008 a:findstart 0
1009 a:base the text with which matches should match; the text that was
1010 located in the first call (can be empty)
1012 The function must return a List with the matching words. These matches
1013 usually include the "a:base" text. When there are no matches return an empty
1014 List.
1015 *complete-items*
1016 Each list item can either be a string or a Dictionary. When it is a string it
1017 is used as the completion. When it is a Dictionary it can contain these
1018 items:
1019 word the text that will be inserted, mandatory
1020 abbr abbreviation of "word"; when not empty it is used in
1021 the menu instead of "word"
1022 menu extra text for the popup menu, displayed after "word"
1023 or "abbr"
1024 info more information about the item, can be displayed in a
1025 preview window
1026 kind single letter indicating the type of completion
1027 icase when non-zero case is to be ignored when comparing
1028 items to be equal; when omitted zero is used, thus
1029 items that only differ in case are added
1030 dup when non-zero this match will be added even when an
1031 item with the same word is already present.
1033 All of these except 'icase' must be a string. If an item does not meet these
1034 requirements then an error message is given and further items in the list are
1035 not used. You can mix string and Dictionary items in the returned list.
1037 The "menu" item is used in the popup menu and may be truncated, thus it should
1038 be relatively short. The "info" item can be longer, it will be displayed in
1039 the preview window when "preview" appears in 'completeopt'. The "info" item
1040 will also remain displayed after the popup menu has been removed. This is
1041 useful for function arguments. Use a single space for "info" to remove
1042 existing text in the preview window.
1044 The "kind" item uses a single letter to indicate the kind of completion. This
1045 may be used to show the completion differently (different color or icon).
1046 Currently these types can be used:
1047 v variable
1048 f function or method
1049 m member of a struct or class
1050 t typedef
1051 d #define or macro
1053 When searching for matches takes some time call |complete_add()| to add each
1054 match to the total list. These matches should then not appear in the returned
1055 list! Call |complete_check()| now and then to allow the user to press a key
1056 while still searching for matches. Stop searching when it returns non-zero.
1058 The function is allowed to move the cursor, it is restored afterwards. This
1059 option cannot be set from a |modeline| or in the |sandbox|, for security
1060 reasons.
1062 An example that completes the names of the months: >
1063 fun! CompleteMonths(findstart, base)
1064 if a:findstart
1065 " locate the start of the word
1066 let line = getline('.')
1067 let start = col('.') - 1
1068 while start > 0 && line[start - 1] =~ '\a'
1069 let start -= 1
1070 endwhile
1071 return start
1072 else
1073 " find months matching with "a:base"
1074 let res = []
1075 for m in split("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec")
1076 if m =~ '^' . a:base
1077 call add(res, m)
1078 endif
1079 endfor
1080 return res
1081 endif
1082 endfun
1083 set completefunc=CompleteMonths
1084 <
1085 The same, but now pretending searching for matches is slow: >
1086 fun! CompleteMonths(findstart, base)
1087 if a:findstart
1088 " locate the start of the word
1089 let line = getline('.')
1090 let start = col('.') - 1
1091 while start > 0 && line[start - 1] =~ '\a'
1092 let start -= 1
1093 endwhile
1094 return start
1095 else
1096 " find months matching with "a:base"
1097 for m in split("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec")
1098 if m =~ '^' . a:base
1099 call complete_add(m)
1100 endif
1101 sleep 300m " simulate searching for next match
1102 if complete_check()
1103 break
1104 endif
1105 endfor
1106 return []
1107 endif
1108 endfun
1109 set completefunc=CompleteMonths
1110 <
1112 INSERT COMPLETION POPUP MENU *ins-completion-menu*
1113 *popupmenu-completion*
1114 Vim can display the matches in a simplistic popup menu.
1116 The menu is used when:
1117 - The 'completeopt' option contains "menu" or "menuone".
1118 - The terminal supports at least 8 colors.
1119 - There are at least two matches. One if "menuone" is used.
1121 The 'pumheight' option can be used to set a maximum height. The default is to
1122 use all space available.
1124 There are three states:
1125 1. A complete match has been inserted, e.g., after using CTRL-N or CTRL-P.
1126 2. A cursor key has been used to select another match. The match was not
1127 inserted then, only the entry in the popup menu is highlighted.
1128 3. Only part of a match has been inserted and characters were typed or the
1129 backspace key was used. The list of matches was then adjusted for what is
1130 in front of the cursor.
1132 You normally start in the first state, with the first match being inserted.
1133 When "longest" is in 'completeopt' and there is more than one match you start
1134 in the third state.
1136 If you select another match, e.g., with CTRL-N or CTRL-P, you go to the first
1137 state. This doesn't change the list of matches.
1139 When you are back at the original text then you are in the third state. To
1140 get there right away you can use a mapping that uses CTRL-P right after
1141 starting the completion: >
1142 :imap <F7> <C-N><C-P>
1143 <
1144 *popupmenu-keys*
1145 In the first state these keys have a special meaning:
1146 <BS> and CTRL-H Delete one character, find the matches for the word before
1147 the cursor. This reduces the list of matches, often to one
1148 entry, and switches to the second state.
1149 Any non-special character:
1150 Stop completion without changing the match and insert the
1151 typed character.
1153 In the second and third state these keys have a special meaning:
1154 <BS> and CTRL-H Delete one character, find the matches for the shorter word
1155 before the cursor. This may find more matches.
1156 CTRL-L Add one character from the current match, may reduce the
1157 number of matches.
1158 any printable, non-white character:
1159 Add this character and reduce the number of matches.
1161 In all three states these can be used:
1162 CTRL-Y Yes: Accept the currently selected match and stop completion.
1163 CTRL-E End completion, go back to what was there before selecting a
1164 match (what was typed or longest common string).
1165 <PageUp> Select a match several entries back, but don't insert it.
1166 <PageDown> Select a match several entries further, but don't insert it.
1167 <Up> Select the previous match, as if CTRL-P was used, but don't
1168 insert it.
1169 <Down> Select the next match, as if CTRL-N was used, but don't
1170 insert it.
1171 <Space> or <Tab> Stop completion without changing the match and insert the
1172 typed character.
1174 The behavior of the <Enter> key depends on the state you are in:
1175 first state: Use the text as it is and insert a line break.
1176 second state: Insert the currently selected match.
1177 third state: Use the text as it is and insert a line break.
1179 In other words: If you used the cursor keys to select another entry in the
1180 list of matches then the <Enter> key inserts that match. If you typed
1181 something else then <Enter> inserts a line break.
1184 The colors of the menu can be changed with these highlight groups:
1185 Pmenu normal item |hl-Pmenu|
1186 PmenuSel selected item |hl-PmenuSel|
1187 PmenuSbar scrollbar |hl-PmenuSbar|
1188 PmenuThumb thumb of the scrollbar |hl-PmenuThumb|
1190 There are no special mappings for when the popup menu is visible. However,
1191 you can use an Insert mode mapping that checks the |pumvisible()| function to
1192 do something different. Example: >
1193 :inoremap <Down> <C-R>=pumvisible() ? "\<lt>C-N>" : "\<lt>Down>"<CR>
1195 You can use of <expr> in mapping to have the popup menu used when typing a
1196 character and some condition is met. For example, for typing a dot: >
1197 inoremap <expr> . MayComplete()
1198 func MayComplete()
1199 if (can complete)
1200 return ".\<C-X>\<C-O>"
1201 endif
1202 return '.'
1203 endfunc
1205 See |:map-<expr>| for more info.
1208 FILETYPE-SPECIFIC REMARKS FOR OMNI COMPLETION *compl-omni-filetypes*
1210 The file used for {filetype} should be autoload/{filetype}complete.vim
1211 in 'runtimepath'. Thus for "java" it is autoload/javacomplete.vim.
1214 C *ft-c-omni*
1216 Completion of C code requires a tags file. You should use Exuberant ctags,
1217 because it adds extra information that is needed for completion. You can find
1218 it here: http://ctags.sourceforge.net/ Version 5.6 or later is recommended.
1220 For version 5.5.4 you should add a patch that adds the "typename:" field:
1221 ftp://ftp.vim.org/pub/vim/unstable/patches/ctags-5.5.4.patch
1222 A compiled .exe for MS-Windows can be found at:
1223 http://georgevreilly.com/vim/ctags.html
1225 If you want to complete system functions you can do something like this. Use
1226 ctags to generate a tags file for all the system header files: >
1227 % ctags -R -f ~/.vim/systags /usr/include /usr/local/include
1228 In your vimrc file add this tags file to the 'tags' option: >
1229 set tags+=~/.vim/systags
1231 When using CTRL-X CTRL-O after a name without any "." or "->" it is completed
1232 from the tags file directly. This works for any identifier, also function
1233 names. If you want to complete a local variable name, which does not appear
1234 in the tags file, use CTRL-P instead.
1236 When using CTRL-X CTRL-O after something that has "." or "->" Vim will attempt
1237 to recognize the type of the variable and figure out what members it has.
1238 This means only members valid for the variable will be listed.
1240 When a member name already was complete, CTRL-X CTRL-O will add a "." or
1241 "->" for composite types.
1243 Vim doesn't include a C compiler, only the most obviously formatted
1244 declarations are recognized. Preprocessor stuff may cause confusion.
1245 When the same structure name appears in multiple places all possible members
1246 are included.
1249 CSS *ft-css-omni*
1251 Complete properties and their appropriate values according to CSS 2.1
1252 specification.
1255 HTML *ft-html-omni*
1256 XHTML *ft-xhtml-omni*
1258 CTRL-X CTRL-O provides completion of various elements of (X)HTML files. It is
1259 designed to support writing of XHTML 1.0 Strict files but will also works for
1260 other versions of HTML. Features:
1262 - after "<" complete tag name depending on context (no div suggestion inside
1263 of an a tag); '/>' indicates empty tags
1264 - inside of tag complete proper attributes (no width attribute for an a tag);
1265 show also type of attribute; '*' indicates required attributes
1266 - when attribute has limited number of possible values help to complete them
1267 - complete names of entities
1268 - complete values of "class" and "id" attributes with data obtained from
1269 <style> tag and included CSS files
1270 - when completing value of "style" attribute or working inside of "style" tag
1271 switch to |ft-css-omni| completion
1272 - when completing values of events attributes or working inside of "script"
1273 tag switch to |ft-javascript-omni| completion
1274 - when used after "</" CTRL-X CTRL-O will close the last opened tag
1276 Note: When used first time completion menu will be shown with little delay
1277 - this is time needed for loading of data file.
1278 Note: Completion may fail in badly formatted documents. In such case try to
1279 run |:make| command to detect formatting problems.
1282 HTML flavor *html-flavor*
1284 The default HTML completion depends on the filetype. For HTML files it is
1285 HTML 4.01 Transitional ('filetype' is "html"), for XHTML it is XHTML 1.0
1286 Strict ('filetype' is "xhtml").
1288 When doing completion outside of any other tag you will have possibility to
1289 choose DOCTYPE and the appropriate data file will be loaded and used for all
1290 next completions.
1292 More about format of data file in |xml-omni-datafile|. Some of the data files
1293 may be found on the Vim website (|www|).
1295 Note that b:html_omni_flavor may point to a file with any XML data. This
1296 makes possible to mix PHP (|ft-php-omni|) completion with any XML dialect
1297 (assuming you have data file for it). Without setting that variable XHTML 1.0
1298 Strict will be used.
1301 JAVASCRIPT *ft-javascript-omni*
1303 Completion of most elements of JavaScript language and DOM elements.
1305 Complete:
1307 - variables
1308 - function name; show function arguments
1309 - function arguments
1310 - properties of variables trying to detect type of variable
1311 - complete DOM objects and properties depending on context
1312 - keywords of language
1314 Completion works in separate JavaScript files (&ft==javascript), inside of
1315 <script> tag of (X)HTML and in values of event attributes (including scanning
1316 of external files.
1318 DOM compatibility
1320 At the moment (beginning of 2006) there are two main browsers - MS Internet
1321 Explorer and Mozilla Firefox. These two applications are covering over 90% of
1322 market. Theoretically standards are created by W3C organisation
1323 (http://www.w3c.org) but they are not always followed/implemented.
1325 IE FF W3C Omni completion ~
1326 +/- +/- + + ~
1327 + + - + ~
1328 + - - - ~
1329 - + - - ~
1331 Regardless from state of implementation in browsers but if element is defined
1332 in standards, completion plugin will place element in suggestion list. When
1333 both major engines implemented element, even if this is not in standards it
1334 will be suggested. All other elements are not placed in suggestion list.
1337 PHP *ft-php-omni*
1339 Completion of PHP code requires a tags file for completion of data from
1340 external files and for class aware completion. You should use Exuberant ctags
1341 version 5.5.4 or newer. You can find it here: http://ctags.sourceforge.net/
1343 Script completes:
1345 - after $ variables name
1346 - if variable was declared as object add "->", if tags file is available show
1347 name of class
1348 - after "->" complete only function and variable names specific for given
1349 class. To find class location and contents tags file is required. Because
1350 PHP isn't strongly typed language user can use @var tag to declare class: >
1352 /* @var $myVar myClass */
1353 $myVar->
1354 <
1355 Still, to find myClass contents tags file is required.
1357 - function names with additional info:
1358 - in case of built-in functions list of possible arguments and after | type
1359 data returned by function
1360 - in case of user function arguments and name of file were function was
1361 defined (if it is not current file)
1363 - constants names
1364 - class names after "new" declaration
1367 Note: when doing completion first time Vim will load all necessary data into
1368 memory. It may take several seconds. After next use of completion delay
1369 should not be noticeable.
1371 Script detects if cursor is inside <?php ?> tags. If it is outside it will
1372 automatically switch to HTML/CSS/JavaScript completion. Note: contrary to
1373 original HTML files completion of tags (and only tags) isn't context aware.
1376 RUBY *ft-ruby-omni*
1378 Completion of Ruby code requires that vim be built with |+ruby|.
1380 Ruby completion will parse your buffer on demand in order to provide a list of
1381 completions. These completions will be drawn from modules loaded by 'require'
1382 and modules defined in the current buffer.
1384 The completions provided by CTRL-X CTRL-O are sensitive to the context:
1386 CONTEXT COMPLETIONS PROVIDED ~
1388 1. Not inside a class definition Classes, constants and globals
1390 2. Inside a class definition Methods or constants defined in the class
1392 3. After '.', '::' or ':' Methods applicable to the object being
1393 dereferenced
1395 4. After ':' or ':foo' Symbol name (beginning with 'foo')
1397 Notes:
1398 - Vim will load/evaluate code in order to provide completions. This may
1399 cause some code execution, which may be a concern. This is no longer
1400 enabled by default, to enable this feature add >
1401 let g:rubycomplete_buffer_loading = 1
1402 <- In context 1 above, Vim can parse the entire buffer to add a list of
1403 classes to the completion results. This feature is turned off by default,
1404 to enable it add >
1405 let g:rubycomplete_classes_in_global = 1
1406 < to your vimrc
1407 - In context 2 above, anonymous classes are not supported.
1408 - In context 3 above, Vim will attempt to determine the methods supported by
1409 the object.
1410 - Vim can detect and load the Rails environment for files within a rails
1411 project. The feature is disabled by default, to enable it add >
1412 let g:rubycomplete_rails = 1
1413 < to your vimrc
1416 SYNTAX *ft-syntax-omni*
1418 Vim has the ability to color syntax highlight nearly 500 languages. Part of
1419 this highlighting includes knowing what keywords are part of a language. Many
1420 filetypes already have custom completion scripts written for them, the
1421 syntaxcomplete plugin provides basic completion for all other filetypes. It
1422 does this by populating the omni completion list with the text Vim already
1423 knows how to color highlight. It can be used for any filetype and provides a
1424 minimal language-sensitive completion.
1426 To enable syntax code completion you can run: >
1427 setlocal omnifunc=syntaxcomplete#Complete
1429 You can automate this by placing the following in your vimrc (after any
1430 ":filetype" command): >
1431 if has("autocmd") && exists("+omnifunc")
1432 autocmd Filetype *
1433 \ if &omnifunc == "" |
1434 \ setlocal omnifunc=syntaxcomplete#Complete |
1435 \ endif
1436 endif
1438 The above will set completion to this script only if a specific plugin does
1439 not already exist for that filetype.
1441 Each filetype can have a wide range of syntax items. The plugin allows you to
1442 customize which syntax groups to include or exclude from the list. Let's have
1443 a look at the PHP filetype to see how this works.
1445 If you edit a file called, index.php, run the following command: >
1446 :syntax list
1448 First thing you will notice is there are many different syntax groups. The
1449 PHP language can include elements from different languages like HTML,
1450 JavaScript and many more. The syntax plugin will only include syntax groups
1451 that begin with the filetype, "php", in this case. For example these syntax
1452 groups are included by default with the PHP: phpEnvVar, phpIntVar,
1453 phpFunctions.
1455 The PHP language has an enormous number of items which it knows how to syntax
1456 highlight. This means these items will be available within the omni
1457 completion list. Some people may find this list unwieldy or are only
1458 interested in certain items.
1460 There are two ways to prune this list (if necessary). If you find certain
1461 syntax groups you do not wish displayed you can add the following to your
1462 vimrc: >
1463 let g:omni_syntax_group_exclude_php = 'phpCoreConstant,phpConstant'
1465 Add as many syntax groups to this list by comma separating them. The basic
1466 form of this variable is: >
1467 let g:omni_syntax_group_exclude_{filetype} = 'comma,separated,list'
1469 For completeness the opposite is also true. Creating this variable in your
1470 vimrc will only include the items in the phpFunctions and phpMethods syntax
1471 groups: >
1472 let g:omni_syntax_group_include_php = 'phpFunctions,phpMethods'
1474 You can create as many of these variables as you need, varying only the
1475 filetype at the end of the variable name.
1477 The plugin uses the isKeyword option to determine where word boundaries are
1478 for the syntax items. For example, in the Scheme language completion should
1479 include the "-", call-with-output-file. Depending on your filetype, this may
1480 not provide the words you are expecting. Setting the
1481 g:omni_syntax_use_iskeyword option to 0 will force the syntax plugin to break
1482 on word characters. This can be controlled adding the following to your
1483 vimrc: >
1484 let g:omni_syntax_use_iskeyword = 0
1487 SQL *ft-sql-omni*
1489 Completion for the SQL language includes statements, functions, keywords.
1490 It will also dynamically complete tables, procedures, views and column lists
1491 with data pulled directly from within a database. For detailed instructions
1492 and a tutorial see |omni-sql-completion|.
1494 The SQL completion plugin can be used in conjunction with other completion
1495 plugins. For example, the PHP filetype has its own completion plugin.
1496 Since PHP is often used to generate dynamic website by accessing a database,
1497 the SQL completion plugin can also be enabled. This allows you to complete
1498 PHP code and SQL code at the same time.
1501 XML *ft-xml-omni*
1503 Vim 7 provides a mechanism for context aware completion of XML files. It
1504 depends on a special |xml-omni-datafile| and two commands: |:XMLns| and
1505 |:XMLent|. Features are:
1507 - after "<" complete the tag name, depending on context
1508 - inside of a tag complete proper attributes
1509 - when an attribute has a limited number of possible values help to complete
1510 them
1511 - complete names of entities (defined in |xml-omni-datafile| and in the
1512 current file with "<!ENTITY" declarations)
1513 - when used after "</" CTRL-X CTRL-O will close the last opened tag
1515 Format of XML data file *xml-omni-datafile*
1517 XML data files are stored in the "autoload/xml" directory in 'runtimepath'.
1518 Vim distribution provides examples of data files in the
1519 "$VIMRUNTIME/autoload/xml" directory. They have a meaningful name which will
1520 be used in commands. It should be a unique name which will not create
1521 conflicts. For example, the name xhtml10s.vim means it is the data file for
1522 XHTML 1.0 Strict.
1524 Each file contains a variable with a name like g:xmldata_xhtml10s . It is
1525 a compound from two parts:
1527 1. "g:xmldata_" general prefix, constant for all data files
1528 2. "xhtml10s" the name of the file and the name of the described XML
1529 dialect; it will be used as an argument for the |:XMLns|
1530 command
1532 Part two must be exactly the same as name of file.
1534 The variable is a |Dictionary|. Keys are tag names and each value is a two
1535 element |List|. The first element of the List is also a List with the names
1536 of possible children. The second element is a |Dictionary| with the names of
1537 attributes as keys and the possible values of attributes as values. Example: >
1539 let g:xmldata_crippled = {
1540 \ "vimxmlentities": ["amp", "lt", "gt", "apos", "quot"],
1541 \ 'vimxmlroot': ['tag1'],
1542 \ 'tag1':
1543 \ [ ['childoftag1a', 'childoftag1b'], {'attroftag1a': [],
1544 \ 'attroftag1b': ['valueofattr1', 'valueofattr2']}],
1545 \ 'childoftag1a':
1546 \ [ [], {'attrofchild': ['attrofchild']}],
1547 \ 'childoftag1b':
1548 \ [ ['childoftag1a'], {'attrofchild': []}],
1549 \ "vimxmltaginfo": {
1550 \ 'tag1': ['Menu info', 'Long information visible in preview window']},
1551 \ 'vimxmlattrinfo': {
1552 \ 'attrofchild': ['Menu info', 'Long information visible in preview window']}}
1554 This example would be put in the "autoload/xml/crippled.vim" file and could
1555 help to write this file: >
1557 <tag1 attroftag1b="valueofattr1">
1558 <childoftag1a attrofchild>
1559 & <
1560 </childoftag1a>
1561 <childoftag1b attrofchild="5">
1562 <childoftag1a>
1563 > ' "
1564 </childoftag1a>
1565 </childoftag1b>
1566 </tag1>
1568 In the example four special elements are visible:
1570 1. "vimxmlentities" - a special key with List containing entities of this XML
1571 dialect.
1572 2. If the list containing possible values of attributes has one element and
1573 this element is equal to the name of the attribute this attribute will be
1574 treated as boolean and inserted as 'attrname' and not as 'attrname="'
1575 3. "vimxmltaginfo" - a special key with a Dictionary containing tag
1576 names as keys and two element List as values, for additional menu info and
1577 the long description.
1578 4. "vimxmlattrinfo" - special key with Dictionary containing attribute names
1579 as keys and two element List as values, for additional menu info and long
1580 description.
1582 Note: Tag names in the data file MUST not contain a namespace description.
1583 Check xsl.vim for an example.
1584 Note: All data and functions are publicly available as global
1585 variables/functions and can be used for personal editing functions.
1588 DTD -> Vim *dtd2vim*
1590 On |www| is the script |dtd2vim| which parses DTD and creates an XML data file
1591 for Vim XML omni completion.
1593 dtd2vim: http://www.vim.org/scripts/script.php?script_id=1462
1595 Check the beginning of that file for usage details.
1596 The script requires perl and:
1598 perlSGML: http://savannah.nongnu.org/projects/perlsgml
1601 Commands
1603 :XMLns {name} [{namespace}] *:XMLns*
1605 Vim has to know which data file should be used and with which namespace. For
1606 loading of the data file and connecting data with the proper namespace use
1607 |:XMLns| command. The first (obligatory) argument is the name of the data
1608 (xhtml10s, xsl). The second argument is the code of namespace (h, xsl). When
1609 used without a second argument the dialect will be used as default - without
1610 namespace declaration. For example to use XML completion in .xsl files: >
1612 :XMLns xhtml10s
1613 :XMLns xsl xsl
1616 :XMLent {name} *:XMLent*
1618 By default entities will be completed from the data file of the default
1619 namespace. The XMLent command should be used in case when there is no default
1620 namespace: >
1622 :XMLent xhtml10s
1624 Usage
1626 While used in this situation (after declarations from previous part, | is
1627 cursor position): >
1629 <|
1631 Will complete to an appropriate XHTML tag, and in this situation: >
1633 <xsl:|
1635 Will complete to an appropriate XSL tag.
1638 The script xmlcomplete.vim, provided through the |autoload| mechanism,
1639 has the xmlcomplete#GetLastOpenTag() function which can be used in XML files
1640 to get the name of the last open tag (b:unaryTagsStack has to be defined): >
1642 :echo xmlcomplete#GetLastOpenTag("b:unaryTagsStack")
1646 ==============================================================================
1647 8. Insert mode commands *inserting*
1649 The following commands can be used to insert new text into the buffer. They
1650 can all be undone and repeated with the "." command.
1652 *a*
1653 a Append text after the cursor [count] times. If the
1654 cursor is in the first column of an empty line Insert
1655 starts there. But not when 'virtualedit' is set!
1657 *A*
1658 A Append text at the end of the line [count] times.
1660 <insert> or *i* *insert* *<Insert>*
1661 i Insert text before the cursor [count] times.
1662 When using CTRL-O in Insert mode |i_CTRL-O| the count
1663 is not supported.
1665 *I*
1666 I Insert text before the first non-blank in the line
1667 [count] times.
1668 When the 'H' flag is present in 'cpoptions' and the
1669 line only contains blanks, insert start just before
1670 the last blank.
1672 *gI*
1673 gI Insert text in column 1 [count] times. {not in Vi}
1675 *gi*
1676 gi Insert text in the same position as where Insert mode
1677 was stopped last time in the current buffer.
1678 This uses the |'^| mark. It's different from "`^i"
1679 when the mark is past the end of the line.
1680 The position is corrected for inserted/deleted lines,
1681 but NOT for inserted/deleted characters.
1682 When the |:keepjumps| command modifier is used the |'^|
1683 mark won't be changed.
1684 {not in Vi}
1686 *o*
1687 o Begin a new line below the cursor and insert text,
1688 repeat [count] times. {Vi: blank [count] screen
1689 lines}
1690 When the '#' flag is in 'cpoptions' the count is
1691 ignored.
1693 *O*
1694 O Begin a new line above the cursor and insert text,
1695 repeat [count] times. {Vi: blank [count] screen
1696 lines}
1697 When the '#' flag is in 'cpoptions' the count is
1698 ignored.
1700 These commands are used to start inserting text. You can end insert mode with
1701 <Esc>. See |mode-ins-repl| for the other special characters in Insert mode.
1702 The effect of [count] takes place after Insert mode is exited.
1704 When 'autoindent' is on, the indent for a new line is obtained from the
1705 previous line. When 'smartindent' or 'cindent' is on, the indent for a line
1706 is automatically adjusted for C programs.
1708 'textwidth' can be set to the maximum width for a line. When a line becomes
1709 too long when appending characters a line break is automatically inserted.
1712 ==============================================================================
1713 9. Ex insert commands *inserting-ex*
1715 *:a* *:append*
1716 :{range}a[ppend][!] Insert several lines of text below the specified
1717 line. If the {range} is missing, the text will be
1718 inserted after the current line.
1719 Adding [!] toggles 'autoindent' for the time this
1720 command is executed.
1722 *:i* *:in* *:insert*
1723 :{range}i[nsert][!] Insert several lines of text above the specified
1724 line. If the {range} is missing, the text will be
1725 inserted before the current line.
1726 Adding [!] toggles 'autoindent' for the time this
1727 command is executed.
1729 These two commands will keep on asking for lines, until you type a line
1730 containing only a ".". Watch out for lines starting with a backslash, see
1731 |line-continuation|.
1733 NOTE: These commands cannot be used with |:global| or |:vglobal|.
1734 ":append" and ":insert" don't work properly in between ":if" and
1735 ":endif", ":for" and ":endfor", ":while" and ":endwhile".
1737 *:start* *:startinsert*
1738 :star[tinsert][!] Start Insert mode just after executing this command.
1739 Works like typing "i" in Normal mode. When the ! is
1740 included it works like "A", append to the line.
1741 Otherwise insertion starts at the cursor position.
1742 Note that when using this command in a function or
1743 script, the insertion only starts after the function
1744 or script is finished.
1745 This command does not work from |:normal|.
1746 {not in Vi}
1747 {not available when compiled without the +ex_extra
1748 feature}
1750 *:stopi* *:stopinsert*
1751 :stopi[nsert] Stop Insert mode as soon as possible. Works like
1752 typing <Esc> in Insert mode.
1753 Can be used in an autocommand, example: >
1754 :au BufEnter scratch stopinsert
1755 <
1756 *replacing-ex* *:startreplace*
1757 :startr[eplace][!] Start Replace mode just after executing this command.
1758 Works just like typing "R" in Normal mode. When the
1759 ! is included it acts just like "$R" had been typed
1760 (ie. begin replace mode at the end-of-line). Other-
1761 wise replacement begins at the cursor position.
1762 Note that when using this command in a function or
1763 script that the replacement will only start after
1764 the function or script is finished.
1765 {not in Vi}
1766 {not available when compiled without the +ex_extra
1767 feature}
1769 *:startgreplace*
1770 :startg[replace][!] Just like |:startreplace|, but use Virtual Replace
1771 mode, like with |gR|.
1772 {not in Vi}
1773 {not available when compiled without the +ex_extra
1774 feature}
1776 ==============================================================================
1777 10. Inserting a file *inserting-file*
1779 *:r* *:re* *:read*
1780 :r[ead] [++opt] [name]
1781 Insert the file [name] (default: current file) below
1782 the cursor.
1783 See |++opt| for the possible values of [++opt].
1785 :{range}r[ead] [++opt] [name]
1786 Insert the file [name] (default: current file) below
1787 the specified line.
1788 See |++opt| for the possible values of [++opt].
1790 *:r!* *:read!*
1791 :[range]r[ead] !{cmd} Execute {cmd} and insert its standard output below
1792 the cursor or the specified line. A temporary file is
1793 used to store the output of the command which is then
1794 read into the buffer. 'shellredir' is used to save
1795 the output of the command, which can be set to include
1796 stderr or not. {cmd} is executed like with ":!{cmd}",
1797 any '!' is replaced with the previous command |:!|.
1799 These commands insert the contents of a file, or the output of a command,
1800 into the buffer. They can be undone. They cannot be repeated with the "."
1801 command. They work on a line basis, insertion starts below the line in which
1802 the cursor is, or below the specified line. To insert text above the first
1803 line use the command ":0r {name}".
1805 After the ":read" command, the cursor is left on the first non-blank in the
1806 first new line. Unless in Ex mode, then the cursor is left on the last new
1807 line (sorry, this is Vi compatible).
1809 If a file name is given with ":r", it becomes the alternate file. This can be
1810 used, for example, when you want to edit that file instead: ":e! #". This can
1811 be switched off by removing the 'a' flag from the 'cpoptions' option.
1813 Of the [++opt] arguments one is specifically for ":read", the ++edit argument.
1814 This is useful when the ":read" command is actually used to read a file into
1815 the buffer as if editing that file. Use this command in an empty buffer: >
1816 :read ++edit filename
1817 The effect is that the 'fileformat', 'fileencoding', 'bomb', etc. options are
1818 set to what has been detected for "filename". Note that a single empty line
1819 remains, you may want to delete it.
1821 *file-read*
1822 The 'fileformat' option sets the <EOL> style for a file:
1823 'fileformat' characters name ~
1824 "dos" <CR><NL> or <NL> DOS format
1825 "unix" <NL> Unix format
1826 "mac" <CR> Mac format
1827 Previously 'textmode' was used. It is obsolete now.
1829 If 'fileformat' is "dos", a <CR> in front of an <NL> is ignored and a CTRL-Z
1830 at the end of the file is ignored.
1832 If 'fileformat' is "mac", a <NL> in the file is internally represented by a
1833 <CR>. This is to avoid confusion with a <NL> which is used to represent a
1834 <NUL>. See |CR-used-for-NL|.
1836 If the 'fileformats' option is not empty Vim tries to recognize the type of
1837 <EOL> (see |file-formats|). However, the 'fileformat' option will not be
1838 changed, the detected format is only used while reading the file.
1839 A similar thing happens with 'fileencodings'.
1841 On non-MS-DOS, Win32, and OS/2 systems the message "[dos format]" is shown if
1842 a file is read in DOS format, to remind you that something unusual is done.
1843 On Macintosh, MS-DOS, Win32, and OS/2 the message "[unix format]" is shown if
1844 a file is read in Unix format.
1845 On non-Macintosh systems, the message "[Mac format]" is shown if a file is
1846 read in Mac format.
1848 An example on how to use ":r !": >
1849 :r !uuencode binfile binfile
1850 This command reads "binfile", uuencodes it and reads it into the current
1851 buffer. Useful when you are editing e-mail and want to include a binary
1852 file.
1854 *read-messages*
1855 When reading a file Vim will display a message with information about the read
1856 file. In the table is an explanation for some of the items. The others are
1857 self explanatory. Using the long or the short version depends on the
1858 'shortmess' option.
1860 long short meaning ~
1861 [readonly] {RO} the file is write protected
1862 [fifo/socket] using a stream
1863 [fifo] using a fifo stream
1864 [socket] using a socket stream
1865 [CR missing] reading with "dos" 'fileformat' and a
1866 NL without a preceding CR was found.
1867 [NL found] reading with "mac" 'fileformat' and a
1868 NL was found (could be "unix" format)
1869 [long lines split] at least one line was split in two
1870 [NOT converted] conversion from 'fileencoding' to
1871 'encoding' was desired but not
1872 possible
1873 [converted] conversion from 'fileencoding' to
1874 'encoding' done
1875 [crypted] file was decrypted
1876 [READ ERRORS] not all of the file could be read
1879 vim:tw=78:ts=8:ft=help:norl: