blob: e9fe36937ae0685c12667a71847cbf63f8987665 [file] [log] [blame]
Bram Moolenaar3991dab2006-03-27 17:01:56 +00001*intro.txt* For Vim version 7.0c. Last change: 2005 Sep 01
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
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
Bram Moolenaare344bea2005-09-01 20:46:49 +0000154It will help to include information about the version of Vim you are using and
155your setup. You can get the information with this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000156 :so $VIMRUNTIME/bugreport.vim
157This will create a file "bugreport.txt" in the current directory, with a lot
158of information of your environment. Before sending this out, check if it
159doesn't contain any confidential information!
160
Bram Moolenaare344bea2005-09-01 20:46:49 +0000161If Vim crashes, please try to find out where. You can find help on this here:
162|debug.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000163
Bram Moolenaare344bea2005-09-01 20:46:49 +0000164In case of doubt or when you wonder if the problem has already been fixed but
165you can't find a fix for it, become a member of the vim-dev maillist and ask
166your question there. |maillist|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000167
168 *year-2000* *Y2K*
169Since Vim internally doesn't use dates for editing, there is no year 2000
170problem to worry about. Vim does use the time in the form of seconds since
171January 1st 1970. It is used for a time-stamp check of the edited file and
172the swap file, which is not critical and should only cause warning messages.
173
174There might be a year 2038 problem, when the seconds don't fit in a 32 bit int
175anymore. This depends on the compiler, libraries and operating system.
176Specifically, time_t and the ctime() function are used. And the time_t is
177stored in four bytes in the swap file. But that's only used for printing a
178file date/time for recovery, it will never affect normal editing.
179
180The Vim strftime() function directly uses the strftime() system function.
181localtime() uses the time() system function. getftime() uses the time
182returned by the stat() system function. If your system libraries are year
1832000 compliant, Vim is too.
184
185The user may create scripts for Vim that use external commands. These might
186introduce Y2K problems, but those are not really part of Vim itself.
187
188==============================================================================
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00001893. Credits *credits* *author* *Bram* *Moolenaar*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000190
191Most of Vim was written by Bram Moolenaar <Bram@vim.org>.
192
193Parts of the documentation come from several Vi manuals, written by:
194 W.N. Joy
195 Alan P.W. Hewett
196 Mark Horton
197
198The Vim editor is based on Stevie and includes (ideas from) other software,
199worked on by the people mentioned here. Other people helped by sending me
200patches, suggestions and giving feedback about what is good and bad in Vim.
201
202Vim would never have become what it is now, without the help of these people!
203
204 Ron Aaron Win32 GUI changes
205 Zoltan Arpadffy work on VMS port
206 Tony Andrews Stevie
207 Gert van Antwerpen changes for DJGPP on MS-DOS
208 Berkeley DB(3) ideas for swap file implementation
209 Keith Bostic Nvi
210 Walter Briscoe Makefile updates, various patches
211 Ralf Brown SPAWNO library for MS-DOS
212 Robert Colon many useful remarks
213 Marcin Dalecki GTK+ GUI port, toolbar icons, gettext()
214 Kayhan Demirel sent me news in Uganda
215 Chris & John Downey xvi (ideas for multi-windows version)
216 Henk Elbers first VMS port
Bram Moolenaar7b0294c2004-10-11 10:16:09 +0000217 Daniel Elstner GTK+ 2 port
Bram Moolenaar071d4272004-06-13 20:20:40 +0000218 Eric Fischer Mac port, 'cindent', and other improvements
219 Benji Fisher Answering lots of user questions
220 Bill Foster Athena GUI port
221 Loic Grenie xvim (ideas for multi windows version)
222 Sven Guckes Vim promotor and previous WWW page maintainer
223 Darren Hiebert Exuberant ctags
Bram Moolenaar7b0294c2004-10-11 10:16:09 +0000224 Jason Hildebrand GTK+ 2 port
Bram Moolenaar071d4272004-06-13 20:20:40 +0000225 Bruce Hunsaker improvements for VMS port
226 Andy Kahn Cscope support, GTK+ GUI port
227 Oezguer Kesim Maintainer of Vim Mailing Lists
228 Axel Kielhorn work on the Macintosh port
229 Steve Kirkendall Elvis
230 Roger Knobbe original port to Windows NT
231 Sergey Laskavy Vim's help from Moscow
232 Felix von Leitner Maintainer of Vim Mailing Lists
233 David Leonard Port of Python extensions to Unix
234 Avner Lottem Edit in right-to-left windows
235 Flemming Madsen X11 client-server, various features and patches
236 MicroSoft Gave me a copy of DevStudio to compile Vim with
237 Paul Moore Python interface extensions, many patches
238 Katsuhito Nagano Work on multi-byte versions
239 Sung-Hyun Nam Work on multi-byte versions
240 Vince Negri Win32 GUI and generic console enhancements
241 Steve Oualline Author of the first Vim book |frombook|
242 George V. Reilly Win32 port, Win32 GUI start-off
243 Stephen Riehm bug collector
244 Stefan Roemer various patches and help to users
245 Ralf Schandl IBM OS/390 port
246 Olaf Seibert DICE and BeBox version, regexp improvements
247 Mortaza Shiran Farsi patches
248 Peter da Silva termlib
249 Paul Slootman OS/2 port
250 Henry Spencer regular expressions
251 Dany St-Amant Macintosh port
252 Tim Thompson Stevie
253 G. R. (Fred) Walter Stevie
254 Sven Verdoolaege Perl interface
255 Robert Webb Command-line completion, GUI versions, and
256 lots of patches
257 Ingo Wilken Tcl interface
258 Mike Williams PostScript printing
259 Juergen Weigert Lattice version, AUX improvements, UNIX and
260 MS-DOS ports, autoconf
261 Stefan 'Sec' Zehl Maintainer of vim.org
262
263I wish to thank all the people that sent me bug reports and suggestions. The
264list is too long to mention them all here. Vim would not be the same without
265the ideas from all these people: They keep Vim alive!
266
267
268In this documentation there are several references to other versions of Vi:
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000269 *Vi* *vi*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000270Vi "the original". Without further remarks this is the version
271 of Vi that appeared in Sun OS 4.x. ":version" returns
272 "Version 3.7, 6/7/85". Sometimes other versions are referred
273 to. Only runs under Unix. Source code only available with a
274 license. More information on Vi can be found through:
275 http://vi-editor.org [doesn't currently work...]
276 *Posix*
277Posix From the IEEE standard 1003.2, Part 2: Shell and utilities.
278 Generally known as "Posix". This is a textual description of
279 how Vi is supposed to work.
Bram Moolenaar7c626922005-02-07 22:01:03 +0000280 See |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000281 *Nvi*
282Nvi The "New" Vi. The version of Vi that comes with BSD 4.4 and FreeBSD.
283 Very good compatibility with the original Vi, with a few extensions.
284 The version used is 1.79. ":version" returns "Version 1.79
285 (10/23/96)". There has been no release the last few years, although
286 there is a development version 1.81.
287 Source code is freely available.
288 *Elvis*
289Elvis Another Vi clone, made by Steve Kirkendall. Very compact but isn't
290 as flexible as Vim.
291 The version used is 2.1. It is still being developed. Source code is
292 freely available.
293
294==============================================================================
2954. Notation *notation*
296
297When syntax highlighting is used to read this, text that is not typed
298literally is often highlighted with the Special group. These are items in [],
299{} and <>, and CTRL-X.
300
301Note that Vim uses all possible characters in commands. Sometimes the [], {}
302and <> are part of what you type, the context should make this clear.
303
304
305[] Characters in square brackets are optional.
306
307 *count* *[count]* *E489*
308[count] An optional number that may precede the command to multiply
309 or iterate the command. If no number is given, a count of one
310 is used, unless otherwise noted. Note that in this manual the
311 [count] is not mentioned in the description of the command,
312 but only in the explanation. This was done to make the
313 commands easier to look up. If the 'showcmd' option is on,
314 the (partially) entered count is shown at the bottom of the
315 window. You can use <Del> to erase the last digit (|N<Del>|).
316
317 *[quotex]*
318["x] An optional register designation where text can be stored.
319 See |registers|. The x is a single character between 'a' and
320 'z' or 'A' and 'Z' or '"', and in some cases (with the put
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000321 command) between '0' and '9', '%', '#', or others. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000322 uppercase and lowercase letter designate the same register,
323 but the lowercase letter is used to overwrite the previous
324 register contents, while the uppercase letter is used to
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000325 append to the previous register contents. Without the ""x" or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000326 with """" the stored text is put into the unnamed register.
327
328 *{}*
329{} Curly braces denote parts of the command which must appear,
330 but which can take a number of different values. The
331 differences between Vim and Vi are also given in curly braces
332 (this will be clear from the context).
333
334 *{char1-char2}*
335{char1-char2} A single character from the range char1 to char2. For
336 example: {a-z} is a lowercase letter. Multiple ranges may be
337 concatenated. For example, {a-zA-Z0-9} is any alphanumeric
338 character.
339
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000340 *{motion}* *movement*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000341{motion} A command that moves the cursor. These are explained in
342 |motion.txt|. Examples:
343 w to start of next word
344 b to begin of current word
345 4j four lines down
346 /The<CR> to next occurrence of "The"
347 This is used after an |operator| command to move over the text
348 that is to be operated upon.
349 - If the motion includes a count and the operator also has a
350 count, the two counts are multiplied. For example: "2d3w"
351 deletes six words.
352 - The motion can be backwards, e.g. "db" to delete to the
353 start of the word.
354 - The motion can also be a mouse click. The mouse is not
355 supported in every terminal though.
356 - The ":omap" command can be used to map characters while an
357 operator is pending.
358 - Ex commands can be used to move the cursor. This can be
359 used to call a function that does some complicated motion.
360 The motion is always characterwise exclusive, no matter
361 what ":" command is used. This means it's impossible to
362 include the last character of a line without the line break
363 (unless 'virtualedit' is set).
364 If the Ex command changes the text before where the operator
365 starts or jumps to another buffer the result is
366 unpredictable. It is possible to change the text further
367 down. Jumping to another buffer is possible if the current
368 buffer is not unloaded.
369
370 *{Visual}*
371{Visual} A selected text area. It is started with the "v", "V", or
372 CTRL-V command, then any cursor movement command can be used
373 to change the end of the selected text.
374 This is used before an |operator| command to highlight the
375 text that is to be operated upon.
376 See |Visual-mode|.
377
378 *<character>*
379<character> A special character from the table below, optionally with
380 modifiers, or a single ASCII character with modifiers.
381
382 *'character'*
383'c' A single ASCII character.
384
385 *CTRL-{char}*
386CTRL-{char} {char} typed as a control character; that is, typing {char}
387 while holding the CTRL key down. The case of {char} does not
388 matter; thus CTRL-A and CTRL-a are equivalent. But on some
389 terminals, using the SHIFT key will produce another code,
390 don't use it then.
391
392 *'option'*
393'option' An option, or parameter, that can be set to a value, is
394 enclosed in single quotes. See |options|.
395
396 *quotecommandquote*
397"command" A reference to a command that you can type is enclosed in
398 double quotes.
399
400 *key-notation* *key-codes* *keycodes*
401These names for keys are used in the documentation. They can also be used
402with the ":map" command (insert the key name by pressing CTRL-K and then the
403key you want the name for).
404
405notation meaning equivalent decimal value(s) ~
406-----------------------------------------------------------------------
407<Nul> zero CTRL-@ 0 (stored as 10) *<Nul>*
408<BS> backspace CTRL-H 8 *backspace*
409<Tab> tab CTRL-I 9 *tab* *Tab*
410 *linefeed*
411<NL> linefeed CTRL-J 10 (used for <Nul>)
412<FF> formfeed CTRL-L 12 *formfeed*
413<CR> carriage return CTRL-M 13 *carriage-return*
414<Return> same as <CR> *<Return>*
415<Enter> same as <CR> *<Enter>*
416<Esc> escape CTRL-[ 27 *escape* *<Esc>*
417<Space> space 32 *space*
418<lt> less-than < 60 *<lt>*
419<Bslash> backslash \ 92 *backslash* *<Bslash>*
420<Bar> vertical bar | 124 *<Bar>*
421<Del> delete 127
422<CSI> command sequence intro ALT-Esc 155 *<CSI>*
423<xCSI> CSI when typed in the GUI *<xCSI>*
424
425<EOL> end-of-line (can be <CR>, <LF> or <CR><LF>,
426 depends on system and 'fileformat') *<EOL>*
427
428<Up> cursor-up *cursor-up* *cursor_up*
429<Down> cursor-down *cursor-down* *cursor_down*
430<Left> cursor-left *cursor-left* *cursor_left*
431<Right> cursor-right *cursor-right* *cursor_right*
432<S-Up> shift-cursor-up
433<S-Down> shift-cursor-down
434<S-Left> shift-cursor-left
435<S-Right> shift-cursor-right
436<C-Left> control-cursor-left
437<C-Right> control-cursor-right
438<F1> - <F12> function keys 1 to 12 *function_key* *function-key*
439<S-F1> - <S-F12> shift-function keys 1 to 12 *<S-F1>*
440<Help> help key
441<Undo> undo key
442<Insert> insert key
443<Home> home *home*
444<End> end *end*
445<PageUp> page-up *page_up* *page-up*
446<PageDown> page-down *page_down* *page-down*
447<kHome> keypad home (upper left) *keypad-home*
448<kEnd> keypad end (lower left) *keypad-end*
449<kPageUp> keypad page-up (upper right) *keypad-page-up*
450<kPageDown> keypad page-down (lower right) *keypad-page-down*
451<kPlus> keypad + *keypad-plus*
452<kMinus> keypad - *keypad-minus*
453<kMultiply> keypad * *keypad-multiply*
454<kDivide> keypad / *keypad-divide*
455<kEnter> keypad Enter *keypad-enter*
456<kPoint> keypad Decimal point *keypad-point*
457<k0> - <k9> keypad 0 to 9 *keypad-0* *keypad-9*
458<S-...> shift-key *shift* *<S-*
459<C-...> control-key *control* *ctrl* *<C-*
460<M-...> alt-key or meta-key *meta* *alt* *<M-*
461<A-...> same as <M-...> *<A-*
462<D-...> command-key (Macintosh only) *<D-*
463<t_xx> key with "xx" entry in termcap
464-----------------------------------------------------------------------
465
466Note: The shifted cursor keys, the help key, and the undo key are only
467available on a few terminals. On the Amiga, shifted function key 10 produces
468a code (CSI) that is also used by key sequences. It will be recognized only
469after typing another key.
470
471Note: There are two codes for the delete key. 127 is the decimal ASCII value
472for the delete key, which is always recognized. Some delete keys send another
473value, in which case this value is obtained from the termcap entry "kD". Both
474values have the same effect. Also see |:fixdel|.
475
476Note: The keypad keys are used in the same way as the corresponding "normal"
477keys. For example, <kHome> has the same effect as <Home>. If a keypad key
478sends the same raw key code as its non-keypad equivalent, it will be
479recognized as the non-keypad code. For example, when <kHome> sends the same
480code as <Home>, when pressing <kHome> Vim will think <Home> was pressed.
481Mapping <kHome> will not work then.
482
483 *<>*
484Examples are often given in the <> notation. Sometimes this is just to make
485clear what you need to type, but often it can be typed literally, e.g., with
486the ":map" command. The rules are:
487 1. Any printable characters are typed directly, except backslash and '<'
488 2. A backslash is represented with "\\", double backslash, or "<Bslash>".
489 3. A real '<' is represented with "\<" or "<lt>". When there is no
490 confusion possible, a '<' can be used directly.
491 4. "<key>" means the special key typed. This is the notation explained in
492 the table above. A few examples:
493 <Esc> Escape key
494 <C-G> CTRL-G
495 <Up> cursor up key
496 <C-LeftMouse> Control- left mouse click
497 <S-F11> Shifted function key 11
498 <M-a> Meta- a ('a' with bit 8 set)
499 <M-A> Meta- A ('A' with bit 8 set)
500 <t_kd> "kd" termcap entry (cursor down key)
501
502If you want to use the full <> notation in Vim, you have to make sure the '<'
503flag is excluded from 'cpoptions' (when 'compatible' is not set, it already is
504by default). >
505 :set cpo-=<
506The <> notation uses <lt> to escape the special meaning of key names. Using a
507backslash also works, but only when 'cpoptions' does not include the 'B' flag.
508
509Examples for mapping CTRL-H to the six characters "<Home>": >
510 :imap <C-H> \<Home>
511 :imap <C-H> <lt>Home>
512The first one only works when the 'B' flag is not in 'cpoptions'. The second
513one always works.
514To get a literal "<lt>" in a mapping: >
515 :map <C-L> <lt>lt>
516
517For mapping, abbreviation and menu commands you can then copy-paste the
518examples and use them directly. Or type them literally, including the '<' and
519'>' characters. This does NOT work for other commands, like ":set" and
520":autocmd"!
521
522==============================================================================
5235. Modes, introduction *vim-modes-intro* *vim-modes*
524
525Vim has six BASIC modes:
526
527 *Normal* *Normal-mode* *command-mode*
528Normal mode In Normal mode you can enter all the normal editor
529 commands. If you start the editor you are in this
530 mode (unless you have set the 'insertmode' option,
531 see below). This is also known as command mode.
532
533Visual mode This is like Normal mode, but the movement commands
534 extend a highlighted area. When a non-movement
535 command is used, it is executed for the highlighted
536 area. See |Visual-mode|.
537 If the 'showmode' option is on "-- VISUAL --" is shown
538 at the bottom of the window.
539
540Select mode This looks most like the MS-Windows selection mode.
541 Typing a printable character deletes the selection
542 and starts Insert mode. See |Select-mode|.
543 If the 'showmode' option is on "-- SELECT --" is shown
544 at the bottom of the window.
545
546Insert mode In Insert mode the text you type is inserted into the
547 buffer. See |Insert-mode|.
548 If the 'showmode' option is on "-- INSERT --" is shown
549 at the bottom of the window.
550
551Command-line mode In Command-line mode (also called Cmdline mode) you
552Cmdline mode can enter one line of text at the bottom of the
553 window. This is for the Ex commands, ":", the pattern
554 search commands, "?" and "/", and the filter command,
555 "!". |Cmdline-mode|
556
557Ex mode Like Command-line mode, but after entering a command
558 you remain in Ex mode. Very limited editing of the
559 command line. |Ex-mode|
560
561There are five ADDITIONAL modes. These are variants of the BASIC modes:
562
563 *Operator-pending* *Operator-pending-mode*
564Operator-pending mode This is like Normal mode, but after an operator
565 command has started, and Vim is waiting for a {motion}
566 to specify the text that the operator will work on.
567
568Replace mode Replace mode is a special case of Insert mode. You
569 can do the same things as in Insert mode, but for
570 each character you enter, one character of the existing
571 text is deleted. See |Replace-mode|.
572 If the 'showmode' option is on "-- REPLACE --" is
573 shown at the bottom of the window.
574
575Insert Normal mode Entered when CTRL-O given in Insert mode. This is
576 like Normal mode, but after executing one command Vim
577 returns to Insert mode.
578 If the 'showmode' option is on "-- (insert) --" is
579 shown at the bottom of the window.
580
581Insert Visual mode Entered when starting a Visual selection from Insert
582 mode, e.g., by using CTRL-O and then "v", "V" or
583 CTRL-V. When the Visual selection ends, Vim returns
584 to Insert mode.
585 If the 'showmode' option is on "-- (insert) VISUAL --"
586 is shown at the bottom of the window.
587
588Insert Select mode Entered when starting Select mode from Insert mode.
589 E.g., by dragging the mouse or <S-Right>.
590 When the Select mode ends, Vim returns to Insert mode.
591 If the 'showmode' option is on "-- (insert) SELECT --"
592 is shown at the bottom of the window.
593
594==============================================================================
5956. Switching from mode to mode *mode-switching*
596
597If for any reason you do not know which mode you are in, you can always get
598back to Normal mode by typing <Esc> twice. This doesn't work for Ex mode
599though, use ":visual".
600You will know you are back in Normal mode when you see the screen flash or
601hear the bell after you type <Esc>. However, when pressing <Esc> after using
602CTRL-O in Insert mode you get a beep but you are still in Insert mode, type
603<Esc> again.
604
605 *i_esc*
606 TO mode ~
607 Normal Visual Select Insert Replace Cmd-line Ex ~
608FROM mode ~
609Normal v V ^V *4 *1 R : / ? ! Q
610Visual *2 ^G c C -- : --
611Select *5 ^O ^G *6 -- -- --
612Insert <Esc> -- -- <Insert> -- --
613Replace <Esc> -- -- <Insert> -- --
614Command-line *3 -- -- :start -- --
615Ex :vi -- -- -- -- --
616
617- NA
618-- not possible
619
620*1 Go from Normal mode to Insert mode by giving the command "i", "I", "a",
621 "A", "o", "O", "c", "C", "s" or S".
622*2 Go from Visual mode to Normal mode by giving a non-movement command, which
623 causes the command to be executed, or by hitting <Esc> "v", "V" or "CTRL-V"
624 (see |v_v|), which just stops Visual mode without side effects.
625*3 Go from Command-line mode to Normal mode by:
626 - Hitting <CR> or <NL>, which causes the entered command to be executed.
627 - Deleting the complete line (e.g., with CTRL-U) and giving a final <BS>.
628 - Hitting CTRL-C or <Esc>, which quits the command-line without executing
629 the command.
630 In the last case <Esc> may be the character defined with the 'wildchar'
631 option, in which case it will start command-line completion. You can
632 ignore that and type <Esc> again. {Vi: when hitting <Esc> the command-line
633 is executed. This is unexpected for most people; therefore it was changed
634 in Vim. But when the <Esc> is part of a mapping, the command-line is
635 executed. If you want the Vi behaviour also when typing <Esc>, use ":cmap
636 ^V<Esc> ^V^M"}
637*4 Go from Normal to Select mode by:
638 - use the mouse to select text while 'selectmode' contains "mouse"
639 - use a non-printable command to move the cursor while keeping the Shift
640 key pressed, and the 'selectmode' option contains "key"
641 - use "v", "V" or "CTRL-V" while 'selectmode' contains "cmd"
642 - use "gh", "gH" or "g CTRL-H" |g_CTRL-H|
643*5 Go from Select mode to Normal mode by using a non-printable command to move
644 the cursor, without keeping the Shift key pressed.
645*6 Go from Select mode to Insert mode by typing a printable character. The
646 selection is deleted and the character is inserted.
647
648If the 'insertmode' option is on, editing a file will start in Insert mode.
649
650 *CTRL-\_CTRL-N* *i_CTRL-\_CTRL-N* *c_CTRL-\_CTRL-N* *v_CTRL-\_CTRL-N*
651Additionally the command CTRL-\ CTRL-N or <C-\><C-N> can be used to go to
652Normal mode from any other mode. This can be used to make sure Vim is in
653Normal mode, without causing a beep like <Esc> would. However, this does not
654work in Ex mode. When used after a command that takes an argument, such as
655|f| or |m|, the timeout set with 'ttimeoutlen' applies.
656
657 *CTRL-\_CTRL-G* *i_CTRL-\_CTRL-G* *c_CTRL-\_CTRL-G* *v_CTRL-\_CTRL-G*
658The command CTRL-\ CTRL-G or <C-\><C-G> can be used to go to Insert mode when
659'insertmode' is set. Otherwise it goes to Normal mode. This can be used to
660make sure Vim is in the mode indicated by 'insertmode', without knowing in
661what mode Vim currently is.
662
663 *Q* *mode-Ex* *Ex-mode* *Ex* *EX* *E501*
664Q Switch to "Ex" mode. This is a bit like typing ":"
665 commands one after another, except:
666 - You don't have to keep pressing ":".
667 - The screen doesn't get updated after each command.
668 - There is no normal command-line editing.
669 - Mappings and abbreviations are not used.
670 In fact, you are editing the lines with the "standard"
671 line-input editing commands (<Del> or <BS> to erase,
672 CTRL-U to kill the whole line).
673 Vim will enter this mode by default if it's invoked as
674 "ex" on the command-line.
675 Use the ":vi" command |:visual| to exit "Ex" mode.
676 Note: In older versions of Vim "Q" formatted text,
677 that is now done with |gq|. But if you use the
678 |vimrc_example.vim| script "Q" works like "gq".
679
680 *gQ*
Bram Moolenaar7c626922005-02-07 22:01:03 +0000681gQ Switch to "Ex" mode like with "Q", but really behave
682 like typing ":" commands after another. All command
683 line editing, completion etc. is available.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000684 Use the ":vi" command |:visual| to exit "Ex" mode.
685 {not in Vi}
686
687==============================================================================
6887. The window contents *window-contents*
689
690In Normal mode and Insert/Replace mode the screen window will show the current
691contents of the buffer: What You See Is What You Get. There are two
692exceptions:
693- When the 'cpoptions' option contains '$', and the change is within one line,
694 the text is not directly deleted, but a '$' is put at the last deleted
695 character.
696- When inserting text in one window, other windows on the same text are not
697 updated until the insert is finished.
698{Vi: The screen is not always updated on slow terminals}
699
700Lines longer than the window width will wrap, unless the 'wrap' option is off
701(see below). The 'linebreak' option can be set to wrap at a blank character.
702
703If the window has room after the last line of the buffer, Vim will show '~' in
704the first column of the last lines in the window, like this: >
705
706 +-----------------------+
707 |some line |
708 |last line |
709 |~ |
710 |~ |
711 +-----------------------+
712
713Thus the '~' lines indicate that the end of the buffer was reached.
714
715If the last line in a window doesn't fit, Vim will indicate this with a '@' in
716the first column of the last lines in the window, like this: >
717
718 +-----------------------+
719 |first line |
720 |second line |
721 |@ |
722 |@ |
723 +-----------------------+
724
725Thus the '@' lines indicate that there is a line that doesn't fit in the
726window.
727
728When the "lastline" flag is present in the 'display' option, you will not see
729'@' characters at the left side of window. If the last line doesn't fit
730completely, only the part that fits is shown, and the last three characters of
731the last line are replaced with "@@@", like this: >
732
733 +-----------------------+
734 |first line |
735 |second line |
736 |a very long line that d|
737 |oesn't fit in the wi@@@|
738 +-----------------------+
739
740If there is a single line that is too long to fit in the window, this is a
741special situation. Vim will show only part of the line, around where the
742cursor is. There are no special characters shown, so that you can edit all
743parts of this line.
744{Vi: gives an "internal error" on lines that do not fit in the window}
745
746The '@' occasion in the 'highlight' option can be used to set special
747highlighting for the '@' and '~' characters. This makes it possible to
748distinguish them from real characters in the buffer.
749
750The 'showbreak' option contains the string to put in front of wrapped lines.
751
752 *wrap-off*
753If the 'wrap' option is off, long lines will not wrap. Only the part that
754fits on the screen is shown. If the cursor is moved to a part of the line
755that is not shown, the screen is scrolled horizontally. The advantage of
756this method is that columns are shown as they are and lines that cannot fit
757on the screen can be edited. The disadvantage is that you cannot see all the
758characters of a line at once. The 'sidescroll' option can be set to the
759minimal number of columns to scroll. {Vi: has no 'wrap' option}
760
761All normal ASCII characters are displayed directly on the screen. The <Tab>
762is replaced with the number of spaces that it represents. Other non-printing
763characters are replaced with "^{char}", where {char} is the non-printing
764character with 64 added. Thus character 7 (bell) will be shown as "^G".
765Characters between 127 and 160 are replaced with "~{char}", where {char} is
766the character with 64 subtracted. These characters occupy more than one
767position on the screen. The cursor can only be positioned on the first one.
768
769If you set the 'number' option, all lines will be preceded with their
770number. Tip: If you don't like wrapping lines to mix with the line numbers,
771set the 'showbreak' option to eight spaces:
772 ":set showbreak=\ \ \ \ \ \ \ \ "
773
774If you set the 'list' option, <Tab> characters will not be shown as several
775spaces, but as "^I". A '$' will be placed at the end of the line, so you can
776find trailing blanks.
777
778In Command-line mode only the command-line itself is shown correctly. The
779display of the buffer contents is updated as soon as you go back to Command
780mode.
781
782The last line of the window is used for status and other messages. The
783status messages will only be used if an option is on:
784
785status message option default Unix default ~
786current mode 'showmode' on on
787command characters 'showcmd' on off
788cursor position 'ruler' off off
789
790The current mode is "-- INSERT --" or "-- REPLACE --", see |'showmode'|. The
791command characters are those that you typed but were not used yet. {Vi: does
792not show the characters you typed or the cursor position}
793
794If you have a slow terminal you can switch off the status messages to speed
795up editing:
796 :set nosc noru nosm
797
798If there is an error, an error message will be shown for at least one second
799(in reverse video). {Vi: error messages may be overwritten with other
800messages before you have a chance to read them}
801
802Some commands show how many lines were affected. Above which threshold this
803happens can be controlled with the 'report' option (default 2).
804
805On the Amiga Vim will run in a CLI window. The name Vim and the full name of
806the current file name will be shown in the title bar. When the window is
807resized, Vim will automatically redraw the window. You may make the window as
808small as you like, but if it gets too small not a single line will fit in it.
809Make it at least 40 characters wide to be able to read most messages on the
810last line.
811
812On most Unix systems, resizing the window is recognized and handled correctly
813by Vim. {Vi: not ok}
814
815==============================================================================
8168. Definitions *definitions*
817
818 screen The whole area that Vim uses to work in. This can be
819 a terminal emulator window. Also called "the Vim
820 window".
821 window A view on a buffer.
822
823A screen contains one or more windows, separated by status lines and with the
824command line at the bottom.
825
826 +-------------------------------+
827screen | window 1 | window 2 |
828 | | |
829 | | |
830 |= status line =|= status line =|
831 | window 3 |
832 | |
833 | |
834 |==== status line ==============|
835 |command line |
836 +-------------------------------+
837
838The command line is also used for messages. It scrolls up the screen when
839there is not enough room in the command line.
840
841A difference is made between four types of lines:
842
843 buffer lines The lines in the buffer. This is the same as the
844 lines as they are read from/written to a file. They
845 can be thousands of characters long.
846 logical lines The buffer lines with folding applied. Buffer lines
847 in a closed fold are changed to a single logical line:
848 "+-- 99 lines folded". They can be thousands of
849 characters long.
850 window lines The lines displayed in a window: A range of logical
851 lines with wrapping, line breaks, etc. applied. They
852 can only be as long as the width of the window allows,
853 longer lines are wrapped or truncated.
854 screen lines The lines of the screen that Vim uses. Consists of
855 the window lines of all windows, with status lines
856 and the command line added. They can only be as long
857 as the width of the screen allows. When the command
858 line gets longer it wraps and lines are scrolled to
859 make room.
860
861buffer lines logical lines window lines screen lines ~
862
8631. one 1. one 1. +-- folded 1. +-- folded
8642. two 2. +-- folded 2. five 2. five
8653. three 3. five 3. six 3. six
8664. four 4. six 4. seven 4. seven
8675. five 5. seven 5. === status line ===
8686. six 6. aaa
8697. seven 7. bbb
870 8. ccc ccc c
8711. aaa 1. aaa 1. aaa 9. cc
8722. bbb 2. bbb 2. bbb 10. ddd
8733. ccc ccc ccc 3. ccc ccc ccc 3. ccc ccc c 11. ~
8744. ddd 4. ddd 4. cc 12. === status line ===
875 5. ddd 13. (command line)
876 6. ~
877
878==============================================================================
879 vim:tw=78:ts=8:ft=help:norl: