blob: 76274d1f501e81421a6f7f2c2c3b4ce841e3a7f5 [file] [log] [blame]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001*usr_24.txt* For Vim version 7.0aa. Last change: 2003 Aug 18
2
3 VIM USER MANUAL - by Bram Moolenaar
4
5 Inserting quickly
6
7
8When entering text, Vim offers various ways to reduce the number of keystrokes
9and avoid typing mistakes. Use Insert mode completion to repeat previously
10typed words. Abbreviate long words to short ones. Type characters that
11aren't on your keyboard.
12
13|24.1| Making corrections
14|24.2| Showing matches
15|24.3| Completion
16|24.4| Repeating an insert
17|24.5| Copying from another line
18|24.6| Inserting a register
19|24.7| Abbreviations
20|24.8| Entering special characters
21|24.9| Digraphs
22|24.10| Normal mode commands
23
24 Next chapter: |usr_25.txt| Editing formatted text
25 Previous chapter: |usr_23.txt| Editing other files
26Table of contents: |usr_toc.txt|
27
28==============================================================================
29*24.1* Making corrections
30
31The <BS> key was already mentioned. It deletes the character just before the
32cursor. The <Del> key does the same for the character under (after) the
33cursor.
34 When you typed a whole word wrong, use CTRL-W:
35
36 The horse had fallen to the sky ~
37 CTRL-W
38 The horse had fallen to the ~
39
40If you really messed up a line and want to start over, use CTRL-U to delete
41it. This keeps the text after the cursor and the indent. Only the text from
42the first non-blank to the cursor is deleted. With the cursor on the "f" of
43"fallen" in the next line pressing CTRL-U does this:
44
45 The horse had fallen to the ~
46 CTRL-U
47 fallen to the ~
48
49When you spot a mistake a few words back, you need to move the cursor there to
50correct it. For example, you typed this:
51
52 The horse had follen to the ground ~
53
54You need to change "follen" to "fallen". With the cursor at the end, you
55would type this to correct it: >
56
57 <Esc>4blraA
58
59< get out of Insert mode <Esc>
60 four words back 4b
61 move on top of the "o" l
62 replace with "a" ra
63 restart Insert mode A
64
65Another way to do this: >
66
67 <C-Left><C-Left><C-Left><C-Left><Right><Del>a<End>
68
69< four words back <C-Left><C-Left><C-Left><C-Left>
70 move on top of the "o" <Right>
71 delete the "o" <Del>
72 insert an "a" a
73 go to end of the line <End>
74
75This uses special keys to move around, while remaining in Insert mode. This
76resembles what you would do in a modeless editor. It's easier to remember,
77but takes more time (you have to move your hand from the letters to the cursor
78keys, and the <End> key is hard to press without looking at the keyboard).
79 These special keys are most useful when writing a mapping that doesn't
80leave Insert mode. The extra typing doesn't matter then.
81 An overview of the keys you can use in Insert mode:
82
83 <C-Home> to start of the file
84 <PageUp> a whole screenful up
85 <Home> to start of line
86 <S-Left> one word left
87 <C-Left> one word left
88 <S-Right> one word right
89 <C-Right> one word right
90 <End> to end of the line
91 <PageDown> a whole screenful down
92 <C-End> to end of the file
93
94There are a few more, see |ins-special-special|.
95
96==============================================================================
97*24.2* Showing matches
98
99When you type a ) it would be nice to see with which ( it matches. To make
100Vim do that use this command: >
101
102 :set showmatch
103
104When you now type a text like "(example)", as soon as you type the ) Vim will
105briefly move the cursor to the matching (, keep it there for half a second,
106and move back to where you were typing.
107 In case there is not matching (, Vim will beep. Then you know that you
108might have forgotten the ( somewhere, or typed a ) too many.
109 The match will also be shown for [] and {} pairs. You don't have to wait
110with typing the next character, as soon as Vim sees it the cursor will move
111back and inserting continues as before.
112 You can change the time Vim waits with the 'matchtime' option. For
113example, to make Vim wait one and a half second: >
114
115 :set matchtime=15
116
117The time is specified in tenths of a second.
118
119==============================================================================
120*24.3* Completion
121
122Vim can automatically complete words on insertion. You type the first part of
123a word, press CTRL-P, and Vim guesses the rest.
124 Suppose, for example, that you are creating a C program and want to type in
125the following:
126
127 total = ch_array[0] + ch_array[1] + ch_array[2]; ~
128
129You start by entering the following:
130
131 total = ch_array[0] + ch_ ~
132
133At this point, you tell Vim to complete the word using the command CTRL-P.
134Vim searches for a word that starts with what's in front of the cursor. In
135this case, it is "ch_", which matches with the word ch_array. So typing
136CTRL-P gives you the following:
137
138 total = ch_array[0] + ch_array ~
139
140After a little more typing, you get this (ending in a space):
141
142 total = ch_array[0] + ch_array[1] + ~
143
144If you now type CTRL-P Vim will search again for a word that completes the
145word before the cursor. Since there is nothing in front of the cursor, it
146finds the first word backwards, which is "ch_array". Typing CTRL-P again
147gives you the next word that matches, in this case "total". A third CTRL-P
148searches further back. If there is nothing else, it causes the editor to run
149out of words, so it returns to the original text, which is nothing. A fourth
150CTRL-P causes the editor to start over again with "ch_array".
151
152To search forward, use CTRL-N. Since the search wraps around the end of the
153file, CTRL-N and CTRL-P will find the same matches, but in a different
154sequence. Hint: CTRL-N is Next-match and CTRL-P is Previous-match.
155
156The Vim editor goes through a lot of effort to find words to complete. By
157default, it searches the following places:
158
159 1. Current file
160 2. Files in other windows
161 3. Other loaded files (hidden buffers)
162 4. Files which are not loaded (inactive buffers)
163 5. Tag files
164 6. All files #included by the current file
165
166
167OPTIONS
168
169You can customize the search order with the 'complete' option.
170
171The 'ignorecase' option is used. When it is set, case differences are ignored
172when searching for matches.
173
174A special option for completion is 'infercase'. This is useful to find
175matches while ignoring case ('ignorecase' must be set) but still using the
176case of the word typed so far. Thus if you type "For" and Vim finds a match
177"fortunately", it will result in "Fortunately".
178
179
180COMPLETING SPECIFIC ITEMS
181
182If you know what you are looking for, you can use these commands to complete
183with a certain type of item:
184
185 CTRL-X CTRL-F file names
186 CTRL-X CTRL-L whole lines
187 CTRL-X CTRL-D macro definitions (also in included files)
188 CTRL-X CTRL-I current and included files
189 CTRL-X CTRL-K words from a dictionary
190 CTRL-X CTRL-T words from a thesaurus
191 CTRL-X CTRL-] tags
192 CTRL-X CTRL-V Vim command line
193
194After each of them CTRL-N can be used to find the next match, CTRL-P to find
195the previous match.
196 More information for each of these commands here: |ins-completion|.
197
198
199COMPLETING FILE NAMES
200
201Let's take CTRL-X CTRL-F as an example. This will find file names. It scans
202the current directory for files and displays each one that matches the word in
203front of the cursor.
204 Suppose, for example, that you have the following files in the current
205directory:
206
207 main.c sub_count.c sub_done.c sub_exit.c
208
209Now enter Insert mode and start typing:
210
211 The exit code is in the file sub ~
212
213At this point, you enter the command CTRL-X CTRL-F. Vim now completes the
214current word "sub" by looking at the files in the current directory. The
215first match is sub_count.c. This is not the one you want, so you match the
216next file by typing CTRL-N. This match is sub_done.c. Typing CTRL-N again
217takes you to sub_exit.c. The results:
218
219 The exit code is in the file sub_exit.c ~
220
221If the file name starts with / (Unix) or C:\ (MS-Windows) you can find all
222files in the file system. For example, type "/u" and CTRL-X CTRL-F. This
223will match "/usr" (this is on Unix):
224
225 the file is found in /usr/ ~
226
227If you now press CTRL-N you go back to "/u". Instead, to accept the "/usr/"
228and go one directory level deeper, use CTRL-X CTRL-F again:
229
230 the file is found in /usr/X11R6/ ~
231
232The results depend on what is found in your file system, of course. The
233matches are sorted alphabetically.
234
235==============================================================================
236*24.4* Repeating an insert
237
238If you press CTRL-A, the editor inserts the text you typed the last time you
239were in Insert mode.
240 Assume, for example, that you have a file that begins with the following:
241
242 "file.h" ~
243 /* Main program begins */ ~
244
245You edit this file by inserting "#include " at the beginning of the first
246line:
247
248 #include "file.h" ~
249 /* Main program begins */ ~
250
251You go down to the beginning of the next line using the commands "j^". You
252now start to insert a new "#include" line. So you type: >
253
254 i CTRL-A
255
256The result is as follows:
257
258 #include "file.h" ~
259 #include /* Main program begins */ ~
260
261The "#include " was inserted because CTRL-A inserts the text of the previous
262insert. Now you type "main.h"<Enter> to finish the line:
263
264
265 #include "file.h" ~
266 #include "main.h" ~
267 /* Main program begins */ ~
268
269The CTRL-@ command does a CTRL-A and then exits Insert mode. That's a quick
270way of doing exactly the same insertion again.
271
272==============================================================================
273*24.5* Copying from another line
274
275The CTRL-Y command inserts the character above the cursor. This is useful
276when you are duplicating a previous line. For example, you have this line of
277C code:
278
279 b_array[i]->s_next = a_array[i]->s_next; ~
280
281Now you need to type the same line, but with "s_prev" instead of "s_next".
282Start the new line, and press CTRL-Y 14 times, until you are at the "n" of
283"next":
284
285 b_array[i]->s_next = a_array[i]->s_next; ~
286 b_array[i]->s_ ~
287
288Now you type "prev":
289
290 b_array[i]->s_next = a_array[i]->s_next; ~
291 b_array[i]->s_prev ~
292
293Continue pressing CTRL-Y until the following "next":
294
295 b_array[i]->s_next = a_array[i]->s_next; ~
296 b_array[i]->s_prev = a_array[i]->s_ ~
297
298Now type "prev;" to finish it off.
299
300The CTRL-E command acts like CTRL-Y except it inserts the character below the
301cursor.
302
303==============================================================================
304*24.6* Inserting a register
305
306The command CTRL-R {register} inserts the contents of the register. This is
307useful to avoid having to type a long word. For example, you need to type
308this:
309
310 r = VeryLongFunction(a) + VeryLongFunction(b) + VeryLongFunction(c) ~
311
312The function name is defined in a different file. Edit that file and move the
313cursor on top of the function name there, and yank it into register v: >
314
315 "vyiw
316
317"v is the register specification, "yiw" is yank-inner-word. Now edit the file
318where the new line is to be inserted, and type the first letters:
319
320 r = ~
321
322Now use CTRL-R v to insert the function name:
323
324 r = VeryLongFunction ~
325
326You continue to type the characters in between the function name, and use
327CTRL-R v two times more.
328 You could have done the same with completion. Using a register is useful
329when there are many words that start with the same characters.
330
331If the register contains characters such as <BS> or other special characters,
332they are interpreted as if they had been typed from the keyboard. If you do
333not want this to happen (you really want the <BS> to be inserted in the text),
334use the command CTRL-R CTRL-R {register}.
335
336==============================================================================
337*24.7* Abbreviations
338
339An abbreviation is a short word that takes the place of a long one. For
340example, "ad" stands for "advertisement". Vim enables you to type an
341abbreviation and then will automatically expand it for you.
342 To tell Vim to expand "ad" into "advertisement" every time you insert it,
343use the following command: >
344
345 :iabbrev ad advertisement
346
347Now, when you type "ad", the whole word "advertisement" will be inserted into
348the text. This is triggered by typing a character that can't be part of a
349word, for example a space:
350
351 What Is Entered What You See
352 I saw the a I saw the a ~
353 I saw the ad I saw the ad ~
354 I saw the ad<Space> I saw the advertisement<Space> ~
355
356The expansion doesn't happen when typing just "ad". That allows you to type a
357word like "add", which will not get expanded. Only whole words are checked
358for abbreviations.
359
360
361ABBREVIATING SEVERAL WORDS
362
363It is possible to define an abbreviation that results in multiple words. For
364example, to define "JB" as "Jack Benny", use the following command: >
365
366 :iabbrev JB Jack Benny
367
368As a programmer, I use two rather unusual abbreviations: >
369
370 :iabbrev #b /****************************************
371 :iabbrev #e <Space>****************************************/
372
373These are used for creating boxed comments. The comment starts with #b, which
374draws the top line. I then type the comment text and use #e to draw the
375bottom line.
376 Notice that the #e abbreviation begins with a space. In other words, the
377first two characters are space-star. Usually Vim ignores spaces between the
378abbreviation and the expansion. To avoid that problem, I spell space as seven
379characters: <, S, p, a, c, e, >.
380
381 Note:
382 ":iabbrev" is a long word to type. ":iab" works just as well.
383 That's abbreviating the abbreviate command!
384
385
386FIXING TYPING MISTAKES
387
388It's very common to make the same typing mistake every time. For example,
389typing "teh" instead of "the". You can fix this with an abbreviation: >
390
391 :abbreviate teh the
392
393You can add a whole list of these. Add one each time you discover a common
394mistake.
395
396
397LISTING ABBREVIATIONS
398
399The ":abbreviate" command lists the abbreviations:
400
401 :abbreviate
402 i #e ****************************************/
403 i #b /****************************************
404 i JB Jack Benny
405 i ad advertisement
406 ! teh the
407
408The "i" in the first column indicates Insert mode. These abbreviations are
409only active in Insert mode. Other possible characters are:
410
411 c Command-line mode :cabbrev
412 ! both Insert and Command-line mode :abbreviate
413
414Since abbreviations are not often useful in Command-line mode, you will mostly
415use the ":iabbrev" command. That avoids, for example, that "ad" gets expanded
416when typing a command like: >
417
418 :edit ad
419
420
421DELETING ABBREVIATIONS
422
423To get rid of an abbreviation, use the ":unabbreviate" command. Suppose you
424have the following abbreviation: >
425
426 :abbreviate @f fresh
427
428You can remove it with this command: >
429
430 :unabbreviate @f
431
432While you type this, you will notice that @f is expanded to "fresh". Don't
433worry about this, Vim understands it anyway (except when you have an
434abbreviation for "fresh", but that's very unlikely).
435 To remove all the abbreviations: >
436
437 :abclear
438
439":unabbreviate" and ":abclear" also come in the variants for Insert mode
440(":iunabbreviate and ":iabclear") and Command-line mode (":cunabbreviate" and
441":cabclear").
442
443
444REMAPPING ABBREVIATIONS
445
446There is one thing to watch out for when defining an abbreviation: The
447resulting string should not be mapped. For example: >
448
449 :abbreviate @a adder
450 :imap dd disk-door
451
452When you now type @a, you will get "adisk-doorer". That's not what you want.
453To avoid this, use the ":noreabbrev" command. It does the same as
454":abbreviate", but avoids that the resulting string is used for mappings: >
455
456 :noreabbrev @a adder
457
458Fortunately, it's unlikely that the result of an abbreviation is mapped.
459
460==============================================================================
461*24.8* Entering special characters
462
463The CTRL-V command is used to insert the next character literally. In other
464words, any special meaning the character has, it will be ignored. For
465example: >
466
467 CTRL-V <Esc>
468
469Inserts an escape character. Thus you don't leave Insert mode. (Don't type
470the space after CTRL-V, it's only to make this easier to read).
471
472 Note:
473 On MS-Windows CTRL-V is used to paste text. Use CTRL-Q instead of
474 CTRL-V. On Unix, on the other hand, CTRL-Q does not work on some
475 terminals, because it has a special meaning.
476
477You can also use the command CTRL-V {digits} to insert a character with the
478decimal number {digits}. For example, the character number 127 is the <Del>
479character (but not necessarily the <Del> key!). To insert <Del> type: >
480
481 CTRL-V 127
482
483You can enter characters up to 255 this way. When you type fewer than two
484digits, a non-digit will terminate the command. To avoid the need of typing a
485non-digit, prepend one or two zeros to make three digits.
486 All the next commands insert a <Tab> and then a dot:
487
488 CTRL-V 9.
489 CTRL-V 09.
490 CTRL-V 009.
491
492To enter a character in hexadecimal, use an "x" after the CTRL-V: >
493
494 CTRL-V x7f
495
496This also goes up to character 255 (CTRL-V xff). You can use "o" to type a
497character as an octal number and two more methods allow you to type up to
498a 16 bit and a 32 bit number (e.g., for a Unicode character): >
499
500 CTRL-V o123
501 CTRL-V u1234
502 CTRL-V U12345678
503
504==============================================================================
505*24.9* Digraphs
506
507Some characters are not on the keyboard. For example, the copyright character
508(©). To type these characters in Vim, you use digraphs, where two characters
509represent one. To enter a ©, for example, you press three keys: >
510
511 CTRL-K Co
512
513To find out what digraphs are available, use the following command: >
514
515 :digraphs
516
517Vim will display the digraph table. Here are three lines of it:
518
519 AC ~_ 159 NS | 160 !I ¡ 161 Ct ¢ 162 Pd £ 163 Cu ¤ 164 Ye ¥ 165 ~
520 BB ¦ 166 SE § 167 ': ¨ 168 Co © 169 -a ª 170 << « 171 NO ¬ 172 ~
521 -- ­ 173 Rg ® 174 'm ¯ 175 DG ° 176 +- ± 177 2S ² 178 3S ³ 179 ~
522
523This shows, for example, that the digraph you get by typing CTRL-K Pd is the
524character (£). This is character number 163 (decimal).
525 Pd is short for Pound. Most digraphs are selected to give you a hint about
526the character they will produce. If you look through the list you will
527understand the logic.
528 You can exchange the first and second character, if there is no digraph for
529that combination. Thus CTRL-K dP also works. Since there is no digraph for
530"dP" Vim will also search for a "Pd" digraph.
531
532 Note:
533 The digraphs depend on the character set that Vim assumes you are
534 using. On MS-DOS they are different from MS-Windows. Always use
535 ":digraphs" to find out which digraphs are currently available.
536
537You can define your own digraphs. Example: >
538
539 :digraph a" ä
540
541This defines that CTRL-K a" inserts an ä character. You can also specify the
542character with a decimal number. This defines the same digraph: >
543
544 :digraph a" 228
545
546More information about digraphs here: |digraphs|
547 Another way to insert special characters is with a keymap. More about that
548here: |45.5|
549
550==============================================================================
551*24.10* Normal mode commands
552
553Insert mode offers a limited number of commands. In Normal mode you have many
554more. When you want to use one, you usually leave Insert mode with <Esc>,
555execute the Normal mode command, and re-enter Insert mode with "i" or "a".
556 There is a quicker way. With CTRL-O {command} you can execute any Normal
557mode command from Insert mode. For example, to delete from the cursor to the
558end of the line: >
559
560 CTRL-O D
561
562You can execute only one Normal mode command this way. But you can specify a
563register or a count. A more complicated example: >
564
565 CTRL-O "g3dw
566
567This deletes up to the third word into register g.
568
569==============================================================================
570
571Next chapter: |usr_25.txt| Editing formatted text
572
573Copyright: see |manual-copyright| vim:tw=78:ts=8:ft=help:norl: