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