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