blob: 76893e255a8e69bcb63abd7fb123318fba922de8 [file] [log] [blame]
Bram Moolenaar4499d2e2005-04-15 20:41:38 +00001*vi_diff.txt* For Vim version 7.0aa. Last change: 2005 Apr 01
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Differences between Vim and Vi *vi-differences*
8
9Throughout the help files differences between Vim and Vi/Ex are given in
10curly braces, like "{not in Vi}". This file only lists what has not been
11mentioned in other files and gives an overview.
12
13Vim is mostly POSIX 1003.2-1 compliant. The only command known to be missing
14is ":open". There are probably a lot of small differences (either because Vim
15is missing something or because Posix is beside the mark).
16
Bram Moolenaar6bdcfc02005-02-22 08:28:13 +0000171. Simulated command |simulated-command|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000182. Missing options |missing-options|
193. Limits |limits|
204. The most interesting additions |vim-additions|
215. Other vim features |other-features|
226. Command-line arguments |cmdline-arguments|
Bram Moolenaarf97ca8f2005-02-07 21:49:25 +0000237. POSIX compliance |posix-compliance|
Bram Moolenaar071d4272004-06-13 20:20:40 +000024
25==============================================================================
Bram Moolenaar6bdcfc02005-02-22 08:28:13 +0000261. Simulated command *simulated-command*
Bram Moolenaar071d4272004-06-13 20:20:40 +000027
Bram Moolenaar6bdcfc02005-02-22 08:28:13 +000028This command is in Vi, but Vim only simuates it:
Bram Moolenaar071d4272004-06-13 20:20:40 +000029
Bram Moolenaar6bdcfc02005-02-22 08:28:13 +000030 *:o* *:op* *:open*
31:[range]o[pen] Works like |:visual|: end Ex mode.
32 {Vi: start editing in open mode}
33
34:[range]o[pen] /pattern/ As above, additionally move the cursor to the
35 column where "pattern" matches in the cursor
36 line.
37
38Vim does not support open mode, since it's not really useful. For those
39situations where ":open" would start open mode Vim will leave Ex mode, which
40allows executing the same commands, but updates the whole screen instead of
41only one line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000042
43==============================================================================
442. Missing options *missing-options*
45
46These options are in the Unix Vi, but not in Vim. If you try to set one of
47them you won't get an error message, but the value is not used and cannot be
48printed.
49
50autoprint (ap) boolean (default on) *'autoprint'* *'ap'*
51beautify (bf) boolean (default off) *'beautify'* *'bf'*
52flash (fl) boolean (default ??) *'flash'* *'fl'*
53graphic (gr) boolean (default off) *'graphic'* *'gr'*
54hardtabs (ht) number (default 8) *'hardtabs'* *'ht'*
55 number of spaces that a <Tab> moves on the display
56mesg boolean (default on) *'mesg'*
57novice boolean (default off) *'novice'*
58open boolean (default on) *'open'*
59optimize (op) boolean (default off) *'optimize'* *'op'*
Bram Moolenaar071d4272004-06-13 20:20:40 +000060redraw boolean (default off) *'redraw'*
61slowopen (slow) boolean (default off) *'slowopen'* *'slow'*
62sourceany boolean (default off) *'sourceany'*
Bram Moolenaar071d4272004-06-13 20:20:40 +000063w300 number (default 23) *'w300'*
64w1200 number (default 23) *'w1200'*
65w9600 number (default 23) *'w9600'*
66
67==============================================================================
683. Limits *limits*
69
70Vim has only a few limits for the files that can be edited {Vi: can not handle
71<Nul> characters and characters above 128, has limited line length, many other
72limits}.
73 *E340*
74Maximum line length On machines with 16-bit ints (Amiga and MS-DOS real
75 mode): 32767, otherwise 2147483647 characters.
76 Longer lines are split.
77Maximum number of lines 2147483647 lines.
78Maximum file size 2147483647 bytes (2 Gbyte) when a long integer is
79 32 bits. Much more for 64 bit longs. Also limited
80 by available disk space for the |swap-file|.
81 *E75*
82Length of a file path Unix and Win32: 1024 characters, otherwise 256
83 characters (or as much as the system supports).
84Length of an expanded string option
85 Unix and Win32: 1024 characters, otherwise 256
86 characters
87Maximum display width Unix and Win32: 1024 characters, otherwise 255
88 characters
89Maximum lhs of a mapping 50 characters.
90Number of highlighting different types: 223
91
92Information for undo and text in registers is kept in memory, thus when making
93(big) changes the amount of (virtual) memory available limits the number of
94undo levels and the text that can be kept in registers. Other things are also
95kept in memory: Command-line history, error messages for Quickfix mode, etc.
96
97Memory usage limits
98-------------------
99
100The option 'maxmem' ('mm') is used to set the maximum memory used for one
101buffer (in kilobytes). 'maxmemtot' is used to set the maximum memory used for
102all buffers (in kilobytes). The defaults depend on the system used. For the
103Amiga and MS-DOS, 'maxmemtot' is set depending on the amount of memory
104available. If you don't like Vim to swap to a file, set 'maxmem' and
105'maxmemtot' to a very large value. The swap file will then only be used for
106recovery. If you don't want a swap file at all, set 'updatecount' to 0, or
107use the "-n" argument when starting Vim. Note that the 'maxmem' option is
108only used when a buffer is created. Changing this option does not affect
109buffers that have already been loaded. Thus you can set it to different
110values for different files. 'maxmemtot' works always.
111
112==============================================================================
1134. The most interesting additions *vim-additions*
114
115Vi compatibility. |'compatible'|
116 Although Vim is 99% Vi compatible, some things in Vi can be
117 considered to be a bug, or at least need improvement. But still, Vim
118 starts in a mode which behaves like the "real" Vi as much as possible.
119 To make Vim behave a little bit better, try resetting the 'compatible'
120 option:
121 :set nocompatible
122 Or start Vim with the "-N" argument:
123 vim -N
124 This is done automatically if you have a .vimrc file. See |startup|.
125 The 'cpoptions' option can be used to set Vi compatibility on/off for
126 a number of specific items.
127
128Support for different systems.
129 Vim can be used on:
130 - All Unix systems (it works on all systems it was tested on, although
131 the GUI and Perl interface may not work everywhere).
132 - Amiga (500, 1000, 1200, 2000, 3000, 4000, ...).
133 - MS-DOS in real-mode (no additional drivers required).
134 - In protected mode on Windows 3.1 and MS-DOS (DPMI driver required).
135 - Windows 95 and Windows NT, with support for long file names.
136 - OS/2 (needs emx.dll)
137 - Atari MiNT
138 - VMS
139 - BeOS
140 - Macintosh
141 - Risc OS
142 - IBM OS/390
143
144Multi level undo. |undo|
145 'u' goes backward in time, 'CTRL-R' goes forward again. Set option
146 'undolevels' to the number of changes to be remembered (default 1000).
Bram Moolenaar4499d2e2005-04-15 20:41:38 +0000147 Set 'undolevels' to 0 for a vi-compatible one level undo. Set it to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000148 -1 for no undo at all.
149
150 When all changes in a buffer have been undone, the buffer is not
151 considered changed anymore. You can exit it with :q, without <!>.
152
153Graphical User Interface (GUI) |gui|
154 Included support for GUI: menu's, mouse, scrollbars, etc. You can
155 define your own menus. Better support for CTRL/SHIFT/ALT keys in
156 combination with special keys and mouse. Supported for various
157 platforms, such as X11 (with Motif and Athena interfaces), GTK, Win32
158 (Windows 95 and later), BeOS, Amiga and Macintosh.
159
160Multiple windows and buffers. |windows.txt|
161 Vim can split the screen into several windows, each editing a
162 different buffer or the same buffer at a different location. Buffers
163 can still be loaded (and changed) but not displayed in a window. This
164 is called a hidden buffer. Many commands and options have been added
165 for this facility.
166
167Syntax highlighting. |:syntax|
168 Vim can highlight keywords, patterns and other things. This is
169 defined by a number of ":syntax" commands, and can be made to
170 highlight most languages and file types. A number of files are
171 included for highlighting the most common languages, like C, C++,
172 Java, Pascal, Makefiles, shell scripts, etc. The colors used for
173 highlighting can be defined for ordinary terminals, color terminals
174 and the GUI with the ":highlight" command.
175
176Folding |folding|
177 A range of lines can be shown as one "folded" line. This allows
178 overviewing a file and moving blocks of text around quickly.
179 Folds can be created manually, from the syntax of the file, by indent,
180 etc.
181
182Plugins |add-plugin|
183 The functionality can be extended by dropping a plugin file in the
184 right directory. That's an easy way to start using Vim scripts
185 written by others. Plugins can be for all kind of files, or
186 specifically for a filetype.
187
188Repeat a series of commands. |q|
189 "q{c}" starts recording typed characters into named register {c}
190 (append to the register if register name is uppercase). A subsequent
191 "q" stops recording. The register can then be executed with the
192 "@{c}" command. This is very useful to repeat a complex action.
193
194Flexible insert mode. |ins-special-special|
195 The arrow keys can be used in insert mode to move around in the file.
196 This breaks the insert in two parts as far as undo and redo is
197 concerned.
198
199 CTRL-O can be used to execute a single command-mode command. This is
200 almost the same as hitting <Esc>, typing the command and doing "a".
201
202Visual mode. |Visual-mode|
203 Visual can be used to first highlight a piece of text and then give a
204 command to do something with it. This is an (easy to use) alternative
205 to first giving the operator and then moving to the end of the text
206 to be operated upon. "v" and "V" are used to start Visual mode. "v"
207 works on characters and 'V' on lines. Move the cursor to extend the
208 Visual part. It is shown highlighted on the screen. By typing "o"
209 the other end of the Visual text can be moved. The Visual text can
210 be affected by an operator:
211 d delete
212 c change
213 y yank
214 > or < insert or delete indent
215 ! filter through external program
216 = filter through indent
217 : start ":" command for the Visual lines.
218 gq format text to 'textwidth' columns
219 J join lines
220 ~ swap case
221 u make lowercase
222 U make uppercase
223
224Block operators. |visual-block|
225 With Visual a rectangular block of text can be selected. Start Visual
226 with CTRL-V. The block can be deleted ("d"), yanked ("y") or its case
227 can be changed ("~", "u" and "U"). A deleted or yanked block can be
228 put into the text with the "p" and "P" commands.
229
230Online help system. |:help|
231 Help is displayed in a window. The usual commands can be used to
232 move around, search for a string, etc. Tags can be used to jump
233 around in the help files, just like hypertext links. The ":help"
234 command takes an argument to quickly jump to the info on a subject.
235 <F1> is the quick access to the help system. The name of the help
236 index file can be set with the 'helpfile' option.
237
238Command-line editing and history. |cmdline-editing|
239 You can insert or delete at any place in the command-line using the
240 cursor keys. The right/left cursor keys can be used to move
241 forward/backward one character. The shifted right/left cursor keys
242 can be used to move forward/backward one word. CTRL-B/CTRL-E can be
243 used to go to the begin/end of the command-line.
244
245 |cmdline-history|
246 The command-lines are remembered. The up/down cursor keys can be used
247 to recall previous command-lines. The 'history' option can be set to
248 the number of lines that will be remembered. There is a separate
249 history for commands and for search patterns.
250
251Command-line completion. |cmdline-completion|
252 While entering a command-line (on the bottom line of the screen)
253 <Tab> can be typed to complete
254 what example ~
255 - command :e<Tab>
256 - tag :ta scr<Tab>
257 - option :set sc<Tab>
258 - option value :set hf=<Tab>
259 - file name :e ve<Tab>
260 - etc.
261
262 If there are multiple matches, CTRL-N (next) and CTRL-P (previous)
263 will walk through the matches. <Tab> works like CTRL-N, but wraps
264 around to the first match.
265
266 The 'wildchar' option can be set to the character for command-line
267 completion, <Tab> is the default. CTRL-D can be typed after an
268 (incomplete) wildcard; all matches will be listed. CTRL-A will insert
269 all matches. CTRL-L will insert the longest common part of the
270 matches.
271
272Insert-mode completion |ins-completion|
273 In insert mode the CTRL-N and CTRL-P keys can be used to complete a
274 word that has previously been used. |i_CTRL-N|
275 With CTRL-X another mode is entered, through which completion can be
276 done for:
277 |i_CTRL-X_CTRL-F| file names
278 |i_CTRL-X_CTRL-K| words from 'dictionary' files
279 |i_CTRL-X_CTRL-T| words from 'thesaurus' files
280 |i_CTRL-X_CTRL-I| words from included files
281 |i_CTRL-X_CTRL-L| whole lines
282 |i_CTRL-X_CTRL-]| words from the tags file
283 |i_CTRL-X_CTRL-D| definitions or macros
284
285Long line support |'wrap'| |'linebreak'|
286 If the 'wrap' option is off, long lines will not wrap and only part
287 of them will be shown. When the cursor is moved to a part that is not
288 shown, the screen will scroll horizontally. The minimum number of
289 columns to scroll can be set with the 'sidescroll' option. The "zh"
290 and "zl" commands can be used to scroll sideways.
291 Alternatively, long lines are broken in between words when the
292 'linebreak' option is set. This allows editing a single-line
293 paragraph conveniently (e.g. when the text is later read into a DTP
294 program). Move the cursor up/down with the "gk" and "gj" commands.
295
296Text formatting. |formatting|
297 The 'textwidth' option can be used to automatically limit the line
298 length. This supplements the 'wrapmargin' option of Vi, which was not
299 very useful. The "gq" operator can be used to format a piece of text
300 (for example, "gqap" formats the current paragraph). Commands for
301 text alignment: ":center", ":left" and ":right".
302
303Extended search patterns |pattern|
304 There are many extra items to match various text items. Examples:
305 A "\n" can be used in a search pattern to match a line break.
306 "x\{2,4}" matches "x" 2 to 4 times.
307 "\s" matches a white space character.
308
309Edit-compile-edit speedup. |quickfix|
310 The ":make" command can be used to run the compilation and jump to
311 the first error. Alternatively Vim can be started with the "-q"
312 option from the compiler. A file with compiler error messages is
313 interpreted. Vim starts editing at the first error.
314
315 Each line in the error file is scanned for the name of a file, line
316 number and error message. The 'errorformat' option can be set to a
317 list of scanf-like strings to handle output from many compilers.
318
319 The ":cn" command can be used to jump to the next error.
320 ":cl" lists all the error messages. Other commands are available
321 (almost the same as with Manx's Z editor on the Amiga).
322 The 'makeef' option has the name of the file with error messages.
323 The 'makeprg' option contains the name of the program to be executed
324 with the ":make" command.
325 The 'shellpipe' option contains the string to be used to put the
326 output of the compiler into the errorfile.
327
328Improved indenting for C programs |'cindent'|
329 When the 'cindent' option is on the indent of each line is
330 automatically adjusted. C syntax is mostly recognized. The indent
331 for various styles can be set with 'cinoptions'. The keys to trigger
332 indenting can be set with 'cinkeys'.
333
334 Comments can be automatically formatted. The 'comments' option can be
335 set to the characters that start and end a comment. This works best
336 for C code, but also works for e-mail (">" at start of the line) and
337 other types of text. The "=" operator can be used to re-indent
338 lines.
339
340Searching for words in include files |include-search|
341 The "[i" command can be used to search for a match of the word under
342 the cursor in the current and included files. The 'include' option
343 can be set the a pattern that describes a command to include a file
344 (the default is for C programs).
345 The "[I" command lists all matches, the "[ CTRL-I" command jumps to
346 a match.
347 The "[d", "[D" and "[ CTRL-D" commands do the same, but only for
348 lines where the pattern given with the 'define' option matches.
349
350Automatic commands |autocommand|
351 Commands can be automatically executed when reading a file, writing a
352 file, jumping to another buffer, etc., depending on the file name.
353 This is useful to set options and mappings for C programs,
354 documentation, plain text, e-mail, etc. This also makes it possible
355 to edit compressed files.
356
357Scripts and Expressions |expression|
358 Commands have been added to form up a simple but powerful script
359 language.
360 |:if| Conditional execution, which can be used for example
361 to set options depending on the value of $TERM.
362 |:while| Repeat a number of commands.
363 |:echo| Print the result of an expression.
364 |:let| Assign a value to an internal variable, option, etc.
365 |:execute| Execute a command formed by an expression.
366 etc.
367
368Viminfo |viminfo-file|
369 The command-line history, marks and registers can be stored in a file
370 that is read on startup. This can be used to repeat a search command
371 or command-line command after exiting and restarting Vim. It is also
372 possible to jump right back to where the last edit stopped with "'0".
373 The 'viminfo' option can be set to select which items to store in the
374 .viminfo file. This is off by default.
375
376Mouse support |mouse-using|
377 The mouse is supported in the GUI version, in an xterm for Unix, for
378 Linux with gpm, for MS-DOS, and Win32. It can be used to position the
379 cursor, select the visual area, paste a register, etc.
380
381Usage of key names |<>| |key-notation|
382 Special keys now all have a name like <Up>, <End>, etc.
383 This name can be used in mappings, to make it easy to edit them.
384
385Editing binary files |edit-binary|
386 Vim can edit binary files. You can change a few characters in an
387 executable file, without corrupting it. Vim doesn't remove NUL
388 characters (they are represented as <NL> internally).
389 |-b| command-line argument to start editing a binary file
390 |'binary'| Option set by "-b". Prevents adding an <EOL> for the
391 last line in the file.
392
393Multi-language support |multi-lang|
394 Files in double-byte or multi-byte encodings can be edited. There is
395 UTF-8 support to be able to edit various languages at the same time,
396 without switching fonts. |UTF-8|
397 Messages and menus are available in different languages.
398
399==============================================================================
4005. Other vim features *other-features*
401
402A random collection of nice extra features.
403
404
405When Vim is started with "-s scriptfile", the characters read from
406"scriptfile" are treated as if you typed them. If end of file is reached
407before the editor exits, further characters are read from the console.
408
409The "-w" option can be used to record all typed characters in a script file.
410This file can then be used to redo the editing, possibly on another file or
411after changing some commands in the script file.
412
413The "-o" option opens a window for each argument. "-o4" opens four windows.
414
415Vi requires several termcap entries to be able to work full-screen. Vim only
416requires the "cm" entry (cursor motion).
417
418
419In command mode:
420
421When the 'showcmd' option is set, the command characters are shown in the last
422line of the screen. They are removed when the command is finished.
423
424If the 'ruler' option is set, the current cursor position is shown in the
425last line of the screen.
426
427"U" still works after having moved off the last changed line and after "u".
428
429Characters with the 8th bit set are displayed. The characters between '~' and
4300xa0 are displayed as "~?", "~@", "~A", etc., unless they are included in the
431'isprint' option.
432
433"][" goes to the next ending of a C function ('}' in column 1).
434"[]" goes to the previous ending of a C function ('}' in column 1).
435
436"]f", "[f" and "gf" start editing the file whose name is under the cursor.
437CTRL-W f splits the window and starts editing the file whose name is under
438the cursor.
439
440"*" searches forward for the identifier under the cursor, "#" backward.
441"K" runs the program defined by the 'keywordprg' option, with the identifier
442under the cursor as argument.
443
444"%" can be preceded with a count. The cursor jumps to the line that
445percentage down in the file. The normal "%" function to jump to the matching
446brace skips braces inside quotes.
447
448With the CTRL-] command, the cursor may be in the middle of the identifier.
449
450The used tags are remembered. Commands that can be used with the tag stack
451are CTRL-T, ":pop" and ":tag". ":tags" lists the tag stack.
452
453The 'tags' option can be set to a list of tag file names. Thus multiple
454tag files can be used. For file names that start with "./", the "./" is
455replaced with the path of the current file. This makes it possible to use a
456tags file in the same directory as the file being edited.
457
458Previously used file names are remembered in the alternate file name list.
459CTRL-^ accepts a count, which is an index in this list.
460":files" command shows the list of alternate file names.
461"#<N>" is replaced with the <N>th alternate file name in the list.
462"#<" is replaced with the current file name without extension.
463
464Search patterns have more features. The <NL> character is seen as part of the
465search pattern and the substitute string of ":s". Vi sees it as the end of
466the command.
467
468Searches can put the cursor on the end of a match and may include a character
469offset.
470
471Count added to "~", ":next", ":Next", "n" and "N".
472
473The command ":next!" with 'autowrite' set does not write the file. In vi the
474file was written, but this is considered to be a bug, because one does not
475expect it and the file is not written with ":rewind!".
476
477In Vi when entering a <CR> in replace mode deletes a character only when 'ai'
478is set (but does not show it until you hit <Esc>). Vim always deletes a
479character (and shows it immediately).
480
481Added :wnext command. Same as ":write" followed by ":next".
482
483The ":w!" command always writes, also when the file is write protected. In Vi
484you would have to do ":!chmod +w %" and ":set noro".
485
486When 'tildeop' has been set, "~" is an operator (must be followed by a
487movement command).
488
489With the "J" (join) command you can reset the 'joinspaces' option to have only
490one space after a period (Vi inserts two spaces).
491
492"cw" can be used to change white space formed by several characters (Vi is
493confusing: "cw" only changes one space, while "dw" deletes all white space).
494
495"o" and "O" accept a count for repeating the insert (Vi clears a part of
496display).
497
498Flags after Ex commands not supported (no plans to include it).
499
500On non-UNIX systems ":cd" command shows current directory instead of going to
501the home directory (there isn't one). ":pwd" prints the current directory on
502all systems.
503
504After a ":cd" command the file names (in the argument list, opened files)
505still point to the same files. In Vi ":cd" is not allowed in a changed file;
506otherwise the meaning of file names change.
507
508":source!" command reads Vi commands from a file.
509
510":mkexrc" command writes current modified options and mappings to a ".exrc"
511file. ":mkvimrc" writes to a ".vimrc" file.
512
513No check for "tail recursion" with mappings. This allows things like
514":map! foo ^]foo".
515
516When a mapping starts with number, vi loses the count typed before it (e.g.
517when using the mapping ":map g 4G" the command "7g" goes to line 4). This is
518considered a vi bug. Vim concatenates the counts (in the example it becomes
519"74G"), as most people would expect.
520
521The :put! command inserts the contents of a register above the current line.
522
523The "p" and "P" commands of vi cannot be repeated with "." when the putted
524text is less than a line. In Vim they can always be repeated.
525
526":noremap" command can be used to enter a mapping that will not be remapped.
527This is useful to exchange the meaning of two keys. ":cmap", ":cunmap" and
528":cnoremap" can be used for mapping in command-line editing only. ":imap",
529":iunmap" and ":inoremap" can be used for mapping in insert mode only.
530Similar commands exist for abbreviations: ":noreabbrev", ":iabbrev"
531":cabbrev", ":iunabbrev", ":cunabbrev", ":inoreabbrev", ":cnoreabbrev".
532
533In Vi the command ":map foo bar" would remove a previous mapping
534":map bug foo". This is considered a bug, so it is not included in Vim.
535":unmap! foo" does remove ":map! bug foo", because unmapping would be very
536difficult otherwise (this is vi compatible).
537
538The ':' register contains the last command-line.
539The '%' register contains the current file name.
540The '.' register contains the last inserted text.
541
542":dis" command shows the contents of the yank registers.
543
544CTRL-O/CTRL-I can be used to jump to older/newer positions. These are the
545same positions as used with the '' command, but may be in another file. The
546":jumps" command lists the older positions.
547
548If the 'shiftround' option is set, an indent is rounded to a multiple of
549'shiftwidth' with ">" and "<" commands.
550
551The 'scrolljump' option can be set to the minimum number of lines to scroll
552when the cursor gets off the screen. Use this when scrolling is slow.
553
554The 'scrolloff' option can be set to the minimum number of lines to keep
555above and below the cursor. This gives some context to where you are
556editing. When set to a large number the cursor line is always in the middle
557of the window.
558
559Uppercase marks can be used to jump between files. The ":marks" command lists
560all currently set marks. The commands "']" and "`]" jump to the end of the
561previous operator or end of the text inserted with the put command. "'[" and
562"`[" do jump to the start.
563
564The 'shelltype' option can be set to reflect the type of shell used on the
565Amiga.
566
567The 'highlight' option can be set for the highlight mode to be used for
568several commands.
569
570The CTRL-A (add) and CTRL-X (subtract) commands are new. The count to the
571command (default 1) is added to/subtracted from the number at or after the
572cursor. That number may be decimal, octal (starts with a '0') or hexadecimal
573(starts with '0x'). Very useful in macros.
574
575With the :set command the prefix "inv" can be used to invert boolean options.
576
577In both Vi and Vim you can create a line break with the ":substitute" command
578by using a CTRL-M. For Vi this means you cannot insert a real CTRL-M in the
579text. With Vim you can put a real CTRL-M in the text by preceding it with a
580CTRL-V.
581
582
583In Insert mode:
584
585If the 'revins' option is set, insert happens backwards. This is for typing
586Hebrew. When inserting normal characters the cursor will not be shifted and
587the text moves rightwards. Backspace, CTRL-W and CTRL-U will also work in
588the opposite direction. CTRL-B toggles the 'revins' option. In replace mode
589'revins' has no effect. Only when enabled at compile time.
590
591The backspace key can be used just like CTRL-D to remove auto-indents.
592
593You can backspace, CTRL-U and CTRL-W over line breaks if the 'backspace' (bs)
594option includes "eol". You can backspace over the start of insert if the
595'backspace' option includes "start".
596
597When the 'paste' option is set, a few option are reset and mapping in insert
598mode and abbreviation are disabled. This allows for pasting text in windowing
599systems without unexpected results. When the 'paste' option is reset, the old
600option values are restored.
601
602CTRL-T/CTRL-D always insert/delete an indent in the current line, no matter
603what column the cursor is in.
604
605CTRL-@ (insert previously inserted text) works always (Vi: only when typed as
606first character).
607
608CTRL-A works like CTRL-@ but does not leave insert mode.
609
610CTRL-R {0-9a-z..} can be used to insert the contents of a register.
611
612When the 'smartindent' option is set, C programs will be better auto-indented.
613With 'cindent' even more.
614
615CTRL-Y and CTRL-E can be used to copy a character from above/below the
616current cursor position.
617
618After CTRL-V you can enter a three digit decimal number. This byte value is
619inserted in the text as a single character. Useful for international
620characters that are not on your keyboard.
621
622When the 'expandtab' (et) option is set, a <Tab> is expanded to the
623appropriate number of spaces.
624
625The window always reflects the contents of the buffer (Vi does not do this
626when changing text and in some other cases).
627
628If Vim is compiled with DIGRAPHS defined, digraphs are supported. A set of
629normal digraphs is included. They are shown with the ":digraph" command.
630More can be added with ":digraph {char1}{char2} {number}". A digraph is
631entered with "CTRL-K {char1} {char2}" or "{char1} BS {char2}" (only when
632'digraph' option is set).
633
634When repeating an insert, e.g. "10atest <Esc>" vi would only handle wrapmargin
635for the first insert. Vim does it for all.
636
637A count to the "i" or "a" command is used for all the text. Vi uses the count
638only for one line. "3iabc<NL>def<Esc>" would insert "abcabcabc<NL>def" in Vi
639but "abc<NL>defabc<NL>defabc<NL>def" in Vim.
640
641
642In Command-line mode:
643
Bram Moolenaar4499d2e2005-04-15 20:41:38 +0000644<Esc> terminates the command-line without executing it. In vi the command
Bram Moolenaar071d4272004-06-13 20:20:40 +0000645line would be executed, which is not what most people expect (hitting <Esc>
646should always get you back to command mode). To avoid problems with some
647obscure macros, an <Esc> in a macro will execute the command. If you want a
648typed <Esc> to execute the command like vi does you can fix this with
649 ":cmap ^V<Esc> ^V<CR>"
650
651General:
652
653The 'ttimeout' option is like 'timeout', but only works for cursor and
654function keys, not for ordinary mapped characters. The 'timeoutlen' option
655gives the number of milliseconds that is waited for. If the 'esckeys' option
656is not set, cursor and function keys that start with <Esc> are not recognized
657in insert mode.
658
659There is an option for each terminal string. Can be used when termcap is not
660supported or to change individual strings.
661
662The 'fileformat' option can be set to select the <EOL>: "dos" <CR><NL>, "unix"
663<NL> or "mac" <CR>.
664When the 'fileformats' option is not empty, Vim tries to detect the type of
665<EOL> automatically. The 'fileformat' option is set accordingly.
666
667On systems that have no job control (older Unix systems and non-Unix systems)
668the CTRL-Z, ":stop" or ":suspend" command starts a new shell.
669
670If Vim is started on the Amiga without an interactive window for output, a
671window is opened (and :sh still works). You can give a device to use for
672editing with the |-d| argument, e.g. "-d con:20/20/600/150".
673
674The 'columns' and 'lines' options are used to set or get the width and height
675of the display.
676
677Option settings are read from the first and last few lines of the file.
678Option 'modelines' determines how many lines are tried (default is 5). Note
679that this is different from the Vi versions that can execute any Ex command
680in a modeline (a major security problem). |trojan-horse|
681
682If the 'insertmode' option is set (e.g. in .exrc), Vim starts in insert mode.
683And it comes back there, when pressing <Esc>.
684
685Undo information is kept in memory. Available memory limits the number and
686size of change that can be undone. This may be a problem with MS-DOS, is
687hardly a problem on the Amiga and almost never with Unix and Win32.
688
689If the 'backup' or 'writebackup' option is set: Before a file is overwritten,
690a backup file (.bak) is made. If the "backup" option is set it is left
691behind.
692
693Vim creates a file ending in ".swp" to store parts of the file that have been
694changed or that do not fit in memory. This file can be used to recover from
695an aborted editing session with "vim -r file". Using the swap file can be
696switched off by setting the 'updatecount' option to 0 or starting Vim with
697the "-n" option. Use the 'directory' option for placing the .swp file
698somewhere else.
699
700Vim is able to work correctly on filesystems with 8.3 file names, also when
701using messydos or crossdos filesystems on the Amiga, or any 8.3 mounted
702filesystem under Unix. See |'shortname'|.
703
704Error messages are shown at least one second (Vi overwrites error messages).
705
706If Vim gives the |hit-enter| prompt, you can hit any key. Characters other
707than <CR>, <NL> and <Space> are interpreted as the (start of) a command. (Vi
708only accepts a command starting with ':').
709
710The contents of the numbered and unnamed registers is remembered when
711changing files.
712
713The "No lines in buffer" message is a normal message instead of an error
714message, since that may cause a mapping to be aborted.
715
716The AUX: device of the Amiga is supported.
717
718==============================================================================
7196. Command-line arguments *cmdline-arguments*
720
721Different versions of Vi have different command-line arguments. This can be
722confusing. To help you, this section gives an overview of the differences.
723
724Five variants of Vi will be considered here:
725 Elvis Elvis version 2.1b
726 Nvi Nvi version 1.79
727 Posix Posix 1003.2
728 Vi Vi version 3.7 (for Sun 4.1.x)
729 Vile Vile version 7.4 (incomplete)
730 Vim Vim version 5.2
731
732Only Vim is able to accept options in between and after the file names.
733
734+{command} Elvis, Nvi, Posix, Vi, Vim: Same as "-c {command}".
735
736- Nvi, Posix, Vi: Run Ex in batch mode.
737 Vim: Read file from stdin (use -s for batch mode).
738
739-- Vim: End of options, only file names are following.
740
741--cmd {command} Vim: execute {command} before sourcing vimrc files.
742
743--echo-wid Vim: GTK+ echoes the Window ID on stdout
744
745--help Vim: show help message and exit.
746
747--literal Vim: take file names literally, don't expand wildcards.
748
749--nofork Vim: same as |-f|
750
751--noplugin[s] Vim: Skip loading plugins.
752
753--remote Vim: edit the files in another Vim server
754
755--remote-expr {expr} Vim: evaluate {expr} in another Vim server
756
757--remote-send {keys} Vim: send {keys} to a Vim server and exit
758
759--remote-silent {file} Vim: edit the files in another Vim server if possible
760
761--remote-wait Vim: edit the files in another Vim server and wait for it
762
763--remote-wait-silent Vim: like --remote-wait, no complaints if not possible
764
765--role {role} Vim: GTK+ 2: set role of main window
766
767--serverlist Vim: Output a list of Vim servers and exit
768
769--servername {name} Vim: Specify Vim server name
770
771--socketid {id} Vim: GTK window socket to run Vim in
772
773--version Vim: show version message and exit.
774
775-? Vile: print usage summary and exit.
776
777-a Elvis: Load all specified file names into a window (use -o for
778 Vim).
779
780-A Vim: Start in Arabic mode (when compiled with Arabic).
781
782-b {blksize} Elvis: Use {blksize} blocksize for the session file.
783-b Vim: set 'binary' mode.
784
785-C Vim: Compatible mode.
786
787-c {command} Elvis, Nvi, Posix, Vim: run {command} as an Ex command after
788 loading the edit buffer.
789 Vim: allow up to 10 "-c" arguments
790
791-d {device} Vim: Use {device} for I/O (Amiga only). {only when compiled
792 without the |+diff| feature}
793-d Vim: start with 'diff' set. |vimdiff|
794
795-dev {device} Vim: Use {device} for I/O (Amiga only).
796
797-D Vim: debug mode.
798
799-e Elvis, Nvi, Vim: Start in Ex mode, as if the executable is
800 called "ex".
801
802-E Vim: Start in improved Ex mode |gQ|, like "exim".
803
804-f Vim: Run GUI in foreground (Amiga: don't open new window).
805-f {session} Elvis: Use {session} as the session file.
806
807-F Vim: Start in Farsi mode (when compiled with Farsi).
808 Nvi: Fast start, don't read the entire file when editing
809 starts.
810
811-G {gui} Elvis: Use the {gui} as user interface.
812
813-g Vim: Start GUI.
814-g N Vile: start editing at line N
815
816-h Vim: Give help message.
817 Vile: edit the help file
818
819-H Vim: start Hebrew mode (when compiled with it).
820
821-i Elvis: Start each window in Insert mode.
822-i {viminfo} Vim: Use {viminfo} for viminfo file.
823
824-L Vim: Same as "-r" (also in some versions of Vi).
825
826-l Nvi, Vi, Vim: Set 'lisp' and 'showmatch' options.
827
828-m Vim: Modifications not allowed to be written, resets 'write'
829 option.
830
831-M Vim: Modifications not allowed, resets 'modifiable' and the
832 'write' option.
833
834-N Vim: No-compatible mode.
835
836-n Vim: No swap file used.
837
838-nb[args] Vim: open a NetBeans interface connection
839
840-O[N] Vim: Like -o, but use vertically split windows.
841
842-o[N] Vim: Open [N] windows, or one for each file.
843
844-P {parent-title} Win32 Vim: open Vim inside a parent application window
845
846-q {name} Vim: Use {name} for quickfix error file.
847-q{name} Vim: Idem.
848
849-R Elvis, Nvi, Posix, Vile, Vim: Set the 'readonly' option.
850
851-r Elvis, Nvi, Posix, Vi, Vim: Recovery mode.
852
853-S Nvi: Set 'secure' option.
854-S {script} Vim: source script after starting up.
855
856-s Nvi, Posix, Vim: Same as "-" (silent mode), when in Ex mode.
857 Elvis: Sets the 'safer' option.
858-s {scriptin} Vim: Read from script file {scriptin}; only when not in Ex
859 mode.
860-s {pattern} Vile: search for {pattern}
861
862-t {tag} Elvis, Nvi, Posix, Vi, Vim: Edit the file containing {tag}.
863-t{tag} Vim: Idem.
864
865-T {term} Vim: Set terminal name to {term}.
866
867-u {vimrc} Vim: Read initializations from {vimrc} file.
868
869-U {gvimrc} Vim: Read GUI initializations from {gvimrc} file.
870
871-v Nvi, Posix, Vi, Vim: Begin in Normal mode (visual mode, in Vi
872 terms).
873 Vile: View mode, no changes possible.
874
875-V Elvis, Vim: Verbose mode.
876-V{nr} Vim: Verbose mode with specified level.
877
878-w {size} Elvis, Posix, Nvi, Vi, Vim: Set value of 'window' to {size}.
879-w{size} Nvi, Vi: Same as "-w {size}".
880-w {name} Vim: Write to script file {name} (must start with non-digit).
881
882-W {name} Vim: Append to script file {name}.
883
884-x Vi, Vim: Ask for encryption key. See |encryption|.
885
886-X Vim: Don't connect to the X server.
887
888-y Vim: Start in easy mode, like |evim|.
889
890-Z Vim: restricted mode
891
892@{cmdfile} Vile: use {cmdfile} as startup file.
893
Bram Moolenaarf97ca8f2005-02-07 21:49:25 +0000894==============================================================================
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008957. POSIX compliance *posix* *posix-compliance*
Bram Moolenaarf97ca8f2005-02-07 21:49:25 +0000896
897In 2005 the POSIX test suite was run to check the compatiblity of Vim. Most
Bram Moolenaar4399ef42005-02-12 14:29:27 +0000898of the test was executed properly. There are the few things where Vim
Bram Moolenaar6bdcfc02005-02-22 08:28:13 +0000899is not POSIX compliant, even when run in Vi compatibility mode.
Bram Moolenaarf97ca8f2005-02-07 21:49:25 +0000900
Bram Moolenaar4399ef42005-02-12 14:29:27 +0000901Set the $VIM_POSIX environment variable to have 'cpoptions' include the POSIX
902flags when Vim starts up. This makes Vim run as POSIX as it can. That's
Bram Moolenaar6bdcfc02005-02-22 08:28:13 +0000903a bit different from being Vi compatible.
Bram Moolenaar4399ef42005-02-12 14:29:27 +0000904
905This is where Vim does not behave as POSIX specifies and why:
906
Bram Moolenaarf97ca8f2005-02-07 21:49:25 +0000907 *posix-screen-size*
Bram Moolenaar4399ef42005-02-12 14:29:27 +0000908 The $COLUMNS and $LINES environment variables are ignored by Vim if
909 the size can be obtained from the terminal in a more reliable way.
910 Add the '|' flag to 'cpoptions' to have $COLUMNS and $LINES overrule
911 sizes obtained in another way.
Bram Moolenaarf97ca8f2005-02-07 21:49:25 +0000912
Bram Moolenaar4399ef42005-02-12 14:29:27 +0000913 The "{" and "}" commands don't stop at a "{" in the original Vi, but
914 POSIX specifies it does. Add the '{' flag to 'cpoptions' if you want
915 it the POSIX way.
916
917 The "D", "o" and "O" commands accept a count. Also when repeated.
918 Add the '#' flag to 'cpoptions' if you want to ignore the count.
Bram Moolenaarf97ca8f2005-02-07 21:49:25 +0000919
Bram Moolenaar6bdcfc02005-02-22 08:28:13 +0000920 The ":cd" command fails if the current buffer is modified when the '.'
921 flag is present in 'cpoptions'.
922
923 There is no ATTENTION message, the "A" flag is added to 'shortmess'.
924
925These are remarks about running the POSIX test suite:
926- vi test 33 sometimes fails for unknown reasons
927- vi test 250 fails; behavior will be changed in a new revision
928 http://www.opengroup.org/austin/mailarchives/ag-review/msg01710.html
929- vi test 310 fails; exit code non-zero when any error occurred?
930- ex test 24 fails because test is wrong. Changed between SUSv2 and SUSv3.
931- ex tests 47, 48, 49, 72, 73 fail because .exrc file isn't read in silent
932 mode and $EXINIT isn't used.
933- ex tests 76, 78 fail because echo is used instead of printf. (fixed)
934 Also: problem with \s not changed to space.
935- ex test 355 fails because 'window' isn't used for "30z".
936- ex test 368 fails because shell command isn't echoed in silent mode.
937- ex test 394 fails because "=" command output isn't visible in silent mode.
938- ex test 411 fails because test file is wrong, contains stray ':'.
939- ex test 475 and 476 fail because reprint output isn't visible in silent mode.
940- ex test 480 and 481 fail because the tags file has spaces instead of a tab.
941- ex test 502 fails because .exrc isn't read in silent mode.
942- ex test 509 fails because .exrc isn't read in silent mode. and exit code is
943 1 instead of 2.
944- ex test 534 fails because .exrc isn't read in silent mode.
945
Bram Moolenaarf97ca8f2005-02-07 21:49:25 +0000946
Bram Moolenaar071d4272004-06-13 20:20:40 +0000947 vim:tw=78:ts=8:ft=help:norl: