blob: 8d3ac6eadf14b89f9fe7b267a0c6abf035541f56 [file] [log] [blame]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001*intro.txt* For Vim version 7.0aa. Last change: 2004 Jun 12
2
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Introduction to Vim *ref* *reference*
8
91. Introduction |intro|
102. Vim on the internet |internet|
113. Credits |credits|
124. Notation |notation|
135. Modes, introduction |vim-modes-intro|
146. Switching from mode to mode |mode-switching|
157. The window contents |window-contents|
168. Definitions |definitions|
17
18==============================================================================
191. Introduction *intro*
20
21Vim stands for Vi IMproved. It used to be Vi IMitation, but there are so many
22improvements that a name change was appropriate. Vim is a text editor which
23includes almost all the commands from the Unix program "Vi" and a lot of new
24ones. It is very useful for editing programs and other plain text.
25 All commands are given with the keyboard. This has the advantage that you
26can keep your fingers on the keyboard and your eyes on the screen. For those
27who want it, there is mouse support and a GUI version with scrollbars and
28menus (see |gui.txt|).
29
30An overview of this manual can be found in the file "help.txt", |help.txt|.
31It can be accessed from within Vim with the <Help> or <F1> key and with the
32|:help| command (just type ":help", without the bars or quotes).
33 The 'helpfile' option can be set to the name of the help file, in case it
34is not located in the default place. You can jump to subjects like with tags:
35Use CTRL-] to jump to a subject under the cursor, use CTRL-T to jump back.
36
37Throughout this manual the differences between Vi and Vim are mentioned in
38curly braces, like this: {Vi does not have on-line help}. See |vi_diff.txt|
39for a summary of the differences between Vim and Vi.
40
41This manual refers to Vim on various machines. There may be small differences
42between different computers and terminals. Besides the remarks given in this
43document, there is a separate document for each supported system, see
44|sys-file-list|.
45
46This manual is a reference for all the Vim commands and options. This is not
47an introduction to the use of Vi or Vim, it gets a bit complicated here and
48there. For beginners, there is a hands-on |tutor|. To learn using Vim, read
49the user manual |usr_toc.txt|.
50
51 *book*
52There are many books on Vi that contain a section for beginners. There are
53two books I can recommend:
54
55 "Vim - Vi Improved" by Steve Oualline
56
57This is the very first book completely dedicated to Vim. It is very good for
58beginners. The most often used commands are explained with pictures and
59examples. The less often used commands are also explained, the more advanced
60features are summarized. There is a comprehensive index and a quick
61reference. Parts of this book have been included in the user manual
62|frombook|.
63Published by New Riders Publishing. ISBN: 0735710015
64For more information try one of these:
65 http://iccf-holland.org/click5.html
66 http://www.vim.org/iccf/click5.html
67
68 "Learning the Vi editor" by Linda Lamb and Arnold Robbins
69
70This is a book about Vi that includes a chapter on Vim (in the sixth edition).
71The first steps in Vi are explained very well. The commands that Vim adds are
72only briefly mentioned. There is also a German translation.
73Published by O'Reilly. ISBN: 1-56592-426-6.
74
75==============================================================================
762. Vim on the internet *internet*
77
78 *www* *faq* *FAQ* *distribution* *download*
79The Vim pages contain the most recent information about Vim. They also
80contain links to the most recent version of Vim. The FAQ is a list of
81Frequently Asked Questions. Read this if you have problems.
82
83 VIM home page: http://www.vim.org/
84 VIM FAQ: http://vimdoc.sf.net/
85 Downloading: ftp://ftp.vim.org/pub/vim/MIRRORS
86
87
88Usenet News group where Vim is discussed: *news* *usenet*
89 comp.editors
90This group is also for other editors. If you write about Vim, don't forget to
91mention that.
92
93 *mail-list* *maillist*
94There are several mailing lists for Vim:
95<vim@vim.org>
96 For discussions about using existing versions of Vim: Useful mappings,
97 questions, answers, where to get a specific version, etc.
98<vim-dev@vim.org> *vim-dev* *vimdev*
99 For discussions about changing Vim: New features, porting, patches,
100 beta-test versions, etc.
101<vim-announce@vim.org> *vim-announce*
102 Announcements about new versions of Vim; also for beta-test versions
103 and ports to different systems.
104<vim-multibyte@vim.org> *vim-multibyte*
105 For discussions about using and improving the multi-byte aspects of
106 Vim.
107<vim-mac@vim.org> *vim-mac*
108 For discussions about using and improving the Macintosh version of
109 Vim.
110
111See http://www.vim.org/maillist.php for the latest information.
112
113NOTE:
114- You can only send messages to these lists if you have subscribed!
115- You need to send the messages from the same location as where you subscribed
116 from (to avoid spam mail).
117- Maximum message size is 40000 characters.
118
119 *subscribe-maillist*
120If you want to join, send a message to
121 <vim-help@vim.org>
122Make sure that your "From:" address is correct. Then the list server will
123give you help on how to subscribe.
124
125You can retrieve old messages from the maillist software, and an index of
126messages. Ask vim-help for instructions.
127
128Archives are kept at: *maillist-archive*
129http://groups.yahoo.com/group/vim
130http://groups.yahoo.com/group/vimdev
131http://groups.yahoo.com/group/vimannounce
132http://groups.yahoo.com/group/vim-multibyte
133http://groups.yahoo.com/group/vim-mac
134
135
136Additional maillists:
137
138<vim-fr@club.voila.fr> *french-maillist*
139 Vim list in the French language. Subscribe by sending a message to
140 <vim-fr-subscribe@club.voila.fr>
141 Or go to http://groups.yahoo.com/group/vim-fr.
142
143
144Bug reports: *bugs* *bug-reports* *bugreport.vim*
145
146Send bug reports to: Vim bugs <bugs@vim.org>
147This is not a maillist but the message is redirected to the Vim maintainer.
148Please be brief; all the time that is spent on answering mail is subtracted
149from the time that is spent on improving Vim! Always give a reproducible
150example and try to find out which settings or other things influence the
151appearance of the bug. Try different machines, if possible. Send me patches
152if you can!
153
154In case of doubt, use: >
155 :so $VIMRUNTIME/bugreport.vim
156This will create a file "bugreport.txt" in the current directory, with a lot
157of information of your environment. Before sending this out, check if it
158doesn't contain any confidential information!
159
160 *debug-vim*
161When Vim crashes in one of the test files, and you are using gcc for
162compilation, here is what you can do to find out exactly where Vim crashes:
163
1641. Compile Vim with the "-g" option (there is a line in the Makefile for this,
165 which you can uncomment).
166
1672. Execute these commands (replace "11" with the test that fails): >
168 cd testdir
169 gdb ../vim
170 run -u unix.vim -U NONE -s dotest.in test11.in
171
1723. Check where Vim crashes, gdb should give a message for this.
173
1744. Get a stack trace from gdb with this command: >
175 where
176< You can check out different places in the stack trace with: >
177 frame 3
178< Replace "3" with one of the numbers in the stack trace.
179
180 *year-2000* *Y2K*
181Since Vim internally doesn't use dates for editing, there is no year 2000
182problem to worry about. Vim does use the time in the form of seconds since
183January 1st 1970. It is used for a time-stamp check of the edited file and
184the swap file, which is not critical and should only cause warning messages.
185
186There might be a year 2038 problem, when the seconds don't fit in a 32 bit int
187anymore. This depends on the compiler, libraries and operating system.
188Specifically, time_t and the ctime() function are used. And the time_t is
189stored in four bytes in the swap file. But that's only used for printing a
190file date/time for recovery, it will never affect normal editing.
191
192The Vim strftime() function directly uses the strftime() system function.
193localtime() uses the time() system function. getftime() uses the time
194returned by the stat() system function. If your system libraries are year
1952000 compliant, Vim is too.
196
197The user may create scripts for Vim that use external commands. These might
198introduce Y2K problems, but those are not really part of Vim itself.
199
200==============================================================================
2013. Credits *credits* *author*
202
203Most of Vim was written by Bram Moolenaar <Bram@vim.org>.
204
205Parts of the documentation come from several Vi manuals, written by:
206 W.N. Joy
207 Alan P.W. Hewett
208 Mark Horton
209
210The Vim editor is based on Stevie and includes (ideas from) other software,
211worked on by the people mentioned here. Other people helped by sending me
212patches, suggestions and giving feedback about what is good and bad in Vim.
213
214Vim would never have become what it is now, without the help of these people!
215
216 Ron Aaron Win32 GUI changes
217 Zoltan Arpadffy work on VMS port
218 Tony Andrews Stevie
219 Gert van Antwerpen changes for DJGPP on MS-DOS
220 Berkeley DB(3) ideas for swap file implementation
221 Keith Bostic Nvi
222 Walter Briscoe Makefile updates, various patches
223 Ralf Brown SPAWNO library for MS-DOS
224 Robert Colon many useful remarks
225 Marcin Dalecki GTK+ GUI port, toolbar icons, gettext()
226 Kayhan Demirel sent me news in Uganda
227 Chris & John Downey xvi (ideas for multi-windows version)
228 Henk Elbers first VMS port
229 Eric Fischer Mac port, 'cindent', and other improvements
230 Benji Fisher Answering lots of user questions
231 Bill Foster Athena GUI port
232 Loic Grenie xvim (ideas for multi windows version)
233 Sven Guckes Vim promotor and previous WWW page maintainer
234 Darren Hiebert Exuberant ctags
235 Bruce Hunsaker improvements for VMS port
236 Andy Kahn Cscope support, GTK+ GUI port
237 Oezguer Kesim Maintainer of Vim Mailing Lists
238 Axel Kielhorn work on the Macintosh port
239 Steve Kirkendall Elvis
240 Roger Knobbe original port to Windows NT
241 Sergey Laskavy Vim's help from Moscow
242 Felix von Leitner Maintainer of Vim Mailing Lists
243 David Leonard Port of Python extensions to Unix
244 Avner Lottem Edit in right-to-left windows
245 Flemming Madsen X11 client-server, various features and patches
246 MicroSoft Gave me a copy of DevStudio to compile Vim with
247 Paul Moore Python interface extensions, many patches
248 Katsuhito Nagano Work on multi-byte versions
249 Sung-Hyun Nam Work on multi-byte versions
250 Vince Negri Win32 GUI and generic console enhancements
251 Steve Oualline Author of the first Vim book |frombook|
252 George V. Reilly Win32 port, Win32 GUI start-off
253 Stephen Riehm bug collector
254 Stefan Roemer various patches and help to users
255 Ralf Schandl IBM OS/390 port
256 Olaf Seibert DICE and BeBox version, regexp improvements
257 Mortaza Shiran Farsi patches
258 Peter da Silva termlib
259 Paul Slootman OS/2 port
260 Henry Spencer regular expressions
261 Dany St-Amant Macintosh port
262 Tim Thompson Stevie
263 G. R. (Fred) Walter Stevie
264 Sven Verdoolaege Perl interface
265 Robert Webb Command-line completion, GUI versions, and
266 lots of patches
267 Ingo Wilken Tcl interface
268 Mike Williams PostScript printing
269 Juergen Weigert Lattice version, AUX improvements, UNIX and
270 MS-DOS ports, autoconf
271 Stefan 'Sec' Zehl Maintainer of vim.org
272
273I wish to thank all the people that sent me bug reports and suggestions. The
274list is too long to mention them all here. Vim would not be the same without
275the ideas from all these people: They keep Vim alive!
276
277
278In this documentation there are several references to other versions of Vi:
279 *Vi*
280Vi "the original". Without further remarks this is the version
281 of Vi that appeared in Sun OS 4.x. ":version" returns
282 "Version 3.7, 6/7/85". Sometimes other versions are referred
283 to. Only runs under Unix. Source code only available with a
284 license. More information on Vi can be found through:
285 http://vi-editor.org [doesn't currently work...]
286 *Posix*
287Posix From the IEEE standard 1003.2, Part 2: Shell and utilities.
288 Generally known as "Posix". This is a textual description of
289 how Vi is supposed to work.
290 The version used is a draft from beginning 1996, so all remarks are
291 "expected to comply to" this. Anything can change though...
292 *Nvi*
293Nvi The "New" Vi. The version of Vi that comes with BSD 4.4 and FreeBSD.
294 Very good compatibility with the original Vi, with a few extensions.
295 The version used is 1.79. ":version" returns "Version 1.79
296 (10/23/96)". There has been no release the last few years, although
297 there is a development version 1.81.
298 Source code is freely available.
299 *Elvis*
300Elvis Another Vi clone, made by Steve Kirkendall. Very compact but isn't
301 as flexible as Vim.
302 The version used is 2.1. It is still being developed. Source code is
303 freely available.
304
305==============================================================================
3064. Notation *notation*
307
308When syntax highlighting is used to read this, text that is not typed
309literally is often highlighted with the Special group. These are items in [],
310{} and <>, and CTRL-X.
311
312Note that Vim uses all possible characters in commands. Sometimes the [], {}
313and <> are part of what you type, the context should make this clear.
314
315
316[] Characters in square brackets are optional.
317
318 *count* *[count]* *E489*
319[count] An optional number that may precede the command to multiply
320 or iterate the command. If no number is given, a count of one
321 is used, unless otherwise noted. Note that in this manual the
322 [count] is not mentioned in the description of the command,
323 but only in the explanation. This was done to make the
324 commands easier to look up. If the 'showcmd' option is on,
325 the (partially) entered count is shown at the bottom of the
326 window. You can use <Del> to erase the last digit (|N<Del>|).
327
328 *[quotex]*
329["x] An optional register designation where text can be stored.
330 See |registers|. The x is a single character between 'a' and
331 'z' or 'A' and 'Z' or '"', and in some cases (with the put
332 command) between '0' and '9', '%', '#', or others. The
333 uppercase and lowercase letter designate the same register,
334 but the lowercase letter is used to overwrite the previous
335 register contents, while the uppercase letter is used to
336 append to the previous register contents. Without the ""x" or
337 with """" the stored text is put into the unnamed register.
338
339 *{}*
340{} Curly braces denote parts of the command which must appear,
341 but which can take a number of different values. The
342 differences between Vim and Vi are also given in curly braces
343 (this will be clear from the context).
344
345 *{char1-char2}*
346{char1-char2} A single character from the range char1 to char2. For
347 example: {a-z} is a lowercase letter. Multiple ranges may be
348 concatenated. For example, {a-zA-Z0-9} is any alphanumeric
349 character.
350
351 *{motion}*
352{motion} A command that moves the cursor. These are explained in
353 |motion.txt|. Examples:
354 w to start of next word
355 b to begin of current word
356 4j four lines down
357 /The<CR> to next occurrence of "The"
358 This is used after an |operator| command to move over the text
359 that is to be operated upon.
360 - If the motion includes a count and the operator also has a
361 count, the two counts are multiplied. For example: "2d3w"
362 deletes six words.
363 - The motion can be backwards, e.g. "db" to delete to the
364 start of the word.
365 - The motion can also be a mouse click. The mouse is not
366 supported in every terminal though.
367 - The ":omap" command can be used to map characters while an
368 operator is pending.
369 - Ex commands can be used to move the cursor. This can be
370 used to call a function that does some complicated motion.
371 The motion is always characterwise exclusive, no matter
372 what ":" command is used. This means it's impossible to
373 include the last character of a line without the line break
374 (unless 'virtualedit' is set).
375 If the Ex command changes the text before where the operator
376 starts or jumps to another buffer the result is
377 unpredictable. It is possible to change the text further
378 down. Jumping to another buffer is possible if the current
379 buffer is not unloaded.
380
381 *{Visual}*
382{Visual} A selected text area. It is started with the "v", "V", or
383 CTRL-V command, then any cursor movement command can be used
384 to change the end of the selected text.
385 This is used before an |operator| command to highlight the
386 text that is to be operated upon.
387 See |Visual-mode|.
388
389 *<character>*
390<character> A special character from the table below, optionally with
391 modifiers, or a single ASCII character with modifiers.
392
393 *'character'*
394'c' A single ASCII character.
395
396 *CTRL-{char}*
397CTRL-{char} {char} typed as a control character; that is, typing {char}
398 while holding the CTRL key down. The case of {char} does not
399 matter; thus CTRL-A and CTRL-a are equivalent. But on some
400 terminals, using the SHIFT key will produce another code,
401 don't use it then.
402
403 *'option'*
404'option' An option, or parameter, that can be set to a value, is
405 enclosed in single quotes. See |options|.
406
407 *quotecommandquote*
408"command" A reference to a command that you can type is enclosed in
409 double quotes.
410
411 *key-notation* *key-codes* *keycodes*
412These names for keys are used in the documentation. They can also be used
413with the ":map" command (insert the key name by pressing CTRL-K and then the
414key you want the name for).
415
416notation meaning equivalent decimal value(s) ~
417-----------------------------------------------------------------------
418<Nul> zero CTRL-@ 0 (stored as 10) *<Nul>*
419<BS> backspace CTRL-H 8 *backspace*
420<Tab> tab CTRL-I 9 *tab* *Tab*
421 *linefeed*
422<NL> linefeed CTRL-J 10 (used for <Nul>)
423<FF> formfeed CTRL-L 12 *formfeed*
424<CR> carriage return CTRL-M 13 *carriage-return*
425<Return> same as <CR> *<Return>*
426<Enter> same as <CR> *<Enter>*
427<Esc> escape CTRL-[ 27 *escape* *<Esc>*
428<Space> space 32 *space*
429<lt> less-than < 60 *<lt>*
430<Bslash> backslash \ 92 *backslash* *<Bslash>*
431<Bar> vertical bar | 124 *<Bar>*
432<Del> delete 127
433<CSI> command sequence intro ALT-Esc 155 *<CSI>*
434<xCSI> CSI when typed in the GUI *<xCSI>*
435
436<EOL> end-of-line (can be <CR>, <LF> or <CR><LF>,
437 depends on system and 'fileformat') *<EOL>*
438
439<Up> cursor-up *cursor-up* *cursor_up*
440<Down> cursor-down *cursor-down* *cursor_down*
441<Left> cursor-left *cursor-left* *cursor_left*
442<Right> cursor-right *cursor-right* *cursor_right*
443<S-Up> shift-cursor-up
444<S-Down> shift-cursor-down
445<S-Left> shift-cursor-left
446<S-Right> shift-cursor-right
447<C-Left> control-cursor-left
448<C-Right> control-cursor-right
449<F1> - <F12> function keys 1 to 12 *function_key* *function-key*
450<S-F1> - <S-F12> shift-function keys 1 to 12 *<S-F1>*
451<Help> help key
452<Undo> undo key
453<Insert> insert key
454<Home> home *home*
455<End> end *end*
456<PageUp> page-up *page_up* *page-up*
457<PageDown> page-down *page_down* *page-down*
458<kHome> keypad home (upper left) *keypad-home*
459<kEnd> keypad end (lower left) *keypad-end*
460<kPageUp> keypad page-up (upper right) *keypad-page-up*
461<kPageDown> keypad page-down (lower right) *keypad-page-down*
462<kPlus> keypad + *keypad-plus*
463<kMinus> keypad - *keypad-minus*
464<kMultiply> keypad * *keypad-multiply*
465<kDivide> keypad / *keypad-divide*
466<kEnter> keypad Enter *keypad-enter*
467<kPoint> keypad Decimal point *keypad-point*
468<k0> - <k9> keypad 0 to 9 *keypad-0* *keypad-9*
469<S-...> shift-key *shift* *<S-*
470<C-...> control-key *control* *ctrl* *<C-*
471<M-...> alt-key or meta-key *meta* *alt* *<M-*
472<A-...> same as <M-...> *<A-*
473<D-...> command-key (Macintosh only) *<D-*
474<t_xx> key with "xx" entry in termcap
475-----------------------------------------------------------------------
476
477Note: The shifted cursor keys, the help key, and the undo key are only
478available on a few terminals. On the Amiga, shifted function key 10 produces
479a code (CSI) that is also used by key sequences. It will be recognized only
480after typing another key.
481
482Note: There are two codes for the delete key. 127 is the decimal ASCII value
483for the delete key, which is always recognized. Some delete keys send another
484value, in which case this value is obtained from the termcap entry "kD". Both
485values have the same effect. Also see |:fixdel|.
486
487Note: The keypad keys are used in the same way as the corresponding "normal"
488keys. For example, <kHome> has the same effect as <Home>. If a keypad key
489sends the same raw key code as its non-keypad equivalent, it will be
490recognized as the non-keypad code. For example, when <kHome> sends the same
491code as <Home>, when pressing <kHome> Vim will think <Home> was pressed.
492Mapping <kHome> will not work then.
493
494 *<>*
495Examples are often given in the <> notation. Sometimes this is just to make
496clear what you need to type, but often it can be typed literally, e.g., with
497the ":map" command. The rules are:
498 1. Any printable characters are typed directly, except backslash and '<'
499 2. A backslash is represented with "\\", double backslash, or "<Bslash>".
500 3. A real '<' is represented with "\<" or "<lt>". When there is no
501 confusion possible, a '<' can be used directly.
502 4. "<key>" means the special key typed. This is the notation explained in
503 the table above. A few examples:
504 <Esc> Escape key
505 <C-G> CTRL-G
506 <Up> cursor up key
507 <C-LeftMouse> Control- left mouse click
508 <S-F11> Shifted function key 11
509 <M-a> Meta- a ('a' with bit 8 set)
510 <M-A> Meta- A ('A' with bit 8 set)
511 <t_kd> "kd" termcap entry (cursor down key)
512
513If you want to use the full <> notation in Vim, you have to make sure the '<'
514flag is excluded from 'cpoptions' (when 'compatible' is not set, it already is
515by default). >
516 :set cpo-=<
517The <> notation uses <lt> to escape the special meaning of key names. Using a
518backslash also works, but only when 'cpoptions' does not include the 'B' flag.
519
520Examples for mapping CTRL-H to the six characters "<Home>": >
521 :imap <C-H> \<Home>
522 :imap <C-H> <lt>Home>
523The first one only works when the 'B' flag is not in 'cpoptions'. The second
524one always works.
525To get a literal "<lt>" in a mapping: >
526 :map <C-L> <lt>lt>
527
528For mapping, abbreviation and menu commands you can then copy-paste the
529examples and use them directly. Or type them literally, including the '<' and
530'>' characters. This does NOT work for other commands, like ":set" and
531":autocmd"!
532
533==============================================================================
5345. Modes, introduction *vim-modes-intro* *vim-modes*
535
536Vim has six BASIC modes:
537
538 *Normal* *Normal-mode* *command-mode*
539Normal mode In Normal mode you can enter all the normal editor
540 commands. If you start the editor you are in this
541 mode (unless you have set the 'insertmode' option,
542 see below). This is also known as command mode.
543
544Visual mode This is like Normal mode, but the movement commands
545 extend a highlighted area. When a non-movement
546 command is used, it is executed for the highlighted
547 area. See |Visual-mode|.
548 If the 'showmode' option is on "-- VISUAL --" is shown
549 at the bottom of the window.
550
551Select mode This looks most like the MS-Windows selection mode.
552 Typing a printable character deletes the selection
553 and starts Insert mode. See |Select-mode|.
554 If the 'showmode' option is on "-- SELECT --" is shown
555 at the bottom of the window.
556
557Insert mode In Insert mode the text you type is inserted into the
558 buffer. See |Insert-mode|.
559 If the 'showmode' option is on "-- INSERT --" is shown
560 at the bottom of the window.
561
562Command-line mode In Command-line mode (also called Cmdline mode) you
563Cmdline mode can enter one line of text at the bottom of the
564 window. This is for the Ex commands, ":", the pattern
565 search commands, "?" and "/", and the filter command,
566 "!". |Cmdline-mode|
567
568Ex mode Like Command-line mode, but after entering a command
569 you remain in Ex mode. Very limited editing of the
570 command line. |Ex-mode|
571
572There are five ADDITIONAL modes. These are variants of the BASIC modes:
573
574 *Operator-pending* *Operator-pending-mode*
575Operator-pending mode This is like Normal mode, but after an operator
576 command has started, and Vim is waiting for a {motion}
577 to specify the text that the operator will work on.
578
579Replace mode Replace mode is a special case of Insert mode. You
580 can do the same things as in Insert mode, but for
581 each character you enter, one character of the existing
582 text is deleted. See |Replace-mode|.
583 If the 'showmode' option is on "-- REPLACE --" is
584 shown at the bottom of the window.
585
586Insert Normal mode Entered when CTRL-O given in Insert mode. This is
587 like Normal mode, but after executing one command Vim
588 returns to Insert mode.
589 If the 'showmode' option is on "-- (insert) --" is
590 shown at the bottom of the window.
591
592Insert Visual mode Entered when starting a Visual selection from Insert
593 mode, e.g., by using CTRL-O and then "v", "V" or
594 CTRL-V. When the Visual selection ends, Vim returns
595 to Insert mode.
596 If the 'showmode' option is on "-- (insert) VISUAL --"
597 is shown at the bottom of the window.
598
599Insert Select mode Entered when starting Select mode from Insert mode.
600 E.g., by dragging the mouse or <S-Right>.
601 When the Select mode ends, Vim returns to Insert mode.
602 If the 'showmode' option is on "-- (insert) SELECT --"
603 is shown at the bottom of the window.
604
605==============================================================================
6066. Switching from mode to mode *mode-switching*
607
608If for any reason you do not know which mode you are in, you can always get
609back to Normal mode by typing <Esc> twice. This doesn't work for Ex mode
610though, use ":visual".
611You will know you are back in Normal mode when you see the screen flash or
612hear the bell after you type <Esc>. However, when pressing <Esc> after using
613CTRL-O in Insert mode you get a beep but you are still in Insert mode, type
614<Esc> again.
615
616 *i_esc*
617 TO mode ~
618 Normal Visual Select Insert Replace Cmd-line Ex ~
619FROM mode ~
620Normal v V ^V *4 *1 R : / ? ! Q
621Visual *2 ^G c C -- : --
622Select *5 ^O ^G *6 -- -- --
623Insert <Esc> -- -- <Insert> -- --
624Replace <Esc> -- -- <Insert> -- --
625Command-line *3 -- -- :start -- --
626Ex :vi -- -- -- -- --
627
628- NA
629-- not possible
630
631*1 Go from Normal mode to Insert mode by giving the command "i", "I", "a",
632 "A", "o", "O", "c", "C", "s" or S".
633*2 Go from Visual mode to Normal mode by giving a non-movement command, which
634 causes the command to be executed, or by hitting <Esc> "v", "V" or "CTRL-V"
635 (see |v_v|), which just stops Visual mode without side effects.
636*3 Go from Command-line mode to Normal mode by:
637 - Hitting <CR> or <NL>, which causes the entered command to be executed.
638 - Deleting the complete line (e.g., with CTRL-U) and giving a final <BS>.
639 - Hitting CTRL-C or <Esc>, which quits the command-line without executing
640 the command.
641 In the last case <Esc> may be the character defined with the 'wildchar'
642 option, in which case it will start command-line completion. You can
643 ignore that and type <Esc> again. {Vi: when hitting <Esc> the command-line
644 is executed. This is unexpected for most people; therefore it was changed
645 in Vim. But when the <Esc> is part of a mapping, the command-line is
646 executed. If you want the Vi behaviour also when typing <Esc>, use ":cmap
647 ^V<Esc> ^V^M"}
648*4 Go from Normal to Select mode by:
649 - use the mouse to select text while 'selectmode' contains "mouse"
650 - use a non-printable command to move the cursor while keeping the Shift
651 key pressed, and the 'selectmode' option contains "key"
652 - use "v", "V" or "CTRL-V" while 'selectmode' contains "cmd"
653 - use "gh", "gH" or "g CTRL-H" |g_CTRL-H|
654*5 Go from Select mode to Normal mode by using a non-printable command to move
655 the cursor, without keeping the Shift key pressed.
656*6 Go from Select mode to Insert mode by typing a printable character. The
657 selection is deleted and the character is inserted.
658
659If the 'insertmode' option is on, editing a file will start in Insert mode.
660
661 *CTRL-\_CTRL-N* *i_CTRL-\_CTRL-N* *c_CTRL-\_CTRL-N* *v_CTRL-\_CTRL-N*
662Additionally the command CTRL-\ CTRL-N or <C-\><C-N> can be used to go to
663Normal mode from any other mode. This can be used to make sure Vim is in
664Normal mode, without causing a beep like <Esc> would. However, this does not
665work in Ex mode. When used after a command that takes an argument, such as
666|f| or |m|, the timeout set with 'ttimeoutlen' applies.
667
668 *CTRL-\_CTRL-G* *i_CTRL-\_CTRL-G* *c_CTRL-\_CTRL-G* *v_CTRL-\_CTRL-G*
669The command CTRL-\ CTRL-G or <C-\><C-G> can be used to go to Insert mode when
670'insertmode' is set. Otherwise it goes to Normal mode. This can be used to
671make sure Vim is in the mode indicated by 'insertmode', without knowing in
672what mode Vim currently is.
673
674 *Q* *mode-Ex* *Ex-mode* *Ex* *EX* *E501*
675Q Switch to "Ex" mode. This is a bit like typing ":"
676 commands one after another, except:
677 - You don't have to keep pressing ":".
678 - The screen doesn't get updated after each command.
679 - There is no normal command-line editing.
680 - Mappings and abbreviations are not used.
681 In fact, you are editing the lines with the "standard"
682 line-input editing commands (<Del> or <BS> to erase,
683 CTRL-U to kill the whole line).
684 Vim will enter this mode by default if it's invoked as
685 "ex" on the command-line.
686 Use the ":vi" command |:visual| to exit "Ex" mode.
687 Note: In older versions of Vim "Q" formatted text,
688 that is now done with |gq|. But if you use the
689 |vimrc_example.vim| script "Q" works like "gq".
690
691 *gQ*
692gQ Switch to "Ex" mode, but really behave like typing ":"
693 commands after another. All command line editing,
694 completion etc. is available.
695 Use the ":vi" command |:visual| to exit "Ex" mode.
696 {not in Vi}
697
698==============================================================================
6997. The window contents *window-contents*
700
701In Normal mode and Insert/Replace mode the screen window will show the current
702contents of the buffer: What You See Is What You Get. There are two
703exceptions:
704- When the 'cpoptions' option contains '$', and the change is within one line,
705 the text is not directly deleted, but a '$' is put at the last deleted
706 character.
707- When inserting text in one window, other windows on the same text are not
708 updated until the insert is finished.
709{Vi: The screen is not always updated on slow terminals}
710
711Lines longer than the window width will wrap, unless the 'wrap' option is off
712(see below). The 'linebreak' option can be set to wrap at a blank character.
713
714If the window has room after the last line of the buffer, Vim will show '~' in
715the first column of the last lines in the window, like this: >
716
717 +-----------------------+
718 |some line |
719 |last line |
720 |~ |
721 |~ |
722 +-----------------------+
723
724Thus the '~' lines indicate that the end of the buffer was reached.
725
726If the last line in a window doesn't fit, Vim will indicate this with a '@' in
727the first column of the last lines in the window, like this: >
728
729 +-----------------------+
730 |first line |
731 |second line |
732 |@ |
733 |@ |
734 +-----------------------+
735
736Thus the '@' lines indicate that there is a line that doesn't fit in the
737window.
738
739When the "lastline" flag is present in the 'display' option, you will not see
740'@' characters at the left side of window. If the last line doesn't fit
741completely, only the part that fits is shown, and the last three characters of
742the last line are replaced with "@@@", like this: >
743
744 +-----------------------+
745 |first line |
746 |second line |
747 |a very long line that d|
748 |oesn't fit in the wi@@@|
749 +-----------------------+
750
751If there is a single line that is too long to fit in the window, this is a
752special situation. Vim will show only part of the line, around where the
753cursor is. There are no special characters shown, so that you can edit all
754parts of this line.
755{Vi: gives an "internal error" on lines that do not fit in the window}
756
757The '@' occasion in the 'highlight' option can be used to set special
758highlighting for the '@' and '~' characters. This makes it possible to
759distinguish them from real characters in the buffer.
760
761The 'showbreak' option contains the string to put in front of wrapped lines.
762
763 *wrap-off*
764If the 'wrap' option is off, long lines will not wrap. Only the part that
765fits on the screen is shown. If the cursor is moved to a part of the line
766that is not shown, the screen is scrolled horizontally. The advantage of
767this method is that columns are shown as they are and lines that cannot fit
768on the screen can be edited. The disadvantage is that you cannot see all the
769characters of a line at once. The 'sidescroll' option can be set to the
770minimal number of columns to scroll. {Vi: has no 'wrap' option}
771
772All normal ASCII characters are displayed directly on the screen. The <Tab>
773is replaced with the number of spaces that it represents. Other non-printing
774characters are replaced with "^{char}", where {char} is the non-printing
775character with 64 added. Thus character 7 (bell) will be shown as "^G".
776Characters between 127 and 160 are replaced with "~{char}", where {char} is
777the character with 64 subtracted. These characters occupy more than one
778position on the screen. The cursor can only be positioned on the first one.
779
780If you set the 'number' option, all lines will be preceded with their
781number. Tip: If you don't like wrapping lines to mix with the line numbers,
782set the 'showbreak' option to eight spaces:
783 ":set showbreak=\ \ \ \ \ \ \ \ "
784
785If you set the 'list' option, <Tab> characters will not be shown as several
786spaces, but as "^I". A '$' will be placed at the end of the line, so you can
787find trailing blanks.
788
789In Command-line mode only the command-line itself is shown correctly. The
790display of the buffer contents is updated as soon as you go back to Command
791mode.
792
793The last line of the window is used for status and other messages. The
794status messages will only be used if an option is on:
795
796status message option default Unix default ~
797current mode 'showmode' on on
798command characters 'showcmd' on off
799cursor position 'ruler' off off
800
801The current mode is "-- INSERT --" or "-- REPLACE --", see |'showmode'|. The
802command characters are those that you typed but were not used yet. {Vi: does
803not show the characters you typed or the cursor position}
804
805If you have a slow terminal you can switch off the status messages to speed
806up editing:
807 :set nosc noru nosm
808
809If there is an error, an error message will be shown for at least one second
810(in reverse video). {Vi: error messages may be overwritten with other
811messages before you have a chance to read them}
812
813Some commands show how many lines were affected. Above which threshold this
814happens can be controlled with the 'report' option (default 2).
815
816On the Amiga Vim will run in a CLI window. The name Vim and the full name of
817the current file name will be shown in the title bar. When the window is
818resized, Vim will automatically redraw the window. You may make the window as
819small as you like, but if it gets too small not a single line will fit in it.
820Make it at least 40 characters wide to be able to read most messages on the
821last line.
822
823On most Unix systems, resizing the window is recognized and handled correctly
824by Vim. {Vi: not ok}
825
826==============================================================================
8278. Definitions *definitions*
828
829 screen The whole area that Vim uses to work in. This can be
830 a terminal emulator window. Also called "the Vim
831 window".
832 window A view on a buffer.
833
834A screen contains one or more windows, separated by status lines and with the
835command line at the bottom.
836
837 +-------------------------------+
838screen | window 1 | window 2 |
839 | | |
840 | | |
841 |= status line =|= status line =|
842 | window 3 |
843 | |
844 | |
845 |==== status line ==============|
846 |command line |
847 +-------------------------------+
848
849The command line is also used for messages. It scrolls up the screen when
850there is not enough room in the command line.
851
852A difference is made between four types of lines:
853
854 buffer lines The lines in the buffer. This is the same as the
855 lines as they are read from/written to a file. They
856 can be thousands of characters long.
857 logical lines The buffer lines with folding applied. Buffer lines
858 in a closed fold are changed to a single logical line:
859 "+-- 99 lines folded". They can be thousands of
860 characters long.
861 window lines The lines displayed in a window: A range of logical
862 lines with wrapping, line breaks, etc. applied. They
863 can only be as long as the width of the window allows,
864 longer lines are wrapped or truncated.
865 screen lines The lines of the screen that Vim uses. Consists of
866 the window lines of all windows, with status lines
867 and the command line added. They can only be as long
868 as the width of the screen allows. When the command
869 line gets longer it wraps and lines are scrolled to
870 make room.
871
872buffer lines logical lines window lines screen lines ~
873
8741. one 1. one 1. +-- folded 1. +-- folded
8752. two 2. +-- folded 2. five 2. five
8763. three 3. five 3. six 3. six
8774. four 4. six 4. seven 4. seven
8785. five 5. seven 5. === status line ===
8796. six 6. aaa
8807. seven 7. bbb
881 8. ccc ccc c
8821. aaa 1. aaa 1. aaa 9. cc
8832. bbb 2. bbb 2. bbb 10. ddd
8843. ccc ccc ccc 3. ccc ccc ccc 3. ccc ccc c 11. ~
8854. ddd 4. ddd 4. cc 12. === status line ===
886 5. ddd 13. (command line)
887 6. ~
888
889==============================================================================
890 vim:tw=78:ts=8:ft=help:norl: