blob: 7813177c26f20e731c675448305cb564d3f49582 [file] [log] [blame]
Bram Moolenaar9712ff12022-09-18 13:04:22 +01001*intro.txt* For Vim version 9.0. Last change: 2022 Sep 12
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
Bram Moolenaar25c9c682019-05-05 18:13:34 +020037The differences between Vi and Vim are mentioned in |vi_diff.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000038
39This manual refers to Vim on various machines. There may be small differences
40between different computers and terminals. Besides the remarks given in this
41document, there is a separate document for each supported system, see
42|sys-file-list|.
43
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +010044 *pronounce*
45Vim is pronounced as one word, like Jim, not vi-ai-em. It's written with a
46capital, since it's a name, again like Jim.
47
Bram Moolenaar071d4272004-06-13 20:20:40 +000048This manual is a reference for all the Vim commands and options. This is not
49an introduction to the use of Vi or Vim, it gets a bit complicated here and
50there. For beginners, there is a hands-on |tutor|. To learn using Vim, read
51the user manual |usr_toc.txt|.
52
Bram Moolenaar4c05fa02019-01-01 15:32:17 +010053 *book* *books*
54Most books on Vi and Vim contain a section for beginners. Others are spending
55more words on specific functionality. You can find an overview of Vim books
56here:
57 http://iccf-holland.org/vim_books.html
Bram Moolenaar071d4272004-06-13 20:20:40 +000058
59==============================================================================
602. Vim on the internet *internet*
61
Bram Moolenaarfc1421e2006-04-20 22:17:20 +000062 *www* *WWW* *faq* *FAQ* *distribution* *download*
Bram Moolenaar071d4272004-06-13 20:20:40 +000063The Vim pages contain the most recent information about Vim. They also
64contain links to the most recent version of Vim. The FAQ is a list of
65Frequently Asked Questions. Read this if you have problems.
66
Bram Moolenaar4c05fa02019-01-01 15:32:17 +010067 Vim home page: https://www.vim.org/
Bram Moolenaar6c1e1572019-06-22 02:13:00 +020068 Vim FAQ: https://vimhelp.org/vim_faq.txt.html
Bram Moolenaar4c05fa02019-01-01 15:32:17 +010069 Downloading: https://www.vim.org/download.php
Bram Moolenaar071d4272004-06-13 20:20:40 +000070
71
Bram Moolenaar790c18b2019-07-04 17:22:06 +020072Asking questions, finding answers: https://vi.stackexchange.com/
73"Vi and Vim Stack Exchange is a question and answer site for people using the
74vi and Vim families of text editors"
75
76
Bram Moolenaar071d4272004-06-13 20:20:40 +000077Usenet News group where Vim is discussed: *news* *usenet*
78 comp.editors
79This group is also for other editors. If you write about Vim, don't forget to
80mention that.
Bram Moolenaar790c18b2019-07-04 17:22:06 +020081You can access it here:
82https://groups.google.com/forum/#!topic/comp.editors
Bram Moolenaar071d4272004-06-13 20:20:40 +000083
84 *mail-list* *maillist*
85There are several mailing lists for Vim:
Bram Moolenaar68563932017-01-10 13:31:15 +010086<vim@vim.org> *vim-use* *vim_use*
Bram Moolenaar071d4272004-06-13 20:20:40 +000087 For discussions about using existing versions of Vim: Useful mappings,
Bram Moolenaarc6fe9192006-04-09 21:54:49 +000088 questions, answers, where to get a specific version, etc. There are
89 quite a few people watching this list and answering questions, also
90 for beginners. Don't hesitate to ask your question here.
Bram Moolenaar68563932017-01-10 13:31:15 +010091<vim-dev@vim.org> *vim-dev* *vim_dev* *vimdev*
Bram Moolenaar071d4272004-06-13 20:20:40 +000092 For discussions about changing Vim: New features, porting, patches,
93 beta-test versions, etc.
Bram Moolenaar68563932017-01-10 13:31:15 +010094<vim-announce@vim.org> *vim-announce* *vim_announce*
Bram Moolenaar071d4272004-06-13 20:20:40 +000095 Announcements about new versions of Vim; also for beta-test versions
Bram Moolenaarc6fe9192006-04-09 21:54:49 +000096 and ports to different systems. This is a read-only list.
Bram Moolenaar68563932017-01-10 13:31:15 +010097<vim-mac@vim.org> *vim-mac* *vim_mac*
Bram Moolenaar071d4272004-06-13 20:20:40 +000098 For discussions about using and improving the Macintosh version of
99 Vim.
100
101See http://www.vim.org/maillist.php for the latest information.
102
103NOTE:
Bram Moolenaar4c05fa02019-01-01 15:32:17 +0100104- Anyone can see the archive, e.g. on Google groups. Search this if you have
105 questions.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000106- You can only send messages to these lists if you have subscribed!
Bram Moolenaar4c05fa02019-01-01 15:32:17 +0100107- The first message is moderated, thus it may take a few hours to show up.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000108- You need to send the messages from the same location as where you subscribed
109 from (to avoid spam mail).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000110
111 *subscribe-maillist*
112If you want to join, send a message to
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000113 <vim-subscribe@vim.org>
Bram Moolenaar071d4272004-06-13 20:20:40 +0000114Make sure that your "From:" address is correct. Then the list server will
115give you help on how to subscribe.
116
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000117 *maillist-archive*
118For more information and archives look on the Vim maillist page:
119http://www.vim.org/maillist.php
Bram Moolenaar071d4272004-06-13 20:20:40 +0000120
121
122Bug reports: *bugs* *bug-reports* *bugreport.vim*
123
Bram Moolenaaracc22402020-06-07 21:07:18 +0200124There are three ways to report bugs:
1251. Open an issue on GitHub: https://github.com/vim/vim/issues
126 The text will be forwarded to the vim-dev maillist.
1272. For issues with runtime files, look in the header for an email address or
128 any other way to report it to the maintainer.
1293. Send bug reports to: Vim Developers <vim-dev@vim.org>
Bram Moolenaar3e496b02016-09-25 22:11:48 +0200130 This is a maillist, you need to become a member first and many people will
131 see the message. If you don't want that, e.g. because it is a security
132 issue, send it to <bugs@vim.org>, this only goes to the Vim maintainer
133 (that's Bram).
Bram Moolenaar822ff862014-06-12 21:46:14 +0200134
Bram Moolenaar071d4272004-06-13 20:20:40 +0000135Please be brief; all the time that is spent on answering mail is subtracted
136from the time that is spent on improving Vim! Always give a reproducible
Bram Moolenaarb6e0ec62017-07-23 22:12:20 +0200137example and try to find out which settings or other things trigger the bug.
138
139Preferably start Vim with: >
140 vim --clean -u reproduce.vim
141Where reproduce.vim is a script that reproduces the problem. Try different
142machines, if relevant (is this an MS-Windows specific bug perhaps?).
143
Bram Moolenaar4c05fa02019-01-01 15:32:17 +0100144Send me patches if you can! If you create a pull request on
145https://github.com/vim/vim then the automated checks will run and report any
146obvious problems. But you can also send the patch by email (use an attachment
147to avoid white space changes).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000148
Bram Moolenaare344bea2005-09-01 20:46:49 +0000149It will help to include information about the version of Vim you are using and
150your setup. You can get the information with this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000151 :so $VIMRUNTIME/bugreport.vim
152This will create a file "bugreport.txt" in the current directory, with a lot
153of information of your environment. Before sending this out, check if it
154doesn't contain any confidential information!
155
Bram Moolenaare344bea2005-09-01 20:46:49 +0000156If Vim crashes, please try to find out where. You can find help on this here:
157|debug.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000158
Bram Moolenaare344bea2005-09-01 20:46:49 +0000159In case of doubt or when you wonder if the problem has already been fixed but
160you can't find a fix for it, become a member of the vim-dev maillist and ask
161your question there. |maillist|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000162
163 *year-2000* *Y2K*
164Since Vim internally doesn't use dates for editing, there is no year 2000
165problem to worry about. Vim does use the time in the form of seconds since
166January 1st 1970. It is used for a time-stamp check of the edited file and
167the swap file, which is not critical and should only cause warning messages.
168
169There might be a year 2038 problem, when the seconds don't fit in a 32 bit int
170anymore. This depends on the compiler, libraries and operating system.
171Specifically, time_t and the ctime() function are used. And the time_t is
172stored in four bytes in the swap file. But that's only used for printing a
173file date/time for recovery, it will never affect normal editing.
174
175The Vim strftime() function directly uses the strftime() system function.
176localtime() uses the time() system function. getftime() uses the time
177returned by the stat() system function. If your system libraries are year
1782000 compliant, Vim is too.
179
180The user may create scripts for Vim that use external commands. These might
181introduce Y2K problems, but those are not really part of Vim itself.
182
183==============================================================================
Bram Moolenaar9ba0eb82005-06-13 22:28:56 +00001843. Credits *credits* *author* *Bram* *Moolenaar*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000185
Bram Moolenaar4c05fa02019-01-01 15:32:17 +0100186Most of Vim was created by Bram Moolenaar <Bram@vim.org>.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000187
188Parts of the documentation come from several Vi manuals, written by:
189 W.N. Joy
190 Alan P.W. Hewett
191 Mark Horton
192
193The Vim editor is based on Stevie and includes (ideas from) other software,
194worked on by the people mentioned here. Other people helped by sending me
195patches, suggestions and giving feedback about what is good and bad in Vim.
196
197Vim would never have become what it is now, without the help of these people!
198
199 Ron Aaron Win32 GUI changes
Bram Moolenaar91604412010-06-03 20:25:18 +0200200 Mohsin Ahmed encryption
Bram Moolenaar071d4272004-06-13 20:20:40 +0000201 Zoltan Arpadffy work on VMS port
202 Tony Andrews Stevie
203 Gert van Antwerpen changes for DJGPP on MS-DOS
204 Berkeley DB(3) ideas for swap file implementation
205 Keith Bostic Nvi
206 Walter Briscoe Makefile updates, various patches
207 Ralf Brown SPAWNO library for MS-DOS
208 Robert Colon many useful remarks
209 Marcin Dalecki GTK+ GUI port, toolbar icons, gettext()
210 Kayhan Demirel sent me news in Uganda
211 Chris & John Downey xvi (ideas for multi-windows version)
212 Henk Elbers first VMS port
Bram Moolenaar7b0294c2004-10-11 10:16:09 +0000213 Daniel Elstner GTK+ 2 port
Bram Moolenaar071d4272004-06-13 20:20:40 +0000214 Eric Fischer Mac port, 'cindent', and other improvements
215 Benji Fisher Answering lots of user questions
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +0100216 Bill Foster Athena GUI port (later removed)
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000217 Google Lets me work on Vim one day a week
Bram Moolenaar071d4272004-06-13 20:20:40 +0000218 Loic Grenie xvim (ideas for multi windows version)
Bram Moolenaarc236c162008-07-13 17:41:49 +0000219 Sven Guckes Vim promoter and previous WWW page maintainer
Bram Moolenaar071d4272004-06-13 20:20:40 +0000220 Darren Hiebert Exuberant ctags
Bram Moolenaar7b0294c2004-10-11 10:16:09 +0000221 Jason Hildebrand GTK+ 2 port
Bram Moolenaar071d4272004-06-13 20:20:40 +0000222 Bruce Hunsaker improvements for VMS port
223 Andy Kahn Cscope support, GTK+ GUI port
224 Oezguer Kesim Maintainer of Vim Mailing Lists
225 Axel Kielhorn work on the Macintosh port
226 Steve Kirkendall Elvis
227 Roger Knobbe original port to Windows NT
228 Sergey Laskavy Vim's help from Moscow
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000229 Felix von Leitner Previous maintainer of Vim Mailing Lists
Bram Moolenaar071d4272004-06-13 20:20:40 +0000230 David Leonard Port of Python extensions to Unix
231 Avner Lottem Edit in right-to-left windows
232 Flemming Madsen X11 client-server, various features and patches
Bram Moolenaar91604412010-06-03 20:25:18 +0200233 Tony Mechelynck answers many user questions
Bram Moolenaar071d4272004-06-13 20:20:40 +0000234 Paul Moore Python interface extensions, many patches
Bram Moolenaar207f0092020-08-30 17:20:20 +0200235 Katsuhito Nagano Work on multibyte versions
236 Sung-Hyun Nam Work on multibyte versions
Bram Moolenaar071d4272004-06-13 20:20:40 +0000237 Vince Negri Win32 GUI and generic console enhancements
238 Steve Oualline Author of the first Vim book |frombook|
Bram Moolenaar574ee7b2019-11-13 23:04:29 +0100239 Dominique Pelle Valgrind reports and many fixes
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000240 A.Politz Many bug reports and some fixes
Bram Moolenaar071d4272004-06-13 20:20:40 +0000241 George V. Reilly Win32 port, Win32 GUI start-off
242 Stephen Riehm bug collector
243 Stefan Roemer various patches and help to users
244 Ralf Schandl IBM OS/390 port
245 Olaf Seibert DICE and BeBox version, regexp improvements
246 Mortaza Shiran Farsi patches
247 Peter da Silva termlib
248 Paul Slootman OS/2 port
249 Henry Spencer regular expressions
250 Dany St-Amant Macintosh port
251 Tim Thompson Stevie
252 G. R. (Fred) Walter Stevie
253 Sven Verdoolaege Perl interface
254 Robert Webb Command-line completion, GUI versions, and
255 lots of patches
256 Ingo Wilken Tcl interface
257 Mike Williams PostScript printing
258 Juergen Weigert Lattice version, AUX improvements, UNIX and
259 MS-DOS ports, autoconf
260 Stefan 'Sec' Zehl Maintainer of vim.org
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200261 Yasuhiro Matsumoto many MS-Windows improvements
262 Ken Takata fixes and features
263 Kazunobu Kuriyama GTK 3
264 Christian Brabandt many fixes, features, user support, etc.
Bram Moolenaar4c05fa02019-01-01 15:32:17 +0100265 Yegappan Lakshmanan many quickfix features
Bram Moolenaar071d4272004-06-13 20:20:40 +0000266
267I wish to thank all the people that sent me bug reports and suggestions. The
268list is too long to mention them all here. Vim would not be the same without
269the ideas from all these people: They keep Vim alive!
Bram Moolenaar56b45b92013-06-24 22:22:18 +0200270*love* *peace* *friendship* *gross-national-happiness*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000271
272
273In this documentation there are several references to other versions of Vi:
Bram Moolenaar1cd871b2004-12-19 22:46:22 +0000274 *Vi* *vi*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000275Vi "the original". Without further remarks this is the version
276 of Vi that appeared in Sun OS 4.x. ":version" returns
277 "Version 3.7, 6/7/85". Sometimes other versions are referred
Bram Moolenaard09091d2019-01-17 16:07:22 +0100278 to. Only runs under Unix. Source code is now available under a
279 BSD-style license. More information on Vi can be found through:
280 http://ex-vi.sourceforge.net/
Bram Moolenaar071d4272004-06-13 20:20:40 +0000281 *Posix*
282Posix From the IEEE standard 1003.2, Part 2: Shell and utilities.
283 Generally known as "Posix". This is a textual description of
284 how Vi is supposed to work.
Bram Moolenaar7c626922005-02-07 22:01:03 +0000285 See |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000286 *Nvi*
287Nvi The "New" Vi. The version of Vi that comes with BSD 4.4 and FreeBSD.
288 Very good compatibility with the original Vi, with a few extensions.
289 The version used is 1.79. ":version" returns "Version 1.79
290 (10/23/96)". There has been no release the last few years, although
291 there is a development version 1.81.
292 Source code is freely available.
293 *Elvis*
294Elvis Another Vi clone, made by Steve Kirkendall. Very compact but isn't
Bram Moolenaard09091d2019-01-17 16:07:22 +0100295 as flexible as Vim. Development has stalled, Elvis has left the
296 building! Source code is freely available.
297 *Neovim*
298Neovim A Vim clone. Forked the Vim source in 2014 and went a different way.
Bram Moolenaar4c05fa02019-01-01 15:32:17 +0100299 Very much bound to github and has many more dependencies, making
300 development more complex and limiting portability. Code has been
301 refactored, resulting in patches not being exchangeable with Vim.
302 Supports a remote GUI and integration with scripting languages.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000303
304==============================================================================
3054. Notation *notation*
306
307When syntax highlighting is used to read this, text that is not typed
308literally is often highlighted with the Special group. These are items in [],
309{} and <>, and CTRL-X.
310
311Note that Vim uses all possible characters in commands. Sometimes the [], {}
312and <> are part of what you type, the context should make this clear.
313
314
315[] Characters in square brackets are optional.
316
Bram Moolenaar4a748032010-09-30 21:47:56 +0200317 *count* *[count]*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000318[count] An optional number that may precede the command to multiply
319 or iterate the command. If no number is given, a count of one
320 is used, unless otherwise noted. Note that in this manual the
321 [count] is not mentioned in the description of the command,
322 but only in the explanation. This was done to make the
323 commands easier to look up. If the 'showcmd' option is on,
324 the (partially) entered count is shown at the bottom of the
325 window. You can use <Del> to erase the last digit (|N<Del>|).
326
327 *[quotex]*
328["x] An optional register designation where text can be stored.
329 See |registers|. The x is a single character between 'a' and
330 'z' or 'A' and 'Z' or '"', and in some cases (with the put
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000331 command) between '0' and '9', '%', '#', or others. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000332 uppercase and lowercase letter designate the same register,
333 but the lowercase letter is used to overwrite the previous
334 register contents, while the uppercase letter is used to
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000335 append to the previous register contents. Without the ""x" or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000336 with """" the stored text is put into the unnamed register.
337
338 *{}*
339{} Curly braces denote parts of the command which must appear,
340 but which can take a number of different values. The
341 differences between Vim and Vi are also given in curly braces
342 (this will be clear from the context).
343
344 *{char1-char2}*
345{char1-char2} A single character from the range char1 to char2. For
346 example: {a-z} is a lowercase letter. Multiple ranges may be
347 concatenated. For example, {a-zA-Z0-9} is any alphanumeric
348 character.
349
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000350 *{motion}* *movement*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000351{motion} A command that moves the cursor. These are explained in
352 |motion.txt|. Examples:
353 w to start of next word
354 b to begin of current word
355 4j four lines down
356 /The<CR> to next occurrence of "The"
357 This is used after an |operator| command to move over the text
358 that is to be operated upon.
359 - If the motion includes a count and the operator also has a
360 count, the two counts are multiplied. For example: "2d3w"
361 deletes six words.
362 - The motion can be backwards, e.g. "db" to delete to the
363 start of the word.
364 - The motion can also be a mouse click. The mouse is not
365 supported in every terminal though.
366 - The ":omap" command can be used to map characters while an
367 operator is pending.
368 - Ex commands can be used to move the cursor. This can be
369 used to call a function that does some complicated motion.
370 The motion is always characterwise exclusive, no matter
371 what ":" command is used. This means it's impossible to
372 include the last character of a line without the line break
373 (unless 'virtualedit' is set).
374 If the Ex command changes the text before where the operator
375 starts or jumps to another buffer the result is
376 unpredictable. It is possible to change the text further
377 down. Jumping to another buffer is possible if the current
378 buffer is not unloaded.
379
380 *{Visual}*
381{Visual} A selected text area. It is started with the "v", "V", or
382 CTRL-V command, then any cursor movement command can be used
383 to change the end of the selected text.
384 This is used before an |operator| command to highlight the
385 text that is to be operated upon.
386 See |Visual-mode|.
387
388 *<character>*
389<character> A special character from the table below, optionally with
390 modifiers, or a single ASCII character with modifiers.
391
392 *'character'*
393'c' A single ASCII character.
394
395 *CTRL-{char}*
396CTRL-{char} {char} typed as a control character; that is, typing {char}
397 while holding the CTRL key down. The case of {char} does not
398 matter; thus CTRL-A and CTRL-a are equivalent. But on some
399 terminals, using the SHIFT key will produce another code,
400 don't use it then.
401
402 *'option'*
403'option' An option, or parameter, that can be set to a value, is
404 enclosed in single quotes. See |options|.
405
406 *quotecommandquote*
407"command" A reference to a command that you can type is enclosed in
408 double quotes.
Bram Moolenaar00154502013-02-13 16:15:55 +0100409`command` New style command, this distinguishes it from other quoted
410 text and strings.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000411
412 *key-notation* *key-codes* *keycodes*
413These names for keys are used in the documentation. They can also be used
414with the ":map" command (insert the key name by pressing CTRL-K and then the
415key you want the name for).
416
417notation meaning equivalent decimal value(s) ~
418-----------------------------------------------------------------------
419<Nul> zero CTRL-@ 0 (stored as 10) *<Nul>*
420<BS> backspace CTRL-H 8 *backspace*
421<Tab> tab CTRL-I 9 *tab* *Tab*
422 *linefeed*
423<NL> linefeed CTRL-J 10 (used for <Nul>)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000424<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
Bram Moolenaar4072ba52020-12-23 13:56:35 +0100436<EOL> end-of-line (can be <CR>, <NL> or <CR><NL>,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000437 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)
Bram Moolenaar207f0092020-08-30 17:20:20 +0200512 Although you can specify <M-{char}> with {char} being a multibyte
Bram Moolenaar56c860c2019-08-17 20:09:31 +0200513 character, Vim may not be able to know what byte sequence that is and then
514 it won't work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000515
516If you want to use the full <> notation in Vim, you have to make sure the '<'
517flag is excluded from 'cpoptions' (when 'compatible' is not set, it already is
518by default). >
519 :set cpo-=<
520The <> notation uses <lt> to escape the special meaning of key names. Using a
521backslash also works, but only when 'cpoptions' does not include the 'B' flag.
522
523Examples for mapping CTRL-H to the six characters "<Home>": >
524 :imap <C-H> \<Home>
525 :imap <C-H> <lt>Home>
526The first one only works when the 'B' flag is not in 'cpoptions'. The second
527one always works.
528To get a literal "<lt>" in a mapping: >
529 :map <C-L> <lt>lt>
530
531For mapping, abbreviation and menu commands you can then copy-paste the
532examples and use them directly. Or type them literally, including the '<' and
533'>' characters. This does NOT work for other commands, like ":set" and
534":autocmd"!
535
Bram Moolenaar9712ff12022-09-18 13:04:22 +0100536The notation can be used in a double quoted strings, using "\<" at the start,
537e.g. "\<C-Space>". This results in a special key code. To convert this back
538to readable text use `keytrans()`.
539
Bram Moolenaar071d4272004-06-13 20:20:40 +0000540==============================================================================
5415. Modes, introduction *vim-modes-intro* *vim-modes*
542
Bram Moolenaar1ccd8ff2017-08-11 19:50:37 +0200543Vim has seven BASIC modes:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000544
545 *Normal* *Normal-mode* *command-mode*
546Normal mode In Normal mode you can enter all the normal editor
547 commands. If you start the editor you are in this
548 mode (unless you have set the 'insertmode' option,
549 see below). This is also known as command mode.
550
551Visual mode This is like Normal mode, but the movement commands
552 extend a highlighted area. When a non-movement
553 command is used, it is executed for the highlighted
554 area. See |Visual-mode|.
555 If the 'showmode' option is on "-- VISUAL --" is shown
556 at the bottom of the window.
557
558Select mode This looks most like the MS-Windows selection mode.
559 Typing a printable character deletes the selection
560 and starts Insert mode. See |Select-mode|.
561 If the 'showmode' option is on "-- SELECT --" is shown
562 at the bottom of the window.
563
564Insert mode In Insert mode the text you type is inserted into the
565 buffer. See |Insert-mode|.
566 If the 'showmode' option is on "-- INSERT --" is shown
567 at the bottom of the window.
568
569Command-line mode In Command-line mode (also called Cmdline mode) you
570Cmdline mode can enter one line of text at the bottom of the
571 window. This is for the Ex commands, ":", the pattern
572 search commands, "?" and "/", and the filter command,
573 "!". |Cmdline-mode|
574
575Ex mode Like Command-line mode, but after entering a command
576 you remain in Ex mode. Very limited editing of the
577 command line. |Ex-mode|
578
Bram Moolenaar1ccd8ff2017-08-11 19:50:37 +0200579Terminal-Job mode Interacting with a job in a terminal window. Typed
580 keys go to the job and the job output is displayed in
581 the terminal window. See |terminal| about how to
582 switch to other modes.
583
Bram Moolenaarf55e4c82017-08-01 20:44:53 +0200584There are seven ADDITIONAL modes. These are variants of the BASIC modes:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000585
586 *Operator-pending* *Operator-pending-mode*
587Operator-pending mode This is like Normal mode, but after an operator
588 command has started, and Vim is waiting for a {motion}
589 to specify the text that the operator will work on.
590
591Replace mode Replace mode is a special case of Insert mode. You
592 can do the same things as in Insert mode, but for
593 each character you enter, one character of the existing
594 text is deleted. See |Replace-mode|.
595 If the 'showmode' option is on "-- REPLACE --" is
596 shown at the bottom of the window.
597
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000598Virtual Replace mode Virtual Replace mode is similar to Replace mode, but
599 instead of file characters you are replacing screen
600 real estate. See |Virtual-Replace-mode|.
601 If the 'showmode' option is on "-- VREPLACE --" is
602 shown at the bottom of the window.
603
Bram Moolenaard473c8c2018-08-11 18:00:22 +0200604Insert Normal mode Entered when CTRL-O is typed in Insert mode (see
605 |i_CTRL-O|). This is like Normal mode, but after
606 executing one command Vim returns to Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000607 If the 'showmode' option is on "-- (insert) --" is
608 shown at the bottom of the window.
609
Bram Moolenaar1ccd8ff2017-08-11 19:50:37 +0200610Terminal-Normal mode Using Normal mode in a terminal window. Making
611 changes is impossible. Use an insert command, such as
612 "a" or "i", to return to Terminal-Job mode.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +0200613
Bram Moolenaar071d4272004-06-13 20:20:40 +0000614Insert Visual mode Entered when starting a Visual selection from Insert
615 mode, e.g., by using CTRL-O and then "v", "V" or
616 CTRL-V. When the Visual selection ends, Vim returns
617 to Insert mode.
618 If the 'showmode' option is on "-- (insert) VISUAL --"
619 is shown at the bottom of the window.
620
621Insert Select mode Entered when starting Select mode from Insert mode.
622 E.g., by dragging the mouse or <S-Right>.
623 When the Select mode ends, Vim returns to Insert mode.
624 If the 'showmode' option is on "-- (insert) SELECT --"
625 is shown at the bottom of the window.
626
627==============================================================================
6286. Switching from mode to mode *mode-switching*
629
630If for any reason you do not know which mode you are in, you can always get
631back to Normal mode by typing <Esc> twice. This doesn't work for Ex mode
632though, use ":visual".
633You will know you are back in Normal mode when you see the screen flash or
634hear the bell after you type <Esc>. However, when pressing <Esc> after using
635CTRL-O in Insert mode you get a beep but you are still in Insert mode, type
636<Esc> again.
637
638 *i_esc*
639 TO mode ~
640 Normal Visual Select Insert Replace Cmd-line Ex ~
641FROM mode ~
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000642Normal v V ^V *4 *1 R gR : / ? ! Q
Bram Moolenaar071d4272004-06-13 20:20:40 +0000643Visual *2 ^G c C -- : --
644Select *5 ^O ^G *6 -- -- --
645Insert <Esc> -- -- <Insert> -- --
646Replace <Esc> -- -- <Insert> -- --
647Command-line *3 -- -- :start -- --
648Ex :vi -- -- -- -- --
649
Bram Moolenaar071d4272004-06-13 20:20:40 +0000650-- not possible
651
652*1 Go from Normal mode to Insert mode by giving the command "i", "I", "a",
653 "A", "o", "O", "c", "C", "s" or S".
654*2 Go from Visual mode to Normal mode by giving a non-movement command, which
655 causes the command to be executed, or by hitting <Esc> "v", "V" or "CTRL-V"
656 (see |v_v|), which just stops Visual mode without side effects.
657*3 Go from Command-line mode to Normal mode by:
658 - Hitting <CR> or <NL>, which causes the entered command to be executed.
659 - Deleting the complete line (e.g., with CTRL-U) and giving a final <BS>.
660 - Hitting CTRL-C or <Esc>, which quits the command-line without executing
661 the command.
662 In the last case <Esc> may be the character defined with the 'wildchar'
663 option, in which case it will start command-line completion. You can
Bram Moolenaara6c27c42019-05-09 19:16:22 +0200664 ignore that and type <Esc> again.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000665*4 Go from Normal to Select mode by:
666 - use the mouse to select text while 'selectmode' contains "mouse"
667 - use a non-printable command to move the cursor while keeping the Shift
668 key pressed, and the 'selectmode' option contains "key"
669 - use "v", "V" or "CTRL-V" while 'selectmode' contains "cmd"
670 - use "gh", "gH" or "g CTRL-H" |g_CTRL-H|
671*5 Go from Select mode to Normal mode by using a non-printable command to move
672 the cursor, without keeping the Shift key pressed.
673*6 Go from Select mode to Insert mode by typing a printable character. The
674 selection is deleted and the character is inserted.
675
676If the 'insertmode' option is on, editing a file will start in Insert mode.
677
678 *CTRL-\_CTRL-N* *i_CTRL-\_CTRL-N* *c_CTRL-\_CTRL-N* *v_CTRL-\_CTRL-N*
679Additionally the command CTRL-\ CTRL-N or <C-\><C-N> can be used to go to
680Normal mode from any other mode. This can be used to make sure Vim is in
681Normal mode, without causing a beep like <Esc> would. However, this does not
682work in Ex mode. When used after a command that takes an argument, such as
683|f| or |m|, the timeout set with 'ttimeoutlen' applies.
Bram Moolenaar7e6a5152021-01-02 16:39:53 +0100684When focus is in a terminal window, CTRL-\ CTRL-N goes to Normal mode until an
685edit command is entered, see |t_CTRL-\_CTRL-N|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000686
687 *CTRL-\_CTRL-G* *i_CTRL-\_CTRL-G* *c_CTRL-\_CTRL-G* *v_CTRL-\_CTRL-G*
688The command CTRL-\ CTRL-G or <C-\><C-G> can be used to go to Insert mode when
689'insertmode' is set. Otherwise it goes to Normal mode. This can be used to
690make sure Vim is in the mode indicated by 'insertmode', without knowing in
691what mode Vim currently is.
692
693 *Q* *mode-Ex* *Ex-mode* *Ex* *EX* *E501*
694Q Switch to "Ex" mode. This is a bit like typing ":"
695 commands one after another, except:
696 - You don't have to keep pressing ":".
697 - The screen doesn't get updated after each command.
698 - There is no normal command-line editing.
699 - Mappings and abbreviations are not used.
700 In fact, you are editing the lines with the "standard"
701 line-input editing commands (<Del> or <BS> to erase,
702 CTRL-U to kill the whole line).
703 Vim will enter this mode by default if it's invoked as
Bram Moolenaar5ed11532022-07-06 13:18:11 +0100704 "ex" on the command-line or the |-e| command line
705 argument was used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000706 Use the ":vi" command |:visual| to exit "Ex" mode.
707 Note: In older versions of Vim "Q" formatted text,
708 that is now done with |gq|. But if you use the
Bram Moolenaar1588bc82022-03-08 21:35:07 +0000709 |vimrc_example.vim| script or |defaults.vim|, "Q"
710 works like "gq". Except for Select mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000711
712 *gQ*
Bram Moolenaar7c626922005-02-07 22:01:03 +0000713gQ Switch to "Ex" mode like with "Q", but really behave
714 like typing ":" commands after another. All command
715 line editing, completion etc. is available.
Bram Moolenaar5ed11532022-07-06 13:18:11 +0100716 Use the `:vi` command (`:visual`) to exit "Ex" mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000717
718==============================================================================
7197. The window contents *window-contents*
720
721In Normal mode and Insert/Replace mode the screen window will show the current
722contents of the buffer: What You See Is What You Get. There are two
723exceptions:
724- When the 'cpoptions' option contains '$', and the change is within one line,
725 the text is not directly deleted, but a '$' is put at the last deleted
726 character.
727- When inserting text in one window, other windows on the same text are not
728 updated until the insert is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000729
730Lines longer than the window width will wrap, unless the 'wrap' option is off
731(see below). The 'linebreak' option can be set to wrap at a blank character.
732
733If the window has room after the last line of the buffer, Vim will show '~' in
Bram Moolenaar166af9b2010-11-16 20:34:40 +0100734the first column of the last lines in the window, like this:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000735
736 +-----------------------+
737 |some line |
738 |last line |
739 |~ |
740 |~ |
741 +-----------------------+
742
743Thus the '~' lines indicate that the end of the buffer was reached.
744
745If the last line in a window doesn't fit, Vim will indicate this with a '@' in
Bram Moolenaar166af9b2010-11-16 20:34:40 +0100746the first column of the last lines in the window, like this:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000747
748 +-----------------------+
749 |first line |
750 |second line |
751 |@ |
752 |@ |
753 +-----------------------+
754
755Thus the '@' lines indicate that there is a line that doesn't fit in the
756window.
757
758When the "lastline" flag is present in the 'display' option, you will not see
759'@' characters at the left side of window. If the last line doesn't fit
760completely, only the part that fits is shown, and the last three characters of
Bram Moolenaar81af9252010-12-10 20:35:50 +0100761the last line are replaced with "@@@", like this:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000762
763 +-----------------------+
764 |first line |
765 |second line |
766 |a very long line that d|
767 |oesn't fit in the wi@@@|
768 +-----------------------+
769
770If there is a single line that is too long to fit in the window, this is a
771special situation. Vim will show only part of the line, around where the
772cursor is. There are no special characters shown, so that you can edit all
773parts of this line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000774
775The '@' occasion in the 'highlight' option can be used to set special
776highlighting for the '@' and '~' characters. This makes it possible to
777distinguish them from real characters in the buffer.
778
779The 'showbreak' option contains the string to put in front of wrapped lines.
780
781 *wrap-off*
782If the 'wrap' option is off, long lines will not wrap. Only the part that
783fits on the screen is shown. If the cursor is moved to a part of the line
784that is not shown, the screen is scrolled horizontally. The advantage of
785this method is that columns are shown as they are and lines that cannot fit
786on the screen can be edited. The disadvantage is that you cannot see all the
787characters of a line at once. The 'sidescroll' option can be set to the
Bram Moolenaara6c27c42019-05-09 19:16:22 +0200788minimal number of columns to scroll.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000789
790All normal ASCII characters are displayed directly on the screen. The <Tab>
791is replaced with the number of spaces that it represents. Other non-printing
792characters are replaced with "^{char}", where {char} is the non-printing
793character with 64 added. Thus character 7 (bell) will be shown as "^G".
794Characters between 127 and 160 are replaced with "~{char}", where {char} is
795the character with 64 subtracted. These characters occupy more than one
796position on the screen. The cursor can only be positioned on the first one.
797
798If you set the 'number' option, all lines will be preceded with their
799number. Tip: If you don't like wrapping lines to mix with the line numbers,
800set the 'showbreak' option to eight spaces:
801 ":set showbreak=\ \ \ \ \ \ \ \ "
802
803If you set the 'list' option, <Tab> characters will not be shown as several
804spaces, but as "^I". A '$' will be placed at the end of the line, so you can
805find trailing blanks.
806
807In Command-line mode only the command-line itself is shown correctly. The
808display of the buffer contents is updated as soon as you go back to Command
809mode.
810
811The last line of the window is used for status and other messages. The
812status messages will only be used if an option is on:
813
814status message option default Unix default ~
815current mode 'showmode' on on
816command characters 'showcmd' on off
817cursor position 'ruler' off off
818
819The current mode is "-- INSERT --" or "-- REPLACE --", see |'showmode'|. The
Bram Moolenaara6c27c42019-05-09 19:16:22 +0200820command characters are those that you typed but were not used yet.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000821
822If you have a slow terminal you can switch off the status messages to speed
823up editing:
824 :set nosc noru nosm
825
826If there is an error, an error message will be shown for at least one second
Bram Moolenaara6c27c42019-05-09 19:16:22 +0200827(in reverse video).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000828
829Some commands show how many lines were affected. Above which threshold this
830happens can be controlled with the 'report' option (default 2).
831
832On the Amiga Vim will run in a CLI window. The name Vim and the full name of
833the current file name will be shown in the title bar. When the window is
834resized, Vim will automatically redraw the window. You may make the window as
835small as you like, but if it gets too small not a single line will fit in it.
836Make it at least 40 characters wide to be able to read most messages on the
837last line.
838
839On most Unix systems, resizing the window is recognized and handled correctly
Bram Moolenaara6c27c42019-05-09 19:16:22 +0200840by Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000841
842==============================================================================
8438. Definitions *definitions*
844
Bram Moolenaarc572da52017-08-27 16:52:01 +0200845 buffer Contains lines of text, usually read from a file.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000846 screen The whole area that Vim uses to work in. This can be
847 a terminal emulator window. Also called "the Vim
848 window".
Bram Moolenaarc572da52017-08-27 16:52:01 +0200849 window A view on a buffer. There can be multiple windows for
850 one buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000851
852A screen contains one or more windows, separated by status lines and with the
853command line at the bottom.
854
855 +-------------------------------+
856screen | window 1 | window 2 |
857 | | |
858 | | |
859 |= status line =|= status line =|
860 | window 3 |
861 | |
862 | |
863 |==== status line ==============|
864 |command line |
865 +-------------------------------+
866
867The command line is also used for messages. It scrolls up the screen when
868there is not enough room in the command line.
869
870A difference is made between four types of lines:
871
872 buffer lines The lines in the buffer. This is the same as the
873 lines as they are read from/written to a file. They
874 can be thousands of characters long.
875 logical lines The buffer lines with folding applied. Buffer lines
876 in a closed fold are changed to a single logical line:
877 "+-- 99 lines folded". They can be thousands of
878 characters long.
879 window lines The lines displayed in a window: A range of logical
880 lines with wrapping, line breaks, etc. applied. They
881 can only be as long as the width of the window allows,
882 longer lines are wrapped or truncated.
883 screen lines The lines of the screen that Vim uses. Consists of
884 the window lines of all windows, with status lines
885 and the command line added. They can only be as long
886 as the width of the screen allows. When the command
887 line gets longer it wraps and lines are scrolled to
888 make room.
889
890buffer lines logical lines window lines screen lines ~
891
8921. one 1. one 1. +-- folded 1. +-- folded
8932. two 2. +-- folded 2. five 2. five
8943. three 3. five 3. six 3. six
8954. four 4. six 4. seven 4. seven
8965. five 5. seven 5. === status line ===
8976. six 6. aaa
8987. seven 7. bbb
899 8. ccc ccc c
9001. aaa 1. aaa 1. aaa 9. cc
9012. bbb 2. bbb 2. bbb 10. ddd
9023. ccc ccc ccc 3. ccc ccc ccc 3. ccc ccc c 11. ~
9034. ddd 4. ddd 4. cc 12. === status line ===
904 5. ddd 13. (command line)
905 6. ~
906
907==============================================================================
Bram Moolenaar91f84f62018-07-29 15:07:52 +0200908 vim:tw=78:ts=8:noet:ft=help:norl: