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