blob: 5f051e74da6c97a70bb282710e7d2dd7d517c1a3 [file] [log] [blame]
Bram Moolenaar4c05fa02019-01-01 15:32:17 +01001*intro.txt* For Vim version 8.1. Last change: 2019 Jan 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
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +010046 *pronounce*
47Vim is pronounced as one word, like Jim, not vi-ai-em. It's written with a
48capital, since it's a name, again like Jim.
49
Bram Moolenaar071d4272004-06-13 20:20:40 +000050This manual is a reference for all the Vim commands and options. This is not
51an introduction to the use of Vi or Vim, it gets a bit complicated here and
52there. For beginners, there is a hands-on |tutor|. To learn using Vim, read
53the user manual |usr_toc.txt|.
54
Bram Moolenaar4c05fa02019-01-01 15:32:17 +010055 *book* *books*
56Most books on Vi and Vim contain a section for beginners. Others are spending
57more words on specific functionality. You can find an overview of Vim books
58here:
59 http://iccf-holland.org/vim_books.html
Bram Moolenaar071d4272004-06-13 20:20:40 +000060
61==============================================================================
622. Vim on the internet *internet*
63
Bram Moolenaarfc1421e2006-04-20 22:17:20 +000064 *www* *WWW* *faq* *FAQ* *distribution* *download*
Bram Moolenaar071d4272004-06-13 20:20:40 +000065The Vim pages contain the most recent information about Vim. They also
66contain links to the most recent version of Vim. The FAQ is a list of
67Frequently Asked Questions. Read this if you have problems.
68
Bram Moolenaar4c05fa02019-01-01 15:32:17 +010069 Vim home page: https://www.vim.org/
70 Vim FAQ: https://vimhelp.appspot.com/vim_faq.txt.html
71 Downloading: https://www.vim.org/download.php
Bram Moolenaar071d4272004-06-13 20:20:40 +000072
73
74Usenet News group where Vim is discussed: *news* *usenet*
75 comp.editors
76This group is also for other editors. If you write about Vim, don't forget to
77mention that.
78
79 *mail-list* *maillist*
80There are several mailing lists for Vim:
Bram Moolenaar68563932017-01-10 13:31:15 +010081<vim@vim.org> *vim-use* *vim_use*
Bram Moolenaar071d4272004-06-13 20:20:40 +000082 For discussions about using existing versions of Vim: Useful mappings,
Bram Moolenaarc6fe9192006-04-09 21:54:49 +000083 questions, answers, where to get a specific version, etc. There are
84 quite a few people watching this list and answering questions, also
85 for beginners. Don't hesitate to ask your question here.
Bram Moolenaar68563932017-01-10 13:31:15 +010086<vim-dev@vim.org> *vim-dev* *vim_dev* *vimdev*
Bram Moolenaar071d4272004-06-13 20:20:40 +000087 For discussions about changing Vim: New features, porting, patches,
88 beta-test versions, etc.
Bram Moolenaar68563932017-01-10 13:31:15 +010089<vim-announce@vim.org> *vim-announce* *vim_announce*
Bram Moolenaar071d4272004-06-13 20:20:40 +000090 Announcements about new versions of Vim; also for beta-test versions
Bram Moolenaarc6fe9192006-04-09 21:54:49 +000091 and ports to different systems. This is a read-only list.
Bram Moolenaar68563932017-01-10 13:31:15 +010092<vim-mac@vim.org> *vim-mac* *vim_mac*
Bram Moolenaar071d4272004-06-13 20:20:40 +000093 For discussions about using and improving the Macintosh version of
94 Vim.
95
96See http://www.vim.org/maillist.php for the latest information.
97
98NOTE:
Bram Moolenaar4c05fa02019-01-01 15:32:17 +010099- Anyone can see the archive, e.g. on Google groups. Search this if you have
100 questions.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000101- You can only send messages to these lists if you have subscribed!
Bram Moolenaar4c05fa02019-01-01 15:32:17 +0100102- The first message is moderated, thus it may take a few hours to show up.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000103- You need to send the messages from the same location as where you subscribed
104 from (to avoid spam mail).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000105
106 *subscribe-maillist*
107If you want to join, send a message to
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000108 <vim-subscribe@vim.org>
Bram Moolenaar071d4272004-06-13 20:20:40 +0000109Make sure that your "From:" address is correct. Then the list server will
110give you help on how to subscribe.
111
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000112 *maillist-archive*
113For more information and archives look on the Vim maillist page:
114http://www.vim.org/maillist.php
Bram Moolenaar071d4272004-06-13 20:20:40 +0000115
116
117Bug reports: *bugs* *bug-reports* *bugreport.vim*
118
Bram Moolenaar3e496b02016-09-25 22:11:48 +0200119There are two ways to report bugs, both work:
1201. Send bug reports to: Vim Developers <vim-dev@vim.org>
121 This is a maillist, you need to become a member first and many people will
122 see the message. If you don't want that, e.g. because it is a security
123 issue, send it to <bugs@vim.org>, this only goes to the Vim maintainer
124 (that's Bram).
Bram Moolenaar40962ec2018-01-28 22:47:25 +01001252. Open an issue on GitHub: https://github.com/vim/vim/issues
Bram Moolenaar3e496b02016-09-25 22:11:48 +0200126 The text will be forwarded to the vim-dev maillist.
Bram Moolenaar822ff862014-06-12 21:46:14 +0200127
Bram Moolenaar071d4272004-06-13 20:20:40 +0000128Please be brief; all the time that is spent on answering mail is subtracted
129from the time that is spent on improving Vim! Always give a reproducible
Bram Moolenaarb6e0ec62017-07-23 22:12:20 +0200130example and try to find out which settings or other things trigger the bug.
131
132Preferably start Vim with: >
133 vim --clean -u reproduce.vim
134Where reproduce.vim is a script that reproduces the problem. Try different
135machines, if relevant (is this an MS-Windows specific bug perhaps?).
136
Bram Moolenaar4c05fa02019-01-01 15:32:17 +0100137Send me patches if you can! If you create a pull request on
138https://github.com/vim/vim then the automated checks will run and report any
139obvious problems. But you can also send the patch by email (use an attachment
140to avoid white space changes).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000141
Bram Moolenaare344bea2005-09-01 20:46:49 +0000142It will help to include information about the version of Vim you are using and
143your setup. You can get the information with this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144 :so $VIMRUNTIME/bugreport.vim
145This will create a file "bugreport.txt" in the current directory, with a lot
146of information of your environment. Before sending this out, check if it
147doesn't contain any confidential information!
148
Bram Moolenaare344bea2005-09-01 20:46:49 +0000149If Vim crashes, please try to find out where. You can find help on this here:
150|debug.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000151
Bram Moolenaare344bea2005-09-01 20:46:49 +0000152In case of doubt or when you wonder if the problem has already been fixed but
153you can't find a fix for it, become a member of the vim-dev maillist and ask
154your question there. |maillist|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000155
156 *year-2000* *Y2K*
157Since Vim internally doesn't use dates for editing, there is no year 2000
158problem to worry about. Vim does use the time in the form of seconds since
159January 1st 1970. It is used for a time-stamp check of the edited file and
160the swap file, which is not critical and should only cause warning messages.
161
162There might be a year 2038 problem, when the seconds don't fit in a 32 bit int
163anymore. This depends on the compiler, libraries and operating system.
164Specifically, time_t and the ctime() function are used. And the time_t is
165stored in four bytes in the swap file. But that's only used for printing a
166file date/time for recovery, it will never affect normal editing.
167
168The Vim strftime() function directly uses the strftime() system function.
169localtime() uses the time() system function. getftime() uses the time
170returned by the stat() system function. If your system libraries are year
1712000 compliant, Vim is too.
172
173The user may create scripts for Vim that use external commands. These might
174introduce Y2K problems, but those are not really part of Vim itself.
175
176==============================================================================
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00001773. Credits *credits* *author* *Bram* *Moolenaar*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178
Bram Moolenaar4c05fa02019-01-01 15:32:17 +0100179Most of Vim was created by Bram Moolenaar <Bram@vim.org>.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000180
181Parts of the documentation come from several Vi manuals, written by:
182 W.N. Joy
183 Alan P.W. Hewett
184 Mark Horton
185
186The Vim editor is based on Stevie and includes (ideas from) other software,
187worked on by the people mentioned here. Other people helped by sending me
188patches, suggestions and giving feedback about what is good and bad in Vim.
189
190Vim would never have become what it is now, without the help of these people!
191
192 Ron Aaron Win32 GUI changes
Bram Moolenaar91604412010-06-03 20:25:18 +0200193 Mohsin Ahmed encryption
Bram Moolenaar071d4272004-06-13 20:20:40 +0000194 Zoltan Arpadffy work on VMS port
195 Tony Andrews Stevie
196 Gert van Antwerpen changes for DJGPP on MS-DOS
197 Berkeley DB(3) ideas for swap file implementation
198 Keith Bostic Nvi
199 Walter Briscoe Makefile updates, various patches
200 Ralf Brown SPAWNO library for MS-DOS
201 Robert Colon many useful remarks
202 Marcin Dalecki GTK+ GUI port, toolbar icons, gettext()
203 Kayhan Demirel sent me news in Uganda
204 Chris & John Downey xvi (ideas for multi-windows version)
205 Henk Elbers first VMS port
Bram Moolenaar7b0294c2004-10-11 10:16:09 +0000206 Daniel Elstner GTK+ 2 port
Bram Moolenaar071d4272004-06-13 20:20:40 +0000207 Eric Fischer Mac port, 'cindent', and other improvements
208 Benji Fisher Answering lots of user questions
209 Bill Foster Athena GUI port
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000210 Google Lets me work on Vim one day a week
Bram Moolenaar071d4272004-06-13 20:20:40 +0000211 Loic Grenie xvim (ideas for multi windows version)
Bram Moolenaarc236c162008-07-13 17:41:49 +0000212 Sven Guckes Vim promoter and previous WWW page maintainer
Bram Moolenaar071d4272004-06-13 20:20:40 +0000213 Darren Hiebert Exuberant ctags
Bram Moolenaar7b0294c2004-10-11 10:16:09 +0000214 Jason Hildebrand GTK+ 2 port
Bram Moolenaar071d4272004-06-13 20:20:40 +0000215 Bruce Hunsaker improvements for VMS port
216 Andy Kahn Cscope support, GTK+ GUI port
217 Oezguer Kesim Maintainer of Vim Mailing Lists
218 Axel Kielhorn work on the Macintosh port
219 Steve Kirkendall Elvis
220 Roger Knobbe original port to Windows NT
221 Sergey Laskavy Vim's help from Moscow
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000222 Felix von Leitner Previous maintainer of Vim Mailing Lists
Bram Moolenaar071d4272004-06-13 20:20:40 +0000223 David Leonard Port of Python extensions to Unix
224 Avner Lottem Edit in right-to-left windows
225 Flemming Madsen X11 client-server, various features and patches
Bram Moolenaar91604412010-06-03 20:25:18 +0200226 Tony Mechelynck answers many user questions
Bram Moolenaar071d4272004-06-13 20:20:40 +0000227 Paul Moore Python interface extensions, many patches
228 Katsuhito Nagano Work on multi-byte versions
229 Sung-Hyun Nam Work on multi-byte versions
230 Vince Negri Win32 GUI and generic console enhancements
231 Steve Oualline Author of the first Vim book |frombook|
Bram Moolenaar91604412010-06-03 20:25:18 +0200232 Dominique Pelle valgrind reports and many fixes
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000233 A.Politz Many bug reports and some fixes
Bram Moolenaar071d4272004-06-13 20:20:40 +0000234 George V. Reilly Win32 port, Win32 GUI start-off
235 Stephen Riehm bug collector
236 Stefan Roemer various patches and help to users
237 Ralf Schandl IBM OS/390 port
238 Olaf Seibert DICE and BeBox version, regexp improvements
239 Mortaza Shiran Farsi patches
240 Peter da Silva termlib
241 Paul Slootman OS/2 port
242 Henry Spencer regular expressions
243 Dany St-Amant Macintosh port
244 Tim Thompson Stevie
245 G. R. (Fred) Walter Stevie
246 Sven Verdoolaege Perl interface
247 Robert Webb Command-line completion, GUI versions, and
248 lots of patches
249 Ingo Wilken Tcl interface
250 Mike Williams PostScript printing
251 Juergen Weigert Lattice version, AUX improvements, UNIX and
252 MS-DOS ports, autoconf
253 Stefan 'Sec' Zehl Maintainer of vim.org
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200254 Yasuhiro Matsumoto many MS-Windows improvements
255 Ken Takata fixes and features
256 Kazunobu Kuriyama GTK 3
257 Christian Brabandt many fixes, features, user support, etc.
Bram Moolenaar4c05fa02019-01-01 15:32:17 +0100258 Yegappan Lakshmanan many quickfix features
Bram Moolenaar071d4272004-06-13 20:20:40 +0000259
260I wish to thank all the people that sent me bug reports and suggestions. The
261list is too long to mention them all here. Vim would not be the same without
262the ideas from all these people: They keep Vim alive!
Bram Moolenaar56b45b92013-06-24 22:22:18 +0200263*love* *peace* *friendship* *gross-national-happiness*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000264
265
266In this documentation there are several references to other versions of Vi:
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000267 *Vi* *vi*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268Vi "the original". Without further remarks this is the version
269 of Vi that appeared in Sun OS 4.x. ":version" returns
270 "Version 3.7, 6/7/85". Sometimes other versions are referred
271 to. Only runs under Unix. Source code only available with a
272 license. More information on Vi can be found through:
273 http://vi-editor.org [doesn't currently work...]
274 *Posix*
275Posix From the IEEE standard 1003.2, Part 2: Shell and utilities.
276 Generally known as "Posix". This is a textual description of
277 how Vi is supposed to work.
Bram Moolenaar7c626922005-02-07 22:01:03 +0000278 See |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000279 *Nvi*
280Nvi The "New" Vi. The version of Vi that comes with BSD 4.4 and FreeBSD.
281 Very good compatibility with the original Vi, with a few extensions.
282 The version used is 1.79. ":version" returns "Version 1.79
283 (10/23/96)". There has been no release the last few years, although
284 there is a development version 1.81.
285 Source code is freely available.
286 *Elvis*
287Elvis Another Vi clone, made by Steve Kirkendall. Very compact but isn't
288 as flexible as Vim.
289 The version used is 2.1. It is still being developed. Source code is
290 freely available.
Bram Moolenaar4c05fa02019-01-01 15:32:17 +0100291 *NeoVim*
292NeoVim A Vim clone. Forked the Vim source in 2014 and went a different way.
293 Very much bound to github and has many more dependencies, making
294 development more complex and limiting portability. Code has been
295 refactored, resulting in patches not being exchangeable with Vim.
296 Supports a remote GUI and integration with scripting languages.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000297
298==============================================================================
2994. Notation *notation*
300
301When syntax highlighting is used to read this, text that is not typed
302literally is often highlighted with the Special group. These are items in [],
303{} and <>, and CTRL-X.
304
305Note that Vim uses all possible characters in commands. Sometimes the [], {}
306and <> are part of what you type, the context should make this clear.
307
308
309[] Characters in square brackets are optional.
310
Bram Moolenaar4a748032010-09-30 21:47:56 +0200311 *count* *[count]*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000312[count] An optional number that may precede the command to multiply
313 or iterate the command. If no number is given, a count of one
314 is used, unless otherwise noted. Note that in this manual the
315 [count] is not mentioned in the description of the command,
316 but only in the explanation. This was done to make the
317 commands easier to look up. If the 'showcmd' option is on,
318 the (partially) entered count is shown at the bottom of the
319 window. You can use <Del> to erase the last digit (|N<Del>|).
320
321 *[quotex]*
322["x] An optional register designation where text can be stored.
323 See |registers|. The x is a single character between 'a' and
324 'z' or 'A' and 'Z' or '"', and in some cases (with the put
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000325 command) between '0' and '9', '%', '#', or others. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000326 uppercase and lowercase letter designate the same register,
327 but the lowercase letter is used to overwrite the previous
328 register contents, while the uppercase letter is used to
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000329 append to the previous register contents. Without the ""x" or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000330 with """" the stored text is put into the unnamed register.
331
332 *{}*
333{} Curly braces denote parts of the command which must appear,
334 but which can take a number of different values. The
335 differences between Vim and Vi are also given in curly braces
336 (this will be clear from the context).
337
338 *{char1-char2}*
339{char1-char2} A single character from the range char1 to char2. For
340 example: {a-z} is a lowercase letter. Multiple ranges may be
341 concatenated. For example, {a-zA-Z0-9} is any alphanumeric
342 character.
343
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000344 *{motion}* *movement*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000345{motion} A command that moves the cursor. These are explained in
346 |motion.txt|. Examples:
347 w to start of next word
348 b to begin of current word
349 4j four lines down
350 /The<CR> to next occurrence of "The"
351 This is used after an |operator| command to move over the text
352 that is to be operated upon.
353 - If the motion includes a count and the operator also has a
354 count, the two counts are multiplied. For example: "2d3w"
355 deletes six words.
356 - The motion can be backwards, e.g. "db" to delete to the
357 start of the word.
358 - The motion can also be a mouse click. The mouse is not
359 supported in every terminal though.
360 - The ":omap" command can be used to map characters while an
361 operator is pending.
362 - Ex commands can be used to move the cursor. This can be
363 used to call a function that does some complicated motion.
364 The motion is always characterwise exclusive, no matter
365 what ":" command is used. This means it's impossible to
366 include the last character of a line without the line break
367 (unless 'virtualedit' is set).
368 If the Ex command changes the text before where the operator
369 starts or jumps to another buffer the result is
370 unpredictable. It is possible to change the text further
371 down. Jumping to another buffer is possible if the current
372 buffer is not unloaded.
373
374 *{Visual}*
375{Visual} A selected text area. It is started with the "v", "V", or
376 CTRL-V command, then any cursor movement command can be used
377 to change the end of the selected text.
378 This is used before an |operator| command to highlight the
379 text that is to be operated upon.
380 See |Visual-mode|.
381
382 *<character>*
383<character> A special character from the table below, optionally with
384 modifiers, or a single ASCII character with modifiers.
385
386 *'character'*
387'c' A single ASCII character.
388
389 *CTRL-{char}*
390CTRL-{char} {char} typed as a control character; that is, typing {char}
391 while holding the CTRL key down. The case of {char} does not
392 matter; thus CTRL-A and CTRL-a are equivalent. But on some
393 terminals, using the SHIFT key will produce another code,
394 don't use it then.
395
396 *'option'*
397'option' An option, or parameter, that can be set to a value, is
398 enclosed in single quotes. See |options|.
399
400 *quotecommandquote*
401"command" A reference to a command that you can type is enclosed in
402 double quotes.
Bram Moolenaar00154502013-02-13 16:15:55 +0100403`command` New style command, this distinguishes it from other quoted
404 text and strings.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000405
406 *key-notation* *key-codes* *keycodes*
407These names for keys are used in the documentation. They can also be used
408with the ":map" command (insert the key name by pressing CTRL-K and then the
409key you want the name for).
410
411notation meaning equivalent decimal value(s) ~
412-----------------------------------------------------------------------
413<Nul> zero CTRL-@ 0 (stored as 10) *<Nul>*
414<BS> backspace CTRL-H 8 *backspace*
415<Tab> tab CTRL-I 9 *tab* *Tab*
416 *linefeed*
417<NL> linefeed CTRL-J 10 (used for <Nul>)
418<FF> formfeed CTRL-L 12 *formfeed*
419<CR> carriage return CTRL-M 13 *carriage-return*
420<Return> same as <CR> *<Return>*
421<Enter> same as <CR> *<Enter>*
422<Esc> escape CTRL-[ 27 *escape* *<Esc>*
423<Space> space 32 *space*
424<lt> less-than < 60 *<lt>*
425<Bslash> backslash \ 92 *backslash* *<Bslash>*
426<Bar> vertical bar | 124 *<Bar>*
427<Del> delete 127
428<CSI> command sequence intro ALT-Esc 155 *<CSI>*
429<xCSI> CSI when typed in the GUI *<xCSI>*
430
431<EOL> end-of-line (can be <CR>, <LF> or <CR><LF>,
432 depends on system and 'fileformat') *<EOL>*
433
434<Up> cursor-up *cursor-up* *cursor_up*
435<Down> cursor-down *cursor-down* *cursor_down*
436<Left> cursor-left *cursor-left* *cursor_left*
437<Right> cursor-right *cursor-right* *cursor_right*
438<S-Up> shift-cursor-up
439<S-Down> shift-cursor-down
440<S-Left> shift-cursor-left
441<S-Right> shift-cursor-right
442<C-Left> control-cursor-left
443<C-Right> control-cursor-right
444<F1> - <F12> function keys 1 to 12 *function_key* *function-key*
445<S-F1> - <S-F12> shift-function keys 1 to 12 *<S-F1>*
446<Help> help key
447<Undo> undo key
448<Insert> insert key
449<Home> home *home*
450<End> end *end*
451<PageUp> page-up *page_up* *page-up*
452<PageDown> page-down *page_down* *page-down*
453<kHome> keypad home (upper left) *keypad-home*
454<kEnd> keypad end (lower left) *keypad-end*
455<kPageUp> keypad page-up (upper right) *keypad-page-up*
456<kPageDown> keypad page-down (lower right) *keypad-page-down*
457<kPlus> keypad + *keypad-plus*
458<kMinus> keypad - *keypad-minus*
459<kMultiply> keypad * *keypad-multiply*
460<kDivide> keypad / *keypad-divide*
461<kEnter> keypad Enter *keypad-enter*
462<kPoint> keypad Decimal point *keypad-point*
463<k0> - <k9> keypad 0 to 9 *keypad-0* *keypad-9*
464<S-...> shift-key *shift* *<S-*
465<C-...> control-key *control* *ctrl* *<C-*
466<M-...> alt-key or meta-key *meta* *alt* *<M-*
467<A-...> same as <M-...> *<A-*
468<D-...> command-key (Macintosh only) *<D-*
469<t_xx> key with "xx" entry in termcap
470-----------------------------------------------------------------------
471
472Note: The shifted cursor keys, the help key, and the undo key are only
473available on a few terminals. On the Amiga, shifted function key 10 produces
474a code (CSI) that is also used by key sequences. It will be recognized only
475after typing another key.
476
477Note: There are two codes for the delete key. 127 is the decimal ASCII value
478for the delete key, which is always recognized. Some delete keys send another
479value, in which case this value is obtained from the termcap entry "kD". Both
480values have the same effect. Also see |:fixdel|.
481
482Note: The keypad keys are used in the same way as the corresponding "normal"
483keys. For example, <kHome> has the same effect as <Home>. If a keypad key
484sends the same raw key code as its non-keypad equivalent, it will be
485recognized as the non-keypad code. For example, when <kHome> sends the same
486code as <Home>, when pressing <kHome> Vim will think <Home> was pressed.
487Mapping <kHome> will not work then.
488
489 *<>*
490Examples are often given in the <> notation. Sometimes this is just to make
491clear what you need to type, but often it can be typed literally, e.g., with
492the ":map" command. The rules are:
493 1. Any printable characters are typed directly, except backslash and '<'
494 2. A backslash is represented with "\\", double backslash, or "<Bslash>".
495 3. A real '<' is represented with "\<" or "<lt>". When there is no
496 confusion possible, a '<' can be used directly.
497 4. "<key>" means the special key typed. This is the notation explained in
498 the table above. A few examples:
499 <Esc> Escape key
500 <C-G> CTRL-G
501 <Up> cursor up key
502 <C-LeftMouse> Control- left mouse click
503 <S-F11> Shifted function key 11
504 <M-a> Meta- a ('a' with bit 8 set)
505 <M-A> Meta- A ('A' with bit 8 set)
506 <t_kd> "kd" termcap entry (cursor down key)
507
508If you want to use the full <> notation in Vim, you have to make sure the '<'
509flag is excluded from 'cpoptions' (when 'compatible' is not set, it already is
510by default). >
511 :set cpo-=<
512The <> notation uses <lt> to escape the special meaning of key names. Using a
513backslash also works, but only when 'cpoptions' does not include the 'B' flag.
514
515Examples for mapping CTRL-H to the six characters "<Home>": >
516 :imap <C-H> \<Home>
517 :imap <C-H> <lt>Home>
518The first one only works when the 'B' flag is not in 'cpoptions'. The second
519one always works.
520To get a literal "<lt>" in a mapping: >
521 :map <C-L> <lt>lt>
522
523For mapping, abbreviation and menu commands you can then copy-paste the
524examples and use them directly. Or type them literally, including the '<' and
525'>' characters. This does NOT work for other commands, like ":set" and
526":autocmd"!
527
528==============================================================================
5295. Modes, introduction *vim-modes-intro* *vim-modes*
530
Bram Moolenaar1ccd8ff2017-08-11 19:50:37 +0200531Vim has seven BASIC modes:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000532
533 *Normal* *Normal-mode* *command-mode*
534Normal mode In Normal mode you can enter all the normal editor
535 commands. If you start the editor you are in this
536 mode (unless you have set the 'insertmode' option,
537 see below). This is also known as command mode.
538
539Visual mode This is like Normal mode, but the movement commands
540 extend a highlighted area. When a non-movement
541 command is used, it is executed for the highlighted
542 area. See |Visual-mode|.
543 If the 'showmode' option is on "-- VISUAL --" is shown
544 at the bottom of the window.
545
546Select mode This looks most like the MS-Windows selection mode.
547 Typing a printable character deletes the selection
548 and starts Insert mode. See |Select-mode|.
549 If the 'showmode' option is on "-- SELECT --" is shown
550 at the bottom of the window.
551
552Insert mode In Insert mode the text you type is inserted into the
553 buffer. See |Insert-mode|.
554 If the 'showmode' option is on "-- INSERT --" is shown
555 at the bottom of the window.
556
557Command-line mode In Command-line mode (also called Cmdline mode) you
558Cmdline mode can enter one line of text at the bottom of the
559 window. This is for the Ex commands, ":", the pattern
560 search commands, "?" and "/", and the filter command,
561 "!". |Cmdline-mode|
562
563Ex mode Like Command-line mode, but after entering a command
564 you remain in Ex mode. Very limited editing of the
565 command line. |Ex-mode|
566
Bram Moolenaar1ccd8ff2017-08-11 19:50:37 +0200567Terminal-Job mode Interacting with a job in a terminal window. Typed
568 keys go to the job and the job output is displayed in
569 the terminal window. See |terminal| about how to
570 switch to other modes.
571
Bram Moolenaarf55e4c82017-08-01 20:44:53 +0200572There are seven ADDITIONAL modes. These are variants of the BASIC modes:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000573
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
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000586Virtual Replace mode Virtual Replace mode is similar to Replace mode, but
587 instead of file characters you are replacing screen
588 real estate. See |Virtual-Replace-mode|.
589 If the 'showmode' option is on "-- VREPLACE --" is
590 shown at the bottom of the window.
591
Bram Moolenaard473c8c2018-08-11 18:00:22 +0200592Insert Normal mode Entered when CTRL-O is typed in Insert mode (see
593 |i_CTRL-O|). This is like Normal mode, but after
594 executing one command Vim returns to Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000595 If the 'showmode' option is on "-- (insert) --" is
596 shown at the bottom of the window.
597
Bram Moolenaar1ccd8ff2017-08-11 19:50:37 +0200598Terminal-Normal mode Using Normal mode in a terminal window. Making
599 changes is impossible. Use an insert command, such as
600 "a" or "i", to return to Terminal-Job mode.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +0200601
Bram Moolenaar071d4272004-06-13 20:20:40 +0000602Insert Visual mode Entered when starting a Visual selection from Insert
603 mode, e.g., by using CTRL-O and then "v", "V" or
604 CTRL-V. When the Visual selection ends, Vim returns
605 to Insert mode.
606 If the 'showmode' option is on "-- (insert) VISUAL --"
607 is shown at the bottom of the window.
608
609Insert Select mode Entered when starting Select mode from Insert mode.
610 E.g., by dragging the mouse or <S-Right>.
611 When the Select mode ends, Vim returns to Insert mode.
612 If the 'showmode' option is on "-- (insert) SELECT --"
613 is shown at the bottom of the window.
614
615==============================================================================
6166. Switching from mode to mode *mode-switching*
617
618If for any reason you do not know which mode you are in, you can always get
619back to Normal mode by typing <Esc> twice. This doesn't work for Ex mode
620though, use ":visual".
621You will know you are back in Normal mode when you see the screen flash or
622hear the bell after you type <Esc>. However, when pressing <Esc> after using
623CTRL-O in Insert mode you get a beep but you are still in Insert mode, type
624<Esc> again.
625
626 *i_esc*
627 TO mode ~
628 Normal Visual Select Insert Replace Cmd-line Ex ~
629FROM mode ~
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000630Normal v V ^V *4 *1 R gR : / ? ! Q
Bram Moolenaar071d4272004-06-13 20:20:40 +0000631Visual *2 ^G c C -- : --
632Select *5 ^O ^G *6 -- -- --
633Insert <Esc> -- -- <Insert> -- --
634Replace <Esc> -- -- <Insert> -- --
635Command-line *3 -- -- :start -- --
636Ex :vi -- -- -- -- --
637
Bram Moolenaar071d4272004-06-13 20:20:40 +0000638-- not possible
639
640*1 Go from Normal mode to Insert mode by giving the command "i", "I", "a",
641 "A", "o", "O", "c", "C", "s" or S".
642*2 Go from Visual mode to Normal mode by giving a non-movement command, which
643 causes the command to be executed, or by hitting <Esc> "v", "V" or "CTRL-V"
644 (see |v_v|), which just stops Visual mode without side effects.
645*3 Go from Command-line mode to Normal mode by:
646 - Hitting <CR> or <NL>, which causes the entered command to be executed.
647 - Deleting the complete line (e.g., with CTRL-U) and giving a final <BS>.
648 - Hitting CTRL-C or <Esc>, which quits the command-line without executing
649 the command.
650 In the last case <Esc> may be the character defined with the 'wildchar'
651 option, in which case it will start command-line completion. You can
652 ignore that and type <Esc> again. {Vi: when hitting <Esc> the command-line
653 is executed. This is unexpected for most people; therefore it was changed
654 in Vim. But when the <Esc> is part of a mapping, the command-line is
655 executed. If you want the Vi behaviour also when typing <Esc>, use ":cmap
656 ^V<Esc> ^V^M"}
657*4 Go from Normal to Select mode by:
658 - use the mouse to select text while 'selectmode' contains "mouse"
659 - use a non-printable command to move the cursor while keeping the Shift
660 key pressed, and the 'selectmode' option contains "key"
661 - use "v", "V" or "CTRL-V" while 'selectmode' contains "cmd"
662 - use "gh", "gH" or "g CTRL-H" |g_CTRL-H|
663*5 Go from Select mode to Normal mode by using a non-printable command to move
664 the cursor, without keeping the Shift key pressed.
665*6 Go from Select mode to Insert mode by typing a printable character. The
666 selection is deleted and the character is inserted.
667
668If the 'insertmode' option is on, editing a file will start in Insert mode.
669
670 *CTRL-\_CTRL-N* *i_CTRL-\_CTRL-N* *c_CTRL-\_CTRL-N* *v_CTRL-\_CTRL-N*
671Additionally the command CTRL-\ CTRL-N or <C-\><C-N> can be used to go to
672Normal mode from any other mode. This can be used to make sure Vim is in
673Normal mode, without causing a beep like <Esc> would. However, this does not
674work in Ex mode. When used after a command that takes an argument, such as
675|f| or |m|, the timeout set with 'ttimeoutlen' applies.
Bram Moolenaar1ccd8ff2017-08-11 19:50:37 +0200676When focus is in a terminal window, CTRL-\ CTRL-N goes to Normal mode for only
677one command, see |t_CTRL-\_CTRL-N|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000678
679 *CTRL-\_CTRL-G* *i_CTRL-\_CTRL-G* *c_CTRL-\_CTRL-G* *v_CTRL-\_CTRL-G*
680The command CTRL-\ CTRL-G or <C-\><C-G> can be used to go to Insert mode when
681'insertmode' is set. Otherwise it goes to Normal mode. This can be used to
682make sure Vim is in the mode indicated by 'insertmode', without knowing in
683what mode Vim currently is.
684
685 *Q* *mode-Ex* *Ex-mode* *Ex* *EX* *E501*
686Q Switch to "Ex" mode. This is a bit like typing ":"
687 commands one after another, except:
688 - You don't have to keep pressing ":".
689 - The screen doesn't get updated after each command.
690 - There is no normal command-line editing.
691 - Mappings and abbreviations are not used.
692 In fact, you are editing the lines with the "standard"
693 line-input editing commands (<Del> or <BS> to erase,
694 CTRL-U to kill the whole line).
695 Vim will enter this mode by default if it's invoked as
696 "ex" on the command-line.
697 Use the ":vi" command |:visual| to exit "Ex" mode.
698 Note: In older versions of Vim "Q" formatted text,
699 that is now done with |gq|. But if you use the
700 |vimrc_example.vim| script "Q" works like "gq".
701
702 *gQ*
Bram Moolenaar7c626922005-02-07 22:01:03 +0000703gQ Switch to "Ex" mode like with "Q", but really behave
704 like typing ":" commands after another. All command
705 line editing, completion etc. is available.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000706 Use the ":vi" command |:visual| to exit "Ex" mode.
707 {not in Vi}
708
709==============================================================================
7107. The window contents *window-contents*
711
712In Normal mode and Insert/Replace mode the screen window will show the current
713contents of the buffer: What You See Is What You Get. There are two
714exceptions:
715- When the 'cpoptions' option contains '$', and the change is within one line,
716 the text is not directly deleted, but a '$' is put at the last deleted
717 character.
718- When inserting text in one window, other windows on the same text are not
719 updated until the insert is finished.
720{Vi: The screen is not always updated on slow terminals}
721
722Lines longer than the window width will wrap, unless the 'wrap' option is off
723(see below). The 'linebreak' option can be set to wrap at a blank character.
724
725If the window has room after the last line of the buffer, Vim will show '~' in
Bram Moolenaar166af9b2010-11-16 20:34:40 +0100726the first column of the last lines in the window, like this:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000727
728 +-----------------------+
729 |some line |
730 |last line |
731 |~ |
732 |~ |
733 +-----------------------+
734
735Thus the '~' lines indicate that the end of the buffer was reached.
736
737If the last line in a window doesn't fit, Vim will indicate this with a '@' in
Bram Moolenaar166af9b2010-11-16 20:34:40 +0100738the first column of the last lines in the window, like this:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000739
740 +-----------------------+
741 |first line |
742 |second line |
743 |@ |
744 |@ |
745 +-----------------------+
746
747Thus the '@' lines indicate that there is a line that doesn't fit in the
748window.
749
750When the "lastline" flag is present in the 'display' option, you will not see
751'@' characters at the left side of window. If the last line doesn't fit
752completely, only the part that fits is shown, and the last three characters of
Bram Moolenaar81af9252010-12-10 20:35:50 +0100753the last line are replaced with "@@@", like this:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000754
755 +-----------------------+
756 |first line |
757 |second line |
758 |a very long line that d|
759 |oesn't fit in the wi@@@|
760 +-----------------------+
761
762If there is a single line that is too long to fit in the window, this is a
763special situation. Vim will show only part of the line, around where the
764cursor is. There are no special characters shown, so that you can edit all
765parts of this line.
766{Vi: gives an "internal error" on lines that do not fit in the window}
767
768The '@' occasion in the 'highlight' option can be used to set special
769highlighting for the '@' and '~' characters. This makes it possible to
770distinguish them from real characters in the buffer.
771
772The 'showbreak' option contains the string to put in front of wrapped lines.
773
774 *wrap-off*
775If the 'wrap' option is off, long lines will not wrap. Only the part that
776fits on the screen is shown. If the cursor is moved to a part of the line
777that is not shown, the screen is scrolled horizontally. The advantage of
778this method is that columns are shown as they are and lines that cannot fit
779on the screen can be edited. The disadvantage is that you cannot see all the
780characters of a line at once. The 'sidescroll' option can be set to the
781minimal number of columns to scroll. {Vi: has no 'wrap' option}
782
783All normal ASCII characters are displayed directly on the screen. The <Tab>
784is replaced with the number of spaces that it represents. Other non-printing
785characters are replaced with "^{char}", where {char} is the non-printing
786character with 64 added. Thus character 7 (bell) will be shown as "^G".
787Characters between 127 and 160 are replaced with "~{char}", where {char} is
788the character with 64 subtracted. These characters occupy more than one
789position on the screen. The cursor can only be positioned on the first one.
790
791If you set the 'number' option, all lines will be preceded with their
792number. Tip: If you don't like wrapping lines to mix with the line numbers,
793set the 'showbreak' option to eight spaces:
794 ":set showbreak=\ \ \ \ \ \ \ \ "
795
796If you set the 'list' option, <Tab> characters will not be shown as several
797spaces, but as "^I". A '$' will be placed at the end of the line, so you can
798find trailing blanks.
799
800In Command-line mode only the command-line itself is shown correctly. The
801display of the buffer contents is updated as soon as you go back to Command
802mode.
803
804The last line of the window is used for status and other messages. The
805status messages will only be used if an option is on:
806
807status message option default Unix default ~
808current mode 'showmode' on on
809command characters 'showcmd' on off
810cursor position 'ruler' off off
811
812The current mode is "-- INSERT --" or "-- REPLACE --", see |'showmode'|. The
813command characters are those that you typed but were not used yet. {Vi: does
814not show the characters you typed or the cursor position}
815
816If you have a slow terminal you can switch off the status messages to speed
817up editing:
818 :set nosc noru nosm
819
820If there is an error, an error message will be shown for at least one second
821(in reverse video). {Vi: error messages may be overwritten with other
822messages before you have a chance to read them}
823
824Some commands show how many lines were affected. Above which threshold this
825happens can be controlled with the 'report' option (default 2).
826
827On the Amiga Vim will run in a CLI window. The name Vim and the full name of
828the current file name will be shown in the title bar. When the window is
829resized, Vim will automatically redraw the window. You may make the window as
830small as you like, but if it gets too small not a single line will fit in it.
831Make it at least 40 characters wide to be able to read most messages on the
832last line.
833
834On most Unix systems, resizing the window is recognized and handled correctly
835by Vim. {Vi: not ok}
836
837==============================================================================
8388. Definitions *definitions*
839
Bram Moolenaarc572da52017-08-27 16:52:01 +0200840 buffer Contains lines of text, usually read from a file.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000841 screen The whole area that Vim uses to work in. This can be
842 a terminal emulator window. Also called "the Vim
843 window".
Bram Moolenaarc572da52017-08-27 16:52:01 +0200844 window A view on a buffer. There can be multiple windows for
845 one buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000846
847A screen contains one or more windows, separated by status lines and with the
848command line at the bottom.
849
850 +-------------------------------+
851screen | window 1 | window 2 |
852 | | |
853 | | |
854 |= status line =|= status line =|
855 | window 3 |
856 | |
857 | |
858 |==== status line ==============|
859 |command line |
860 +-------------------------------+
861
862The command line is also used for messages. It scrolls up the screen when
863there is not enough room in the command line.
864
865A difference is made between four types of lines:
866
867 buffer lines The lines in the buffer. This is the same as the
868 lines as they are read from/written to a file. They
869 can be thousands of characters long.
870 logical lines The buffer lines with folding applied. Buffer lines
871 in a closed fold are changed to a single logical line:
872 "+-- 99 lines folded". They can be thousands of
873 characters long.
874 window lines The lines displayed in a window: A range of logical
875 lines with wrapping, line breaks, etc. applied. They
876 can only be as long as the width of the window allows,
877 longer lines are wrapped or truncated.
878 screen lines The lines of the screen that Vim uses. Consists of
879 the window lines of all windows, with status lines
880 and the command line added. They can only be as long
881 as the width of the screen allows. When the command
882 line gets longer it wraps and lines are scrolled to
883 make room.
884
885buffer lines logical lines window lines screen lines ~
886
8871. one 1. one 1. +-- folded 1. +-- folded
8882. two 2. +-- folded 2. five 2. five
8893. three 3. five 3. six 3. six
8904. four 4. six 4. seven 4. seven
8915. five 5. seven 5. === status line ===
8926. six 6. aaa
8937. seven 7. bbb
894 8. ccc ccc c
8951. aaa 1. aaa 1. aaa 9. cc
8962. bbb 2. bbb 2. bbb 10. ddd
8973. ccc ccc ccc 3. ccc ccc ccc 3. ccc ccc c 11. ~
8984. ddd 4. ddd 4. cc 12. === status line ===
899 5. ddd 13. (command line)
900 6. ~
901
902==============================================================================
Bram Moolenaar91f84f62018-07-29 15:07:52 +0200903 vim:tw=78:ts=8:noet:ft=help:norl: