blob: b71fdbce47a72ccbac168f26315d38f49dc5d102 [file] [log] [blame]
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001*vi_diff.txt* For Vim version 8.1. Last change: 2019 Apr 28
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|
Bram Moolenaar6c60f472019-04-28 16:00:35 +0200226. Supported Vi features |vi-features|
237. Command-line arguments |cmdline-arguments|
248. POSIX compliance |posix-compliance|
Bram Moolenaar071d4272004-06-13 20:20:40 +000025
26==============================================================================
Bram Moolenaar6bdcfc02005-02-22 08:28:13 +0000271. Simulated command *simulated-command*
Bram Moolenaar071d4272004-06-13 20:20:40 +000028
Bram Moolenaardd2a3cd2007-05-05 17:10:09 +000029This command is in Vi, but Vim only simulates it:
Bram Moolenaar071d4272004-06-13 20:20:40 +000030
Bram Moolenaar6bdcfc02005-02-22 08:28:13 +000031 *:o* *:op* *:open*
32:[range]o[pen] Works like |:visual|: end Ex mode.
33 {Vi: start editing in open mode}
34
35:[range]o[pen] /pattern/ As above, additionally move the cursor to the
36 column where "pattern" matches in the cursor
37 line.
38
39Vim does not support open mode, since it's not really useful. For those
40situations where ":open" would start open mode Vim will leave Ex mode, which
41allows executing the same commands, but updates the whole screen instead of
42only one line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000043
44==============================================================================
452. Missing options *missing-options*
46
47These options are in the Unix Vi, but not in Vim. If you try to set one of
48them you won't get an error message, but the value is not used and cannot be
49printed.
50
51autoprint (ap) boolean (default on) *'autoprint'* *'ap'*
52beautify (bf) boolean (default off) *'beautify'* *'bf'*
53flash (fl) boolean (default ??) *'flash'* *'fl'*
54graphic (gr) boolean (default off) *'graphic'* *'gr'*
55hardtabs (ht) number (default 8) *'hardtabs'* *'ht'*
56 number of spaces that a <Tab> moves on the display
57mesg boolean (default on) *'mesg'*
58novice boolean (default off) *'novice'*
59open boolean (default on) *'open'*
60optimize (op) boolean (default off) *'optimize'* *'op'*
Bram Moolenaar071d4272004-06-13 20:20:40 +000061redraw boolean (default off) *'redraw'*
62slowopen (slow) boolean (default off) *'slowopen'* *'slow'*
63sourceany boolean (default off) *'sourceany'*
Bram Moolenaar071d4272004-06-13 20:20:40 +000064w300 number (default 23) *'w300'*
65w1200 number (default 23) *'w1200'*
66w9600 number (default 23) *'w9600'*
67
68==============================================================================
693. Limits *limits*
70
71Vim has only a few limits for the files that can be edited {Vi: can not handle
72<Nul> characters and characters above 128, has limited line length, many other
73limits}.
74 *E340*
75Maximum line length On machines with 16-bit ints (Amiga and MS-DOS real
76 mode): 32767, otherwise 2147483647 characters.
77 Longer lines are split.
78Maximum number of lines 2147483647 lines.
79Maximum file size 2147483647 bytes (2 Gbyte) when a long integer is
80 32 bits. Much more for 64 bit longs. Also limited
81 by available disk space for the |swap-file|.
82 *E75*
83Length of a file path Unix and Win32: 1024 characters, otherwise 256
84 characters (or as much as the system supports).
85Length of an expanded string option
86 Unix and Win32: 1024 characters, otherwise 256
87 characters
88Maximum display width Unix and Win32: 1024 characters, otherwise 255
89 characters
90Maximum lhs of a mapping 50 characters.
Bram Moolenaar4770d092006-01-12 23:22:24 +000091Number of different highlighting types: over 30000
Bram Moolenaar5302d9e2011-09-14 17:55:08 +020092Range of a Number variable: -2147483648 to 2147483647 (might be more on 64
93 bit systems)
Bram Moolenaar4a748032010-09-30 21:47:56 +020094Maximum length of a line in a tags file: 512 bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +000095
96Information for undo and text in registers is kept in memory, thus when making
97(big) changes the amount of (virtual) memory available limits the number of
98undo levels and the text that can be kept in registers. Other things are also
99kept in memory: Command-line history, error messages for Quickfix mode, etc.
100
101Memory usage limits
102-------------------
103
104The option 'maxmem' ('mm') is used to set the maximum memory used for one
105buffer (in kilobytes). 'maxmemtot' is used to set the maximum memory used for
106all buffers (in kilobytes). The defaults depend on the system used. For the
107Amiga and MS-DOS, 'maxmemtot' is set depending on the amount of memory
Bram Moolenaar18144c82006-04-12 21:52:12 +0000108available.
109These are not hard limits, but tell Vim when to move text into a swap file.
110If you don't like Vim to swap to a file, set 'maxmem' and 'maxmemtot' to a
111very large value. The swap file will then only be used for recovery. If you
112don't want a swap file at all, set 'updatecount' to 0, or use the "-n"
113argument when starting Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000114
115==============================================================================
1164. The most interesting additions *vim-additions*
117
118Vi compatibility. |'compatible'|
119 Although Vim is 99% Vi compatible, some things in Vi can be
120 considered to be a bug, or at least need improvement. But still, Vim
121 starts in a mode which behaves like the "real" Vi as much as possible.
122 To make Vim behave a little bit better, try resetting the 'compatible'
123 option:
124 :set nocompatible
125 Or start Vim with the "-N" argument:
126 vim -N
Bram Moolenaar18144c82006-04-12 21:52:12 +0000127 Vim starts with 'nocompatible' automatically if you have a .vimrc
128 file. See |startup|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000129 The 'cpoptions' option can be used to set Vi compatibility on/off for
130 a number of specific items.
131
132Support for different systems.
133 Vim can be used on:
134 - All Unix systems (it works on all systems it was tested on, although
135 the GUI and Perl interface may not work everywhere).
136 - Amiga (500, 1000, 1200, 2000, 3000, 4000, ...).
137 - MS-DOS in real-mode (no additional drivers required).
138 - In protected mode on Windows 3.1 and MS-DOS (DPMI driver required).
139 - Windows 95 and Windows NT, with support for long file names.
140 - OS/2 (needs emx.dll)
141 - Atari MiNT
142 - VMS
143 - BeOS
144 - Macintosh
145 - Risc OS
146 - IBM OS/390
Bram Moolenaar18144c82006-04-12 21:52:12 +0000147 Note that on some systems features need to be disabled to reduce
148 resource usage, esp. on MS-DOS. For some outdated systems you need to
149 use an older Vim version.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000150
Bram Moolenaardc1f1642016-08-16 18:33:43 +0200151Multi level persistent undo. |undo|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152 'u' goes backward in time, 'CTRL-R' goes forward again. Set option
153 'undolevels' to the number of changes to be remembered (default 1000).
Bram Moolenaar7cba6c02013-09-05 22:13:31 +0200154 Set 'undolevels' to 0 for a Vi-compatible one level undo. Set it to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000155 -1 for no undo at all.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000156 When all changes in a buffer have been undone, the buffer is not
157 considered changed anymore. You can exit it with :q, without <!>.
Bram Moolenaar18144c82006-04-12 21:52:12 +0000158 When undoing a few changes and then making a new change Vim will
159 create a branch in the undo tree. This means you can go back to any
Bram Moolenaar143c38c2007-05-10 16:41:10 +0000160 state of the text, there is no risk of a change causing text to be
Bram Moolenaar18144c82006-04-12 21:52:12 +0000161 lost forever. |undo-tree|
Bram Moolenaardc1f1642016-08-16 18:33:43 +0200162 The undo information is stored in a file when the 'undofile' option is
163 set. This means you can exit Vim, start Vim on a previously edited
164 file and undo changes that were made before exiting Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000165
Bram Moolenaar18144c82006-04-12 21:52:12 +0000166Graphical User Interface (GUI). |gui|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000167 Included support for GUI: menu's, mouse, scrollbars, etc. You can
168 define your own menus. Better support for CTRL/SHIFT/ALT keys in
169 combination with special keys and mouse. Supported for various
170 platforms, such as X11 (with Motif and Athena interfaces), GTK, Win32
171 (Windows 95 and later), BeOS, Amiga and Macintosh.
172
173Multiple windows and buffers. |windows.txt|
174 Vim can split the screen into several windows, each editing a
175 different buffer or the same buffer at a different location. Buffers
176 can still be loaded (and changed) but not displayed in a window. This
177 is called a hidden buffer. Many commands and options have been added
178 for this facility.
Bram Moolenaar18144c82006-04-12 21:52:12 +0000179 Vim can also use multiple tab pages, each with one or more windows. A
180 line with tab labels can be used to quickly switch between these pages.
181 |tab-page|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000182
183Syntax highlighting. |:syntax|
184 Vim can highlight keywords, patterns and other things. This is
Bram Moolenaar18144c82006-04-12 21:52:12 +0000185 defined by a number of |:syntax| commands, and can be made to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000186 highlight most languages and file types. A number of files are
187 included for highlighting the most common languages, like C, C++,
188 Java, Pascal, Makefiles, shell scripts, etc. The colors used for
189 highlighting can be defined for ordinary terminals, color terminals
Bram Moolenaar18144c82006-04-12 21:52:12 +0000190 and the GUI with the |:highlight| command. A convenient way to do
191 this is using a |:colorscheme| command.
192 The highlighted text can be exported as HTML. |convert-to-HTML|
193 Other items that can be highlighted are matches with the search string
194 |'hlsearch'|, matching parens |matchparen| and the cursor line and
195 column |'cursorline'| |'cursorcolumn'|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000196
Bram Moolenaar18144c82006-04-12 21:52:12 +0000197Spell checking. |spell|
198 When the 'spell' option is set Vim will highlight spelling mistakes.
Bram Moolenaar9b451252012-08-15 17:43:31 +0200199 About 50 languages are currently supported, selected with the
Bram Moolenaarf2330482008-06-24 20:19:36 +0000200 'spelllang' option. In source code only comments and strings are
Bram Moolenaar18144c82006-04-12 21:52:12 +0000201 checked for spelling.
202
203Folding. |folding|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000204 A range of lines can be shown as one "folded" line. This allows
205 overviewing a file and moving blocks of text around quickly.
206 Folds can be created manually, from the syntax of the file, by indent,
207 etc.
208
Bram Moolenaar18144c82006-04-12 21:52:12 +0000209Diff mode. |diff|
210 Vim can show two versions of a file with the differences highlighted.
211 Parts of the text that are equal are folded away. Commands can be
212 used to move text from one version to the other.
213
214Plugins. |add-plugin|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000215 The functionality can be extended by dropping a plugin file in the
216 right directory. That's an easy way to start using Vim scripts
217 written by others. Plugins can be for all kind of files, or
218 specifically for a filetype.
Bram Moolenaardc1f1642016-08-16 18:33:43 +0200219 Packages make this even easier. |packages|
220
221Asynchronous communication and timers. |channel| |job| |timer|
222 Vim can exchange messages with other processes in the background.
223 This makes it possible to have servers do work and send back the
224 results to Vim. |channel|
225 Vim can start a job, communicate with it and stop it. |job|
226 Timers can fire once or repeatedly and invoke a function to do any
227 work. |timer|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000228
229Repeat a series of commands. |q|
Bram Moolenaar18144c82006-04-12 21:52:12 +0000230 "q{c}" starts recording typed characters into named register {c}.
231 A subsequent "q" stops recording. The register can then be executed
232 with the "@{c}" command. This is very useful to repeat a complex
233 action.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000234
235Flexible insert mode. |ins-special-special|
236 The arrow keys can be used in insert mode to move around in the file.
237 This breaks the insert in two parts as far as undo and redo is
238 concerned.
239
Bram Moolenaar18144c82006-04-12 21:52:12 +0000240 CTRL-O can be used to execute a single Normal mode command. This is
241 almost the same as hitting <Esc>, typing the command and doing |a|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000242
243Visual mode. |Visual-mode|
Bram Moolenaar18144c82006-04-12 21:52:12 +0000244 Visual mode can be used to first highlight a piece of text and then
245 give a command to do something with it. This is an (easy to use)
246 alternative to first giving the operator and then moving to the end of
247 the text to be operated upon.
248 |v| and |V| are used to start Visual mode. |v| works on characters
249 and |V| on lines. Move the cursor to extend the Visual area. It is
250 shown highlighted on the screen. By typing "o" the other end of the
251 Visual area can be moved. The Visual area can be affected by an
252 operator:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000253 d delete
254 c change
255 y yank
256 > or < insert or delete indent
257 ! filter through external program
258 = filter through indent
Bram Moolenaar18144c82006-04-12 21:52:12 +0000259 : start |:| command for the Visual lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000260 gq format text to 'textwidth' columns
261 J join lines
262 ~ swap case
263 u make lowercase
264 U make uppercase
265
266Block operators. |visual-block|
Bram Moolenaar18144c82006-04-12 21:52:12 +0000267 With Visual mode a rectangular block of text can be selected. Start
268 Visual mode with CTRL-V. The block can be deleted ("d"), yanked ("y")
269 or its case can be changed ("~", "u" and "U"). A deleted or yanked
270 block can be put into the text with the "p" and "P" commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000271
Bram Moolenaar18144c82006-04-12 21:52:12 +0000272Help system. |:help|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000273 Help is displayed in a window. The usual commands can be used to
274 move around, search for a string, etc. Tags can be used to jump
Bram Moolenaar18144c82006-04-12 21:52:12 +0000275 around in the help files, just like hypertext links. The |:help|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000276 command takes an argument to quickly jump to the info on a subject.
277 <F1> is the quick access to the help system. The name of the help
278 index file can be set with the 'helpfile' option.
279
280Command-line editing and history. |cmdline-editing|
281 You can insert or delete at any place in the command-line using the
282 cursor keys. The right/left cursor keys can be used to move
283 forward/backward one character. The shifted right/left cursor keys
284 can be used to move forward/backward one word. CTRL-B/CTRL-E can be
285 used to go to the begin/end of the command-line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000286 |cmdline-history|
287 The command-lines are remembered. The up/down cursor keys can be used
288 to recall previous command-lines. The 'history' option can be set to
289 the number of lines that will be remembered. There is a separate
290 history for commands and for search patterns.
291
292Command-line completion. |cmdline-completion|
293 While entering a command-line (on the bottom line of the screen)
294 <Tab> can be typed to complete
295 what example ~
296 - command :e<Tab>
297 - tag :ta scr<Tab>
298 - option :set sc<Tab>
299 - option value :set hf=<Tab>
300 - file name :e ve<Tab>
301 - etc.
302
303 If there are multiple matches, CTRL-N (next) and CTRL-P (previous)
304 will walk through the matches. <Tab> works like CTRL-N, but wraps
305 around to the first match.
306
307 The 'wildchar' option can be set to the character for command-line
308 completion, <Tab> is the default. CTRL-D can be typed after an
309 (incomplete) wildcard; all matches will be listed. CTRL-A will insert
310 all matches. CTRL-L will insert the longest common part of the
311 matches.
312
Bram Moolenaar18144c82006-04-12 21:52:12 +0000313Insert-mode completion. |ins-completion|
314 In Insert mode the CTRL-N and CTRL-P keys can be used to complete a
315 word that appears elsewhere. |i_CTRL-N|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 With CTRL-X another mode is entered, through which completion can be
317 done for:
318 |i_CTRL-X_CTRL-F| file names
319 |i_CTRL-X_CTRL-K| words from 'dictionary' files
320 |i_CTRL-X_CTRL-T| words from 'thesaurus' files
321 |i_CTRL-X_CTRL-I| words from included files
322 |i_CTRL-X_CTRL-L| whole lines
323 |i_CTRL-X_CTRL-]| words from the tags file
324 |i_CTRL-X_CTRL-D| definitions or macros
Bram Moolenaar18144c82006-04-12 21:52:12 +0000325 |i_CTRL-X_CTRL-O| Omni completion: clever completion
326 specifically for a file type
327 etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000328
Bram Moolenaar18144c82006-04-12 21:52:12 +0000329Long line support. |'wrap'| |'linebreak'|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000330 If the 'wrap' option is off, long lines will not wrap and only part
331 of them will be shown. When the cursor is moved to a part that is not
332 shown, the screen will scroll horizontally. The minimum number of
Bram Moolenaar18144c82006-04-12 21:52:12 +0000333 columns to scroll can be set with the 'sidescroll' option. The |zh|
334 and |zl| commands can be used to scroll sideways.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000335 Alternatively, long lines are broken in between words when the
336 'linebreak' option is set. This allows editing a single-line
337 paragraph conveniently (e.g. when the text is later read into a DTP
Bram Moolenaar18144c82006-04-12 21:52:12 +0000338 program). Move the cursor up/down with the |gk| and |gj| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000339
340Text formatting. |formatting|
341 The 'textwidth' option can be used to automatically limit the line
342 length. This supplements the 'wrapmargin' option of Vi, which was not
Bram Moolenaar18144c82006-04-12 21:52:12 +0000343 very useful. The |gq| operator can be used to format a piece of text
344 (for example, |gqap| formats the current paragraph). Commands for
345 text alignment: |:center|, |:left| and |:right|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000346
Bram Moolenaar18144c82006-04-12 21:52:12 +0000347Extended search patterns. |pattern|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000348 There are many extra items to match various text items. Examples:
349 A "\n" can be used in a search pattern to match a line break.
350 "x\{2,4}" matches "x" 2 to 4 times.
351 "\s" matches a white space character.
352
Bram Moolenaar18144c82006-04-12 21:52:12 +0000353Directory, remote and archive browsing. |netrw|
354 Vim can browse the file system. Simply edit a directory. Move around
355 in the list with the usual commands and press <Enter> to go to the
356 directory or file under the cursor.
357 This also works for remote files over ftp, http, ssh, etc.
358 Zip and tar archives can also be browsed. |tar| |zip|
359
Bram Moolenaar071d4272004-06-13 20:20:40 +0000360Edit-compile-edit speedup. |quickfix|
Bram Moolenaar18144c82006-04-12 21:52:12 +0000361 The |:make| command can be used to run the compilation and jump to the
362 first error. A file with compiler error messages is interpreted. Vim
363 jumps to the first error.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000364
365 Each line in the error file is scanned for the name of a file, line
366 number and error message. The 'errorformat' option can be set to a
367 list of scanf-like strings to handle output from many compilers.
368
Bram Moolenaar18144c82006-04-12 21:52:12 +0000369 The |:cn| command can be used to jump to the next error.
370 |:cl| lists all the error messages. Other commands are available.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000371 The 'makeef' option has the name of the file with error messages.
372 The 'makeprg' option contains the name of the program to be executed
Bram Moolenaar18144c82006-04-12 21:52:12 +0000373 with the |:make| command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000374 The 'shellpipe' option contains the string to be used to put the
375 output of the compiler into the errorfile.
376
Bram Moolenaar18144c82006-04-12 21:52:12 +0000377Finding matches in files. |:vimgrep|
378 Vim can search for a pattern in multiple files. This uses the
379 advanced Vim regexp pattern, works on all systems and also works to
380 search in compressed files.
381
382Improved indenting for programs. |'cindent'|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000383 When the 'cindent' option is on the indent of each line is
384 automatically adjusted. C syntax is mostly recognized. The indent
385 for various styles can be set with 'cinoptions'. The keys to trigger
386 indenting can be set with 'cinkeys'.
387
388 Comments can be automatically formatted. The 'comments' option can be
389 set to the characters that start and end a comment. This works best
390 for C code, but also works for e-mail (">" at start of the line) and
Bram Moolenaar18144c82006-04-12 21:52:12 +0000391 other types of text. The |=| operator can be used to re-indent
Bram Moolenaar071d4272004-06-13 20:20:40 +0000392 lines.
393
Bram Moolenaar18144c82006-04-12 21:52:12 +0000394 For many other languages an indent plugin is present to support
395 automatic indenting. |30.3|
396
397Searching for words in included files. |include-search|
398 The |[i| command can be used to search for a match of the word under
Bram Moolenaar071d4272004-06-13 20:20:40 +0000399 the cursor in the current and included files. The 'include' option
Bram Moolenaarc236c162008-07-13 17:41:49 +0000400 can be set to a pattern that describes a command to include a file
Bram Moolenaar071d4272004-06-13 20:20:40 +0000401 (the default is for C programs).
Bram Moolenaar18144c82006-04-12 21:52:12 +0000402 The |[I| command lists all matches, the |[_CTRL-I| command jumps to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000403 a match.
Bram Moolenaar18144c82006-04-12 21:52:12 +0000404 The |[d|, |[D| and |[_CTRL-D| commands do the same, but only for
Bram Moolenaar071d4272004-06-13 20:20:40 +0000405 lines where the pattern given with the 'define' option matches.
406
Bram Moolenaar18144c82006-04-12 21:52:12 +0000407Automatic commands. |autocommand|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000408 Commands can be automatically executed when reading a file, writing a
409 file, jumping to another buffer, etc., depending on the file name.
410 This is useful to set options and mappings for C programs,
411 documentation, plain text, e-mail, etc. This also makes it possible
412 to edit compressed files.
413
Bram Moolenaar18144c82006-04-12 21:52:12 +0000414Scripts and Expressions. |expression|
415 Commands have been added to form up a powerful script language.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000416 |:if| Conditional execution, which can be used for example
417 to set options depending on the value of $TERM.
418 |:while| Repeat a number of commands.
Bram Moolenaar18144c82006-04-12 21:52:12 +0000419 |:for| Loop over a list.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000420 |:echo| Print the result of an expression.
421 |:let| Assign a value to an internal variable, option, etc.
Bram Moolenaar18144c82006-04-12 21:52:12 +0000422 Variable types are Number, String, List and Dictionary.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000423 |:execute| Execute a command formed by an expression.
Bram Moolenaar18144c82006-04-12 21:52:12 +0000424 |:try| Catch exceptions.
425 etc., etc. See |eval|.
426 Debugging and profiling are supported. |debug-scripts| |profile|
427 If this is not enough, an interface is provided to |Python|, |Ruby|,
Bram Moolenaar0ba04292010-07-14 23:23:17 +0200428 |Tcl|, |Lua|, |Perl| and |MzScheme|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000429
Bram Moolenaar18144c82006-04-12 21:52:12 +0000430Viminfo. |viminfo-file|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000431 The command-line history, marks and registers can be stored in a file
432 that is read on startup. This can be used to repeat a search command
433 or command-line command after exiting and restarting Vim. It is also
Bram Moolenaar18144c82006-04-12 21:52:12 +0000434 possible to jump right back to where the last edit stopped with |'0|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000435 The 'viminfo' option can be set to select which items to store in the
436 .viminfo file. This is off by default.
437
Bram Moolenaar18144c82006-04-12 21:52:12 +0000438Printing. |printing|
439 The |:hardcopy| command sends text to the printer. This can include
440 syntax highlighting.
441
442Mouse support. |mouse-using|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000443 The mouse is supported in the GUI version, in an xterm for Unix, for
Bram Moolenaarf2330482008-06-24 20:19:36 +0000444 BSDs with sysmouse, for Linux with gpm, for MS-DOS, and Win32. It
445 can be used to position the cursor, select the visual area, paste a
446 register, etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000447
Bram Moolenaar18144c82006-04-12 21:52:12 +0000448Usage of key names. |<>| |key-notation|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000449 Special keys now all have a name like <Up>, <End>, etc.
450 This name can be used in mappings, to make it easy to edit them.
451
Bram Moolenaar18144c82006-04-12 21:52:12 +0000452Editing binary files. |edit-binary|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000453 Vim can edit binary files. You can change a few characters in an
454 executable file, without corrupting it. Vim doesn't remove NUL
455 characters (they are represented as <NL> internally).
456 |-b| command-line argument to start editing a binary file
Bram Moolenaar18144c82006-04-12 21:52:12 +0000457 |'binary'| Option set by |-b|. Prevents adding an <EOL> for the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000458 last line in the file.
459
Bram Moolenaar18144c82006-04-12 21:52:12 +0000460Multi-language support. |multi-lang|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000461 Files in double-byte or multi-byte encodings can be edited. There is
462 UTF-8 support to be able to edit various languages at the same time,
463 without switching fonts. |UTF-8|
464 Messages and menus are available in different languages.
465
Bram Moolenaar18144c82006-04-12 21:52:12 +0000466Move cursor beyond lines.
467 When the 'virtualedit' option is set the cursor can move all over the
468 screen, also where there is no text. This is useful to edit tables
469 and figures easily.
470
Bram Moolenaar071d4272004-06-13 20:20:40 +0000471==============================================================================
4725. Other vim features *other-features*
473
474A random collection of nice extra features.
475
476
477When Vim is started with "-s scriptfile", the characters read from
478"scriptfile" are treated as if you typed them. If end of file is reached
479before the editor exits, further characters are read from the console.
480
481The "-w" option can be used to record all typed characters in a script file.
482This file can then be used to redo the editing, possibly on another file or
483after changing some commands in the script file.
484
485The "-o" option opens a window for each argument. "-o4" opens four windows.
486
487Vi requires several termcap entries to be able to work full-screen. Vim only
488requires the "cm" entry (cursor motion).
489
490
491In command mode:
492
493When the 'showcmd' option is set, the command characters are shown in the last
494line of the screen. They are removed when the command is finished.
495
496If the 'ruler' option is set, the current cursor position is shown in the
497last line of the screen.
498
499"U" still works after having moved off the last changed line and after "u".
500
501Characters with the 8th bit set are displayed. The characters between '~' and
5020xa0 are displayed as "~?", "~@", "~A", etc., unless they are included in the
503'isprint' option.
504
505"][" goes to the next ending of a C function ('}' in column 1).
506"[]" goes to the previous ending of a C function ('}' in column 1).
507
508"]f", "[f" and "gf" start editing the file whose name is under the cursor.
509CTRL-W f splits the window and starts editing the file whose name is under
510the cursor.
511
512"*" searches forward for the identifier under the cursor, "#" backward.
513"K" runs the program defined by the 'keywordprg' option, with the identifier
514under the cursor as argument.
515
516"%" can be preceded with a count. The cursor jumps to the line that
517percentage down in the file. The normal "%" function to jump to the matching
518brace skips braces inside quotes.
519
520With the CTRL-] command, the cursor may be in the middle of the identifier.
521
522The used tags are remembered. Commands that can be used with the tag stack
523are CTRL-T, ":pop" and ":tag". ":tags" lists the tag stack.
524
525The 'tags' option can be set to a list of tag file names. Thus multiple
526tag files can be used. For file names that start with "./", the "./" is
527replaced with the path of the current file. This makes it possible to use a
528tags file in the same directory as the file being edited.
529
530Previously used file names are remembered in the alternate file name list.
531CTRL-^ accepts a count, which is an index in this list.
532":files" command shows the list of alternate file names.
533"#<N>" is replaced with the <N>th alternate file name in the list.
534"#<" is replaced with the current file name without extension.
535
536Search patterns have more features. The <NL> character is seen as part of the
537search pattern and the substitute string of ":s". Vi sees it as the end of
538the command.
539
540Searches can put the cursor on the end of a match and may include a character
541offset.
542
543Count added to "~", ":next", ":Next", "n" and "N".
544
545The command ":next!" with 'autowrite' set does not write the file. In vi the
546file was written, but this is considered to be a bug, because one does not
547expect it and the file is not written with ":rewind!".
548
549In Vi when entering a <CR> in replace mode deletes a character only when 'ai'
550is set (but does not show it until you hit <Esc>). Vim always deletes a
551character (and shows it immediately).
552
553Added :wnext command. Same as ":write" followed by ":next".
554
555The ":w!" command always writes, also when the file is write protected. In Vi
Bram Moolenaar26df0922014-02-23 23:39:13 +0100556you would have to do ":!chmod +w %:S" and ":set noro".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000557
558When 'tildeop' has been set, "~" is an operator (must be followed by a
559movement command).
560
561With the "J" (join) command you can reset the 'joinspaces' option to have only
562one space after a period (Vi inserts two spaces).
563
564"cw" can be used to change white space formed by several characters (Vi is
565confusing: "cw" only changes one space, while "dw" deletes all white space).
566
567"o" and "O" accept a count for repeating the insert (Vi clears a part of
568display).
569
570Flags after Ex commands not supported (no plans to include it).
571
572On non-UNIX systems ":cd" command shows current directory instead of going to
573the home directory (there isn't one). ":pwd" prints the current directory on
574all systems.
575
576After a ":cd" command the file names (in the argument list, opened files)
577still point to the same files. In Vi ":cd" is not allowed in a changed file;
578otherwise the meaning of file names change.
579
580":source!" command reads Vi commands from a file.
581
582":mkexrc" command writes current modified options and mappings to a ".exrc"
583file. ":mkvimrc" writes to a ".vimrc" file.
584
585No check for "tail recursion" with mappings. This allows things like
586":map! foo ^]foo".
587
588When a mapping starts with number, vi loses the count typed before it (e.g.
589when using the mapping ":map g 4G" the command "7g" goes to line 4). This is
590considered a vi bug. Vim concatenates the counts (in the example it becomes
591"74G"), as most people would expect.
592
593The :put! command inserts the contents of a register above the current line.
594
595The "p" and "P" commands of vi cannot be repeated with "." when the putted
596text is less than a line. In Vim they can always be repeated.
597
598":noremap" command can be used to enter a mapping that will not be remapped.
599This is useful to exchange the meaning of two keys. ":cmap", ":cunmap" and
600":cnoremap" can be used for mapping in command-line editing only. ":imap",
601":iunmap" and ":inoremap" can be used for mapping in insert mode only.
602Similar commands exist for abbreviations: ":noreabbrev", ":iabbrev"
603":cabbrev", ":iunabbrev", ":cunabbrev", ":inoreabbrev", ":cnoreabbrev".
604
605In Vi the command ":map foo bar" would remove a previous mapping
606":map bug foo". This is considered a bug, so it is not included in Vim.
607":unmap! foo" does remove ":map! bug foo", because unmapping would be very
608difficult otherwise (this is vi compatible).
609
610The ':' register contains the last command-line.
611The '%' register contains the current file name.
612The '.' register contains the last inserted text.
613
614":dis" command shows the contents of the yank registers.
615
616CTRL-O/CTRL-I can be used to jump to older/newer positions. These are the
617same positions as used with the '' command, but may be in another file. The
618":jumps" command lists the older positions.
619
620If the 'shiftround' option is set, an indent is rounded to a multiple of
621'shiftwidth' with ">" and "<" commands.
622
623The 'scrolljump' option can be set to the minimum number of lines to scroll
624when the cursor gets off the screen. Use this when scrolling is slow.
625
626The 'scrolloff' option can be set to the minimum number of lines to keep
627above and below the cursor. This gives some context to where you are
628editing. When set to a large number the cursor line is always in the middle
629of the window.
630
631Uppercase marks can be used to jump between files. The ":marks" command lists
632all currently set marks. The commands "']" and "`]" jump to the end of the
633previous operator or end of the text inserted with the put command. "'[" and
634"`[" do jump to the start.
635
636The 'shelltype' option can be set to reflect the type of shell used on the
637Amiga.
638
639The 'highlight' option can be set for the highlight mode to be used for
640several commands.
641
642The CTRL-A (add) and CTRL-X (subtract) commands are new. The count to the
643command (default 1) is added to/subtracted from the number at or after the
644cursor. That number may be decimal, octal (starts with a '0') or hexadecimal
645(starts with '0x'). Very useful in macros.
646
647With the :set command the prefix "inv" can be used to invert boolean options.
648
649In both Vi and Vim you can create a line break with the ":substitute" command
650by using a CTRL-M. For Vi this means you cannot insert a real CTRL-M in the
651text. With Vim you can put a real CTRL-M in the text by preceding it with a
652CTRL-V.
653
654
655In Insert mode:
656
657If the 'revins' option is set, insert happens backwards. This is for typing
658Hebrew. When inserting normal characters the cursor will not be shifted and
659the text moves rightwards. Backspace, CTRL-W and CTRL-U will also work in
660the opposite direction. CTRL-B toggles the 'revins' option. In replace mode
661'revins' has no effect. Only when enabled at compile time.
662
663The backspace key can be used just like CTRL-D to remove auto-indents.
664
665You can backspace, CTRL-U and CTRL-W over line breaks if the 'backspace' (bs)
666option includes "eol". You can backspace over the start of insert if the
667'backspace' option includes "start".
668
Bram Moolenaar9b451252012-08-15 17:43:31 +0200669When the 'paste' option is set, a few options are reset and mapping in insert
Bram Moolenaar071d4272004-06-13 20:20:40 +0000670mode and abbreviation are disabled. This allows for pasting text in windowing
671systems without unexpected results. When the 'paste' option is reset, the old
672option values are restored.
673
674CTRL-T/CTRL-D always insert/delete an indent in the current line, no matter
675what column the cursor is in.
676
677CTRL-@ (insert previously inserted text) works always (Vi: only when typed as
678first character).
679
680CTRL-A works like CTRL-@ but does not leave insert mode.
681
682CTRL-R {0-9a-z..} can be used to insert the contents of a register.
683
684When the 'smartindent' option is set, C programs will be better auto-indented.
685With 'cindent' even more.
686
687CTRL-Y and CTRL-E can be used to copy a character from above/below the
688current cursor position.
689
690After CTRL-V you can enter a three digit decimal number. This byte value is
691inserted in the text as a single character. Useful for international
692characters that are not on your keyboard.
693
694When the 'expandtab' (et) option is set, a <Tab> is expanded to the
695appropriate number of spaces.
696
697The window always reflects the contents of the buffer (Vi does not do this
698when changing text and in some other cases).
699
700If Vim is compiled with DIGRAPHS defined, digraphs are supported. A set of
701normal digraphs is included. They are shown with the ":digraph" command.
702More can be added with ":digraph {char1}{char2} {number}". A digraph is
703entered with "CTRL-K {char1} {char2}" or "{char1} BS {char2}" (only when
704'digraph' option is set).
705
706When repeating an insert, e.g. "10atest <Esc>" vi would only handle wrapmargin
707for the first insert. Vim does it for all.
708
709A count to the "i" or "a" command is used for all the text. Vi uses the count
710only for one line. "3iabc<NL>def<Esc>" would insert "abcabcabc<NL>def" in Vi
711but "abc<NL>defabc<NL>defabc<NL>def" in Vim.
712
713
714In Command-line mode:
715
Bram Moolenaar4499d2e2005-04-15 20:41:38 +0000716<Esc> terminates the command-line without executing it. In vi the command
Bram Moolenaar071d4272004-06-13 20:20:40 +0000717line would be executed, which is not what most people expect (hitting <Esc>
718should always get you back to command mode). To avoid problems with some
719obscure macros, an <Esc> in a macro will execute the command. If you want a
720typed <Esc> to execute the command like vi does you can fix this with
721 ":cmap ^V<Esc> ^V<CR>"
722
723General:
724
725The 'ttimeout' option is like 'timeout', but only works for cursor and
726function keys, not for ordinary mapped characters. The 'timeoutlen' option
727gives the number of milliseconds that is waited for. If the 'esckeys' option
728is not set, cursor and function keys that start with <Esc> are not recognized
729in insert mode.
730
731There is an option for each terminal string. Can be used when termcap is not
732supported or to change individual strings.
733
734The 'fileformat' option can be set to select the <EOL>: "dos" <CR><NL>, "unix"
735<NL> or "mac" <CR>.
736When the 'fileformats' option is not empty, Vim tries to detect the type of
737<EOL> automatically. The 'fileformat' option is set accordingly.
738
739On systems that have no job control (older Unix systems and non-Unix systems)
740the CTRL-Z, ":stop" or ":suspend" command starts a new shell.
741
742If Vim is started on the Amiga without an interactive window for output, a
743window is opened (and :sh still works). You can give a device to use for
744editing with the |-d| argument, e.g. "-d con:20/20/600/150".
745
746The 'columns' and 'lines' options are used to set or get the width and height
747of the display.
748
749Option settings are read from the first and last few lines of the file.
750Option 'modelines' determines how many lines are tried (default is 5). Note
751that this is different from the Vi versions that can execute any Ex command
752in a modeline (a major security problem). |trojan-horse|
753
754If the 'insertmode' option is set (e.g. in .exrc), Vim starts in insert mode.
755And it comes back there, when pressing <Esc>.
756
757Undo information is kept in memory. Available memory limits the number and
758size of change that can be undone. This may be a problem with MS-DOS, is
759hardly a problem on the Amiga and almost never with Unix and Win32.
760
761If the 'backup' or 'writebackup' option is set: Before a file is overwritten,
762a backup file (.bak) is made. If the "backup" option is set it is left
763behind.
764
765Vim creates a file ending in ".swp" to store parts of the file that have been
766changed or that do not fit in memory. This file can be used to recover from
767an aborted editing session with "vim -r file". Using the swap file can be
768switched off by setting the 'updatecount' option to 0 or starting Vim with
769the "-n" option. Use the 'directory' option for placing the .swp file
770somewhere else.
771
772Vim is able to work correctly on filesystems with 8.3 file names, also when
773using messydos or crossdos filesystems on the Amiga, or any 8.3 mounted
774filesystem under Unix. See |'shortname'|.
775
776Error messages are shown at least one second (Vi overwrites error messages).
777
778If Vim gives the |hit-enter| prompt, you can hit any key. Characters other
779than <CR>, <NL> and <Space> are interpreted as the (start of) a command. (Vi
780only accepts a command starting with ':').
781
782The contents of the numbered and unnamed registers is remembered when
783changing files.
784
785The "No lines in buffer" message is a normal message instead of an error
786message, since that may cause a mapping to be aborted.
787
788The AUX: device of the Amiga is supported.
789
790==============================================================================
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007916. Supported Vi features *vi-features*
792
793Vim supports nearly all Vi commands and mostly in the same way. That is when
794the 'compatible' option is set and 'cpoptions' contains all flags. What the
795effect is of resetting 'compatible' and removing flags from 'cpoptions' can be
796found at the help for the specific command.
797
798Below is listed what features are present in Vi. Anything else has been added
799by Vim.
800
801The following Ex commands are supported by Vi: ~
802
803TODO
804
805`:set` but not `:set inv{option}`, `:set option&`, `:set all&`,
806 `:set option+=value`,
807 `:set option^=value`
808 `:set option-=value`
809 `:set option<`
810
811
812The following Normal mode commands are supported by Vi: ~
813
814TODO
815
816
817The following options are supported by Vi: ~
818
819'autoindent' 'ai' take indent for new line from previous line
820'autowrite' 'aw' automatically write file if changed
821'directory' 'dir' list of directory names for the swap file
822'edcompatible' 'ed' toggle flags of ":substitute" command
823'errorbells' 'eb' ring the bell for error messages
824'ignorecase' 'ic' ignore case in search patterns
825'lines' number of lines in the display
826'lisp' automatic indenting for Lisp
827'list' show <Tab> and <EOL>
828'magic' changes special characters in search patterns
829'modeline' 'ml' recognize 'modelines' at start or end of file
830 {called modelines in some Vi versions}
831'number' 'nu' print the line number in front of each line
832'paragraphs' 'para' nroff macros that separate paragraphs
833'prompt' 'prompt' enable prompt in Ex mode
834'readonly' 'ro' disallow writing the buffer {Vim sets 'readonly'
835 when editing a file with `:view`}
836'remap' allow mappings to work recursively
837'report' threshold for reporting nr. of lines changed
838'scroll' 'scr' lines to scroll with CTRL-U and CTRL-D
839'sections' 'sect' nroff macros that separate sections
840'shell' 'sh' name of shell to use for external commands
841'shiftwidth' 'sw' number of spaces to use for (auto)indent step
842'showmatch' 'sm' briefly jump to matching bracket if insert one
843'showmode' 'smd' message on status line to show current mode
844'tabstop' 'ts' number of spaces that <Tab> in file uses
845'taglength' 'tl' number of significant characters for a tag
846'tags' 'tag' list of file names used by the tag command
847'tagstack' 'tgst' push tags onto the tag stack {not in all versions
848 of Vi}
849'term' name of the terminal
850'terse' shorten some messages
851'timeout' 'to' time out on mappings and key codes
852'ttytype' 'tty' alias for 'term'
853'verbose' 'vbs' give informative messages {only in some Vi
854 versions as a boolean option}
855'warn' warn for shell command when buffer was changed
856'window' 'wi' nr of lines to scroll for CTRL-F and CTRL-B
857'wrapmargin' 'wm' chars from the right where wrapping starts
858'wrapscan' 'ws' searches wrap around the end of the file
859'writeany' 'wa' write to file with no need for "!" override
860
861Also see |missing-options|.
862
863==============================================================================
8647. Command-line arguments *cmdline-arguments*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000865
866Different versions of Vi have different command-line arguments. This can be
867confusing. To help you, this section gives an overview of the differences.
868
869Five variants of Vi will be considered here:
870 Elvis Elvis version 2.1b
871 Nvi Nvi version 1.79
872 Posix Posix 1003.2
873 Vi Vi version 3.7 (for Sun 4.1.x)
874 Vile Vile version 7.4 (incomplete)
875 Vim Vim version 5.2
876
877Only Vim is able to accept options in between and after the file names.
878
879+{command} Elvis, Nvi, Posix, Vi, Vim: Same as "-c {command}".
880
881- Nvi, Posix, Vi: Run Ex in batch mode.
882 Vim: Read file from stdin (use -s for batch mode).
883
884-- Vim: End of options, only file names are following.
885
886--cmd {command} Vim: execute {command} before sourcing vimrc files.
887
888--echo-wid Vim: GTK+ echoes the Window ID on stdout
889
890--help Vim: show help message and exit.
891
892--literal Vim: take file names literally, don't expand wildcards.
893
894--nofork Vim: same as |-f|
895
896--noplugin[s] Vim: Skip loading plugins.
897
898--remote Vim: edit the files in another Vim server
899
900--remote-expr {expr} Vim: evaluate {expr} in another Vim server
901
902--remote-send {keys} Vim: send {keys} to a Vim server and exit
903
904--remote-silent {file} Vim: edit the files in another Vim server if possible
905
906--remote-wait Vim: edit the files in another Vim server and wait for it
907
908--remote-wait-silent Vim: like --remote-wait, no complaints if not possible
909
910--role {role} Vim: GTK+ 2: set role of main window
911
912--serverlist Vim: Output a list of Vim servers and exit
913
914--servername {name} Vim: Specify Vim server name
915
916--socketid {id} Vim: GTK window socket to run Vim in
917
Bram Moolenaar78e17622007-08-30 10:26:19 +0000918--windowid {id} Vim: Win32 window ID to run Vim in
919
Bram Moolenaar071d4272004-06-13 20:20:40 +0000920--version Vim: show version message and exit.
921
922-? Vile: print usage summary and exit.
923
924-a Elvis: Load all specified file names into a window (use -o for
925 Vim).
926
927-A Vim: Start in Arabic mode (when compiled with Arabic).
928
929-b {blksize} Elvis: Use {blksize} blocksize for the session file.
930-b Vim: set 'binary' mode.
931
932-C Vim: Compatible mode.
933
934-c {command} Elvis, Nvi, Posix, Vim: run {command} as an Ex command after
935 loading the edit buffer.
936 Vim: allow up to 10 "-c" arguments
937
938-d {device} Vim: Use {device} for I/O (Amiga only). {only when compiled
939 without the |+diff| feature}
940-d Vim: start with 'diff' set. |vimdiff|
941
942-dev {device} Vim: Use {device} for I/O (Amiga only).
943
944-D Vim: debug mode.
945
946-e Elvis, Nvi, Vim: Start in Ex mode, as if the executable is
947 called "ex".
948
949-E Vim: Start in improved Ex mode |gQ|, like "exim".
950
951-f Vim: Run GUI in foreground (Amiga: don't open new window).
952-f {session} Elvis: Use {session} as the session file.
953
954-F Vim: Start in Farsi mode (when compiled with Farsi).
955 Nvi: Fast start, don't read the entire file when editing
956 starts.
957
958-G {gui} Elvis: Use the {gui} as user interface.
959
960-g Vim: Start GUI.
961-g N Vile: start editing at line N
962
963-h Vim: Give help message.
964 Vile: edit the help file
965
966-H Vim: start Hebrew mode (when compiled with it).
967
968-i Elvis: Start each window in Insert mode.
969-i {viminfo} Vim: Use {viminfo} for viminfo file.
970
971-L Vim: Same as "-r" (also in some versions of Vi).
972
973-l Nvi, Vi, Vim: Set 'lisp' and 'showmatch' options.
974
975-m Vim: Modifications not allowed to be written, resets 'write'
976 option.
977
978-M Vim: Modifications not allowed, resets 'modifiable' and the
979 'write' option.
980
981-N Vim: No-compatible mode.
982
983-n Vim: No swap file used.
984
985-nb[args] Vim: open a NetBeans interface connection
986
987-O[N] Vim: Like -o, but use vertically split windows.
988
989-o[N] Vim: Open [N] windows, or one for each file.
990
Bram Moolenaar18144c82006-04-12 21:52:12 +0000991-p[N] Vim: Open [N] tab pages, or one for each file.
992
Bram Moolenaar071d4272004-06-13 20:20:40 +0000993-P {parent-title} Win32 Vim: open Vim inside a parent application window
994
995-q {name} Vim: Use {name} for quickfix error file.
996-q{name} Vim: Idem.
997
998-R Elvis, Nvi, Posix, Vile, Vim: Set the 'readonly' option.
999
1000-r Elvis, Nvi, Posix, Vi, Vim: Recovery mode.
1001
1002-S Nvi: Set 'secure' option.
1003-S {script} Vim: source script after starting up.
1004
1005-s Nvi, Posix, Vim: Same as "-" (silent mode), when in Ex mode.
1006 Elvis: Sets the 'safer' option.
1007-s {scriptin} Vim: Read from script file {scriptin}; only when not in Ex
1008 mode.
1009-s {pattern} Vile: search for {pattern}
1010
1011-t {tag} Elvis, Nvi, Posix, Vi, Vim: Edit the file containing {tag}.
1012-t{tag} Vim: Idem.
1013
1014-T {term} Vim: Set terminal name to {term}.
1015
1016-u {vimrc} Vim: Read initializations from {vimrc} file.
1017
1018-U {gvimrc} Vim: Read GUI initializations from {gvimrc} file.
1019
1020-v Nvi, Posix, Vi, Vim: Begin in Normal mode (visual mode, in Vi
1021 terms).
1022 Vile: View mode, no changes possible.
1023
1024-V Elvis, Vim: Verbose mode.
1025-V{nr} Vim: Verbose mode with specified level.
1026
1027-w {size} Elvis, Posix, Nvi, Vi, Vim: Set value of 'window' to {size}.
1028-w{size} Nvi, Vi: Same as "-w {size}".
1029-w {name} Vim: Write to script file {name} (must start with non-digit).
1030
1031-W {name} Vim: Append to script file {name}.
1032
1033-x Vi, Vim: Ask for encryption key. See |encryption|.
1034
1035-X Vim: Don't connect to the X server.
1036
1037-y Vim: Start in easy mode, like |evim|.
1038
1039-Z Vim: restricted mode
1040
1041@{cmdfile} Vile: use {cmdfile} as startup file.
1042
Bram Moolenaarf97ca8f2005-02-07 21:49:25 +00001043==============================================================================
Bram Moolenaar6c60f472019-04-28 16:00:35 +020010448. POSIX compliance *posix* *posix-compliance*
Bram Moolenaarf97ca8f2005-02-07 21:49:25 +00001045
Bram Moolenaardd2a3cd2007-05-05 17:10:09 +00001046In 2005 the POSIX test suite was run to check the compatibility of Vim. Most
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001047of the test was executed properly. There are the few things where Vim
Bram Moolenaar6bdcfc02005-02-22 08:28:13 +00001048is not POSIX compliant, even when run in Vi compatibility mode.
Bram Moolenaar38a55632016-02-15 22:07:32 +01001049 *$VIM_POSIX*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001050Set the $VIM_POSIX environment variable to have 'cpoptions' include the POSIX
1051flags when Vim starts up. This makes Vim run as POSIX as it can. That's
Bram Moolenaar6bdcfc02005-02-22 08:28:13 +00001052a bit different from being Vi compatible.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001053
1054This is where Vim does not behave as POSIX specifies and why:
1055
Bram Moolenaarf97ca8f2005-02-07 21:49:25 +00001056 *posix-screen-size*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001057 The $COLUMNS and $LINES environment variables are ignored by Vim if
1058 the size can be obtained from the terminal in a more reliable way.
1059 Add the '|' flag to 'cpoptions' to have $COLUMNS and $LINES overrule
1060 sizes obtained in another way.
Bram Moolenaarf97ca8f2005-02-07 21:49:25 +00001061
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001062 The "{" and "}" commands don't stop at a "{" in the original Vi, but
1063 POSIX specifies it does. Add the '{' flag to 'cpoptions' if you want
1064 it the POSIX way.
1065
1066 The "D", "o" and "O" commands accept a count. Also when repeated.
1067 Add the '#' flag to 'cpoptions' if you want to ignore the count.
Bram Moolenaarf97ca8f2005-02-07 21:49:25 +00001068
Bram Moolenaar6bdcfc02005-02-22 08:28:13 +00001069 The ":cd" command fails if the current buffer is modified when the '.'
1070 flag is present in 'cpoptions'.
1071
1072 There is no ATTENTION message, the "A" flag is added to 'shortmess'.
1073
1074These are remarks about running the POSIX test suite:
1075- vi test 33 sometimes fails for unknown reasons
1076- vi test 250 fails; behavior will be changed in a new revision
1077 http://www.opengroup.org/austin/mailarchives/ag-review/msg01710.html
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001078 (link no longer works, perhaps it's now:
1079 https://www.opengroup.org/sophocles/show_mail.tpl?CALLER=show_archive.tpl&source=L&listname=austin-review-l&id=1711)
Bram Moolenaar6bdcfc02005-02-22 08:28:13 +00001080- vi test 310 fails; exit code non-zero when any error occurred?
1081- ex test 24 fails because test is wrong. Changed between SUSv2 and SUSv3.
1082- ex tests 47, 48, 49, 72, 73 fail because .exrc file isn't read in silent
1083 mode and $EXINIT isn't used.
1084- ex tests 76, 78 fail because echo is used instead of printf. (fixed)
1085 Also: problem with \s not changed to space.
1086- ex test 355 fails because 'window' isn't used for "30z".
1087- ex test 368 fails because shell command isn't echoed in silent mode.
1088- ex test 394 fails because "=" command output isn't visible in silent mode.
1089- ex test 411 fails because test file is wrong, contains stray ':'.
1090- ex test 475 and 476 fail because reprint output isn't visible in silent mode.
1091- ex test 480 and 481 fail because the tags file has spaces instead of a tab.
1092- ex test 502 fails because .exrc isn't read in silent mode.
1093- ex test 509 fails because .exrc isn't read in silent mode. and exit code is
1094 1 instead of 2.
1095- ex test 534 fails because .exrc isn't read in silent mode.
1096
Bram Moolenaarf97ca8f2005-02-07 21:49:25 +00001097
Bram Moolenaard473c8c2018-08-11 18:00:22 +02001098 vim:tw=78:ts=8:noet:ft=help:norl: