Mercurial > vim
annotate runtime/doc/vi_diff.txt @ 16443:32a543152dc0 v8.1.1226
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
commit https://github.com/vim/vim/commit/6c60f47fb9251e686217d51cf81847e14d0dd26d
Author: Bram Moolenaar <Bram@vim.org>
Date: Sun Apr 28 16:00:35 2019 +0200
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Problem: {not in Vi} remarks get in the way of useful help text.
Solution: Make a list of all Vi options, instead of mentioning what Vi does
not have. Update the help text for options.
author | Bram Moolenaar <Bram@vim.org> |
---|---|
date | Sun, 28 Apr 2019 16:15:06 +0200 |
parents | 5c5908e81e93 |
children | 0e473e9e70c2 |
rev | line source |
---|---|
16443
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
1 *vi_diff.txt* For Vim version 8.1. Last change: 2019 Apr 28 |
7 | 2 |
3 | |
4 VIM REFERENCE MANUAL by Bram Moolenaar | |
5 | |
6 | |
7 Differences between Vim and Vi *vi-differences* | |
8 | |
9 Throughout the help files differences between Vim and Vi/Ex are given in | |
10 curly braces, like "{not in Vi}". This file only lists what has not been | |
11 mentioned in other files and gives an overview. | |
12 | |
13 Vim is mostly POSIX 1003.2-1 compliant. The only command known to be missing | |
14 is ":open". There are probably a lot of small differences (either because Vim | |
15 is missing something or because Posix is beside the mark). | |
16 | |
166 | 17 1. Simulated command |simulated-command| |
7 | 18 2. Missing options |missing-options| |
19 3. Limits |limits| | |
20 4. The most interesting additions |vim-additions| | |
21 5. Other vim features |other-features| | |
16443
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
22 6. Supported Vi features |vi-features| |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
23 7. Command-line arguments |cmdline-arguments| |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
24 8. POSIX compliance |posix-compliance| |
7 | 25 |
26 ============================================================================== | |
166 | 27 1. Simulated command *simulated-command* |
28 | |
1118 | 29 This command is in Vi, but Vim only simulates it: |
166 | 30 |
31 *:o* *:op* *:open* | |
32 :[range]o[pen] Works like |:visual|: end Ex mode. | |
33 {Vi: start editing in open mode} | |
7 | 34 |
166 | 35 :[range]o[pen] /pattern/ As above, additionally move the cursor to the |
36 column where "pattern" matches in the cursor | |
37 line. | |
7 | 38 |
166 | 39 Vim does not support open mode, since it's not really useful. For those |
40 situations where ":open" would start open mode Vim will leave Ex mode, which | |
41 allows executing the same commands, but updates the whole screen instead of | |
42 only one line. | |
7 | 43 |
44 ============================================================================== | |
45 2. Missing options *missing-options* | |
46 | |
47 These options are in the Unix Vi, but not in Vim. If you try to set one of | |
48 them you won't get an error message, but the value is not used and cannot be | |
49 printed. | |
50 | |
51 autoprint (ap) boolean (default on) *'autoprint'* *'ap'* | |
52 beautify (bf) boolean (default off) *'beautify'* *'bf'* | |
53 flash (fl) boolean (default ??) *'flash'* *'fl'* | |
54 graphic (gr) boolean (default off) *'graphic'* *'gr'* | |
55 hardtabs (ht) number (default 8) *'hardtabs'* *'ht'* | |
56 number of spaces that a <Tab> moves on the display | |
57 mesg boolean (default on) *'mesg'* | |
58 novice boolean (default off) *'novice'* | |
59 open boolean (default on) *'open'* | |
60 optimize (op) boolean (default off) *'optimize'* *'op'* | |
61 redraw boolean (default off) *'redraw'* | |
62 slowopen (slow) boolean (default off) *'slowopen'* *'slow'* | |
63 sourceany boolean (default off) *'sourceany'* | |
64 w300 number (default 23) *'w300'* | |
65 w1200 number (default 23) *'w1200'* | |
66 w9600 number (default 23) *'w9600'* | |
67 | |
68 ============================================================================== | |
69 3. Limits *limits* | |
70 | |
71 Vim 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 | |
73 limits}. | |
74 *E340* | |
75 Maximum line length On machines with 16-bit ints (Amiga and MS-DOS real | |
76 mode): 32767, otherwise 2147483647 characters. | |
77 Longer lines are split. | |
78 Maximum number of lines 2147483647 lines. | |
79 Maximum 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* | |
83 Length of a file path Unix and Win32: 1024 characters, otherwise 256 | |
84 characters (or as much as the system supports). | |
85 Length of an expanded string option | |
86 Unix and Win32: 1024 characters, otherwise 256 | |
87 characters | |
88 Maximum display width Unix and Win32: 1024 characters, otherwise 255 | |
89 characters | |
90 Maximum lhs of a mapping 50 characters. | |
625 | 91 Number of different highlighting types: over 30000 |
3082 | 92 Range of a Number variable: -2147483648 to 2147483647 (might be more on 64 |
93 bit systems) | |
2596 | 94 Maximum length of a line in a tags file: 512 bytes. |
7 | 95 |
96 Information 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 | |
98 undo levels and the text that can be kept in registers. Other things are also | |
99 kept in memory: Command-line history, error messages for Quickfix mode, etc. | |
100 | |
101 Memory usage limits | |
102 ------------------- | |
103 | |
104 The option 'maxmem' ('mm') is used to set the maximum memory used for one | |
105 buffer (in kilobytes). 'maxmemtot' is used to set the maximum memory used for | |
106 all buffers (in kilobytes). The defaults depend on the system used. For the | |
107 Amiga and MS-DOS, 'maxmemtot' is set depending on the amount of memory | |
827 | 108 available. |
109 These are not hard limits, but tell Vim when to move text into a swap file. | |
110 If you don't like Vim to swap to a file, set 'maxmem' and 'maxmemtot' to a | |
111 very large value. The swap file will then only be used for recovery. If you | |
112 don't want a swap file at all, set 'updatecount' to 0, or use the "-n" | |
113 argument when starting Vim. | |
7 | 114 |
115 ============================================================================== | |
116 4. The most interesting additions *vim-additions* | |
117 | |
118 Vi 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 | |
827 | 127 Vim starts with 'nocompatible' automatically if you have a .vimrc |
128 file. See |startup|. | |
7 | 129 The 'cpoptions' option can be used to set Vi compatibility on/off for |
130 a number of specific items. | |
131 | |
132 Support 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 | |
827 | 147 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. | |
7 | 150 |
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
151 Multi level persistent undo. |undo| |
7 | 152 'u' goes backward in time, 'CTRL-R' goes forward again. Set option |
153 'undolevels' to the number of changes to be remembered (default 1000). | |
5340 | 154 Set 'undolevels' to 0 for a Vi-compatible one level undo. Set it to |
7 | 155 -1 for no undo at all. |
156 When all changes in a buffer have been undone, the buffer is not | |
157 considered changed anymore. You can exit it with :q, without <!>. | |
827 | 158 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 | |
1186 | 160 state of the text, there is no risk of a change causing text to be |
827 | 161 lost forever. |undo-tree| |
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
162 The undo information is stored in a file when the 'undofile' option is |
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
163 set. This means you can exit Vim, start Vim on a previously edited |
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
164 file and undo changes that were made before exiting Vim. |
7 | 165 |
827 | 166 Graphical User Interface (GUI). |gui| |
7 | 167 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 | |
173 Multiple 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. | |
827 | 179 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| | |
7 | 182 |
183 Syntax highlighting. |:syntax| | |
184 Vim can highlight keywords, patterns and other things. This is | |
827 | 185 defined by a number of |:syntax| commands, and can be made to |
7 | 186 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 | |
827 | 190 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'|. | |
7 | 196 |
827 | 197 Spell checking. |spell| |
198 When the 'spell' option is set Vim will highlight spelling mistakes. | |
3750 | 199 About 50 languages are currently supported, selected with the |
1618 | 200 'spelllang' option. In source code only comments and strings are |
827 | 201 checked for spelling. |
202 | |
203 Folding. |folding| | |
7 | 204 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 | |
827 | 209 Diff 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 | |
214 Plugins. |add-plugin| | |
7 | 215 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. | |
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
219 Packages make this even easier. |packages| |
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
220 |
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
221 Asynchronous communication and timers. |channel| |job| |timer| |
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
222 Vim can exchange messages with other processes in the background. |
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
223 This makes it possible to have servers do work and send back the |
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
224 results to Vim. |channel| |
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
225 Vim can start a job, communicate with it and stop it. |job| |
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
226 Timers can fire once or repeatedly and invoke a function to do any |
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
227 work. |timer| |
7 | 228 |
229 Repeat a series of commands. |q| | |
827 | 230 "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. | |
7 | 234 |
235 Flexible 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 | |
827 | 240 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|. | |
7 | 242 |
243 Visual mode. |Visual-mode| | |
827 | 244 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: | |
7 | 253 d delete |
254 c change | |
255 y yank | |
256 > or < insert or delete indent | |
257 ! filter through external program | |
258 = filter through indent | |
827 | 259 : start |:| command for the Visual lines. |
7 | 260 gq format text to 'textwidth' columns |
261 J join lines | |
262 ~ swap case | |
263 u make lowercase | |
264 U make uppercase | |
265 | |
266 Block operators. |visual-block| | |
827 | 267 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. | |
7 | 271 |
827 | 272 Help system. |:help| |
7 | 273 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 | |
827 | 275 around in the help files, just like hypertext links. The |:help| |
7 | 276 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 | |
280 Command-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. | |
286 |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 | |
292 Command-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 | |
827 | 313 Insert-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| | |
7 | 316 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 | |
827 | 325 |i_CTRL-X_CTRL-O| Omni completion: clever completion |
326 specifically for a file type | |
327 etc. | |
7 | 328 |
827 | 329 Long line support. |'wrap'| |'linebreak'| |
7 | 330 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 | |
827 | 333 columns to scroll can be set with the 'sidescroll' option. The |zh| |
334 and |zl| commands can be used to scroll sideways. | |
7 | 335 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 | |
827 | 338 program). Move the cursor up/down with the |gk| and |gj| commands. |
7 | 339 |
340 Text 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 | |
827 | 343 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|. | |
7 | 346 |
827 | 347 Extended search patterns. |pattern| |
7 | 348 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 | |
827 | 353 Directory, 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 | |
7 | 360 Edit-compile-edit speedup. |quickfix| |
827 | 361 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. | |
7 | 364 |
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 | |
827 | 369 The |:cn| command can be used to jump to the next error. |
370 |:cl| lists all the error messages. Other commands are available. | |
7 | 371 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 | |
827 | 373 with the |:make| command. |
7 | 374 The 'shellpipe' option contains the string to be used to put the |
375 output of the compiler into the errorfile. | |
376 | |
827 | 377 Finding 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 | |
382 Improved indenting for programs. |'cindent'| | |
7 | 383 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 | |
827 | 391 other types of text. The |=| operator can be used to re-indent |
7 | 392 lines. |
393 | |
827 | 394 For many other languages an indent plugin is present to support |
395 automatic indenting. |30.3| | |
396 | |
397 Searching for words in included files. |include-search| | |
398 The |[i| command can be used to search for a match of the word under | |
7 | 399 the cursor in the current and included files. The 'include' option |
1668 | 400 can be set to a pattern that describes a command to include a file |
7 | 401 (the default is for C programs). |
827 | 402 The |[I| command lists all matches, the |[_CTRL-I| command jumps to |
7 | 403 a match. |
827 | 404 The |[d|, |[D| and |[_CTRL-D| commands do the same, but only for |
7 | 405 lines where the pattern given with the 'define' option matches. |
406 | |
827 | 407 Automatic commands. |autocommand| |
7 | 408 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 | |
827 | 414 Scripts and Expressions. |expression| |
415 Commands have been added to form up a powerful script language. | |
7 | 416 |: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. | |
827 | 419 |:for| Loop over a list. |
7 | 420 |:echo| Print the result of an expression. |
421 |:let| Assign a value to an internal variable, option, etc. | |
827 | 422 Variable types are Number, String, List and Dictionary. |
7 | 423 |:execute| Execute a command formed by an expression. |
827 | 424 |: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|, | |
2320
966a5609669e
Added Lua interfae. (Luis Carvalho)
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
428 |Tcl|, |Lua|, |Perl| and |MzScheme|. |
7 | 429 |
827 | 430 Viminfo. |viminfo-file| |
7 | 431 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 | |
827 | 434 possible to jump right back to where the last edit stopped with |'0|. |
7 | 435 The 'viminfo' option can be set to select which items to store in the |
436 .viminfo file. This is off by default. | |
437 | |
827 | 438 Printing. |printing| |
439 The |:hardcopy| command sends text to the printer. This can include | |
440 syntax highlighting. | |
441 | |
442 Mouse support. |mouse-using| | |
7 | 443 The mouse is supported in the GUI version, in an xterm for Unix, for |
1618 | 444 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. | |
7 | 447 |
827 | 448 Usage of key names. |<>| |key-notation| |
7 | 449 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 | |
827 | 452 Editing binary files. |edit-binary| |
7 | 453 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 | |
827 | 457 |'binary'| Option set by |-b|. Prevents adding an <EOL> for the |
7 | 458 last line in the file. |
459 | |
827 | 460 Multi-language support. |multi-lang| |
7 | 461 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 | |
827 | 466 Move 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 | |
7 | 471 ============================================================================== |
472 5. Other vim features *other-features* | |
473 | |
474 A random collection of nice extra features. | |
475 | |
476 | |
477 When 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 | |
479 before the editor exits, further characters are read from the console. | |
480 | |
481 The "-w" option can be used to record all typed characters in a script file. | |
482 This file can then be used to redo the editing, possibly on another file or | |
483 after changing some commands in the script file. | |
484 | |
485 The "-o" option opens a window for each argument. "-o4" opens four windows. | |
486 | |
487 Vi requires several termcap entries to be able to work full-screen. Vim only | |
488 requires the "cm" entry (cursor motion). | |
489 | |
490 | |
491 In command mode: | |
492 | |
493 When the 'showcmd' option is set, the command characters are shown in the last | |
494 line of the screen. They are removed when the command is finished. | |
495 | |
496 If the 'ruler' option is set, the current cursor position is shown in the | |
497 last line of the screen. | |
498 | |
499 "U" still works after having moved off the last changed line and after "u". | |
500 | |
501 Characters with the 8th bit set are displayed. The characters between '~' and | |
502 0xa0 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. | |
509 CTRL-W f splits the window and starts editing the file whose name is under | |
510 the 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 | |
514 under the cursor as argument. | |
515 | |
516 "%" can be preceded with a count. The cursor jumps to the line that | |
517 percentage down in the file. The normal "%" function to jump to the matching | |
518 brace skips braces inside quotes. | |
519 | |
520 With the CTRL-] command, the cursor may be in the middle of the identifier. | |
521 | |
522 The used tags are remembered. Commands that can be used with the tag stack | |
523 are CTRL-T, ":pop" and ":tag". ":tags" lists the tag stack. | |
524 | |
525 The 'tags' option can be set to a list of tag file names. Thus multiple | |
526 tag files can be used. For file names that start with "./", the "./" is | |
527 replaced with the path of the current file. This makes it possible to use a | |
528 tags file in the same directory as the file being edited. | |
529 | |
530 Previously used file names are remembered in the alternate file name list. | |
531 CTRL-^ 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 | |
536 Search patterns have more features. The <NL> character is seen as part of the | |
537 search pattern and the substitute string of ":s". Vi sees it as the end of | |
538 the command. | |
539 | |
540 Searches can put the cursor on the end of a match and may include a character | |
541 offset. | |
542 | |
543 Count added to "~", ":next", ":Next", "n" and "N". | |
544 | |
545 The command ":next!" with 'autowrite' set does not write the file. In vi the | |
546 file was written, but this is considered to be a bug, because one does not | |
547 expect it and the file is not written with ":rewind!". | |
548 | |
549 In Vi when entering a <CR> in replace mode deletes a character only when 'ai' | |
550 is set (but does not show it until you hit <Esc>). Vim always deletes a | |
551 character (and shows it immediately). | |
552 | |
553 Added :wnext command. Same as ":write" followed by ":next". | |
554 | |
555 The ":w!" command always writes, also when the file is write protected. In Vi | |
5690 | 556 you would have to do ":!chmod +w %:S" and ":set noro". |
7 | 557 |
558 When 'tildeop' has been set, "~" is an operator (must be followed by a | |
559 movement command). | |
560 | |
561 With the "J" (join) command you can reset the 'joinspaces' option to have only | |
562 one space after a period (Vi inserts two spaces). | |
563 | |
564 "cw" can be used to change white space formed by several characters (Vi is | |
565 confusing: "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 | |
568 display). | |
569 | |
570 Flags after Ex commands not supported (no plans to include it). | |
571 | |
572 On non-UNIX systems ":cd" command shows current directory instead of going to | |
573 the home directory (there isn't one). ":pwd" prints the current directory on | |
574 all systems. | |
575 | |
576 After a ":cd" command the file names (in the argument list, opened files) | |
577 still point to the same files. In Vi ":cd" is not allowed in a changed file; | |
578 otherwise 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" | |
583 file. ":mkvimrc" writes to a ".vimrc" file. | |
584 | |
585 No check for "tail recursion" with mappings. This allows things like | |
586 ":map! foo ^]foo". | |
587 | |
588 When a mapping starts with number, vi loses the count typed before it (e.g. | |
589 when using the mapping ":map g 4G" the command "7g" goes to line 4). This is | |
590 considered a vi bug. Vim concatenates the counts (in the example it becomes | |
591 "74G"), as most people would expect. | |
592 | |
593 The :put! command inserts the contents of a register above the current line. | |
594 | |
595 The "p" and "P" commands of vi cannot be repeated with "." when the putted | |
596 text 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. | |
599 This 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. | |
602 Similar commands exist for abbreviations: ":noreabbrev", ":iabbrev" | |
603 ":cabbrev", ":iunabbrev", ":cunabbrev", ":inoreabbrev", ":cnoreabbrev". | |
604 | |
605 In 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 | |
608 difficult otherwise (this is vi compatible). | |
609 | |
610 The ':' register contains the last command-line. | |
611 The '%' register contains the current file name. | |
612 The '.' register contains the last inserted text. | |
613 | |
614 ":dis" command shows the contents of the yank registers. | |
615 | |
616 CTRL-O/CTRL-I can be used to jump to older/newer positions. These are the | |
617 same positions as used with the '' command, but may be in another file. The | |
618 ":jumps" command lists the older positions. | |
619 | |
620 If the 'shiftround' option is set, an indent is rounded to a multiple of | |
621 'shiftwidth' with ">" and "<" commands. | |
622 | |
623 The 'scrolljump' option can be set to the minimum number of lines to scroll | |
624 when the cursor gets off the screen. Use this when scrolling is slow. | |
625 | |
626 The 'scrolloff' option can be set to the minimum number of lines to keep | |
627 above and below the cursor. This gives some context to where you are | |
628 editing. When set to a large number the cursor line is always in the middle | |
629 of the window. | |
630 | |
631 Uppercase marks can be used to jump between files. The ":marks" command lists | |
632 all currently set marks. The commands "']" and "`]" jump to the end of the | |
633 previous operator or end of the text inserted with the put command. "'[" and | |
634 "`[" do jump to the start. | |
635 | |
636 The 'shelltype' option can be set to reflect the type of shell used on the | |
637 Amiga. | |
638 | |
639 The 'highlight' option can be set for the highlight mode to be used for | |
640 several commands. | |
641 | |
642 The CTRL-A (add) and CTRL-X (subtract) commands are new. The count to the | |
643 command (default 1) is added to/subtracted from the number at or after the | |
644 cursor. That number may be decimal, octal (starts with a '0') or hexadecimal | |
645 (starts with '0x'). Very useful in macros. | |
646 | |
647 With the :set command the prefix "inv" can be used to invert boolean options. | |
648 | |
649 In both Vi and Vim you can create a line break with the ":substitute" command | |
650 by using a CTRL-M. For Vi this means you cannot insert a real CTRL-M in the | |
651 text. With Vim you can put a real CTRL-M in the text by preceding it with a | |
652 CTRL-V. | |
653 | |
654 | |
655 In Insert mode: | |
656 | |
657 If the 'revins' option is set, insert happens backwards. This is for typing | |
658 Hebrew. When inserting normal characters the cursor will not be shifted and | |
659 the text moves rightwards. Backspace, CTRL-W and CTRL-U will also work in | |
660 the opposite direction. CTRL-B toggles the 'revins' option. In replace mode | |
661 'revins' has no effect. Only when enabled at compile time. | |
662 | |
663 The backspace key can be used just like CTRL-D to remove auto-indents. | |
664 | |
665 You can backspace, CTRL-U and CTRL-W over line breaks if the 'backspace' (bs) | |
666 option includes "eol". You can backspace over the start of insert if the | |
667 'backspace' option includes "start". | |
668 | |
3750 | 669 When the 'paste' option is set, a few options are reset and mapping in insert |
7 | 670 mode and abbreviation are disabled. This allows for pasting text in windowing |
671 systems without unexpected results. When the 'paste' option is reset, the old | |
672 option values are restored. | |
673 | |
674 CTRL-T/CTRL-D always insert/delete an indent in the current line, no matter | |
675 what column the cursor is in. | |
676 | |
677 CTRL-@ (insert previously inserted text) works always (Vi: only when typed as | |
678 first character). | |
679 | |
680 CTRL-A works like CTRL-@ but does not leave insert mode. | |
681 | |
682 CTRL-R {0-9a-z..} can be used to insert the contents of a register. | |
683 | |
684 When the 'smartindent' option is set, C programs will be better auto-indented. | |
685 With 'cindent' even more. | |
686 | |
687 CTRL-Y and CTRL-E can be used to copy a character from above/below the | |
688 current cursor position. | |
689 | |
690 After CTRL-V you can enter a three digit decimal number. This byte value is | |
691 inserted in the text as a single character. Useful for international | |
692 characters that are not on your keyboard. | |
693 | |
694 When the 'expandtab' (et) option is set, a <Tab> is expanded to the | |
695 appropriate number of spaces. | |
696 | |
697 The window always reflects the contents of the buffer (Vi does not do this | |
698 when changing text and in some other cases). | |
699 | |
700 If Vim is compiled with DIGRAPHS defined, digraphs are supported. A set of | |
701 normal digraphs is included. They are shown with the ":digraph" command. | |
702 More can be added with ":digraph {char1}{char2} {number}". A digraph is | |
703 entered with "CTRL-K {char1} {char2}" or "{char1} BS {char2}" (only when | |
704 'digraph' option is set). | |
705 | |
706 When repeating an insert, e.g. "10atest <Esc>" vi would only handle wrapmargin | |
707 for the first insert. Vim does it for all. | |
708 | |
709 A count to the "i" or "a" command is used for all the text. Vi uses the count | |
710 only for one line. "3iabc<NL>def<Esc>" would insert "abcabcabc<NL>def" in Vi | |
711 but "abc<NL>defabc<NL>defabc<NL>def" in Vim. | |
712 | |
713 | |
714 In Command-line mode: | |
715 | |
235 | 716 <Esc> terminates the command-line without executing it. In vi the command |
7 | 717 line would be executed, which is not what most people expect (hitting <Esc> |
718 should always get you back to command mode). To avoid problems with some | |
719 obscure macros, an <Esc> in a macro will execute the command. If you want a | |
720 typed <Esc> to execute the command like vi does you can fix this with | |
721 ":cmap ^V<Esc> ^V<CR>" | |
722 | |
723 General: | |
724 | |
725 The 'ttimeout' option is like 'timeout', but only works for cursor and | |
726 function keys, not for ordinary mapped characters. The 'timeoutlen' option | |
727 gives the number of milliseconds that is waited for. If the 'esckeys' option | |
728 is not set, cursor and function keys that start with <Esc> are not recognized | |
729 in insert mode. | |
730 | |
731 There is an option for each terminal string. Can be used when termcap is not | |
732 supported or to change individual strings. | |
733 | |
734 The 'fileformat' option can be set to select the <EOL>: "dos" <CR><NL>, "unix" | |
735 <NL> or "mac" <CR>. | |
736 When the 'fileformats' option is not empty, Vim tries to detect the type of | |
737 <EOL> automatically. The 'fileformat' option is set accordingly. | |
738 | |
739 On systems that have no job control (older Unix systems and non-Unix systems) | |
740 the CTRL-Z, ":stop" or ":suspend" command starts a new shell. | |
741 | |
742 If Vim is started on the Amiga without an interactive window for output, a | |
743 window is opened (and :sh still works). You can give a device to use for | |
744 editing with the |-d| argument, e.g. "-d con:20/20/600/150". | |
745 | |
746 The 'columns' and 'lines' options are used to set or get the width and height | |
747 of the display. | |
748 | |
749 Option settings are read from the first and last few lines of the file. | |
750 Option 'modelines' determines how many lines are tried (default is 5). Note | |
751 that this is different from the Vi versions that can execute any Ex command | |
752 in a modeline (a major security problem). |trojan-horse| | |
753 | |
754 If the 'insertmode' option is set (e.g. in .exrc), Vim starts in insert mode. | |
755 And it comes back there, when pressing <Esc>. | |
756 | |
757 Undo information is kept in memory. Available memory limits the number and | |
758 size of change that can be undone. This may be a problem with MS-DOS, is | |
759 hardly a problem on the Amiga and almost never with Unix and Win32. | |
760 | |
761 If the 'backup' or 'writebackup' option is set: Before a file is overwritten, | |
762 a backup file (.bak) is made. If the "backup" option is set it is left | |
763 behind. | |
764 | |
765 Vim creates a file ending in ".swp" to store parts of the file that have been | |
766 changed or that do not fit in memory. This file can be used to recover from | |
767 an aborted editing session with "vim -r file". Using the swap file can be | |
768 switched off by setting the 'updatecount' option to 0 or starting Vim with | |
769 the "-n" option. Use the 'directory' option for placing the .swp file | |
770 somewhere else. | |
771 | |
772 Vim is able to work correctly on filesystems with 8.3 file names, also when | |
773 using messydos or crossdos filesystems on the Amiga, or any 8.3 mounted | |
774 filesystem under Unix. See |'shortname'|. | |
775 | |
776 Error messages are shown at least one second (Vi overwrites error messages). | |
777 | |
778 If Vim gives the |hit-enter| prompt, you can hit any key. Characters other | |
779 than <CR>, <NL> and <Space> are interpreted as the (start of) a command. (Vi | |
780 only accepts a command starting with ':'). | |
781 | |
782 The contents of the numbered and unnamed registers is remembered when | |
783 changing files. | |
784 | |
785 The "No lines in buffer" message is a normal message instead of an error | |
786 message, since that may cause a mapping to be aborted. | |
787 | |
788 The AUX: device of the Amiga is supported. | |
789 | |
790 ============================================================================== | |
16443
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
791 6. Supported Vi features *vi-features* |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
792 |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
793 Vim supports nearly all Vi commands and mostly in the same way. That is when |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
794 the 'compatible' option is set and 'cpoptions' contains all flags. What the |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
795 effect is of resetting 'compatible' and removing flags from 'cpoptions' can be |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
796 found at the help for the specific command. |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
797 |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
798 Below is listed what features are present in Vi. Anything else has been added |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
799 by Vim. |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
800 |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
801 The following Ex commands are supported by Vi: ~ |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
802 |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
803 TODO |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
804 |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
805 `:set` but not `:set inv{option}`, `:set option&`, `:set all&`, |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
806 `:set option+=value`, |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
807 `:set option^=value` |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
808 `:set option-=value` |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
809 `:set option<` |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
810 |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
811 |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
812 The following Normal mode commands are supported by Vi: ~ |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
813 |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
814 TODO |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
815 |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
816 |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
817 The following options are supported by Vi: ~ |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
818 |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
819 'autoindent' 'ai' take indent for new line from previous line |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
820 'autowrite' 'aw' automatically write file if changed |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
821 'directory' 'dir' list of directory names for the swap file |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
822 'edcompatible' 'ed' toggle flags of ":substitute" command |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
823 'errorbells' 'eb' ring the bell for error messages |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
824 'ignorecase' 'ic' ignore case in search patterns |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
825 'lines' number of lines in the display |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
826 'lisp' automatic indenting for Lisp |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
827 'list' show <Tab> and <EOL> |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
828 'magic' changes special characters in search patterns |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
829 'modeline' 'ml' recognize 'modelines' at start or end of file |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
830 {called modelines in some Vi versions} |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
831 'number' 'nu' print the line number in front of each line |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
832 'paragraphs' 'para' nroff macros that separate paragraphs |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
833 'prompt' 'prompt' enable prompt in Ex mode |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
834 'readonly' 'ro' disallow writing the buffer {Vim sets 'readonly' |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
835 when editing a file with `:view`} |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
836 'remap' allow mappings to work recursively |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
837 'report' threshold for reporting nr. of lines changed |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
838 'scroll' 'scr' lines to scroll with CTRL-U and CTRL-D |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
839 'sections' 'sect' nroff macros that separate sections |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
840 'shell' 'sh' name of shell to use for external commands |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
841 'shiftwidth' 'sw' number of spaces to use for (auto)indent step |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
842 'showmatch' 'sm' briefly jump to matching bracket if insert one |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
843 'showmode' 'smd' message on status line to show current mode |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
844 'tabstop' 'ts' number of spaces that <Tab> in file uses |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
845 'taglength' 'tl' number of significant characters for a tag |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
846 'tags' 'tag' list of file names used by the tag command |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
847 'tagstack' 'tgst' push tags onto the tag stack {not in all versions |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
848 of Vi} |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
849 'term' name of the terminal |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
850 'terse' shorten some messages |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
851 'timeout' 'to' time out on mappings and key codes |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
852 'ttytype' 'tty' alias for 'term' |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
853 'verbose' 'vbs' give informative messages {only in some Vi |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
854 versions as a boolean option} |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
855 'warn' warn for shell command when buffer was changed |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
856 'window' 'wi' nr of lines to scroll for CTRL-F and CTRL-B |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
857 'wrapmargin' 'wm' chars from the right where wrapping starts |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
858 'wrapscan' 'ws' searches wrap around the end of the file |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
859 'writeany' 'wa' write to file with no need for "!" override |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
860 |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
861 Also see |missing-options|. |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
862 |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
863 ============================================================================== |
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
864 7. Command-line arguments *cmdline-arguments* |
7 | 865 |
866 Different versions of Vi have different command-line arguments. This can be | |
867 confusing. To help you, this section gives an overview of the differences. | |
868 | |
869 Five 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 | |
877 Only 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 | |
1376 | 918 --windowid {id} Vim: Win32 window ID to run Vim in |
919 | |
7 | 920 --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 | |
827 | 991 -p[N] Vim: Open [N] tab pages, or one for each file. |
992 | |
7 | 993 -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 | |
160 | 1043 ============================================================================== |
16443
32a543152dc0
patch 8.1.1226: {not in Vi} remarks get in the way of useful help text
Bram Moolenaar <Bram@vim.org>
parents:
14519
diff
changeset
|
1044 8. POSIX compliance *posix* *posix-compliance* |
160 | 1045 |
1118 | 1046 In 2005 the POSIX test suite was run to check the compatibility of Vim. Most |
164 | 1047 of the test was executed properly. There are the few things where Vim |
166 | 1048 is not POSIX compliant, even when run in Vi compatibility mode. |
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7228
diff
changeset
|
1049 *$VIM_POSIX* |
164 | 1050 Set the $VIM_POSIX environment variable to have 'cpoptions' include the POSIX |
1051 flags when Vim starts up. This makes Vim run as POSIX as it can. That's | |
166 | 1052 a bit different from being Vi compatible. |
164 | 1053 |
1054 This is where Vim does not behave as POSIX specifies and why: | |
1055 | |
160 | 1056 *posix-screen-size* |
164 | 1057 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. | |
160 | 1061 |
164 | 1062 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. | |
160 | 1068 |
166 | 1069 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 | |
1074 These 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 | |
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
1078 (link no longer works, perhaps it's now: |
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2596
diff
changeset
|
1079 https://www.opengroup.org/sophocles/show_mail.tpl?CALLER=show_archive.tpl&source=L&listname=austin-review-l&id=1711) |
166 | 1080 - 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 | |
160 | 1097 |
14519 | 1098 vim:tw=78:ts=8:noet:ft=help:norl: |