blob: 17201b457e5324ea73634f8b8bcfaf911846257f [file] [log] [blame]
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00001*options.txt* For Vim version 7.0aa. Last change: 2004 Sep 04
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
13For an overview of options see help.txt |option-list|.
14
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
221. Setting options *set-option*
23
24 *:se* *:set*
25:se[t] Show all options that differ from their default value.
26
27:se[t] all Show all but terminal options.
28
29:se[t] termcap Show all terminal options. Note that in the GUI the
30 key codes are not shown, because they are generated
31 internally and can't be changed. Changing the terminal
32 codes in the GUI is not useful either...
33
34 *E518* *E519*
35:se[t] {option}? Show value of {option}.
36
37:se[t] {option} Toggle option: set, switch it on.
38 Number option: show value.
39 String option: show value.
40
41:se[t] no{option} Toggle option: Reset, switch it off.
42
43:se[t] {option}! or
44:se[t] inv{option} Toggle option: Invert value. {not in Vi}
45
46 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
47:se[t] {option}& Reset option to its default value. May depend on the
48 current value of 'compatible'. {not in Vi}
49:se[t] {option}&vi Reset option to its Vi default value. {not in Vi}
50:se[t] {option}&vim Reset option to its Vim default value. {not in Vi}
51
52:se[t] all& Set all options, except terminal options, to their
Bram Moolenaarf4b8e572004-06-24 15:53:16 +000053 default value. The values of 'term', 'lines' and
Bram Moolenaar071d4272004-06-13 20:20:40 +000054 'columns' are not changed. {not in Vi}
55
56 *:set-args* *E487* *E521*
57:se[t] {option}={value} or
58:se[t] {option}:{value}
59 Set string or number option to {value}.
60 For numeric options the value can be given in decimal,
61 hex (preceded with 0x) or octal (preceded with '0')
62 (hex and octal are only available for machines which
63 have the strtol() function).
64 The old value can be inserted by typing 'wildchar' (by
65 default this is a <Tab> or CTRL-E if 'compatible' is
66 set). See |cmdline-completion|.
67 White space between {option} and '=' is allowed and
68 will be ignored. White space between '=' and {value}
69 is not allowed.
70 See |option-backslash| for using white space and
71 backslashes in {value}.
72
73:se[t] {option}+={value} *:set+=*
74 Add the {value} to a number option, or append the
75 {value} to a string option. When the option is a
76 comma separated list, a comma is added, unless the
77 value was empty.
78 If the option is a list of flags, superfluous flags
79 are removed. Otherwise there is no check for doubled
80 values. You can avoid this by removing a value first.
81 Example: >
82 :set guioptions-=T guioptions+=T
83< Also see |:set-args| above.
84 {not in Vi}
85
86:se[t] {option}^={value} *:set^=*
87 Multiply the {value} to a number option, or prepend
88 the {value} to a string option. When the option is a
89 comma separated list, a comma is added, unless the
90 value was empty.
91 Also see |:set-args| above.
92 {not in Vi}
93
94:se[t] {option}-={value} *:set-=*
95 Subtract the {value} from a number option, or remove
96 the {value} from a string option, if it is there.
97 If the {value} is not found in a string option, there
98 is no error or warning. When the option is a comma
99 separated list, a comma is deleted, unless the option
100 becomes empty.
101 When the option is a list of flags, {value} must be
102 exactly as they appear in the option. Remove flags
103 one by one to avoid problems.
104 Also see |:set-args| above.
105 {not in Vi}
106
107The {option} arguments to ":set" may be repeated. For example: >
108 :set ai nosi sw=3 ts=3
109If you make an error in one of the arguments, an error message will be given
110and the following arguments will be ignored.
111
112 *:set-verbose*
113When 'verbose' is non-zero, displaying an option value will also tell where it
114was last set. Example: >
115 :verbose set shiftwidth cindent?
116 shiftwidth=4
117 Last set from modeline
118 cindent
119 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim
120This is only done when specific option values are requested, not for ":set
121all" or ":set" without an argument.
122When the option was set by hand there is no "Last set" message. There is only
123one value for all local options with the same name. Thus the message applies
124to the option name, not necessarily its value.
125When the option was set while executing a function, user command or
126autocommand, the script in which it was defined is reported.
127Note that an option may also have been set as a side effect of setting
128'compatible'.
129{not available when compiled without the +eval feature}
130
131 *:set-termcap* *E522*
132For {option} the form "t_xx" may be used to set a termcap option. This will
133override the value from the termcap. You can then use it in a mapping. If
134the "xx" part contains special characters, use the <t_xx> form: >
135 :set <t_#4>=^[Ot
136This can also be used to translate a special code for a normal key. For
137example, if Alt-b produces <Esc>b, use this: >
138 :set <M-b>=^[b
139(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
140The advantage over a mapping is that it works in all situations.
141
142The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000143at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144"set all" probably does not fit on the screen, causing Vim to give the
145|more-prompt|.
146
147 *option-backslash*
148To include white space in a string option value it has to be preceded with a
149backslash. To include a backslash you have to use two. Effectively this
150means that the number of backslashes in an option value is halved (rounded
151down).
152A few examples: >
153 :set tags=tags\ /usr/tags results in "tags /usr/tags"
154 :set tags=tags\\,file results in "tags\,file"
155 :set tags=tags\\\ file results in "tags\ file"
156
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000157The "|" character separates a ":set" command from a following command. To
158include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000159'titlestring' option to "hi|there": >
160 :set titlestring=hi\|there
161This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
162 :set titlestring=hi|set iconstring=there
163
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000164For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000165precise: For options that expect a file name (those where environment
166variables are expanded) a backslash before a normal file name character is not
167removed. But a backslash before a special character (space, backslash, comma,
168etc.) is used like explained above.
169There is one special situation, when the value starts with "\\": >
170 :set dir=\\machine\path results in "\\machine\path"
171 :set dir=\\\\machine\\path results in "\\machine\path"
172 :set dir=\\path\\file results in "\\path\file" (wrong!)
173For the first one the start is kept, but for the second one the backslashes
174are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000175halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000176result which is probably not what you want. Avoid it.
177
178 *add-option-flags* *remove-option-flags*
179 *E539* *E550* *E551* *E552*
180Some options are a list of flags. When you want to add a flag to such an
181option, without changing the existing ones, you can do it like this: >
182 :set guioptions+=a
183Remove a flag from an option like this: >
184 :set guioptions-=a
185This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000186Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000187the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
188doesn't appear.
189
190 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000191Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000192environment variable exists the '$' and the following environment variable
193name is replaced with its value. If it does not exist the '$' and the name
194are not modified. Any non-id character (not a letter, digit or '_') may
195follow the environment variable name. That character and what follows is
196appended to the value of the environment variable. Examples: >
197 :set term=$TERM.new
198 :set path=/usr/$INCLUDE,$HOME/include,.
199When adding or removing a string from an option with ":set opt-=val" or ":set
200opt+=val" the expansion is done before the adding or removing.
201
202
203Handling of local options *local-options*
204
205Some of the options only apply to a window or buffer. Each window or buffer
206has its own copy of this option, thus can each have their own value. This
207allows you to set 'list' in one window but not in another. And set
208'shiftwidth' to 3 in one buffer and 4 in another.
209
210The following explains what happens to these local options in specific
211situations. You don't really need to know all of this, since Vim mostly uses
212the option values you would expect. Unfortunately, doing what the user
213expects is a bit complicated...
214
215When splitting a window, the local options are copied to the new window. Thus
216right after the split the contents of the two windows look the same.
217
218When editing a new buffer, its local option values must be initialized. Since
219the local options of the current buffer might be specifically for that buffer,
220these are not used. Instead, for each buffer-local option there also is a
221global value, which is used for new buffers. With ":set" both the local and
222global value is changed. With "setlocal" only the local value is changed,
223thus this value is not used when editing a new buffer.
224
225When editing a buffer that has been edited before, the last used window
226options are used again. If this buffer has been edited in this window, the
227values from back then are used. Otherwise the values from the window where
228the buffer was edited last are used.
229
230It's possible to set a local window option specifically for a type of buffer.
231When you edit another buffer in the same window, you don't want to keep
232using these local window options. Therefore Vim keeps a global value of the
233local window options, which is used when editing another buffer. Each window
234has its own copy of these values. Thus these are local to the window, but
235global to all buffers in the window. With this you can do: >
236 :e one
237 :set list
238 :e two
239Now the 'list' option will also be set in "two", since with the ":set list"
240command you have also set the global value. >
241 :set nolist
242 :e one
243 :setlocal list
244 :e two
245Now the 'list' option is not set, because ":set nolist" resets the global
246value, ":setlocal list" only changes the local value and ":e two" gets the
247global value. Note that if you do this next: >
248 :e one
249You will not get back the 'list' value as it was the last time you edited
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000250"one". The options local to a window are not remembered for each buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000251
252 *:setl* *:setlocal*
253:setl[ocal] ... Like ":set" but set only the value local to the
254 current buffer or window. Not all options have a
255 local value. If the option does not have a local
256 value the global value is set.
257 With the "all" argument: display all local option's
258 local values.
259 Without argument: Display all local option's local
260 values which are different from the default.
261 When displaying a specific local option, show the
262 local value. For a global option the global value is
263 shown (but that might change in the future).
264 {not in Vi}
265
266:setl[ocal] {option}< Set the local value of {option} to its global value.
267 {not in Vi}
268
269 *:setg* *:setglobal*
270:setg[lobal] ... Like ":set" but set only the global value for a local
271 option without changing the local value.
272 When displaying an option, the global value is shown.
273 With the "all" argument: display all local option's
274 global values.
275 Without argument: display all local option's global
276 values which are different from the default.
277 {not in Vi}
278
279For buffer-local and window-local options:
280 Command global value local value ~
281 :set option=value set set
282 :setlocal option=value - set
283:setglobal option=value set -
284 :set option? - display
285 :setlocal option? - display
286:setglobal option? display -
287
288
289Global options with a local value *global-local*
290
291Options are global when you mostly use one value for all buffers. For some
292global options it's useful to sometimes have a different local value. You can
293set the local value with ":setlocal". That buffer will then use the local
294value, while other buffers continue using the global value.
295
296For example, you have two windows, both on C source code. They use the global
297'makeprg' option. If you do this in one of the two windows: >
298 :set makeprg=gmake
299then the other window will switch to the same value. There is no need to set
300the 'makeprg' option in the other C source window too.
301However, if you start editing a Perl file in a new window, you want to use
302another 'makeprog' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000303files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304 :setlocal makeprg=perlmake
305You can switch back to using the global value by making the local value empty: >
306 :setlocal makeprg=
307This only works for a string option. For a boolean option you need to use the
308"<" flag, like this: >
309 :setlocal autoread<
310Note that for non-boolean options using "<" copies the global value to the
311local value, it doesn't switch back to using the global value (that matters
312when changing the global value later).
313Note: In the future more global options can be made global-local. Using
314":setlocal" on a global option might work differently then.
315
316
317Setting the filetype
318
319:setf[iletype] {filetype} *:setf* *:setfiletype*
320 Set the 'filetype' option to {filetype}, but only if
321 not done yet in a sequence of (nested) autocommands.
322 This is short for: >
323 :if !did_filetype()
324 : setlocal filetype={filetype}
325 :endif
326< This command is used in a filetype.vim file to avoid
327 setting the 'filetype' option twice, causing different
328 settings and syntax files to be loaded.
329 {not in Vi}
330
331:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
332:opt[ions] Open a window for viewing and setting all options.
333 Options are grouped by function.
334 Offers short help for each option. Hit <CR> on the
335 short help to open a help window with more help for
336 the option.
337 Modify the value of the option and hit <CR> on the
338 "set" line to set the new value. For window and
339 buffer specific options, the last accessed window is
340 used to set the option value in, unless this is a help
341 window, in which case the window below help window is
342 used (skipping the option-window).
343 {not available when compiled without the |+eval| or
344 |+autocmd| features}
345
346 *$HOME*
347Using "~" is like using "$HOME", but it is only recognized at the start of an
348option and after a space or comma.
349
350On Unix systems "~user" can be used too. It is replaced by the home directory
351of user "user". Example: >
352 :set path=~mool/include,/usr/include,.
353
354On Unix systems the form "${HOME}" can be used too. The name between {} can
355contain non-id characters then. Note that if you want to use this for the
356"gf" command, you need to add the '{' and '}' characters to 'isfname'.
357
358NOTE: expanding environment variables and "~/" is only done with the ":set"
359command, not when assigning a value to an option with ":let".
360
361
362Note the maximum length of an expanded option is limited. How much depends on
363the system, mostly it is something like 256 or 1024 characters.
364
365 *:fix* *:fixdel*
366:fix[del] Set the value of 't_kD':
367 't_kb' is 't_kD' becomes ~
368 CTRL-? CTRL-H
369 not CTRL-? CTRL-?
370
371 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
372
373 If your delete key terminal code is wrong, but the
374 code for backspace is alright, you can put this in
375 your .vimrc: >
376 :fixdel
377< This works no matter what the actual code for
378 backspace is.
379
380 If the backspace key terminal code is wrong you can
381 use this: >
382 :if &term == "termname"
383 : set t_kb=^V<BS>
384 : fixdel
385 :endif
386< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000387 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000388 with your terminal name.
389
390 If your <Delete> key sends a strange key sequence (not
391 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
392 :if &term == "termname"
393 : set t_kD=^V<Delete>
394 :endif
395< Where "^V" is CTRL-V and "<Delete>" is the delete key
396 (don't type eight characters!). Replace "termname"
397 with your terminal name.
398
399 *Linux-backspace*
400 Note about Linux: By default the backspace key
401 produces CTRL-?, which is wrong. You can fix it by
402 putting this line in your rc.local: >
403 echo "keycode 14 = BackSpace" | loadkeys
404<
405 *NetBSD-backspace*
406 Note about NetBSD: If your backspace doesn't produce
407 the right code, try this: >
408 xmodmap -e "keycode 22 = BackSpace"
409< If this works, add this in your .Xmodmap file: >
410 keysym 22 = BackSpace
411< You need to restart for this to take effect.
412
413==============================================================================
4142. Automatically setting options *auto-setting*
415
416Besides changing options with the ":set" command, there are three alternatives
417to set options automatically for one or more files:
418
4191. When starting Vim initializations are read from various places. See
420 |initialization|. Most of them are performed for all editing sessions,
421 and some of them depend on the directory where Vim is started.
422 You can create an initialization file with |:mkvimrc|, |:mkview| and
423 |:mksession|.
4242. If you start editing a new file, the automatic commands are executed.
425 This can be used to set options for files matching a particular pattern and
426 many other things. See |autocommand|.
4273. If you start editing a new file, and the 'modeline' option is on, a
428 number of lines at the beginning and end of the file are checked for
429 modelines. This is explained here.
430
431 *modeline* *vim:* *vi:* *ex:* *E520*
432There are two forms of modelines. The first form:
433 [text]{white}{vi:|vim:|ex:}[white]{options}
434
435[text] any text or empty
436{white} at least one blank character (<Space> or <Tab>)
437{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
438[white] optional white space
439{options} a list of option settings, separated with white space or ':',
440 where each part between ':' is the argument for a ":set"
441 command
442
443Example: >
444 vi:noai:sw=3 ts=6
445
446The second form (this is compatible with some versions of Vi):
447
448 [text]{white}{vi:|vim:|ex:}[white]se[t] {options}:[text]
449
450[text] any text or empty
451{white} at least one blank character (<Space> or <Tab>)
452{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
453[white] optional white space
454se[t] the string "set " or "se " (note the space)
455{options} a list of options, separated with white space, which is the
456 argument for a ":set" command
457: a colon
458[text] any text or empty
459
460Example: >
461 /* vim: set ai tw=75: */
462
463The white space before {vi:|vim:|ex:} is required. This minimizes the chance
464that a normal word like "lex:" is caught. There is one exception: "vi:" and
465"vim:" can also be at the start of the line (for compatibility with version
4663.0). Using "ex:" at the start of the line will be ignored (this could be
467short for "example:").
468
469 *modeline-local*
470The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000471buffer and window that contain the file. Although it's possible to set global
472options from a modeline, this is unusual. If you have two windows open and
473the files in it set the same global option to a different value, the result
474depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000475
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000476When editing a file that was already loaded, only the window-local options
477from the modeline are used. Thus if you manually changed a buffer-local
478option after opening the file, it won't be changed if you edit the same buffer
479in another window. But window-local options will be set.
480
Bram Moolenaar071d4272004-06-13 20:20:40 +0000481 *modeline-version*
482If the modeline is only to be used for some versions of Vim, the version
483number can be specified where "vim:" is used:
484 vim{vers}: version {vers} or later
485 vim<{vers}: version before {vers}
486 vim={vers}: version {vers}
487 vim>{vers}: version after {vers}
488{vers} is 600 for Vim 6.0 (hundred times the major version plus minor).
489For example, to use a modeline only for Vim 6.0 and later: >
490 /* vim600: set foldmethod=marker: */
491To use a modeline for Vim before version 5.7: >
492 /* vim<570: set sw=4: */
493There can be no blanks between "vim" and the ":".
494
495
496The number of lines that are checked can be set with the 'modelines' option.
497If 'modeline' is off or 'modelines' is 0 no lines are checked.
498
499Note that for the first form all of the rest of the line is used, thus a line
500like: >
501 /* vi:ts=4: */
502will give an error message for the trailing "*/". This line is OK: >
503 /* vi:set ts=4: */
504
505If an error is detected the rest of the line is skipped.
506
507If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000508backslash in front of the ':' will be removed. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000509 /* vi:set dir=c\:\tmp: */
510This sets the 'dir' option to "c:\tmp". Only a single backslash before the
511':' is removed. Thus to include "\:" you have to specify "\\:".
512
513No other commands than "set" are supported, for security reasons (somebody
514might create a Trojan horse text file with modelines).
515
516Hint: If you would like to do something else than setting an option, you could
517define an autocommand that checks the file for a specific string. For
518example: >
519 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
520And define a function SetVar() that does something with the line containing
521"VAR".
522
523==============================================================================
5243. Options summary *option-summary*
525
526In the list below all the options are mentioned with their full name and with
527an abbreviation if there is one. Both forms may be used.
528
529In this document when a boolean option is "set" that means that ":set option"
530is entered. When an option is "reset", ":set nooption" is used.
531
532For some options there are two default values: The "Vim default", which is
533used when 'compatible' is not set, and the "Vi default", which is used when
534'compatible' is set.
535
536Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000537are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000538different value in each window. For example the 'list' option can be set in
539one window and reset in another for the same text, giving both types of view
540at the same time. There are a few options that are specific to a certain
541file. These can have a different value for each file or buffer. For example
542the 'textwidth' option can be 78 for a normal text file and 0 for a C
543program.
544
545 global one option for all buffers and windows
546 local to window each window has its own copy of this option
547 local to buffer each buffer has its own copy of this option
548
549When creating a new window the option values from the currently active window
550are used as a default value for the window-specific options. For the
551buffer-specific options this depends on the 's' and 'S' flags in the
552'cpoptions' option. If 's' is included (which is the default) the values for
553buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000554first entered. If 'S' is present the options are copied each time the buffer
555is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000556present, the options are copied from the currently active buffer when the
557buffer is created.
558
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000559Not all options are supported in all versions. To test if option "foo" can be
560used with ":set" use "exists('&foo')". This doesn't mean the value is
561actually remembered and works. Some options are hidden, which means that you
Bram Moolenaar071d4272004-06-13 20:20:40 +0000562can set them but the value is not remembered. To test if option "foo" is
563really supported use "exists('+foo')".
564
565 *E355*
566A jump table for the options with a short description can be found at |Q_op|.
567
568 *'aleph'* *'al'* *aleph* *Aleph*
569'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
570 global
571 {not in Vi}
572 {only available when compiled with the |+rightleft|
573 feature}
574 The ASCII code for the first letter of the Hebrew alphabet. The
575 routine that maps the keyboard in Hebrew mode, both in Insert mode
576 (when hkmap is set) and on the command-line (when hitting CTRL-_)
577 outputs the Hebrew characters in the range [aleph..aleph+26].
578 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
579 See |rileft.txt|.
580
581 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
582'allowrevins' 'ari' boolean (default off)
583 global
584 {not in Vi}
585 {only available when compiled with the |+rightleft|
586 feature}
587 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
588 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
589 into reverse Insert mode, and don't know how to get out. See
590 'revins'.
591 NOTE: This option is reset when 'compatible' is set.
592
593 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
594'altkeymap' 'akm' boolean (default off)
595 global
596 {not in Vi}
597 {only available when compiled with the |+farsi|
598 feature}
599 When on, the second language is Farsi. In editing mode CTRL-_ toggles
600 the keyboard map between Farsi and English, when 'allowrevins' set.
601
602 When off, the keyboard map toggles between Hebrew and English. This
603 is useful to start the Vim in native mode i.e. English (left-to-right
604 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000605 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000606
607 *'ambiwidth'* *'ambw'*
608'ambiwidth' 'ambw' string (default: "single")
609 global
610 {not in Vi}
611 {only available when compiled with the |+multi_byte|
612 feature}
613 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
614 Tells Vim what to do with characters with East Asian Width Class
615 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
616 letters, Cyrillic letters).
617
618 There are currently two possible values:
619 "single": Use the same width as characters in US-ASCII. This is
620 expected by most users.
621 "double": Use twice the width of ASCII characters.
622
623 There are a number of CJK fonts for which the width of glyphs for
624 those characters are solely based on how many octets they take in
625 legacy/traditional CJK encodings. In those encodings, Euro,
626 Registered sign, Greek/Cyrillic letters are represented by two octets,
627 therefore those fonts have "wide" glyphs for them. This is also
628 true of some line drawing characters used to make tables in text
629 file. Therefore, when a CJK font is used for GUI Vim or
630 Vim is running inside a terminal (emulators) that uses a CJK font
631 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
632 this option should be set to "double" to match the width perceived
633 by Vim with the width of glyphs in the font. Perhaps it also has
634 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
635 when the system locale is set to one of CJK locales. See Unicode
636 Standard Annex #11 (http://www.unicode.org/reports/tr11).
637
638 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
639'antialias' 'anti' boolean (default: off)
640 global
641 {not in Vi}
642 {only available when compiled with GUI enabled
643 on Mac OS X}
644 This option only has an effect in the GUI version of Vim on Mac OS X
645 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
646 which can be easier to read at certain sizes on certain displays.
647 Setting this option can sometimes cause problems if 'guifont' is set
648 to its default (empty string).
649
650 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
651'autochdir' 'acd' boolean (default off)
652 global
653 {not in Vi}
654 {only available when compiled with the
655 |+netbeans_intg| or |+sun_workshop| feature}
656 When on, Vim will change its value for the current working directory
657 whenever you open a file, switch buffers, delete a buffer or
658 open/close a window. It will change to the directory containing the
659 file which was opened or selected. This option is provided for
660 backward compatibility with the Vim released with Sun ONE Studio 4
661 Enterprise Edition.
662
663 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
664'arabic' 'arab' boolean (default off)
665 local to window
666 {not in Vi}
667 {only available when compiled with the |+arabic|
668 feature}
669 This option can be set to start editing Arabic text.
670 Setting this option will:
671 - Set the 'rightleft' option, unless 'termbidi' is set.
672 - Set the 'arabicshape' option, unless 'termbidi' is set.
673 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
674 between typing English and Arabic key mapping.
675 - Set the 'delcombine' option
676 Note that 'encoding' must be "utf-8" for working with Arabic text.
677
678 Resetting this option will:
679 - Reset the 'rightleft' option.
680 - Disable the use of 'keymap' (without changing its value).
681 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
682 option.
683 Also see |arabic.txt|.
684
685 *'arabicshape'* *'arshape'*
686 *'noarabicshape'* *'noarshape'*
687'arabicshape' 'arshape' boolean (default on)
688 global
689 {not in Vi}
690 {only available when compiled with the |+arabic|
691 feature}
692 When on and 'termbidi' is off, the required visual character
693 corrections that need to take place for displaying the Arabic language
694 take affect. Shaping, in essence, gets enabled; the term is a broad
695 one which encompasses:
696 a) the changing/morphing of characters based on their location
697 within a word (initial, medial, final and stand-alone).
698 b) the enabling of the ability to compose characters
699 c) the enabling of the required combining of some characters
700 When disabled the character display reverts back to each character's
701 true stand-alone form.
702 Arabic is a complex language which requires other settings, for
703 further details see |arabic.txt|.
704
705 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
706'autoindent' 'ai' boolean (default off)
707 local to buffer
708 Copy indent from current line when starting a new line (typing <CR>
709 in Insert mode or when using the "o" or "O" command). If you do not
710 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000711 <Esc> or <CR>, the indent is deleted again. Moving the cursor to
712 another line has the same effect, unless the 'I' flag is included in
713 'cpoptions'.
714 When autoindent is on, formatting (with the "gq" command or when you
715 reach 'textwidth' in Insert mode) uses the indentation of the first
716 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000717 When 'smartindent' or 'cindent' is on the indent is changed in
718 a different way.
719 The 'autoindent' option is reset when the 'paste' option is set.
720 {small difference from Vi: After the indent is deleted when typing
721 <Esc> or <CR>, the cursor position when moving up or down is after the
722 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
723
724 *'autoread'* *'ar'* *'noautoread'* *'noar'*
725'autoread' 'ar' boolean (default off)
726 global or local to buffer |global-local|
727 {not in Vi}
728 When a file has been detected to have been changed outside of Vim and
729 it has not been changed inside of Vim, automatically read it again.
730 When the file has been deleted this is not done. |timestamp|
731 If this option has a local value, use this command to switch back to
732 using the global value: >
733 :set autoread<
734<
735 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
736'autowrite' 'aw' boolean (default off)
737 global
738 Write the contents of the file, if it has been modified, on each
739 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
740 :make, CTRL-] and CTRL-^ command; and when a CTRL-O, CTRL-I,
741 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
742 Note that for some commands the 'autowrite' option is not used, see
743 'autowriteall' for that.
744
745 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
746'autowriteall' 'awa' boolean (default off)
747 global
748 {not in Vi}
749 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
750 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
751 Setting this option also implies that Vim behaves like 'autowrite' has
752 been set.
753
754 *'background'* *'bg'*
755'background' 'bg' string (default "dark" or "light")
756 global
757 {not in Vi}
758 When set to "dark", Vim will try to use colors that look good on a
759 dark background. When set to "light", Vim will try to use colors that
760 look good on a light background. Any other value is illegal.
761 Vim tries to set the default value according to the terminal used.
762 This will not always be correct.
763 Setting this option does not change the background color, it tells Vim
764 what the background color looks like. For changing the background
765 color, see |:hi-normal|.
766
767 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000768 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 change.
770 When a color scheme is loaded (the "colors_name" variable is set)
771 setting 'background' will cause the color scheme to be reloaded. If
772 the color scheme adjusts to the value of 'background' this will work.
773 However, if the color scheme sets 'background' itself the effect may
774 be undone. First delete the "colors_name" variable when needed.
775
776 When setting 'background' to the default value with: >
777 :set background&
778< Vim will guess the value. In the GUI this should work correctly,
779 in other cases Vim might not be able to guess the right value.
780
781 When starting the GUI, the default value for 'background' will be
782 "light". When the value is not set in the .gvimrc, and Vim detects
783 that the background is actually quite dark, 'background' is set to
784 "dark". But this happens only AFTER the .gvimrc file has been read
785 (because the window needs to be opened to find the actual background
786 color). To get around this, force the GUI window to be opened by
787 putting a ":gui" command in the .gvimrc file, before where the value
788 of 'background' is used (e.g., before ":syntax on").
789 Normally this option would be set in the .vimrc file. Possibly
790 depending on the terminal name. Example: >
791 :if &term == "pcterm"
792 : set background=dark
793 :endif
794< When this option is set, the default settings for the highlight groups
795 will change. To use other settings, place ":highlight" commands AFTER
796 the setting of the 'background' option.
797 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
798 to select the colors for syntax highlighting. After changing this
799 option, you must load syntax.vim again to see the result. This can be
800 done with ":syntax on".
801
802 *'backspace'* *'bs'*
803'backspace' 'bs' string (default "")
804 global
805 {not in Vi}
806 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
807 mode. This is a list of items, separated by commas. Each item allows
808 a way to backspace over something:
809 value effect ~
810 indent allow backspacing over autoindent
811 eol allow backspacing over line breaks (join lines)
812 start allow backspacing over the start of insert; CTRL-W and CTRL-U
813 stop once at the start of insert.
814
815 When the value is empty, Vi compatible backspacing is used.
816
817 For backwards compatibility with version 5.4 and earlier:
818 value effect ~
819 0 same as ":set backspace=" (Vi compatible)
820 1 same as ":set backspace=indent,eol"
821 2 same as ":set backspace=indent,eol,start"
822
823 See |:fixdel| if your <BS> or <Del> key does not do what you want.
824 NOTE: This option is set to "" when 'compatible' is set.
825
826 *'backup'* *'bk'* *'nobackup'* *'nobk'*
827'backup' 'bk' boolean (default off)
828 global
829 {not in Vi}
830 Make a backup before overwriting a file. Leave it around after the
831 file has been successfully written. If you do not want to keep the
832 backup file, but you do want a backup while the file is being
833 written, reset this option and set the 'writebackup' option (this is
834 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000835 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000836 |backup-table| for more explanations.
837 When the 'backupskip' pattern matches, a backup is not made anyway.
838 When 'patchmode' is set, the backup may be renamed to become the
839 oldest version of a file.
840 NOTE: This option is reset when 'compatible' is set.
841
842 *'backupcopy'* *'bkc'*
843'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
844 global
845 {not in Vi}
846 When writing a file and a backup is made, this option tells how it's
847 done. This is a comma separated list of words.
848
849 The main values are:
850 "yes" make a copy of the file and overwrite the original one
851 "no" rename the file and write a new one
852 "auto" one of the previous, what works best
853
854 Extra values that can be combined with the ones above are:
855 "breaksymlink" always break symlinks when writing
856 "breakhardlink" always break hardlinks when writing
857
858 Making a copy and overwriting the original file:
859 - Takes extra time to copy the file.
860 + When the file has special attributes, is a (hard/symbolic) link or
861 has a resource fork, all this is preserved.
862 - When the file is a link the backup will have the name of the link,
863 not of the real file.
864
865 Renaming the file and writing a new one:
866 + It's fast.
867 - Sometimes not all attributes of the file can be copied to the new
868 file.
869 - When the file is a link the new file will not be a link.
870
871 The "auto" value is the middle way: When Vim sees that renaming file
872 is possible without side effects (the attributes can be passed on and
873 and the file is not a link) that is used. When problems are expected,
874 a copy will be made.
875
876 The "breaksymlink" and "breakhardlink" values can be used in
877 combination with any of "yes", "no" and "auto". When included, they
878 force Vim to always break either symbolic or hard links by doing
879 exactly what the "no" option does, renaming the original file to
880 become the backup and writing a new file in its place. This can be
881 useful for example in source trees where all the files are symbolic or
882 hard links and any changes should stay in the local source tree, not
883 be propagated back to the original source.
884 *crontab*
885 One situation where "no" and "auto" will cause problems: A program
886 that opens a file, invokes Vim to edit that file, and then tests if
887 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000888 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000889 example.
890
891 When a copy is made, the original file is truncated and then filled
892 with the new text. This means that protection bits, owner and
893 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000894 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000895 group of the backup is set to the group of the original file. If this
896 fails, the protection bits for the group are made the same as for
897 others.
898
899 When the file is renamed this is the other way around: The backup has
900 the same attributes of the original file, and the newly written file
901 is owned by the current user. When the file was a (hard/symbolic)
902 link, the new file will not! That's why the "auto" value doesn't
903 rename when the file is a link. The owner and group of the newly
904 written file will be set to the same ones as the original file, but
905 the system may refuse to do this. In that case the "auto" value will
906 again not rename the file.
907
908 *'backupdir'* *'bdir'*
909'backupdir' 'bdir' string (default for Amiga: ".,t:",
910 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
911 for Unix: ".,~/tmp,~/")
912 global
913 {not in Vi}
914 List of directories for the backup file, separated with commas.
915 - The backup file will be created in the first directory in the list
916 where this is possible.
917 - Empty means that no backup file will be created ('patchmode' is
918 impossible!). Writing may fail because of this.
919 - A directory "." means to put the backup file in the same directory
920 as the edited file.
921 - A directory starting with "./" (or ".\" for MS-DOS et.al.) means to
922 put the backup file relative to where the edited file is. The
923 leading "." is replaced with the path name of the edited file.
924 ("." inside a directory name has no special meaning).
925 - Spaces after the comma are ignored, other spaces are considered part
926 of the directory name. To have a space at the start of a directory
927 name, precede it with a backslash.
928 - To include a comma in a directory name precede it with a backslash.
929 - A directory name may end in an '/'.
930 - Environment variables are expanded |:set_env|.
931 - Careful with '\' characters, type one before a space, type two to
932 get one in the option (see |option-backslash|), for example: >
933 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
934< - For backwards compatibility with Vim version 3.0 a '>' at the start
935 of the option is removed.
936 See also 'backup' and 'writebackup' options.
937 If you want to hide your backup files on Unix, consider this value: >
938 :set backupdir=./.backup,~/.backup,.,/tmp
939< You must create a ".backup" directory in each directory and in your
940 home directory for this to work properly.
941 The use of |:set+=| and |:set-=| is preferred when adding or removing
942 directories from the list. This avoids problems when a future version
943 uses another default.
944 This option cannot be set from a |modeline| or in the |sandbox|, for
945 security reasons.
946
947 *'backupext'* *'bex'* *E589*
948'backupext' 'bex' string (default "~", for VMS: "_")
949 global
950 {not in Vi}
951 String which is appended to a file name to make the name of the
952 backup file. The default is quite unusual, because this avoids
953 accidentally overwriting existing files with a backup file. You might
954 prefer using ".bak", but make sure that you don't have files with
955 ".bak" that you want to keep.
956
957 *'backupskip'* *'bsk'*
958'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
959 global
960 {not in Vi}
961 {not available when compiled without the |+wildignore|
962 feature}
963 A list of file patterns. When one of the patterns matches with the
964 name of the file which is written, no backup file is created. Both
965 the specified file name and the full path name of the file are used.
966 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
967 Watch out for special characters, see |option-backslash|.
968 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
969 default value. "/tmp/*" is only used for Unix.
970
971 *'balloondelay'* *'bdlay'*
972'balloondelay' 'bdlay' number (default: 600)
973 global
974 {not in Vi}
975 {only available when compiled with the |+balloon_eval|
976 feature}
977 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
978
979 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
980'ballooneval' 'beval' boolean (default off)
981 global
982 {not in Vi}
983 {only available when compiled with the |+balloon_eval|
984 and |+sun_workshop| or |+netbeans_intg| features}
985 Switch on the |balloon-eval| functionality.
986
987 *'binary'* *'bin'* *'nobinary'* *'nobin'*
988'binary' 'bin' boolean (default off)
989 local to buffer
990 {not in Vi}
991 This option should be set before editing a binary file. You can also
992 use the |-b| Vim argument. When this option is switched on a few
993 options will be changed (also when it already was on):
994 'textwidth' will be set to 0
995 'wrapmargin' will be set to 0
996 'modeline' will be off
997 'expandtab' will be off
998 Also, 'fileformat' and 'fileformats' options will not be used, the
999 file is read and written like 'fileformat' was "unix" (a single <NL>
1000 separates lines).
1001 The 'fileencoding' and 'fileencodings' options will not be used, the
1002 file is read without conversion.
1003 NOTE: When you start editing a(nother) file while the 'bin' option is
1004 on, settings from autocommands may change the settings again (e.g.,
1005 'textwidth'), causing trouble when editing. You might want to set
1006 'bin' again when the file has been loaded.
1007 The previous values of these options are remembered and restored when
1008 'bin' is switched from on to off. Each buffer has its own set of
1009 saved option values.
1010 To edit a file with 'binary' set you can use the |++bin| argument.
1011 This avoids you have to do ":set bin", which would have effect for all
1012 files you edit.
1013 When writing a file the <EOL> for the last line is only written if
1014 there was one in the original file (normally Vim appends an <EOL> to
1015 the last line if there is none; this would make the file longer). See
1016 the 'endofline' option.
1017
1018 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1019'bioskey' 'biosk' boolean (default on)
1020 global
1021 {not in Vi} {only for MS-DOS}
1022 When on the bios is called to obtain a keyboard character. This works
1023 better to detect CTRL-C, but only works for the console. When using a
1024 terminal over a serial port reset this option.
1025 Also see |'conskey'|.
1026
1027 *'bomb'* *'nobomb'*
1028'bomb' boolean (default off)
1029 local to buffer
1030 {not in Vi}
1031 {only available when compiled with the |+multi_byte|
1032 feature}
1033 When writing a file and the following conditions are met, a BOM (Byte
1034 Order Mark) is prepended to the file:
1035 - this option is on
1036 - the 'binary' option is off
1037 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1038 endian variants.
1039 Some applications use the BOM to recognize the encoding of the file.
1040 Often used for UCS-2 files on MS-Windows. For other applications it
1041 causes trouble, for example: "cat file1 file2" makes the BOM of file2
1042 appear halfway the resulting file.
1043 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1044 check for the presence of the BOM is done and 'bomb' set accordingly.
1045 Unless 'binary' is set, it is removed from the first line, so that you
1046 don't see it when editing. When you don't change the options, the BOM
1047 will be restored when writing the file.
1048
1049 *'breakat'* *'brk'*
1050'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1051 global
1052 {not in Vi}
1053 {not available when compiled without the |+linebreak|
1054 feature}
1055 This option lets you choose which characters might cause a line
1056 break if 'linebreak' is on.
1057
1058 *'browsedir'* *'bsdir'*
1059'browsedir' 'bsdir' string (default for "last")
1060 global
1061 {not in Vi} {only for Motif and Win32 GUI}
1062 Which directory to use for the file browser:
1063 last Use same directory as with last file browser.
1064 buffer Use the directory of the related buffer.
1065 current Use the current directory.
1066 {path} Use the specified directory
1067
1068 *'bufhidden'* *'bh'*
1069'bufhidden' 'bh' string (default: "")
1070 local to buffer
1071 {not in Vi}
1072 {not available when compiled without the |+quickfix|
1073 feature}
1074 This option specifies what happens when a buffer is no longer
1075 displayed in a window:
1076 <empty> follow the global 'hidden' option
1077 hide hide the buffer (don't unload it), also when 'hidden'
1078 is not set
1079 unload unload the buffer, also when 'hidden' is set or using
1080 |:hide|
1081 delete delete the buffer from the buffer list, also when
1082 'hidden' is set or using |:hide|, like using
1083 |:bdelete|
1084 wipe wipe out the buffer from the buffer list, also when
1085 'hidden' is set or using |:hide|, like using
1086 |:bwipeout|
1087
1088 This option is used together with 'buftype' and 'swapfile' to specify
1089 special kinds of buffers. See |special-buffers|.
1090
1091 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1092'buflisted' 'bl' boolean (default: on)
1093 local to buffer
1094 {not in Vi}
1095 When this option is set, the buffer shows up in the buffer list. If
1096 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1097 This option is reset by Vim for buffers that are only used to remember
1098 a file name or marks. Vim sets it when starting to edit a buffer.
1099 But not when moving to a buffer with ":buffer".
1100
1101 *'buftype'* *'bt'* *E382*
1102'buftype' 'bt' string (default: "")
1103 local to buffer
1104 {not in Vi}
1105 {not available when compiled without the |+quickfix|
1106 feature}
1107 The value of this option specifies the type of a buffer:
1108 <empty> normal buffer
1109 nofile buffer which is not related to a file and will not be
1110 written
1111 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001112 acwrite buffer which will always be written with BufWriteCmd
1113 autocommands. {not available when compiled without the
1114 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001115 quickfix quickfix buffer, contains list of errors |:cwindow|
1116 help help buffer (you are not supposed to set this
1117 manually)
1118
1119 This option is used together with 'bufhidden' and 'swapfile' to
1120 specify special kinds of buffers. See |special-buffers|.
1121
1122 Be careful with changing this option, it can have many side effects!
1123
1124 A "quickfix" buffer is only used for the error list. This value is
1125 set by the |:cwindow| command and you are not supposed to change it.
1126
1127 "nofile" and "nowrite" buffers are similar:
1128 both: The buffer is not to be written to disk, ":w" doesn't
1129 work (":w filename" does work though).
1130 both: The buffer is never considered to be |'modified'|.
1131 There is no warning when the changes will be lost, for
1132 example when you quit Vim.
1133 both: A swap file is only created when using too much memory
1134 (when 'swapfile' has been reset there is never a swap
1135 file).
1136 nofile only: The buffer name is fixed, it is not handled like a
1137 file name. It is not modified in response to a |:cd|
1138 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001139 *E676*
1140 "acwrite" implies that the buffer name is not related to a file, like
1141 "nofile", but it will be written. Thus, in contrast to "nofile" and
1142 "nowrite", ":w" does work and a modified buffer can't be abandoned
1143 without saving. For writing there must be matching |BufWriteCmd|,
1144 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001145
1146 *'casemap'* *'cmp'*
1147'casemap' 'cmp' string (default: "internal,keepascii")
1148 global
1149 {not in Vi}
1150 Specifies details about changing the case of letters. It may contain
1151 these words, separated by a comma:
1152 internal Use internal case mapping functions, the current
1153 locale does not change the case mapping. This only
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001154 matters when 'encoding' is a Unicode encoding. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00001155 "internal" is omitted, the towupper() and towlower()
1156 system library functions are used when available.
1157 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1158 case mapping, the current locale is not effective.
1159 This probably only matters for Turkish.
1160
1161 *'cdpath'* *'cd'* *E344* *E346*
1162'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1163 global
1164 {not in Vi}
1165 {not available when compiled without the
1166 |+file_in_path| feature}
1167 This is a list of directories which will be searched when using the
1168 |:cd| and |:lcd| commands, provided that the directory being searched
1169 for has a relative path (not starting with "/", "./" or "../").
1170 The 'cdpath' option's value has the same form and semantics as
1171 |'path'|. Also see |file-searching|.
1172 The default value is taken from $CDPATH, with a "," prepended to look
1173 in the current directory first.
1174 If the default value taken from $CDPATH is not what you want, include
1175 a modified version of the following command in your vimrc file to
1176 override it: >
1177 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1178< This option cannot be set from a |modeline| or in the |sandbox|, for
1179 security reasons.
1180 (parts of 'cdpath' can be passed to the shell to expand file names).
1181
1182 *'cedit'*
1183'cedit' string (Vi default: "", Vim default: CTRL-F)
1184 global
1185 {not in Vi}
1186 {not available when compiled without the |+vertsplit|
1187 feature}
1188 The key used in Command-line Mode to open the command-line window.
1189 The default is CTRL-F when 'compatible' is off.
1190 Only non-printable keys are allowed.
1191 The key can be specified as a single character, but it is difficult to
1192 type. The preferred way is to use the <> notation. Examples: >
1193 :set cedit=<C-Y>
1194 :set cedit=<Esc>
1195< |Nvi| also has this option, but it only uses the first character.
1196 See |cmdwin|.
1197
1198 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1199'charconvert' 'ccv' string (default "")
1200 global
1201 {only available when compiled with the |+multi_byte|
1202 feature and the |+eval| feature}
1203 {not in Vi}
1204 An expression that is used for character encoding conversion. It is
1205 evaluated when a file that is to be read or has been written has a
1206 different encoding from what is desired.
1207 'charconvert' is not used when the internal iconv() function is
1208 supported and is able to do the conversion. Using iconv() is
1209 preferred, because it is much faster.
1210 'charconvert' is not used when reading stdin |--|, because there is no
1211 file to convert from. You will have to save the text in a file first.
1212 The expression must return zero or an empty string for success,
1213 non-zero for failure.
1214 The possible encoding names encountered are in 'encoding'.
1215 Additionally, names given in 'fileencodings' and 'fileencoding' are
1216 used.
1217 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1218 is done internally by Vim, 'charconvert' is not used for this.
1219 'charconvert' is also used to convert the viminfo file, if the 'c'
1220 flag is present in 'viminfo'. Also used for Unicode conversion.
1221 Example: >
1222 set charconvert=CharConvert()
1223 fun CharConvert()
1224 system("recode "
1225 \ . v:charconvert_from . ".." . v:charconvert_to
1226 \ . " <" . v:fname_in . " >" v:fname_out)
1227 return v:shell_error
1228 endfun
1229< The related Vim variables are:
1230 v:charconvert_from name of the current encoding
1231 v:charconvert_to name of the desired encoding
1232 v:fname_in name of the input file
1233 v:fname_out name of the output file
1234 Note that v:fname_in and v:fname_out will never be the same.
1235 Note that v:charconvert_from and v:charconvert_to may be different
1236 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1237 Encryption is not done by Vim when using 'charconvert'. If you want
1238 to encrypt the file after conversion, 'charconvert' should take care
1239 of this.
1240 This option cannot be set from a |modeline| or in the |sandbox|, for
1241 security reasons.
1242
1243 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1244'cindent' 'cin' boolean (default off)
1245 local to buffer
1246 {not in Vi}
1247 {not available when compiled without the |+cindent|
1248 feature}
1249 Enables automatic C program indenting See 'cinkeys' to set the keys
1250 that trigger reindenting in insert mode and 'cinoptions' to set your
1251 preferred indent style.
1252 If 'indentexpr' is not empty, it overrules 'cindent'.
1253 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1254 the "=" operator indents using this algorithm rather than calling an
1255 external program.
1256 See |C-indenting|.
1257 When you don't like the way 'cindent' works, try the 'smartindent'
1258 option or 'indentexpr'.
1259 This option is not used when 'paste' is set.
1260 NOTE: This option is reset when 'compatible' is set.
1261
1262 *'cinkeys'* *'cink'*
1263'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1264 local to buffer
1265 {not in Vi}
1266 {not available when compiled without the |+cindent|
1267 feature}
1268 A list of keys that, when typed in Insert mode, cause reindenting of
1269 the current line. Only used if 'cindent' is on and 'indentexpr' is
1270 empty.
1271 For the format of this option see |cinkeys-format|.
1272 See |C-indenting|.
1273
1274 *'cinoptions'* *'cino'*
1275'cinoptions' 'cino' string (default "")
1276 local to buffer
1277 {not in Vi}
1278 {not available when compiled without the |+cindent|
1279 feature}
1280 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1281 program. See |cinoptions-values| for the values of this option, and
1282 |C-indenting| for info on C indenting in general.
1283
1284
1285 *'cinwords'* *'cinw'*
1286'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1287 local to buffer
1288 {not in Vi}
1289 {not available when compiled without both the
1290 |+cindent| and the |+smartindent| features}
1291 These keywords start an extra indent in the next line when
1292 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1293 an appropriate place (inside {}).
1294 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1295 matter, include the keyword both the uppercase and lowercase:
1296 "if,If,IF".
1297
1298 *'clipboard'* *'cb'*
1299'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1300 for X-windows, "" otherwise)
1301 global
1302 {not in Vi}
1303 {only in GUI versions or when the |+xterm_clipboard|
1304 feature is included}
1305 This option is a list of comma separated names.
1306 These names are recognized:
1307
1308 unnamed When included, Vim will use the clipboard register '*'
1309 for all yank, delete, change and put operations which
1310 would normally go to the unnamed register. When a
1311 register is explicitly specified, it will always be
1312 used regardless of whether "unnamed" is in 'clipboard'
1313 or not. The clipboard register can always be
1314 explicitly accessed using the "* notation. Also see
1315 |gui-clipboard|.
1316
1317 autoselect Works like the 'a' flag in 'guioptions': If present,
1318 then whenever Visual mode is started, or the Visual
1319 area extended, Vim tries to become the owner of the
1320 windowing system's global selection or put the
1321 selected text on the clipboard used by the selection
1322 register "*. See |guioptions_a| and |quotestar| for
1323 details. When the GUI is active, the 'a' flag in
1324 'guioptions' is used, when the GUI is not active, this
1325 "autoselect" flag is used.
1326 Also applies to the modeless selection.
1327
1328 autoselectml Like "autoselect", but for the modeless selection
1329 only. Compare to the 'A' flag in 'guioptions'.
1330
1331 exclude:{pattern}
1332 Defines a pattern that is matched against the name of
1333 the terminal 'term'. If there is a match, no
1334 connection will be made to the X server. This is
1335 useful in this situation:
1336 - Running Vim in a console.
1337 - $DISPLAY is set to start applications on another
1338 display.
1339 - You do not want to connect to the X server in the
1340 console, but do want this in a terminal emulator.
1341 To never connect to the X server use: >
1342 exclude:.*
1343< This has the same effect as using the |-X| argument.
1344 Note that when there is no connection to the X server
1345 the window title won't be restored and the clipboard
1346 cannot be accessed.
1347 The value of 'magic' is ignored, {pattern} is
1348 interpreted as if 'magic' was on.
1349 The rest of the option value will be used for
1350 {pattern}, this must be the last entry.
1351
1352 *'cmdheight'* *'ch'*
1353'cmdheight' 'ch' number (default 1)
1354 global
1355 {not in Vi}
1356 Number of screen lines to use for the command-line. Helps avoiding
1357 |hit-enter| prompts.
1358
1359 *'cmdwinheight'* *'cwh'*
1360'cmdwinheight' 'cwh' number (default 7)
1361 global
1362 {not in Vi}
1363 {not available when compiled without the |+vertsplit|
1364 feature}
1365 Number of screen lines to use for the command-line window. |cmdwin|
1366
1367 *'columns'* *'co'* *E594*
1368'columns' 'co' number (default 80 or terminal width)
1369 global
1370 {not in Vi}
1371 Number of columns of the screen. Normally this is set by the terminal
1372 initialization and does not have to be set by hand.
1373 When Vim is running in the GUI or in a resizable window, setting this
1374 option will cause the window size to be changed. When you only want
1375 to use the size for the GUI, put the command in your |gvimrc| file.
1376 When you set this option and Vim is unable to change the physical
1377 number of columns of the display, the display may be messed up.
1378
1379 *'comments'* *'com'* *E524* *E525*
1380'comments' 'com' string (default
1381 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1382 local to buffer
1383 {not in Vi}
1384 {not available when compiled without the |+comments|
1385 feature}
1386 A comma separated list of strings that can start a comment line. See
1387 |format-comments|. See |option-backslash| about using backslashes to
1388 insert a space.
1389
1390 *'commentstring'* *'cms'* *E537*
1391'commentstring' 'cms' string (default "/*%s*/")
1392 local to buffer
1393 {not in Vi}
1394 {not available when compiled without the |+folding|
1395 feature}
1396 A template for a comment. The "%s" in the value is replaced with the
1397 comment text. Currently only used to add markers for folding, see
1398 |fold-marker|.
1399
1400 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
1401'compatible' 'cp' boolean (default on, off when a .vimrc file is found)
1402 global
1403 {not in Vi}
1404 This option has the effect of making Vim either more Vi-compatible, or
1405 make Vim behave in a more useful way.
1406 This is a special kind of option, because when it's set or reset,
1407 other options are also changed as a side effect. CAREFUL: Setting or
1408 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001409 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001410 set this option in your vimrc file, you should probably put it at the
1411 very start.
1412 By default this option is on and the Vi defaults are used for the
1413 options. This default was chosen for those people who want to use Vim
1414 just like Vi, and don't even (want to) know about the 'compatible'
1415 option.
1416 When a ".vimrc" file is found while Vim is starting up, this option is
1417 switched off, and all options that have not been modified will be set
1418 to the Vim defaults. Effectively, this means that when a ".vimrc"
1419 file exists, Vim will use the Vim defaults, otherwise it will use the
1420 Vi defaults. (Note: This doesn't happen for the system-wide vimrc
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001421 file). Also see |compatible-default|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001422 You can also set this option with the "-C" argument, and reset it with
1423 "-N". See |-C| and |-N|.
1424 Switching this option off makes the Vim defaults be used for options
1425 that have a different Vi and Vim default value. See the options
1426 marked with a '+' below. Other options are not modified.
1427 At the moment this option is set, several other options will be set
1428 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001429 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001430 editing.
1431 See also 'cpoptions'.
1432
1433 option + set value effect ~
1434
1435 'allowrevins' off no CTRL-_ command
1436 'backupcopy' Unix: "yes" backup file is a copy
1437 others: "auto" copy or rename backup file
1438 'backspace' "" normal backspace
1439 'backup' off no backup file
1440 'cindent' off no C code indentation
1441 'cedit' + "" no key to open the |cmdwin|
1442 'cpoptions' + (all flags) Vi-compatible flags
1443 'cscopetag' off don't use cscope for ":tag"
1444 'cscopetagorder' 0 see |cscopetagorder|
1445 'cscopeverbose' off see |cscopeverbose|
1446 'digraph' off no digraphs
1447 'esckeys' + off no <Esc>-keys in Insert mode
1448 'expandtab' off tabs not expanded to spaces
1449 'fileformats' + "" no automatic file format detection,
1450 "dos,unix" except for DOS, Windows and OS/2
1451 'formatoptions' + "vt" Vi compatible formatting
1452 'gdefault' off no default 'g' flag for ":s"
1453 'history' + 0 no commandline history
1454 'hkmap' off no Hebrew keyboard mapping
1455 'hkmapp' off no phonetic Hebrew keyboard mapping
1456 'hlsearch' off no highlighting of search matches
1457 'incsearch' off no incremental searching
1458 'indentexpr' "" no indenting by expression
1459 'insertmode' off do not start in Insert mode
1460 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1461 characters and '_'
1462 'joinspaces' on insert 2 spaces after period
1463 'modeline' + off no modelines
1464 'more' + off no pauses in listings
1465 'revins' off no reverse insert
1466 'ruler' off no ruler
1467 'scrolljump' 1 no jump scroll
1468 'scrolloff' 0 no scroll offset
1469 'shiftround' off indent not rounded to shiftwidth
1470 'shortmess' + "" no shortening of messages
1471 'showcmd' + off command characters not shown
1472 'showmode' + off current mode not shown
1473 'smartcase' off no automatic ignore case switch
1474 'smartindent' off no smart indentation
1475 'smarttab' off no smart tab size
1476 'softtabstop' 0 tabs are always 'tabstop' positions
1477 'startofline' on goto startofline with some commands
1478 'tagrelative' + off tag file names are not relative
1479 'textauto' + off no automatic textmode detection
1480 'textwidth' 0 no automatic line wrap
1481 'tildeop' off tilde is not an operator
1482 'ttimeout' off no terminal timeout
1483 'whichwrap' + "" left-right movements don't wrap
1484 'wildchar' + CTRL-E only when the current value is <Tab>
1485 use CTRL-E for cmdline completion
1486 'writebackup' on or off depends on +writebackup feature
1487
1488 *'complete'* *'cpt'* *E535*
1489'complete' 'cpt' string (default: ".,w,b,u,t,i")
1490 local to buffer
1491 {not in Vi}
1492 This option specifies how keyword completion |ins-completion| works
1493 when CTRL-P or CTRL-N are used. It is also used for whole-line
1494 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1495 and the places to scan. It is a comma separated list of flags:
1496 . scan the current buffer ('wrapscan' is ignored)
1497 w scan buffers from other windows
1498 b scan other loaded buffers that are in the buffer list
1499 u scan the unloaded buffers that are in the buffer list
1500 U scan the buffers that are not in the buffer list
1501 k scan the files given with the 'dictionary' option
1502 k{dict} scan the file {dict}. Several "k" flags can be given,
1503 patterns are valid too. For example: >
1504 :set cpt=k/usr/dict/*,k~/spanish
1505< s scan the files given with the 'thesaurus' option
1506 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1507 are valid too.
1508 i scan current and included files
1509 d scan current and included files for defined name or macro
1510 |i_CTRL-X_CTRL-D|
1511 ] tag completion
1512 t same as "]"
1513
1514 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1515 not executed, this may lead to unexpected completions from some files
1516 (gzipped files for example). Unloaded buffers are not scanned for
1517 whole-line completion.
1518
1519 The default is ".,w,b,u,t,i", which means to scan:
1520 1. the current buffer
1521 2. buffers in other windows
1522 3. other loaded buffers
1523 4. unloaded buffers
1524 5. tags
1525 6. included files
1526
1527 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
1528 based expansion (eg dictionary |i_CTRL-X_CTRL-K|, included patterns
1529 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions)
1530
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001531 *'completefunc'* *'cfu'*
1532'completefunc' 'cfu' string (default: empty)
1533 local to buffer
1534 {not in Vi}
1535 This option specifies a completion function to be used for CTRL-X
1536 CTRL-X. The function will be invoked with four arguments:
1537 a:line the text of the current line
1538 a:base the text with which matches should match
1539 a:col column in a:line where the cursor is, first column is
1540 zero
1541 a:findstart either 1 or 0
1542 When the a:findstart argument is 1, the function must return the
1543 column of where the completion starts. It must be a number between
1544 zero and "a:col". This involves looking at the characters in a:line
1545 before column a:col and include those characters that could be part of
1546 the completed item.
1547 When the a:findstart argument is 0 the function must return a string
1548 with the matching words, separated by newlines. When there are no
1549 matches return an empty string.
1550 An example that completes the names of the months: >
1551 fun! CompleteMonths(line, base, col, findstart)
1552 if a:findstart
1553 " locate start column of word
1554 let start = a:col
1555 while start > 0 && a:line[start - 1] =~ '\a'
1556 let start = start - 1
1557 endwhile
1558 return start
1559 else
1560 " find months matching with "a:base"
1561 let res = "Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec"
1562 if a:base != ''
1563 let res = substitute(res, '\c\<\(\(' . a:base . '.\{-}\>\)\|.\{-}\>\)', '\2', 'g')
1564 endif
1565 let res = substitute(res, ' \+', "\n", 'g')
1566 return res
1567 endif
1568 endfun
1569 set completefunc=CompleteMonths
1570< Note that a substitute() function is used to reduce the list of
1571 possible values and remove the ones that don't match the base. The
1572 part before the "\|" matches the base, the part after it is used
1573 when there is no match. The "\2" in the replacement is empty if the
1574 part before the "\|" does not match.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001575
Bram Moolenaar071d4272004-06-13 20:20:40 +00001576 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1577'confirm' 'cf' boolean (default off)
1578 global
1579 {not in Vi}
1580 When 'confirm' is on, certain operations that would normally
1581 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1582 instead raise a |dialog| asking if you wish to save the current
1583 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1584 If 'confirm' is off you can still activate confirmation for one
1585 command only (this is most useful in mappings) with the |:confirm|
1586 command.
1587 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1588
1589 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1590'conskey' 'consk' boolean (default off)
1591 global
1592 {not in Vi} {only for MS-DOS}
1593 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001594 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001595 three methods of console input are available:
1596 'conskey' 'bioskey' action ~
1597 on on or off direct console input
1598 off on BIOS
1599 off off STDIN
1600
1601 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1602'copyindent' 'ci' boolean (default off)
1603 local to buffer
1604 {not in Vi}
1605 Copy the structure of the existing lines indent when autoindenting a
1606 new line. Normally the new indent is reconstructed by a series of
1607 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1608 in which case only spaces are used). Enabling this option makes the
1609 new line copy whatever characters were used for indenting on the
1610 existing line. If the new indent is greater than on the existing
1611 line, the remaining space is filled in the normal manner.
1612 NOTE: 'copyindent' is reset when 'compatible' is set.
1613 Also see 'preserveindent'.
1614
1615 *'cpoptions'* *'cpo'*
1616'cpoptions' 'cpo' string (Vim default: "aABceFs",
1617 Vi default: all flags)
1618 global
1619 {not in Vi}
1620 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001621 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001622 not being vi-compatible is mostly or sometimes preferred.
1623 'cpoptions' stands for "compatible-options".
1624 Commas can be added for readability.
1625 To avoid problems with flags that are added in the future, use the
1626 "+=" and "-=" feature of ":set" |add-option-flags|.
1627 NOTE: This option is set to the Vi default value when 'compatible' is
1628 set and to the Vim default value when 'compatible' is reset.
1629
1630 contains behavior ~
1631 *cpo-a*
1632 a When included, a ":read" command with a file name
1633 argument will set the alternate file name for the
1634 current window.
1635 *cpo-A*
1636 A When included, a ":write" command with a file name
1637 argument will set the alternate file name for the
1638 current window.
1639 *cpo-b*
1640 b "\|" in a ":map" command is recognized as the end of
1641 the map command. The '\' is included in the mapping,
1642 the text after the '|' is interpreted as the next
1643 command. Use a CTRL-V instead of a backslash to
1644 include the '|' in the mapping. Applies to all
1645 mapping, abbreviation, menu and autocmd commands.
1646 See also |map_bar|.
1647 *cpo-B*
1648 B A backslash has no special meaning in mappings,
1649 abbreviations and the "to" part of the menu commands.
1650 Remove this flag to be able to use a backslash like a
1651 CTRL-V. For example, the command ":map X \<Esc>"
1652 results in X being mapped to:
1653 'B' included: "\^[" (^[ is a real <Esc>)
1654 'B' excluded: "<Esc>" (5 characters)
1655 ('<' excluded in both cases)
1656 *cpo-c*
1657 c Searching continues at the end of any match at the
1658 cursor position, but not further than the start of the
1659 next line. When not present searching continues
1660 one character from the cursor position. With 'c'
1661 "abababababab" only gets three matches when repeating
1662 "/abab", without 'c' there are five matches.
1663 *cpo-C*
1664 C Do not concatenate sourced lines that start with a
1665 backslash. See |line-continuation|.
1666 *cpo-d*
1667 d Using "./" in the 'tags' option doesn't mean to use
1668 the tags file relative to the current file, but the
1669 tags file in the current directory.
1670 *cpo-D*
1671 D Can't use CTRL-K to enter a digraph after Normal mode
1672 commands with a character argument, like |r|, |f| and
1673 |t|.
1674 *cpo-e*
1675 e When executing a register with ":@r", always add a
1676 <CR> to the last line, also when the register is not
1677 linewise. If this flag is not present, the register
1678 is not linewise and the last line does not end in a
1679 <CR>, then the last line is put on the command-line
1680 and can be edited before hitting <CR>.
1681 *cpo-E*
1682 E It is an error when using "y", "d", "c", "g~", "gu" or
1683 "gU" on an Empty region. The operators only work when
1684 at least one character is to be operate on. Example:
1685 This makes "y0" fail in the first column.
1686 *cpo-f*
1687 f When included, a ":read" command with a file name
1688 argument will set the file name for the current buffer,
1689 if the current buffer doesn't have a file name yet.
1690 *cpo-F*
1691 F When included, a ":write" command with a file name
1692 argument will set the file name for the current
1693 buffer, if the current buffer doesn't have a file name
1694 yet.
1695 *cpo-g*
1696 g Goto line 1 when using ":edit" without argument.
1697 *cpo-i*
1698 i When included, interrupting the reading of a file will
1699 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001700 *cpo-I*
1701 I When moving the cursor up or down just after inserting
1702 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001703 *cpo-j*
1704 j When joining lines, only add two spaces after a '.',
1705 not after '!' or '?'. Also see 'joinspaces'.
1706 *cpo-J*
1707 J A |sentence| has to be followed by two spaces after
1708 the '.', '!' or '?'. A <Tab> is not recognized as
1709 white space.
1710 *cpo-k*
1711 k Disable the recognition of raw key codes in
1712 mappings, abbreviations, and the "to" part of menu
1713 commands. For example, if <Key> sends ^[OA (where ^[
1714 is <Esc>), the command ":map X ^[OA" results in X
1715 being mapped to:
1716 'k' included: "^[OA" (3 characters)
1717 'k' excluded: "<Key>" (one key code)
1718 Also see the '<' flag below.
1719 *cpo-K*
1720 K Don't wait for a key code to complete when it is
1721 halfway a mapping. This breaks mapping <F1><F1> when
1722 only part of the second <F1> has been read. It
1723 enables cancelling the mapping by typing <F1><Esc>.
1724 *cpo-l*
1725 l Backslash in a [] range in a search pattern is taken
1726 literally, only "\]" is special See |/[]|
1727 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1728 'l' excluded: "/[ \t]" finds <Space> and <Tab>
1729 *cpo-L*
1730 L When the 'list' option is set, 'wrapmargin',
1731 'textwidth', 'softtabstop' and Virtual Replace mode
1732 (see |gR|) count a <Tab> as two characters, instead of
1733 the normal behavior of a <Tab>.
1734 *cpo-m*
1735 m When included, a showmatch will always wait half a
1736 second. When not included, a showmatch will wait half
1737 a second or until a character is typed. |'showmatch'|
1738 *cpo-M*
1739 M When excluded, "%" matching will take backslashes into
1740 account. Thus in "( \( )" and "\( ( \)" the outer
1741 parenthesis match. When included "%" ignores
1742 backslashes, which is Vi compatible.
1743 *cpo-n*
1744 n When included, the column used for 'number' will also
1745 be used for text of wrapped lines.
1746 *cpo-o*
1747 o Line offset to search command is not remembered for
1748 next search.
1749 *cpo-O*
1750 O Don't complain if a file is being overwritten, even
1751 when it didn't exist when editing it. This is a
1752 protection against a file unexpectedly created by
1753 someone else. Vi didn't complain about this.
1754 *cpo-p*
1755 p Vi compatible Lisp indenting. When not present, a
1756 slightly better algorithm is used.
1757 *cpo-r*
1758 r Redo ("." command) uses "/" to repeat a search
1759 command, instead of the actually used search string.
1760 *cpo-R*
1761 R Remove marks from filtered lines. Without this flag
1762 marks are kept like |:keepmarks| was used.
1763 *cpo-s*
1764 s Set buffer options when entering the buffer for the
1765 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001766 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001767 set when the buffer is created.
1768 *cpo-S*
1769 S Set buffer options always when entering a buffer
1770 (except 'readonly', 'fileformat', 'filetype' and
1771 'syntax'). This is the (most) Vi compatible setting.
1772 The options are set to the values in the current
1773 buffer. When you change an option and go to another
1774 buffer, the value is copied. Effectively makes the
1775 buffer options global to all buffers.
1776
1777 's' 'S' copy buffer options
1778 no no when buffer created
1779 yes no when buffer first entered (default)
1780 X yes each time when buffer entered (vi comp.)
1781 *cpo-t*
1782 t Search pattern for the tag command is remembered for
1783 "n" command. Otherwise Vim only puts the pattern in
1784 the history for search pattern, but doesn't change the
1785 last used search pattern.
1786 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001787 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001788 *cpo-v*
1789 v Backspaced characters remain visible on the screen in
1790 Insert mode. Without this flag the characters are
1791 erased from the screen right away. With this flag the
1792 screen newly typed text overwrites backspaced
1793 characters.
1794 *cpo-w*
1795 w When using "cw" on a blank character, only change one
1796 character and not all blanks until the start of the
1797 next word.
1798 *cpo-W*
1799 W Don't overwrite a readonly file. When omitted, ":w!"
1800 overwrites a readonly file, if possible.
1801 *cpo-x*
1802 x <Esc> on the command-line executes the command-line.
1803 The default in Vim is to abandon the command-line,
1804 because <Esc> normally aborts a command. |c_<Esc>|
1805 *cpo-y*
1806 y A yank command can be redone with ".".
1807 *cpo-!*
1808 ! When redoing a filter command, use the last used
1809 external command, whatever it was. Otherwise the last
1810 used -filter- command is used.
1811 *cpo-$*
1812 $ When making a change to one line, don't redisplay the
1813 line, but put a '$' at the end of the changed text.
1814 The changed text will be overwritten when you type the
1815 new text. The line is redisplayed if you type any
1816 command that moves the cursor from the insertion
1817 point.
1818 *cpo-%*
1819 % Vi-compatible matching is done for the "%" command.
1820 Does not recognize "#if", "#endif", etc.
1821 Does not recognize "/*" and "*/".
1822 Parens inside single and double quotes are also
1823 counted, causing a string that contains a paren to
1824 disturb the matching. For example, in a line like
1825 "if (strcmp("foo(", s))" the first paren does not
1826 match the last one. When this flag is not included,
1827 parens inside single and double quotes are treated
1828 specially. When matching a paren outside of quotes,
1829 everything inside quotes is ignored. When matching a
1830 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001831 there is one). This works very well for C programs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832 *cpo-star*
1833 * Use ":*" in the same way as ":@". When not included,
1834 ":*" is an alias for ":'<,'>", select the Visual area.
1835 *cpo-<*
1836 < Disable the recognition of special key codes in |<>|
1837 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001838 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001839 ":map X <Tab>" results in X being mapped to:
1840 '<' included: "<Tab>" (5 characters)
1841 '<' excluded: "^I" (^I is a real <Tab>)
1842 Also see the 'k' flag above.
1843
1844 *'cscopepathcomp'* *'cspc'*
1845'cscopepathcomp' 'cspc' number (default 0)
1846 global
1847 {not available when compiled without the |+cscope|
1848 feature}
1849 {not in Vi}
1850 Determines how many components of the path to show in a list of tags.
1851 See |cscopepathcomp|.
1852
1853 *'cscopeprg'* *'csprg'*
1854'cscopeprg' 'csprg' string (default "cscope")
1855 global
1856 {not available when compiled without the |+cscope|
1857 feature}
1858 {not in Vi}
1859 Specifies the command to execute cscope. See |cscopeprg|.
1860 This option cannot be set from a |modeline| or in the |sandbox|, for
1861 security reasons.
1862
1863 *'cscopequickfix'* *'csqf'*
1864'cscopequickfix' 'csqf' string (default "")
1865 global
1866 {not available when compiled without the |+cscope|
1867 or |+quickfix| features}
1868 {not in Vi}
1869 Specifies whether to use quickfix window to show cscope results.
1870 See |cscopequickfix|.
1871
1872 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
1873'cscopetag' 'cst' boolean (default off)
1874 global
1875 {not available when compiled without the |+cscope|
1876 feature}
1877 {not in Vi}
1878 Use cscope for tag commands. See |cscope-options|.
1879 NOTE: This option is reset when 'compatible' is set.
1880
1881 *'cscopetagorder'* *'csto'*
1882'cscopetagorder' 'csto' number (default 0)
1883 global
1884 {not available when compiled without the |+cscope|
1885 feature}
1886 {not in Vi}
1887 Determines the order in which ":cstag" performs a search. See
1888 |cscopetagorder|.
1889 NOTE: This option is set to 0 when 'compatible' is set.
1890
1891 *'cscopeverbose'* *'csverb'*
1892 *'nocscopeverbose'* *'nocsverb'*
1893'cscopeverbose' 'csverb' boolean (default off)
1894 global
1895 {not available when compiled without the |+cscope|
1896 feature}
1897 {not in Vi}
1898 Give messages when adding a cscope database. See |cscopeverbose|.
1899 NOTE: This option is reset when 'compatible' is set.
1900
1901 *'debug'*
1902'debug' string (default "")
1903 global
1904 {not in Vi}
1905 When set to "msg", error messages that would otherwise be omitted will
1906 be given anyway. This is useful when debugging 'foldexpr' or
1907 'indentexpr'.
1908
1909 *'define'* *'def'*
1910'define' 'def' string (default "^\s*#\s*define")
1911 global or local to buffer |global-local|
1912 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001913 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00001914 pattern, just like for the "/" command. This option is used for the
1915 commands like "[i" and "[d" |include-search|. The 'isident' option is
1916 used to recognize the defined name after the match:
1917 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
1918 See |option-backslash| about inserting backslashes to include a space
1919 or backslash.
1920 The default value is for C programs. For C++ this value would be
1921 useful, to include const type declarations: >
1922 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
1923< When using the ":set" command, you need to double the backslashes!
1924
1925 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
1926'delcombine' 'deco' boolean (default off)
1927 global
1928 {not in Vi}
1929 {only available when compiled with the |+multi_byte|
1930 feature}
1931 If editing Unicode and this option is set, backspace and Normal mode
1932 "x" delete each combining character on its own. When it is off (the
1933 default) the character along with its combining characters are
1934 deleted.
1935 Note: When 'delcombine' is set "xx" may work different from "2x"!
1936
1937 This is useful for Arabic, Hebrew and many other languages where one
1938 may have combining characters overtop of base characters, and want
1939 to remove only the combining ones.
1940
1941 *'dictionary'* *'dict'*
1942'dictionary' 'dict' string (default "")
1943 global or local to buffer |global-local|
1944 {not in Vi}
1945 List of file names, separated by commas, that are used to lookup words
1946 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
1947 contain a list of words. This can be one word per line, or several
1948 words per line, separated by non-keyword characters (white space is
1949 preferred). Maximum line length is 510 bytes.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001950 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00001951 after a comma are ignored, otherwise spaces are included in the file
1952 name. See |option-backslash| about using backslashes.
1953 Where to find a list of words?
1954 - On FreeBSD, there is the file "/usr/share/dict/words".
1955 - In the Simtel archive, look in the "msdos/linguist" directory.
1956 - In "miscfiles" of the GNU collection.
1957 The use of |:set+=| and |:set-=| is preferred when adding or removing
1958 directories from the list. This avoids problems when a future version
1959 uses another default.
1960 Backticks cannot be used in this option for security reasons.
1961
1962 *'diff'* *'nodiff'*
1963'diff' boolean (default off)
1964 local to window
1965 {not in Vi}
1966 {not available when compiled without the |+diff|
1967 feature}
1968 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001969 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001970
1971 *'dex'* *'diffexpr'*
1972'diffexpr' 'dex' string (default "")
1973 global
1974 {not in Vi}
1975 {not available when compiled without the |+diff|
1976 feature}
1977 Expression which is evaluated to obtain an ed-style diff file from two
1978 versions of a file. See |diff-diffexpr|.
1979 This option cannot be set from a |modeline| or in the |sandbox|, for
1980 security reasons.
1981
1982 *'dip'* *'diffopt'*
1983'diffopt' 'dip' string (default "filler")
1984 global
1985 {not in Vi}
1986 {not available when compiled without the |+diff|
1987 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001988 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001989 All are optional. Items must be separated by a comma.
1990
1991 filler Show filler lines, to keep the text
1992 synchronized with a window that has inserted
1993 lines at the same position. Mostly useful
1994 when windows are side-by-side and 'scrollbind'
1995 is set.
1996
1997 context:{n} Use a context of {n} lines between a change
1998 and a fold that contains unchanged lines.
1999 When omitted a context of six lines is used.
2000 See |fold-diff|.
2001
2002 icase Ignore changes in case of text. "a" and "A"
2003 are considered the same. Adds the "-i" flag
2004 to the "diff" command if 'diffexpr' is empty.
2005
2006 iwhite Ignore changes in amount of white space. Adds
2007 the "-b" flag to the "diff" command if
2008 'diffexpr' is empty. Check the documentation
2009 of the "diff" command for what this does
2010 exactly. It should ignore adding trailing
2011 white space, but not leading white space.
2012
2013 Examples: >
2014
2015 :set diffopt=filler,context:4
2016 :set diffopt=
2017 :set diffopt=filler
2018<
2019 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2020'digraph' 'dg' boolean (default off)
2021 global
2022 {not in Vi}
2023 {not available when compiled without the |+digraphs|
2024 feature}
2025 Enable the entering of digraphs in Insert mode with {char1} <BS>
2026 {char2}. See |digraphs|.
2027 NOTE: This option is reset when 'compatible' is set.
2028
2029 *'directory'* *'dir'*
2030'directory' 'dir' string (default for Amiga: ".,t:",
2031 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2032 for Unix: ".,~/tmp,/var/tmp,/tmp")
2033 global
2034 List of directory names for the swap file, separated with commas.
2035 - The swap file will be created in the first directory where this is
2036 possible.
2037 - Empty means that no swap file will be used (recovery is
2038 impossible!).
2039 - A directory "." means to put the swap file in the same directory as
2040 the edited file. On Unix, a dot is prepended to the file name, so
2041 it doesn't show in a directory listing. On MS-Windows the "hidden"
2042 attribute is set and a dot prepended if possible.
2043 - A directory starting with "./" (or ".\" for MS-DOS et.al.) means to
2044 put the swap file relative to where the edited file is. The leading
2045 "." is replaced with the path name of the edited file.
2046 - For Unix and Win32, if a directory ends in two path separators, the
2047 swap file name will be built from the complete path to the file
2048 with all path separators substituted to percent '%' signs. This will
2049 ensure file name uniqueness in the preserve directory.
2050 - Spaces after the comma are ignored, other spaces are considered part
2051 of the directory name. To have a space at the start of a directory
2052 name, precede it with a backslash.
2053 - To include a comma in a directory name precede it with a backslash.
2054 - A directory name may end in an ':' or '/'.
2055 - Environment variables are expanded |:set_env|.
2056 - Careful with '\' characters, type one before a space, type two to
2057 get one in the option (see |option-backslash|), for example: >
2058 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2059< - For backwards compatibility with Vim version 3.0 a '>' at the start
2060 of the option is removed.
2061 Using "." first in the list is recommended. This means that editing
2062 the same file twice will result in a warning. Using "/tmp" on Unix is
2063 discouraged: When the system crashes you lose the swap file.
2064 "/var/tmp" is often not cleared when rebooting, thus is a better
2065 choice than "/tmp". But it can contain a lot of files, your swap
2066 files get lost in the crowd. That is why a "tmp" directory in your
2067 home directory is tried first.
2068 The use of |:set+=| and |:set-=| is preferred when adding or removing
2069 directories from the list. This avoids problems when a future version
2070 uses another default.
2071 This option cannot be set from a |modeline| or in the |sandbox|, for
2072 security reasons.
2073 {Vi: directory to put temp file in, defaults to "/tmp"}
2074
2075 *'display'* *'dy'*
2076'display' 'dy' string (default "")
2077 global
2078 {not in Vi}
2079 Change the way text is displayed. This is comma separated list of
2080 flags:
2081 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002082 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002083 last line that doesn't fit is replaced with "@" lines.
2084 uhex Show unprintable characters hexadecimal as <xx>
2085 instead of using ^C and ~C.
2086
2087 *'eadirection'* *'ead'*
2088'eadirection' 'ead' string (default "both")
2089 global
2090 {not in Vi}
2091 {not available when compiled without the +vertsplit
2092 feature}
2093 Tells when the 'equalalways' option applies:
2094 ver vertically, width of windows is not affected
2095 hor horizontally, height of windows is not affected
2096 both width and height of windows is affected
2097
2098 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2099'edcompatible' 'ed' boolean (default off)
2100 global
2101 Makes the 'g' and 'c' flags of the ":substitute" command to be
2102 toggled each time the flag is given. See |complex-change|. See
2103 also 'gdefault' option.
2104 Switching this option on is discouraged!
2105
2106 *'encoding'* *'enc'* *E543*
2107'encoding' 'enc' string (default: "latin1" or value from $LANG)
2108 global
2109 {only available when compiled with the |+multi_byte|
2110 feature}
2111 {not in Vi}
2112 Sets the character encoding used inside Vim. It applies to text in
2113 the buffers, registers, Strings in expressions, text stored in the
2114 viminfo file, etc. It sets the kind of characters which Vim can work
2115 with. See |encoding-names| for the possible values.
2116
2117 NOTE: Changing this option will not change the encoding of the
2118 existing text in Vim. It may cause multi-byte text to become invalid.
2119 It should normally be kept at its default value, or set when Vim
2120 starts up. See |multibyte|.
2121
2122 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2123 "utf-8". Although care has been taken to allow different values of
2124 'encoding', "utf-8" is the natural choice for the environment and
2125 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002126 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002127 versions, and to avoid changing the encoding of newly created files
2128 without your knowledge (in case 'fileencodings' is empty).
2129
2130 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002131 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002132 iconv() or as specified with 'charconvert'.
2133
2134 Normally 'encoding' will be equal to your current locale. This will
2135 be the default if Vim recognizes your environment settings. If
2136 'encoding' is not set to the current locale, 'termencoding' must be
2137 set to convert typed and displayed text. See |encoding-table|.
2138
2139 When you set this option, it fires the |EncodingChanged| autocommand
2140 event so that you can set up fonts if necessary.
2141
2142 When the option is set, the value is converted to lowercase. Thus
2143 you can set it with uppercase values too. Underscores are translated
2144 to '-' signs.
2145 When the encoding is recognized, it is changed to the standard name.
2146 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2147 "iso-8859-2" and "utf8" becomes "utf-8".
2148
2149 Note: "latin1" is also used when the encoding could not be detected.
2150 This only works when editing files in the same encoding! When the
2151 actual character set is not latin1, make sure 'fileencoding' and
2152 'fileencodings' are empty. When conversion is needed, switch to using
2153 utf-8.
2154
2155 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2156 You don't notice this while editing, but it does matter for the
2157 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2158 setting 'encoding' to one of these values instead of utf-8 only has
2159 effect for encoding used for files when 'fileencoding' is empty.
2160
2161 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2162 not set yet, the default for 'fileencodings' is changed.
2163
2164 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2165'endofline' 'eol' boolean (default on)
2166 local to buffer
2167 {not in Vi}
2168 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002169 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002170 option is automatically set when starting to edit a new file, unless
2171 the file does not have an <EOL> for the last line in the file, in
2172 which case it is reset. Normally you don't have to set or reset this
2173 option. When 'binary' is off the value is not used when writing the
2174 file. When 'binary' is on it is used to remember the presence of a
2175 <EOL> for the last line in the file, so that when you write the file
2176 the situation from the original file can be kept. But you can change
2177 it if you want to.
2178
2179 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2180'equalalways' 'ea' boolean (default on)
2181 global
2182 {not in Vi}
2183 When on, all the windows are automatically made the same size after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002184 splitting or closing a window. When off, splitting a window will
Bram Moolenaar071d4272004-06-13 20:20:40 +00002185 reduce the size of the current window and leave the other windows the
2186 same. When closing a window the extra lines are given to the window
2187 next to it (depending on 'splitbelow' and 'splitright').
2188 When mixing vertically and horizontally split windows, a minimal size
2189 is computed and some windows may be larger if there is room. The
2190 'eadirection' option tells in which direction the size is affected.
2191 Changing the height of a window can be avoided by setting
2192 'winfixheight'.
2193
2194 *'equalprg'* *'ep'*
2195'equalprg' 'ep' string (default "")
2196 global or local to buffer |global-local|
2197 {not in Vi}
2198 External program to use for "=" command. When this option is empty
2199 the internal formatting functions are used ('lisp', 'cindent' or
2200 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002201 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002202 about including spaces and backslashes.
2203 This option cannot be set from a |modeline| or in the |sandbox|, for
2204 security reasons.
2205
2206 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2207'errorbells' 'eb' boolean (default off)
2208 global
2209 Ring the bell (beep or screen flash) for error messages. This only
2210 makes a difference for error messages, the bell will be used always
2211 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002212 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002213 screen flash or do nothing.
2214
2215 *'errorfile'* *'ef'*
2216'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2217 others: "errors.err")
2218 global
2219 {not in Vi}
2220 {not available when compiled without the |+quickfix|
2221 feature}
2222 Name of the errorfile for the QuickFix mode (see |:cf|).
2223 When the "-q" command-line argument is used, 'errorfile' is set to the
2224 following argument. See |-q|.
2225 NOT used for the ":make" command. See 'makeef' for that.
2226 Environment variables are expanded |:set_env|.
2227 See |option-backslash| about including spaces and backslashes.
2228 This option cannot be set from a |modeline| or in the |sandbox|, for
2229 security reasons.
2230
2231 *'errorformat'* *'efm'*
2232'errorformat' 'efm' string (default is very long)
2233 global or local to buffer |global-local|
2234 {not in Vi}
2235 {not available when compiled without the |+quickfix|
2236 feature}
2237 Scanf-like description of the format for the lines in the error file
2238 (see |errorformat|).
2239
2240 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2241'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2242 global
2243 {not in Vi}
2244 Function keys that start with an <Esc> are recognized in Insert
2245 mode. When this option is off, the cursor and function keys cannot be
2246 used in Insert mode if they start with an <Esc>. The advantage of
2247 this is that the single <Esc> is recognized immediately, instead of
2248 after one second. Instead of resetting this option, you might want to
2249 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2250 when 'esckeys' is off, you can still map anything, but the cursor keys
2251 won't work by default.
2252 NOTE: This option is set to the Vi default value when 'compatible' is
2253 set and to the Vim default value when 'compatible' is reset.
2254
2255 *'eventignore'* *'ei'*
2256'eventignore' 'ei' string (default "")
2257 global
2258 {not in Vi}
2259 {not available when compiled without the |+autocmd|
2260 feature}
2261 A list of autocommand event names, which are to be ignored.
2262 When set to "all", all autocommand events are ignored, autocommands
2263 will not be executed.
2264 Otherwise this is a comma separated list of event names. Example: >
2265 :set ei=WinEnter,WinLeave
2266<
2267 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2268'expandtab' 'et' boolean (default off)
2269 local to buffer
2270 {not in Vi}
2271 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002272 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002273 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2274 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2275 NOTE: This option is reset when 'compatible' is set.
2276
2277 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2278'exrc' 'ex' boolean (default off)
2279 global
2280 {not in Vi}
2281 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2282 directory. If you switch this option on you should also consider
2283 setting the 'secure' option (see |initialization|). Using a local
2284 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2285 also see |.vimrc| and |gui-init|.
2286 This option cannot be set from a |modeline| or in the |sandbox|, for
2287 security reasons.
2288
2289 *'fileencoding'* *'fenc'* *E213*
2290'fileencoding' 'fenc' string (default: "")
2291 local to buffer
2292 {only available when compiled with the |+multi_byte|
2293 feature}
2294 {not in Vi}
2295 Sets the character encoding for the file of this buffer.
2296 When 'fileencoding' is different from 'encoding', conversion will be
2297 done when reading and writing the file.
2298 When 'fileencoding' is empty, the same value as 'encoding' will be
2299 used (no conversion when reading or writing a file).
2300 WARNING: Conversion can cause loss of information! When
2301 'encoding' is "utf-8" conversion is most likely done in a way
2302 that the reverse conversion results in the same text. When
2303 'encoding' is not "utf-8" some characters may be lost!
2304 See 'encoding' for the possible values. Additionally, values may be
2305 specified that can be handled by the converter, see
2306 |mbyte-conversion|.
2307 When reading a file 'fileencoding' will be set from 'fileencodings'.
2308 To read a file in a certain encoding it won't work by setting
2309 'fileencoding', use the |++enc| argument.
2310 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2311 When the option is set, the value is converted to lowercase. Thus
2312 you can set it with uppercase values too. '_' characters are
2313 replaced with '-'. If a name is recognized from the list for
2314 'encoding', it is replaced by the standard name. For example
2315 "ISO8859-2" becomes "iso-8859-2".
2316 When this option is set, after starting to edit a file, the 'modified'
2317 option is set, because the file would be different when written.
2318 If you do this in a modeline, you might want to set 'nomodified' to
2319 avoid this.
2320 This option can not be changed when 'modifiable' is off.
2321
2322 *'fe'*
2323 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002324 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002325 old short name was 'fe', which is no longer used.
2326
2327 *'fileencodings'* *'fencs'*
2328'fileencodings' 'fencs' string (default: "ucs-bom", "ucs-bom,utf-8,latin1"
2329 when 'encoding' is set to a Unicode value)
2330 global
2331 {only available when compiled with the |+multi_byte|
2332 feature}
2333 {not in Vi}
2334 This is a list of character encodings considered when starting to edit
2335 an existing file. When a file is read, Vim tries to use the first
2336 mentioned character encoding. If an error is detected, the next one
2337 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002338 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002339 an empty string, which means the value of 'encoding' is used.
2340 WARNING: Conversion can cause loss of information! When
2341 'encoding' is "utf-8" (or one of the other Unicode variants)
2342 conversion is most likely done in a way that the reverse
2343 conversion results in the same text. When 'encoding' is not
2344 "utf-8" special characters may be lost!
2345 For an empty file or a file with only ASCII characters most encodings
2346 will work and the first entry of 'fileencodings' will be used (except
2347 "ucs-bom", which requires the BOM to be present). If you prefer
2348 another encoding use an BufReadPost autocommand event to test if your
2349 preferred encoding is to be used. Example: >
2350 au BufReadPost * if search('\S', 'w') == 0 |
2351 \ set fenc=iso-2022-jp | endif
2352< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2353 non-blank characters.
2354 Note that 'fileencodings' is not used for an new file, 'fileencoding'
2355 is always empty then. This means that a non-existing file may get a
2356 different encoding than an empty file.
2357 The special value "ucs-bom" can be used to check for a Unicode BOM
2358 (Byte Order Mark) at the start of the file. It must not be preceded
2359 by "utf-8" or another Unicode encoding for this to work properly.
2360 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2361 because Vim cannot detect an error, thus the encoding is always
2362 accepted.
2363 WRONG VALUES: WHAT'S WRONG:
2364 latin1,utf-8 "latin1" will always be used
2365 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2366 file
2367 cp1250,latin1 "cp1250" will always be used
2368 If 'fileencodings' is empty, 'fileencoding' is not modified.
2369 See 'fileencoding' for the possible values.
2370 Setting this option does not have an effect until the next time a file
2371 is read.
2372
2373 *'fileformat'* *'ff'*
2374'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2375 Unix default: "unix",
2376 Macintosh default: "mac")
2377 local to buffer
2378 {not in Vi}
2379 This gives the <EOL> of the current buffer, which is used for
2380 reading/writing the buffer from/to a file:
2381 dos <CR> <NL>
2382 unix <NL>
2383 mac <CR>
2384 When "dos" is used, CTRL-Z at the end of a file is ignored.
2385 See |file-formats| and |file-read|.
2386 For the character encoding of the file see 'fileencoding'.
2387 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2388 works like it was set to "unix'.
2389 This option is set automatically when starting to edit a file and
2390 'fileformats' is not empty and 'binary' is off.
2391 When this option is set, after starting to edit a file, the 'modified'
2392 option is set, because the file would be different when written.
2393 This option can not be changed when 'modifiable' is off.
2394 For backwards compatibility: When this option is set to "dos",
2395 'textmode' is set, otherwise 'textmode' is reset.
2396
2397 *'fileformats'* *'ffs'*
2398'fileformats' 'ffs' string (default:
2399 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2400 Vim Unix: "unix,dos",
2401 Vim Mac: "mac,unix,dos",
2402 Vi Cygwin: "unix,dos",
2403 Vi others: "")
2404 global
2405 {not in Vi}
2406 This gives the end-of-line (<EOL>) formats that will be tried when
2407 starting to edit a new buffer and when reading a file into an existing
2408 buffer:
2409 - When empty, the format defined with 'fileformat' will be used
2410 always. It is not set automatically.
2411 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002412 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002413 'fileformats' name will be used when a file is read into an existing
2414 buffer, no matter what 'fileformat' for that buffer is set to.
2415 - When more than one name is present, separated by commas, automatic
2416 <EOL> detection will be done when reading a file. When starting to
2417 edit a file, a check is done for the <EOL>:
2418 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2419 'fileformat' is set to "dos".
2420 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002421 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002422 preceding <CR>, "unix" is preferred over "dos".
2423 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2424 This means that "mac" is only chosen when "unix" is not present,
2425 or when no <NL> is found in the file, and when "dos" is not
2426 present, or no <CR><NL> is present in the file.
2427 Also if "unix" was first chosen, but the first <CR> is before
2428 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2429 the file, then 'fileformat' is set to "mac".
2430 4. If 'fileformat' is still not set, the first name from
2431 'fileformats' is used.
2432 When reading a file into an existing buffer, the same is done, but
2433 this happens like 'fileformat' has been set appropriately for that
2434 file only, the option is not changed.
2435 When 'binary' is set, the value of 'fileformats' is not used.
2436
2437 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2438 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2439 done:
2440 - When 'fileformats' is empty, there is no automatic detection. Dos
2441 format will be used.
2442 - When 'fileformats' is set to one or more names, automatic detection
2443 is done. This is based on the first <NL> in the file: If there is a
2444 <CR> in front of it, Dos format is used, otherwise Unix format is
2445 used.
2446 Also see |file-formats|.
2447 For backwards compatibility: When this option is set to an empty
2448 string or one format (no comma is included), 'textauto' is reset,
2449 otherwise 'textauto' is set.
2450 NOTE: This option is set to the Vi default value when 'compatible' is
2451 set and to the Vim default value when 'compatible' is reset.
2452
2453 *'filetype'* *'ft'*
2454'filetype' 'ft' string (default: "")
2455 local to buffer
2456 {not in Vi}
2457 {not available when compiled without the |+autocmd|
2458 feature}
2459 When this option is set, the FileType autocommand event is triggered.
2460 All autocommands that match with the value of this option will be
2461 executed. Thus the value of 'filetype' is used in place of the file
2462 name.
2463 Otherwise this option does not always reflect the current file type.
2464 This option is normally set when the file type is detected. To enable
2465 this use the ":filetype on" command. |:filetype|
2466 Setting this option to a different value is most useful in a modeline,
2467 for a file for which the file type is not automatically recognized.
2468 Example, for in an IDL file: >
2469 /* vim: set filetype=idl : */
2470< |FileType| |filetypes|
2471 Do not confuse this option with 'osfiletype', which is for the file
2472 type that is actually stored with the file.
2473 This option is not copied to another buffer, independent of the 's' or
2474 'S' flag in 'cpoptions'.
2475
2476 *'fillchars'* *'fcs'*
2477'fillchars' 'fcs' string (default "vert:|,fold:-")
2478 global
2479 {not in Vi}
2480 {not available when compiled without the |+windows|
2481 and |+folding| features}
2482 Characters to fill the statuslines and vertical separators.
2483 It is a comma separated list of items:
2484
2485 item default Used for ~
2486 stl:c ' ' or '^' statusline of the current window
2487 stlnc:c ' ' or '-' statusline of the non-current windows
2488 vert:c '|' vertical separators |:vsplit|
2489 fold:c '-' filling 'foldtext'
2490 diff:c '-' deleted lines of the 'diff' option
2491
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002492 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002493 "stlnc" the space will be used when there is highlighting, '^' or '-'
2494 otherwise.
2495
2496 Example: >
2497 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2498< This is similar to the default, except that these characters will also
2499 be used when there is highlighting.
2500
2501 The highlighting used for these items:
2502 item highlight group ~
2503 stl:c StatusLine |hl-StatusLine|
2504 stlnc:c StatusLineNC |hl-StatusLineNC|
2505 vert:c VertSplit |hl-VertSplit|
2506 fold:c Folded |hl-Folded|
2507 diff:c DiffDelete |hl-DiffDelete|
2508
2509 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2510'fkmap' 'fk' boolean (default off) *E198*
2511 global
2512 {not in Vi}
2513 {only available when compiled with the |+rightleft|
2514 feature}
2515 When on, the keyboard is mapped for the Farsi character set.
2516 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002517 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002518
2519 *'foldclose'* *'fcl'*
2520'foldclose' 'fcl' string (default "")
2521 global
2522 {not in Vi}
2523 {not available when compiled without the |+folding|
2524 feature}
2525 When set to "all", a fold is closed when the cursor isn't in it and
2526 its level is higher than 'foldlevel'. Useful if you want folds to
2527 automatically close when moving out of them.
2528
2529 *'foldcolumn'* *'fdc'*
2530'foldcolumn' 'fdc' number (default 0)
2531 local to window
2532 {not in Vi}
2533 {not available when compiled without the |+folding|
2534 feature}
2535 When non-zero, a column with the specified width is shown at the side
2536 of the window which indicates open and closed folds. The maximum
2537 value is 12.
2538 See |folding|.
2539
2540 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2541'foldenable' 'fen' boolean (default on)
2542 local to window
2543 {not in Vi}
2544 {not available when compiled without the |+folding|
2545 feature}
2546 When off, all folds are open. This option can be used to quickly
2547 switch between showing all text unfolded and viewing the text with
2548 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002549 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002550 'foldenable' is off.
2551 This option is set by commands that create a new fold or close a fold.
2552 See |folding|.
2553
2554 *'foldexpr'* *'fde'*
2555'foldexpr' 'fde' string (default: "0")
2556 local to window
2557 {not in Vi}
2558 {not available when compiled without the |+folding|
2559 or |+eval| feature}
2560 The expression used for when 'foldmethod' is "expr". It is evaluated
2561 for each line to obtain its fold level. See |fold-expr|. Also see
2562 |eval-sandbox|.
2563
2564 *'foldignore'* *'fdi'*
2565'foldignore' 'fdi' string (default: "#")
2566 local to window
2567 {not in Vi}
2568 {not available when compiled without the |+folding|
2569 feature}
2570 Used only when 'foldmethod' is "indent". Lines starting with
2571 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002572 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002573 The default "#" works well for C programs. See |fold-indent|.
2574
2575 *'foldlevel'* *'fdl'*
2576'foldlevel' 'fdl' number (default: 0)
2577 local to window
2578 {not in Vi}
2579 {not available when compiled without the |+folding|
2580 feature}
2581 Sets the fold level: Folds with a higher level will be closed.
2582 Setting this option to zero will close all folds. Higher numbers will
2583 close fewer folds.
2584 This option is set by commands like |zm|, |zM| and |zR|.
2585 See |fold-foldlevel|.
2586
2587 *'foldlevelstart'* *'fdls'*
2588'foldlevelstart' 'fdls' number (default: -1)
2589 global
2590 {not in Vi}
2591 {not available when compiled without the |+folding|
2592 feature}
2593 Sets 'foldlevel' when starting to edit another buffer in a window.
2594 Useful to always start editing with all folds closed (value zero),
2595 some folds closed (one) or no folds closed (99).
2596 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002597 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002598 ignores this option and closes all folds.
2599 It is also done before BufReadPre autocommands, to allow an autocmd to
2600 overrule the 'foldlevel' value for specific files.
2601 When the value is negative, it is not used.
2602
2603 *'foldmarker'* *'fmr'* *E536*
2604'foldmarker' 'fmr' string (default: "{{{,}}}")
2605 local to window
2606 {not in Vi}
2607 {not available when compiled without the |+folding|
2608 feature}
2609 The start and end marker used when 'foldmethod' is "marker". There
2610 must be one comma, which separates the start and end marker. The
2611 marker is a literal string (a regular expression would be too slow).
2612 See |fold-marker|.
2613
2614 *'foldmethod'* *'fdm'*
2615'foldmethod' 'fdm' string (default: "manual")
2616 local to window
2617 {not in Vi}
2618 {not available when compiled without the |+folding|
2619 feature}
2620 The kind of folding used for the current window. Possible values:
2621 |fold-manual| manual Folds are created manually.
2622 |fold-indent| indent Lines with equal indent form a fold.
2623 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2624 |fold-marker| marker Markers are used to specify folds.
2625 |fold-syntax| syntax Syntax highlighting items specify folds.
2626 |fold-diff| diff Fold text that is not changed.
2627
2628 *'foldminlines'* *'fml'*
2629'foldminlines' 'fml' number (default: 1)
2630 local to window
2631 {not in Vi}
2632 {not available when compiled without the |+folding|
2633 feature}
2634 Sets the minimum number of screen lines for a fold to be displayed
2635 closed. Also for manually closed folds.
2636 Note that this only has an effect of what is displayed. After using
2637 "zc" to close a fold, which is displayed open because it's smaller
2638 than 'foldminlines', a following "zc" may close a containing fold.
2639
2640 *'foldnestmax'* *'fdn'*
2641'foldnestmax' 'fdn' number (default: 20)
2642 local to window
2643 {not in Vi}
2644 {not available when compiled without the |+folding|
2645 feature}
2646 Sets the maximum nesting of folds for the "indent" and "syntax"
2647 methods. This avoids that too many folds will be created. Using more
2648 than 20 doesn't work, because the internal limit is 20.
2649
2650 *'foldopen'* *'fdo'*
2651'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2652 search,tag,undo")
2653 global
2654 {not in Vi}
2655 {not available when compiled without the |+folding|
2656 feature}
2657 Specifies for which type of commands folds will be opened, if the
2658 command moves the cursor into a closed fold. It is a comma separated
2659 list of items.
2660 item commands ~
2661 all any
2662 block "(", "{", "[[", "[{", etc.
2663 hor horizontal movements: "l", "w", "fx", etc.
2664 insert any command in Insert mode
2665 jump far jumps: "G", "gg", etc.
2666 mark jumping to a mark: "'m", CTRL-O, etc.
2667 percent "%"
2668 quickfix ":cn", ":crew", ":make", etc.
2669 search search for a pattern: "/", "n", "*", "gd", etc.
2670 (not for a search pattern in a ":" command)
2671 tag jumping to a tag: ":ta", CTRL-T, etc.
2672 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002673 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002674 the |zv| command to the mapping to get the same effect.
2675 When a movement command is used for an operator (e.g., "dl" or "y%")
2676 this option is not used. This means the operator will include the
2677 whole closed fold.
2678 Note that vertical movements are not here, because it would make it
2679 very difficult to move onto a closed fold.
2680 In insert mode the folds containing the cursor will always be open
2681 when text is inserted.
2682 To close folds you can re-apply 'foldlevel' with the |zx| command or
2683 set the 'foldclose' option to "all".
2684
2685 *'foldtext'* *'fdt'*
2686'foldtext' 'fdt' string (default: "foldtext()")
2687 local to window
2688 {not in Vi}
2689 {not available when compiled without the |+folding|
2690 feature}
2691 An expression which is used to specify the text displayed for a closed
2692 fold. See |fold-foldtext|.
2693
2694 *'formatoptions'* *'fo'*
2695'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2696 local to buffer
2697 {not in Vi}
2698 This is a sequence of letters which describes how automatic
2699 formatting is to be done. See |fo-table|. When the 'paste' option is
2700 on, no formatting is done (like 'formatoptions' is empty). Commas can
2701 be inserted for readability.
2702 To avoid problems with flags that are added in the future, use the
2703 "+=" and "-=" feature of ":set" |add-option-flags|.
2704 NOTE: This option is set to the Vi default value when 'compatible' is
2705 set and to the Vim default value when 'compatible' is reset.
2706
2707 *'formatprg'* *'fp'*
2708'formatprg' 'fp' string (default "")
2709 global
2710 {not in Vi}
2711 The name of an external program that will be used to format the lines
2712 selected with the "gq" command. The program must take the input on
2713 stdin and produce the output on stdout. The Unix program "fmt" is
2714 such a program. If this option is an empty string, the internal
2715 format function will be used |C-indenting|. Environment variables are
2716 expanded |:set_env|. See |option-backslash| about including spaces
2717 and backslashes.
2718 This option cannot be set from a |modeline| or in the |sandbox|, for
2719 security reasons.
2720
2721 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
2722'gdefault' 'gd' boolean (default off)
2723 global
2724 {not in Vi}
2725 When on, the ":substitute" flag 'g' is default on. This means that
2726 all matches in a line are substituted instead of one. When a 'g' flag
2727 is given to a ":substitute" command, this will toggle the substitution
2728 of all or one match. See |complex-change|.
2729
2730 command 'gdefault' on 'gdefault' off ~
2731 :s/// subst. all subst. one
2732 :s///g subst. one subst. all
2733 :s///gg subst. all subst. one
2734
2735 NOTE: This option is reset when 'compatible' is set.
2736
2737 *'grepformat'* *'gfm'*
2738'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
2739 global
2740 {not in Vi}
2741 Format to recognize for the ":grep" command output.
2742 This is a scanf-like string that uses the same format as the
2743 'errorformat' option: see |errorformat|.
2744
2745 *'grepprg'* *'gp'*
2746'grepprg' 'gp' string (default "grep -n ",
2747 Unix: "grep -n $* /dev/null",
2748 Win32: "findstr /n" or "grep -n",
2749 VMS: "SEARCH/NUMBERS ")
2750 global or local to buffer |global-local|
2751 {not in Vi}
2752 Program to use for the ":grep" command. This option may contain '%'
2753 and '#' characters, which are expanded like when used in a command-
2754 line. The placeholder "$*" is allowed to specify where the arguments
2755 will be included. Environment variables are expanded |:set_env|. See
2756 |option-backslash| about including spaces and backslashes.
2757 When your "grep" accepts the "-H" argument, use this to make ":grep"
2758 also work well with a single file: >
2759 :set grepprg=grep\ -nH
2760< See also the section |:make_makeprg|, since most of the comments there
2761 apply equally to 'grepprg'.
2762 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
2763 otherwise it's "grep -n".
2764 This option cannot be set from a |modeline| or in the |sandbox|, for
2765 security reasons.
2766
2767 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
2768'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
2769 ve:ver35-Cursor,
2770 o:hor50-Cursor,
2771 i-ci:ver25-Cursor/lCursor,
2772 r-cr:hor20-Cursor/lCursor,
2773 sm:block-Cursor
2774 -blinkwait175-blinkoff150-blinkon175",
2775 for MS-DOS and Win32 console:
2776 "n-v-c:block,o:hor50,i-ci:hor15,
2777 r-cr:hor30,sm:block")
2778 global
2779 {not in Vi}
2780 {only available when compiled with GUI enabled, and
2781 for MS-DOS and Win32 console}
2782 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002783 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00002784 the height of the cursor can be changed. This can be done by
2785 specifying a block cursor, or a percentage for a vertical or
2786 horizontal cursor.
2787
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002788 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789 mode-list and an argument-list:
2790 mode-list:argument-list,mode-list:argument-list,..
2791 The mode-list is a dash separated list of these modes:
2792 n Normal mode
2793 v Visual mode
2794 ve Visual mode with 'selection' "exclusive" (same as 'v',
2795 if not specified)
2796 o Operator-pending mode
2797 i Insert mode
2798 r Replace mode
2799 c Command-line Normal (append) mode
2800 ci Command-line Insert mode
2801 cr Command-line Replace mode
2802 sm showmatch in Insert mode
2803 a all modes
2804 The argument-list is a dash separated list of these arguments:
2805 hor{N} horizontal bar, {N} percent of the character height
2806 ver{N} vertical bar, {N} percent of the character width
2807 block block cursor, fills the whole character
2808 [only one of the above three should be present]
2809 blinkwait{N} *cursor-blinking*
2810 blinkon{N}
2811 blinkoff{N}
2812 blink times for cursor: blinkwait is the delay before
2813 the cursor starts blinking, blinkon is the time that
2814 the cursor is shown and blinkoff is the time that the
2815 cursor is not shown. The times are in msec. When one
2816 of the numbers is zero, there is no blinking. The
2817 default is: "blinkwait700-blinkon400-blinkoff250".
2818 These numbers are used for a missing entry. This
2819 means that blinking is enabled by default. To switch
2820 blinking off you can use "blinkon0". The cursor only
2821 blinks when Vim is waiting for input, not while
2822 executing a command.
2823 To make the cursor blink in an xterm, see
2824 |xterm-blink|.
2825 {group-name}
2826 a highlight group name, that sets the color and font
2827 for the cursor
2828 {group-name}/{group-name}
2829 Two highlight group names, the first is used when
2830 no language mappings are used, the other when they
2831 are. |language-mapping|
2832
2833 Examples of parts:
2834 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
2835 block cursor with colors from the "nCursor"
2836 highlight group
2837 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
2838 In Insert and Command-line Insert mode, use a
2839 30% vertical bar cursor with colors from the
2840 "iCursor" highlight group. Blink a bit
2841 faster.
2842
2843 The 'a' mode is different. It will set the given argument-list for
2844 all modes. It does not reset anything to defaults. This can be used
2845 to do a common setting for all modes. For example, to switch off
2846 blinking: "a:blinkon0"
2847
2848 Examples of cursor highlighting: >
2849 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
2850 :highlight Cursor gui=NONE guifg=bg guibg=fg
2851<
2852 *'guifont'* *'gfn'*
2853 *E235* *E596* *E610* *E611*
2854'guifont' 'gfn' string (default "")
2855 global
2856 {not in Vi}
2857 {only available when compiled with GUI enabled}
2858 This is a list of fonts which will be used for the GUI version of Vim.
2859 In its simplest form the value is just one font name. When
2860 the font cannot be found you will get an error message. To try other
2861 font names a list can be specified, font names separated with commas.
2862 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00002863
Bram Moolenaar071d4272004-06-13 20:20:40 +00002864 When 'guifontset' is not empty, 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00002865
Bram Moolenaar071d4272004-06-13 20:20:40 +00002866 Spaces after a comma are ignored. To include a comma in a font name
2867 precede it with a backslash. Setting an option requires an extra
2868 backslash before a space and a backslash. See also
2869 |option-backslash|. For example: >
2870 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00002871< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00002873
2874 If none of the fonts can be loaded, Vim will keep the current setting.
2875 If an empty font list is given, Vim will try using other resource
2876 settings (for X, it will use the Vim.font resource), and finally it
2877 will try some builtin default which should always be there ("7x13" in
2878 the case of X). The font names given should be "normal" fonts. Vim
2879 will try to find the related bold and italic fonts.
2880
2881 For Win32, GTK and Photon only: >
2882 :set guifont=*
2883< will bring up a font requester, where you can pick the font you want.
2884
2885 The font name depends on the GUI used. See |setting-guifont| for a
2886 way to set 'guifont' for various systems.
2887
Bram Moolenaar071d4272004-06-13 20:20:40 +00002888 For the GTK+ 2 GUI the font name looks like this: >
2889 :set guifont=Andale\ Mono\ 11
2890< That's all. XLFDs are no longer accepted.
2891 *E236*
2892 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00002893 width). An exception is GTK 2: all fonts are accepted, but
2894 mono-spaced fonts look best.
2895
Bram Moolenaar071d4272004-06-13 20:20:40 +00002896 To preview a font on X11, you might be able to use the "xfontsel"
2897 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00002898
Bram Moolenaar071d4272004-06-13 20:20:40 +00002899 For the Win32 GUI *E244* *E245*
2900 - takes these options in the font name:
2901 hXX - height is XX (points, can be floating-point)
2902 wXX - width is XX (points, can be floating-point)
2903 b - bold
2904 i - italic
2905 u - underline
2906 s - strikeout
2907 cXX - character set XX. valid charsets are: ANSI, ARABIC,
2908 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
2909 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
2910 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002911 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002912
2913 Use a ':' to separate the options.
2914 - A '_' can be used in the place of a space, so you don't need to use
2915 backslashes to escape the spaces.
2916 - Examples: >
2917 :set guifont=courier_new:h12:w5:b:cRUSSIAN
2918 :set guifont=Andale_Mono:h7.5:w4.5
2919< See also |font-sizes|.
2920
2921 *'guifontset'* *'gfs'*
2922 *E250* *E252* *E234* *E597* *E598*
2923'guifontset' 'gfs' string (default "")
2924 global
2925 {not in Vi}
2926 {only available when compiled with GUI enabled and
2927 with the |+xfontset| feature}
2928 {not available in the GTK+ 2 GUI}
2929 When not empty, specifies two (or more) fonts to be used. The first
2930 one for normal English, the second one for your special language. See
2931 |xfontset|.
2932 Setting this option also means that all font names will be handled as
2933 a fontset name. Also the ones used for the "font" argument of the
2934 |:highlight| command.
2935 The fonts must match with the current locale. If fonts for the
2936 character sets that the current locale uses are not included, setting
2937 'guifontset' will fail.
2938 Note the difference between 'guifont' and 'guifontset': In 'guifont'
2939 the comma-separated names are alternative names, one of which will be
2940 used. In 'guifontset' the whole string is one fontset name,
2941 including the commas. It is not possible to specify alternative
2942 fontset names.
2943 This example works on many X11 systems: >
2944 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
2945<
2946 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
2947'guifontwide' 'gfw' string (default "")
2948 global
2949 {not in Vi}
2950 {only available when compiled with GUI enabled}
2951 When not empty, specifies a comma-separated list of fonts to be used
2952 for double-width characters. The first font that can be loaded is
2953 used.
2954 Note: The size of these fonts must be exactly twice as wide as the one
2955 specified with 'guifont' and the same height.
2956
2957 All GUI versions but GTK+ 2:
2958
2959 'guifontwide' is only used when 'encoding' is set to "utf-8" and
2960 'guifontset' is empty or invalid.
2961 When 'guifont' is set and a valid font is found in it and
2962 'guifontwide' is empty Vim will attempt to find a matching
2963 double-width font and set 'guifontwide' to it.
2964
2965 GTK+ 2 GUI only: *guifontwide_gtk2*
2966
2967 If set and valid, 'guifontwide' is always used for double width
2968 characters, even if 'encoding' is not set to "utf-8".
2969 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002970 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00002971 font for characters not available in 'guifont'. Thus you do not need
2972 to set 'guifontwide' at all unless you want to override the choice
2973 made by Pango/Xft.
2974
2975 *'guiheadroom'* *'ghr'*
2976'guiheadroom' 'ghr' number (default 50)
2977 global
2978 {not in Vi} {only for GTK and X11 GUI}
2979 The number of pixels subtracted from the screen height when fitting
2980 the GUI window on the screen. Set this before the GUI is started,
2981 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002982 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00002983 lines will be left for window decorations and other items on the
2984 screen. Set it to a negative value to allow windows taller than the
2985 screen.
2986
2987 *'guioptions'* *'go'*
2988'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
2989 "agimrLtT" (GTK, Motif and Athena)
2990 global
2991 {not in Vi}
2992 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00002993 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002994 sequence of letters which describes what components and options of the
2995 GUI should be used.
2996 To avoid problems with flags that are added in the future, use the
2997 "+=" and "-=" feature of ":set" |add-option-flags|.
2998
2999 Valid letters are as follows:
3000 *guioptions_a*
3001 'a' Autoselect: If present, then whenever VISUAL mode is started,
3002 or the Visual area extended, Vim tries to become the owner of
3003 the windowing system's global selection. This means that the
3004 Visually highlighted text is available for pasting into other
3005 applications as well as into Vim itself. When the Visual mode
3006 ends, possibly due to an operation on the text, or when an
3007 application wants to paste the selection, the highlighted text
3008 is automatically yanked into the "* selection register.
3009 Thus the selection is still available for pasting into other
3010 applications after the VISUAL mode has ended.
3011 If not present, then Vim won't become the owner of the
3012 windowing system's global selection unless explicitly told to
3013 by a yank or delete operation for the "* register.
3014 The same applies to the modeless selection.
3015
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003016 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003017 applies to the modeless selection.
3018
3019 'guioptions' autoselect Visual autoselect modeless ~
3020 "" - -
3021 "a" yes yes
3022 "A" - yes
3023 "aA" yes yes
3024
3025 'c' Use console dialogs instead of popup dialogs for simple
3026 choices.
3027
3028 'f' Foreground: Don't use fork() to detach the GUI from the shell
3029 where it was started. Use this for programs that wait for the
3030 editor to finish (e.g., an e-mail program). Alternatively you
3031 can use "gvim -f" or ":gui -f" to start the GUI in the
3032 foreground. |gui-fork|
3033 Note: Set this option in the vimrc file. The forking may have
3034 happened already when the gvimrc file is read.
3035
3036 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3037 corner of the window. It's black&white on non-GTK, because of
3038 limitations of X11. For a color icon, see |X11-icon|.
3039
3040 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003041 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003042 that this flag must be added in the .vimrc file, before
3043 switching on syntax or filetype recognition (when the .gvimrc
3044 file is sourced the system menu has already been loaded; the
3045 ":syntax on" and ":filetype on" commands load the menu too).
3046 'g' Grey menu items: Make menu items that are not active grey. If
3047 'g' is not included inactive menu items are not shown at all.
3048 Exception: Athena will always use grey menu items.
3049
3050 't' Include tearoff menu items. Currently only works for Win32,
3051 GTK+, and Motif 1.2 GUI.
3052 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, and
3053 Athena GUIs.
3054
3055 'r' Right-hand scrollbar is always present.
3056 'R' Right-hand scrollbar is present when there is a vertically
3057 split window.
3058 'l' Left-hand scrollbar is always present.
3059 'L' Left-hand scrollbar is present when there is a vertically
3060 split window.
3061 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3062 the longest visible line, or on the cursor line if the 'h'
3063 flag is included. |gui-horiz-scroll|
3064 'h' Limit horizontal scrollbar size to the length of the cursor
3065 line. Reduces computations. |gui-horiz-scroll|
3066
3067 And yes, you may even have scrollbars on the left AND the right if
3068 you really want to :-). See |gui-scrollbars| for more information.
3069
3070 'v' Use a vertical button layout for dialogs. When not included,
3071 a horizontal layout is preferred, but when it doesn't fit a
3072 vertical layout is used anyway.
3073 'p' Use Pointer callbacks for X11 GUI. This is required for some
3074 window managers. If the cursor is not blinking or hollow at
3075 the right moment, try adding this flag. This must be done
3076 before starting the GUI. Set it in your gvimrc. Adding or
3077 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003078 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003079
3080 *'guipty'* *'noguipty'*
3081'guipty' boolean (default on)
3082 global
3083 {not in Vi}
3084 {only available when compiled with GUI enabled}
3085 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3086 I/O to/from shell commands. See |gui-pty|.
3087
3088 *'helpfile'* *'hf'*
3089'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3090 (others) "$VIMRUNTIME/doc/help.txt")
3091 global
3092 {not in Vi}
3093 Name of the main help file. All distributed help files should be
3094 placed together in one directory. Additionally, all "doc" directories
3095 in 'runtimepath' will be used.
3096 Environment variables are expanded |:set_env|. For example:
3097 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003098 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003099 spaces and backslashes.
3100 This option cannot be set from a |modeline| or in the |sandbox|, for
3101 security reasons.
3102
3103 *'helpheight'* *'hh'*
3104'helpheight' 'hh' number (default 20)
3105 global
3106 {not in Vi}
3107 {not available when compiled without the +windows
3108 feature}
3109 Minimal initial height of the help window when it is opened with the
3110 ":help" command. The initial height of the help window is half of the
3111 current window, or (when the 'ea' option is on) the same as other
3112 windows. When the height is less than 'helpheight', the height is
3113 set to 'helpheight'. Set to zero to disable.
3114
3115 *'helplang'* *'hlg'*
3116'helplang' 'hlg' string (default: messages language or empty)
3117 global
3118 {only available when compiled with the |+multi_lang|
3119 feature}
3120 {not in Vi}
3121 Comma separated list of languages. Vim will use the first language
3122 for which the desired help can be found. The English help will always
3123 be used as a last resort. You can add "en" to prefer English over
3124 another language, but that will only find tags that exist in that
3125 language and not in the English help.
3126 Example: >
3127 :set helplang=de,it
3128< This will first search German, then Italian and finally English help
3129 files.
3130 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3131 try to find the tag in the current language before using this option.
3132 See |help-translated|.
3133
3134 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3135'hidden' 'hid' boolean (default off)
3136 global
3137 {not in Vi}
3138 When off a buffer is unloaded when it is |abandon|ed. When on a
3139 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3140 displayed in another window, it does not become hidden, of course.
3141 The commands that move through the buffer list sometimes make a buffer
3142 hidden although the 'hidden' option is off: When the buffer is
3143 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003144 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003145 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003146 This option is set for one command with ":hide {command}" |:hide|.
3147 WARNING: It's easy to forget that you have changes in hidden buffers.
3148 Think twice when using ":q!" or ":qa!".
3149
3150 *'highlight'* *'hl'*
3151'highlight' 'hl' string (default (as a single string):
3152 "8:SpecialKey,@:NonText,d:Directory,
3153 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3154 M:ModeMsg,n:LineNr,r:Question,
3155 s:StatusLine,S:StatusLineNC,c:VertSplit
3156 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3157 f:Folded,F:FoldColumn,A:DiffAdd,
3158 C:DiffChange,D:DiffDelete,T:DiffText,
3159 >:SignColumn")
3160 global
3161 {not in Vi}
3162 This option can be used to set highlighting mode for various
3163 occasions. It is a comma separated list of character pairs. The
3164 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003165 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003166 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3167 |hl-NonText| @ '~' and '@' at the end of the window and
3168 characters from 'showbreak'
3169 |hl-Directory| d directories in CTRL-D listing and other special
3170 things in listings
3171 |hl-ErrorMsg| e error messages
3172 h (obsolete, ignored)
3173 |hl-IncSearch| i 'incsearch' highlighting
3174 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3175 |hl-MoreMsg| m |more-prompt|
3176 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3177 |hl-LineNr| n line number for ":number" and ":#" commands
3178 |hl-Question| r |hit-enter| prompt and yes/no questions
3179 |hl-StatusLine| s status line of current window |status-line|
3180 |hl-StatusLineNC| S status lines of not-current windows
3181 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3182 |hl-VertSplit| c column used to separate vertically split windows
3183 |hl-Visual| v Visual mode
3184 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3185 Selection" Only X11 Gui's |gui-x11| and
3186 |xterm-clipboard|.
3187 |hl-WarningMsg| w warning messages
3188 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3189 |hl-Folded| f line used for closed folds
3190 |hl-FoldColumn| F 'foldcolumn'
3191 |hl-SignColumn| > column used for |signs|
3192
3193 The display modes are:
3194 r reverse (termcap entry "mr" and "me")
3195 i italic (termcap entry "ZH" and "ZR")
3196 b bold (termcap entry "md" and "me")
3197 s standout (termcap entry "so" and "se")
3198 u underline (termcap entry "us" and "ue")
3199 n no highlighting
3200 - no highlighting
3201 : use a highlight group
3202 The default is used for occasions that are not included.
3203 If you want to change what the display modes do, see |dos-colors|
3204 for an example.
3205 When using the ':' display mode, this must be followed by the name of
3206 a highlight group. A highlight group can be used to define any type
3207 of highlighting, including using color. See |:highlight| on how to
3208 define one. The default uses a different group for each occasion.
3209 See |highlight-default| for the default highlight groups.
3210
3211 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3212'hlsearch' 'hls' boolean (default off)
3213 global
3214 {not in Vi}
3215 {not available when compiled without the
3216 |+extra_search| feature}
3217 When there is a previous search pattern, highlight all its matches.
3218 The type of highlighting used can be set with the 'l' occasion in the
3219 'highlight' option. This uses the "Search" highlight group by
3220 default. Note that only the matching text is highlighted, any offsets
3221 are not applied.
3222 See also: 'incsearch' and |:match|.
3223 When you get bored looking at the highlighted matches, you can turn it
3224 off with |:nohlsearch|. As soon as you use a search command, the
3225 highlighting comes back.
3226 When the search pattern can match an end-of-line, Vim will try to
3227 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003228 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003229 line below a closed fold. A match in a previous line which is not
3230 drawn may not continue in an newly drawn line.
3231 NOTE: This option is reset when 'compatible' is set.
3232
3233 *'history'* *'hi'*
3234'history' 'hi' number (Vim default: 20, Vi default: 0)
3235 global
3236 {not in Vi}
3237 A history of ":" commands, and a history of previous search patterns
3238 are remembered. This option decides how many entries may be stored in
3239 each of these histories (see |cmdline-editing|).
3240 NOTE: This option is set to the Vi default value when 'compatible' is
3241 set and to the Vim default value when 'compatible' is reset.
3242
3243 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3244'hkmap' 'hk' boolean (default off)
3245 global
3246 {not in Vi}
3247 {only available when compiled with the |+rightleft|
3248 feature}
3249 When on, the keyboard is mapped for the Hebrew character set.
3250 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3251 toggle this option. See |rileft.txt|.
3252 NOTE: This option is reset when 'compatible' is set.
3253
3254 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3255'hkmapp' 'hkp' boolean (default off)
3256 global
3257 {not in Vi}
3258 {only available when compiled with the |+rightleft|
3259 feature}
3260 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3261 This is useful if you have a non-Hebrew keyboard.
3262 See |rileft.txt|.
3263 NOTE: This option is reset when 'compatible' is set.
3264
3265 *'icon'* *'noicon'*
3266'icon' boolean (default off, on when title can be restored)
3267 global
3268 {not in Vi}
3269 {not available when compiled without the |+title|
3270 feature}
3271 When on, the icon text of the window will be set to the value of
3272 'iconstring' (if it is not empty), or to the name of the file
3273 currently being edited. Only the last part of the name is used.
3274 Overridden by the 'iconstring' option.
3275 Only works if the terminal supports setting window icons (currently
3276 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3277 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3278 builtin termcap).
3279 When Vim was compiled with HAVE_X11 defined, the original icon will be
3280 restored if possible |X11|. See |X11-icon| for changing the icon on
3281 X11.
3282
3283 *'iconstring'*
3284'iconstring' string (default "")
3285 global
3286 {not in Vi}
3287 {not available when compiled without the |+title|
3288 feature}
3289 When this option is not empty, it will be used for the icon text of
3290 the window. This happens only when the 'icon' option is on.
3291 Only works if the terminal supports setting window icon text
3292 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3293 Does not work for MS Windows.
3294 When Vim was compiled with HAVE_X11 defined, the original icon will be
3295 restored if possible |X11|.
3296 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003297 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003298 'titlestring' for example settings.
3299 {not available when compiled without the |+statusline| feature}
3300
3301 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3302'ignorecase' 'ic' boolean (default off)
3303 global
3304 Ignore case in search patterns. Also used when searching in the tags
3305 file.
3306 Also see 'smartcase'.
3307 Can be overruled by using "\c" or "\C" in the pattern, see
3308 |/ignorecase|.
3309
3310 *'imactivatekey'* *'imak'*
3311'imactivatekey' 'imak' string (default "")
3312 global
3313 {not in Vi}
3314 {only available when compiled with |+xim| and
3315 |+GUI_GTK|}
3316 Specifies the key that your Input Method in X-Windows uses for
3317 activation. When this is specified correctly, vim can fully control
3318 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3319 You can't use this option to change the activation key, the option
3320 tells Vim what the key is.
3321 Format:
3322 [MODIFIER_FLAG-]KEY_STRING
3323
3324 These characters can be used for MODIFIER_FLAG (case is ignored):
3325 S Shift key
3326 L Lock key
3327 C Control key
3328 1 Mod1 key
3329 2 Mod2 key
3330 3 Mod3 key
3331 4 Mod4 key
3332 5 Mod5 key
3333 Combinations are allowed, for example "S-C-space" or "SC-space" are
3334 both shift+ctrl+space.
3335 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3336
3337 Example: >
3338 :set imactivatekey=S-space
3339< "S-space" means shift+space. This is the activation key for kinput2 +
3340 canna (Japanese), and ami (Korean).
3341
3342 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3343'imcmdline' 'imc' boolean (default off)
3344 global
3345 {not in Vi}
3346 {only available when compiled with the |+xim|
3347 |+multi_byte_ime| or |global-ime| feature}
3348 When set the Input Method is always on when starting to edit a command
3349 line, unless entering a search pattern (see 'imsearch' for that).
3350 Setting this option is useful when your input method allows entering
3351 English characters directly, e.g., when it's used to type accented
3352 characters with dead keys.
3353
3354 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3355'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3356 global
3357 {not in Vi}
3358 {only available when compiled with the |+xim|
3359 |+multi_byte_ime| or |global-ime| feature}
3360 When set the Input Method is never used. This is useful to disable
3361 the IM when it doesn't work properly.
3362 Currently this option is on by default for SGI/IRIX machines. This
3363 may change in later releases.
3364
3365 *'iminsert'* *'imi'*
3366'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3367 local to buffer
3368 {not in Vi}
3369 Specifies whether :lmap or an Input Method (IM) is to be used in
3370 Insert mode. Valid values:
3371 0 :lmap is off and IM is off
3372 1 :lmap is ON and IM is off
3373 2 :lmap is off and IM is ON
3374 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3375 or |global-ime|.
3376 To always reset the option to zero when leaving Insert mode with <Esc>
3377 this can be used: >
3378 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3379< This makes :lmap and IM turn off automatically when leaving Insert
3380 mode.
3381 Note that this option changes when using CTRL-^ in Insert mode
3382 |i_CTRL-^|.
3383 The value is set to 1 when setting 'keymap' to a valid keymap name.
3384 It is also used for the argument of commands like "r" and "f".
3385 The value 0 may not work correctly with Athena and Motif with some XIM
3386 methods. Use 'imdisable' to disable XIM then.
3387
3388 *'imsearch'* *'ims'*
3389'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3390 local to buffer
3391 {not in Vi}
3392 Specifies whether :lmap or an Input Method (IM) is to be used when
3393 entering a search pattern. Valid values:
3394 -1 the value of 'iminsert' is used, makes it look like
3395 'iminsert' is also used when typing a search pattern
3396 0 :lmap is off and IM is off
3397 1 :lmap is ON and IM is off
3398 2 :lmap is off and IM is ON
3399 Note that this option changes when using CTRL-^ in Command-line mode
3400 |c_CTRL-^|.
3401 The value is set to 1 when it is not -1 and setting the 'keymap'
3402 option to a valid keymap name.
3403 The value 0 may not work correctly with Athena and Motif with some XIM
3404 methods. Use 'imdisable' to disable XIM then.
3405
3406 *'include'* *'inc'*
3407'include' 'inc' string (default "^\s*#\s*include")
3408 global or local to buffer |global-local|
3409 {not in Vi}
3410 {not available when compiled without the
3411 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003412 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003413 pattern, just like for the "/" command (See |pattern|). The default
3414 value is for C programs. This option is used for the commands "[i",
3415 "]I", "[d", etc.. The 'isfname' option is used to recognize the file
3416 name that comes after the matched pattern. See |option-backslash|
3417 about including spaces and backslashes.
3418
3419 *'includeexpr'* *'inex'*
3420'includeexpr' 'inex' string (default "")
3421 local to buffer
3422 {not in Vi}
3423 {not available when compiled without the
3424 |+find_in_path| or |+eval| feature}
3425 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003426 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003427 :set includeexpr=substitute(v:fname,'\\.','/','g')
3428< The "v:fname" variable will be set to the file name that was detected.
3429 Evaluated in the |sandbox|.
3430 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003431 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003432 Also used for |<cfile>|.
3433
3434 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3435'incsearch' 'is' boolean (default off)
3436 global
3437 {not in Vi}
3438 {not available when compiled without the
3439 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003440 While typing a search command, show where the pattern, as it was typed
3441 so far, matches. The matched string is highlighted. If the pattern
3442 is invalid or not found, nothing is shown. The screen will be updated
3443 often, this is only useful on fast terminals.
3444 Note that the match will be shown, but the cursor will return to its
3445 original position when no match is found and when pressing <Esc>. You
3446 still need to finish the search command with <Enter> to move the
3447 cursor to the match.
3448 The highlighting can be set with the 'i' flag in 'highlight'.
3449 See also: 'hlsearch'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003450 NOTE: This option is reset when 'compatible' is set.
3451
3452 *'indentexpr'* *'inde'*
3453'indentexpr' 'inde' string (default "")
3454 local to buffer
3455 {not in Vi}
3456 {not available when compiled without the |+cindent|
3457 or |+eval| features}
3458 Expression which is evaluated to obtain the proper indent for a line.
3459 It is used when a new line is created, for the |=| operator and
3460 in Insert mode as specified with the 'indentkeys' option.
3461 When this option is not empty, it overrules the 'cindent' and
3462 'smartindent' indenting.
3463 When 'paste' is set this option is not used for indenting.
3464 The expression is evaluated with |v:lnum| set to the line number for
3465 which the indent is to be computed. The cursor is also as this line
3466 when the expression is evaluated (but it may be moved around).
3467 The expression must return the number of spaces worth of indent. It
3468 can return "-1" to keep the current indent (this means 'autoindent' is
3469 used for the indent).
3470 Functions useful for computing the indent are |indent()|, |cindent()|
3471 and |lispindent()|.
3472 The evaluation of the expression must not have side effects! It must
3473 not change the text, jump to another window, etc. Afterwards the
3474 cursor position is always restored, thus the cursor may be moved.
3475 Normally this option would be set to call a function: >
3476 :set indentexpr=GetMyIndent()
3477< Error messages will be suppressed, unless the 'debug' option contains
3478 "msg".
3479 See |indent-expression|. Also see |eval-sandbox|.
3480 NOTE: This option is made empty when 'compatible' is set.
3481
3482 *'indentkeys'* *'indk'*
3483'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3484 local to buffer
3485 {not in Vi}
3486 {not available when compiled without the |+cindent|
3487 feature}
3488 A list of keys that, when typed in Insert mode, cause reindenting of
3489 the current line. Only happens if 'indentexpr' isn't empty.
3490 The format is identical to 'cinkeys', see |indentkeys-format|.
3491 See |C-indenting| and |indent-expression|.
3492
3493 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3494'infercase' 'inf' boolean (default off)
3495 local to buffer
3496 {not in Vi}
3497 When doing keyword completion in insert mode |ins-completion|, and
3498 'ignorecase' is also on, the case of the match is adjusted. If the
3499 typed text contains a lowercase letter where the match has an upper
3500 case letter, the completed part is made lowercase. If the typed text
3501 has no lowercase letters and the match has a lowercase letter where
3502 the typed text has an uppercase letter, and there is a letter before
3503 it, the completed part is made uppercase.
3504
3505 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3506'insertmode' 'im' boolean (default off)
3507 global
3508 {not in Vi}
3509 Makes Vim work in a way that Insert mode is the default mode. Useful
3510 if you want to use Vim as a modeless editor. Used for |evim|.
3511 These Insert mode commands will be useful:
3512 - Use the cursor keys to move around.
3513 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3514 this is a mapping, it is executed as if 'insertmode' was off.
3515 Normal mode remains active until the mapping is finished.
3516 *i_CTRL-L*
3517 - Use CTRL-L to execute a number of Normal mode commands, then use
3518 <Esc> to get back to Insert mode.
3519
3520 These items change when 'insertmode' is set:
3521 - when starting to edit of a file, Vim goes to Insert mode.
3522 - <Esc> in Insert mode is a no-op and beeps.
3523 - <Esc> in Normal mode makes Vim go to Insert mode.
3524 - CTRL-L in Insert mode is a command, it is not inserted.
3525 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3526 However, when <Esc> is used inside a mapping, it behaves like
3527 'insertmode' was not set. This was done to be able to use the same
3528 mappings with 'insertmode' set or not set.
3529 When executing commands with |:normal| 'insertmode' is not used.
3530
3531 NOTE: This option is reset when 'compatible' is set.
3532
3533 *'isfname'* *'isf'*
3534'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3535 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3536 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3537 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3538 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3539 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3540 global
3541 {not in Vi}
3542 The characters specified by this option are included in file names and
3543 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003544 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003545 Multi-byte characters 256 and above are always included, only the
3546 characters up to 255 are specified with this option.
3547 For UTF-8 the characters 0xa0 to 0xff are included as well.
3548
3549 Note that on systems using a backslash as path separator, Vim tries to
3550 do its best to make it work as you would expect. That is a bit
3551 tricky, since Vi originally used the backslash to escape special
3552 characters. Vim will not remove a backslash in front of a normal file
3553 name character on these systems, but it will on Unix and alikes. The
3554 '&' and '^' are not included by default, because these are special for
3555 cmd.exe.
3556
3557 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003558 Each part can be a single character number or a range. A range is two
3559 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560 decimal number between 0 and 255 or the ASCII character itself (does
3561 not work for digits). Example:
3562 "_,-,128-140,#-43" (include '_' and '-' and the range
3563 128 to 140 and '#' to 43)
3564 If a part starts with '^', the following character number or range
3565 will be excluded from the option. The option is interpreted from left
3566 to right. Put the excluded character after the range where it is
3567 included. To include '^' itself use it as the last character of the
3568 option or the end of a range. Example:
3569 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3570 If the character is '@', all characters where isalpha() returns TRUE
3571 are included. Normally these are the characters a to z and A to Z,
3572 plus accented characters. To include '@' itself use "@-@". Examples:
3573 "@,^a-z" All alphabetic characters, excluding lower
3574 case letters.
3575 "a-z,A-Z,@-@" All letters plus the '@' character.
3576 A comma can be included by using it where a character number is
3577 expected. Example:
3578 "48-57,,,_" Digits, comma and underscore.
3579 A comma can be excluded by prepending a '^'. Example:
3580 " -~,^,,9" All characters from space to '~', excluding
3581 comma, plus <Tab>.
3582 See |option-backslash| about including spaces and backslashes.
3583
3584 *'isident'* *'isi'*
3585'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3586 "@,48-57,_,128-167,224-235"
3587 otherwise: "@,48-57,_,192-255")
3588 global
3589 {not in Vi}
3590 The characters given by this option are included in identifiers.
3591 Identifiers are used in recognizing environment variables and after a
3592 match of the 'define' option. It is also used for "\i" in a
3593 |pattern|. See 'isfname' for a description of the format of this
3594 option.
3595 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003596 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003597 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3598
3599 *'iskeyword'* *'isk'*
3600'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3601 "@,48-57,_,128-167,224-235"
3602 otherwise: "@,48-57,_,192-255"
3603 Vi default: "@,48-57,_")
3604 local to buffer
3605 {not in Vi}
3606 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003607 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003608 'isfname' for a description of the format of this option. For C
3609 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3610 For a help file it is set to all non-blank printable characters except
3611 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3612 command).
3613 When the 'lisp' option is on the '-' character is always included.
3614 NOTE: This option is set to the Vi default value when 'compatible' is
3615 set and to the Vim default value when 'compatible' is reset.
3616
3617 *'isprint'* *'isp'*
3618'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3619 "@,~-255"; otherwise: "@,161-255")
3620 global
3621 {not in Vi}
3622 The characters given by this option are displayed directly on the
3623 screen. It is also used for "\p" in a |pattern|. The characters from
3624 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3625 even when they are not included in 'isprint' or excluded. See
3626 'isfname' for a description of the format of this option.
3627
3628 Non-printable characters are displayed with two characters:
3629 0 - 31 "^@" - "^_"
3630 32 - 126 always single characters
3631 127 "^?"
3632 128 - 159 "~@" - "~_"
3633 160 - 254 "| " - "|~"
3634 255 "~?"
3635 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3636 displayed as <xx>, with the hexadecimal value of the byte.
3637 When 'display' contains "uhex" all unprintable characters are
3638 displayed as <xx>.
3639 The NonText highlighting will be used for unprintable characters.
3640 |hl-NonText|
3641
3642 Multi-byte characters 256 and above are always included, only the
3643 characters up to 255 are specified with this option. When a character
3644 is printable but it is not available in the current font, a
3645 replacement character will be shown.
3646 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
3647 There is no option to specify these characters.
3648
3649 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
3650'joinspaces' 'js' boolean (default on)
3651 global
3652 {not in Vi}
3653 Insert two spaces after a '.', '?' and '!' with a join command.
3654 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
3655 Otherwise only one space is inserted.
3656 NOTE: This option is set when 'compatible' is set.
3657
3658 *'key'*
3659'key' string (default "")
3660 local to buffer
3661 {not in Vi}
3662 The key that is used for encrypting and decrypting the current buffer.
3663 See |encryption|.
3664 Careful: Do not set the key value by hand, someone might see the typed
3665 key. Use the |:X| command. But you can make 'key' empty: >
3666 :set key=
3667< It is not possible to get the value of this option with ":set key" or
3668 "echo &key". This is to avoid showing it to someone who shouldn't
3669 know. It also means you cannot see it yourself once you have set it,
3670 be careful not to make a typing error!
3671
3672 *'keymap'* *'kmp'* *E544*
3673'keymap' 'kmp' string (default "")
3674 local to buffer
3675 {not in Vi}
3676 {only available when compiled with the |+keymap|
3677 feature}
3678 Name of a keyboard mapping. See |mbyte-keymap|.
3679 Setting this option to a valid keymap name has the side effect of
3680 setting 'iminsert' to one, so that the keymap becomes effective.
3681 'imsearch' is also set to one, unless it was -1
3682
3683 *'keymodel'* *'km'*
3684'keymodel' 'km' string (default "")
3685 global
3686 {not in Vi}
3687 List of comma separated words, which enable special things that keys
3688 can do. These values can be used:
3689 startsel Using a shifted special key starts selection (either
3690 Select mode or Visual mode, depending on "key" being
3691 present in 'selectmode').
3692 stopsel Using a not-shifted special key stops selection.
3693 Special keys in this context are the cursor keys, <End>, <Home>,
3694 <PageUp> and <PageDown>.
3695 The 'keymodel' option is set by the |:behave| command.
3696
3697 *'keywordprg'* *'kp'*
3698'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
3699 OS/2: "view /", VMS: "help")
3700 global or local to buffer |global-local|
3701 {not in Vi}
3702 Program to use for the |K| command. Environment variables are
3703 expanded |:set_env|. ":help" may be used to access the Vim internal
3704 help. (Note that previously setting the global option to the empty
3705 value did this, which is now deprecated.)
3706 When "man" is used, Vim will automatically translate a count for the
3707 "K" command to a section number. Also for "man -s", in which case the
3708 "-s" is removed when there is no count.
3709 See |option-backslash| about including spaces and backslashes.
3710 Example: >
3711 :set keywordprg=man\ -s
3712< This option cannot be set from a |modeline| or in the |sandbox|, for
3713 security reasons.
3714
3715 *'langmap'* *'lmap'* *E357* *E358*
3716'langmap' 'lmap' string (default "")
3717 global
3718 {not in Vi}
3719 {only available when compiled with the |+langmap|
3720 feature}
3721 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003722 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00003723 inserted directly. When in command mode the 'langmap' option takes
3724 care of translating these special characters to the original meaning
3725 of the key. This means you don't have to change the keyboard mode to
3726 be able to execute Normal mode commands.
3727 This is the opposite of the 'keymap' option, where characters are
3728 mapped in Insert mode.
3729 This only works for 8-bit characters. The value of 'langmap' may be
3730 specified with multi-byte characters (e.g., UTF-8), but only the lower
3731 8 bits of each character will be used.
3732
3733 Example (for Greek): *greek* >
3734 :set langmap=ÁA,ÂB,ØC,ÄD,ÅE,ÖF,ÃG,ÇH,ÉI,ÎJ,ÊK,ËL,ÌM,ÍN,ÏO,ÐP,QQ,ÑR,ÓS,ÔT,ÈU,ÙV,WW,×X,ÕY,ÆZ,áa,âb,øc,äd,åe,öf,ãg,çh,éi,îj,êk,ël,ìm,ín,ïo,ðp,qq,ñr,ós,ôt,èu,ùv,òw,÷x,õy,æz
3735< Example (exchanges meaning of z and y for commands): >
3736 :set langmap=zy,yz,ZY,YZ
3737<
3738 The 'langmap' option is a list of parts, separated with commas. Each
3739 part can be in one of two forms:
3740 1. A list of pairs. Each pair is a "from" character immediately
3741 followed by the "to" character. Examples: "aA", "aAbBcC".
3742 2. A list of "from" characters, a semi-colon and a list of "to"
3743 characters. Example: "abc;ABC"
3744 Example: "aA,fgh;FGH,cCdDeE"
3745 Special characters need to be preceded with a backslash. These are
3746 ";", ',' and backslash itself.
3747
3748 This will allow you to activate vim actions without having to switch
3749 back and forth between the languages. Your language characters will
3750 be understood as normal vim English characters (according to the
3751 langmap mappings) in the following cases:
3752 o Normal/Visual mode (commands, buffer/register names, user mappings)
3753 o Insert/Replace Mode: Register names after CTRL-R
3754 o Insert/Replace Mode: Mappings
3755 Characters entered in Command-line mode will NOT be affected by
3756 this option. Note that this option can be changed at any time
3757 allowing to switch between mappings for different languages/encodings.
3758 Use a mapping to avoid having to type it each time!
3759
3760 *'langmenu'* *'lm'*
3761'langmenu' 'lm' string (default "")
3762 global
3763 {not in Vi}
3764 {only available when compiled with the |+menu| and
3765 |+multi_lang| features}
3766 Language to use for menu translation. Tells which file is loaded
3767 from the "lang" directory in 'runtimepath': >
3768 "lang/menu_" . &langmenu . ".vim"
3769< (without the spaces). For example, to always use the Dutch menus, no
3770 matter what $LANG is set to: >
3771 :set langmenu=nl_NL.ISO_8859-1
3772< When 'langmenu' is empty, |v:lang| is used.
3773 If your $LANG is set to a non-English language but you do want to use
3774 the English menus: >
3775 :set langmenu=none
3776< This option must be set before loading menus, switching on filetype
3777 detection or syntax highlighting. Once the menus are defined setting
3778 this option has no effect. But you could do this: >
3779 :source $VIMRUNTIME/delmenu.vim
3780 :set langmenu=de_DE.ISO_8859-1
3781 :source $VIMRUNTIME/menu.vim
3782< Warning: This deletes all menus that you defined yourself!
3783
3784 *'laststatus'* *'ls'*
3785'laststatus' 'ls' number (default 1)
3786 global
3787 {not in Vi}
3788 The value of this option influences when the last window will have a
3789 status line:
3790 0: never
3791 1: only if there are at least two windows
3792 2: always
3793 The screen looks nicer with a status line if you have several
3794 windows, but it takes another screen line. |status-line|
3795
3796 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
3797'lazyredraw' 'lz' boolean (default off)
3798 global
3799 {not in Vi}
3800 When this option is set, the screen will not be redrawn while
3801 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003802 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00003803 update use |:redraw|.
3804
3805 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
3806'linebreak' 'lbr' boolean (default off)
3807 local to window
3808 {not in Vi}
3809 {not available when compiled without the |+linebreak|
3810 feature}
3811 If on Vim will wrap long lines at a character in 'breakat' rather
3812 than at the last character that fits on the screen. Unlike
3813 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
3814 it only affects the way the file is displayed, not its contents. The
3815 value of 'showbreak' is used to put in front of wrapped lines.
3816 This option is not used when the 'wrap' option is off or 'list' is on.
3817 Note that <Tab> characters after an <EOL> are mostly not displayed
3818 with the right amount of white space.
3819
3820 *'lines'* *E593*
3821'lines' number (default 24 or terminal height)
3822 global
3823 Number of lines of the Vim window.
3824 Normally you don't need to set this. It is done automatically by the
3825 terminal initialization code.
3826 When Vim is running in the GUI or in a resizable window, setting this
3827 option will cause the window size to be changed. When you only want
3828 to use the size for the GUI, put the command in your |gvimrc| file.
3829 Vim limits the number of lines to what fits on the screen. You can
3830 use this command to get the tallest window possible: >
3831 :set lines=999
3832< If you get less lines than expected, check the 'guiheadroom' option.
3833 When you set this option and Vim is unable to change the physical
3834 number of lines of the display, the display may be messed up.
3835
3836 *'linespace'* *'lsp'*
3837'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
3838 global
3839 {not in Vi}
3840 {only in the GUI}
3841 Number of pixel lines inserted between characters. Useful if the font
3842 uses the full character cell height, making lines touch each other.
3843 When non-zero there is room for underlining.
3844
3845 *'lisp'* *'nolisp'*
3846'lisp' boolean (default off)
3847 local to buffer
3848 {not available when compiled without the |+lispindent|
3849 feature}
3850 Lisp mode: When <Enter> is typed in insert mode set the indent for
3851 the next line to Lisp standards (well, sort of). Also happens with
3852 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
3853 flag in 'cpoptions' changes the method of indenting: Vi compatible or
3854 better. Also see 'lispwords'.
3855 The '-' character is included in keyword characters. Redefines the
3856 "=" operator to use this same indentation algorithm rather than
3857 calling an external program if 'equalprg' is empty.
3858 This option is not used when 'paste' is set.
3859 {Vi: Does it a little bit differently}
3860
3861 *'lispwords'* *'lw'*
3862'lispwords' 'lw' string (default is very long)
3863 global
3864 {not in Vi}
3865 {not available when compiled without the |+lispindent|
3866 feature}
3867 Comma separated list of words that influence the Lisp indenting.
3868 |'lisp'|
3869
3870 *'list'* *'nolist'*
3871'list' boolean (default off)
3872 local to window
3873 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
3874 see the difference between tabs and spaces and for trailing blanks.
3875 Note that this will also affect formatting (set with 'textwidth' or
3876 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
3877 changing the way tabs are displayed.
3878
3879 *'listchars'* *'lcs'*
3880'listchars' 'lcs' string (default "eol:$")
3881 global
3882 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003883 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00003884 settings.
3885 eol:c Character to show at the end of each line. When
3886 omitted, there is no extra character at the end of the
3887 line.
3888 tab:xy Two characters to be used to show a Tab. The first
3889 char is used once. The second char is repeated to
3890 fill the space that the Tab normally occupies.
3891 "tab:>-" will show a Tab that takes four spaces as
3892 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003893 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003894 trailing spaces are blank.
3895 extends:c Character to show in the last column, when 'wrap' is
3896 off and the line continues beyond the right of the
3897 screen.
3898 precedes:c Character to show in the first column, when 'wrap'
3899 is off and there is text preceding the character
3900 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00003901 nbsp:c Character to show for a non-breakable space (character
3902 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003903
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003904 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00003905 be used when 'encoding' is "utf-8", otherwise only printable
3906 characters are allowed.
3907
3908 Examples: >
3909 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003910 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911 :set lcs=extends:>,precedes:<
3912< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003913 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003914
3915 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
3916'loadplugins' 'lpl' boolean (default on)
3917 global
3918 {not in Vi}
3919 When on the plugin scripts are loaded when starting up |load-plugins|.
3920 This option can be reset in your |vimrc| file to disable the loading
3921 of plugins.
3922 Note that using the "-u NONE" and "--noplugin" command line arguments
3923 reset this option. |-u| |--noplugin|
3924
3925 *'magic'* *'nomagic'*
3926'magic' boolean (default on)
3927 global
3928 Changes the special characters that can be used in search patterns.
3929 See |pattern|.
3930 NOTE: To avoid portability problems with using patterns, always keep
3931 this option at the default "on". Only switch it off when working with
3932 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00003933 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003934
3935 *'makeef'* *'mef'*
3936'makeef' 'mef' string (default: "")
3937 global
3938 {not in Vi}
3939 {not available when compiled without the |+quickfix|
3940 feature}
3941 Name of the errorfile for the |:make| command (see |:make_makeprg|)
3942 and the |:grep| command.
3943 When it is empty, an internally generated temp file will be used.
3944 When "##" is included, it is replaced by a number to make the name
3945 unique. This makes sure that the ":make" command doesn't overwrite an
3946 existing file.
3947 NOT used for the ":cf" command. See 'errorfile' for that.
3948 Environment variables are expanded |:set_env|.
3949 See |option-backslash| about including spaces and backslashes.
3950 This option cannot be set from a |modeline| or in the |sandbox|, for
3951 security reasons.
3952
3953 *'makeprg'* *'mp'*
3954'makeprg' 'mp' string (default "make", VMS: "MMS")
3955 global or local to buffer |global-local|
3956 {not in Vi}
3957 Program to use for the ":make" command. See |:make_makeprg|. This
3958 option may contain '%' and '#' characters, which are expanded like
3959 when used in a command-line. Environment variables are expanded
3960 |:set_env|. See |option-backslash| about including spaces and
3961 backslashes. Note that a '|' must be escaped twice: once for ":set"
3962 and once for the interpretation of a command. When you use a filter
3963 called "myfilter" do it like this: >
3964 :set makeprg=gmake\ \\\|\ myfilter
3965< The placeholder "$*" can be given (even multiple times) to specify
3966 where the arguments will be included, for example: >
3967 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
3968< This option cannot be set from a |modeline| or in the |sandbox|, for
3969 security reasons.
3970
3971 *'matchpairs'* *'mps'*
3972'matchpairs' 'mps' string (default "(:),{:},[:]")
3973 local to buffer
3974 {not in Vi}
3975 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003976 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00003977 must be different. The characters must be separated by a colon. The
3978 pairs must be separated by a comma. Example for including '<' and '>'
3979 (HTML): >
3980 :set mps+=<:>
3981
3982< A more exotic example, to jump between the '=' and ';' in an
3983 assignment, useful for languages like C and Java: >
3984 :au FileType c,cpp,java set mps+==:;
3985
3986< For a more advanced way of using "%", see the matchit.vim plugin in
3987 the $VIMRUNTIME/macros directory. |add-local-help|
3988
3989 *'matchtime'* *'mat'*
3990'matchtime' 'mat' number (default 5)
3991 global
3992 {not in Vi}{in Nvi}
3993 Tenths of a second to show the matching paren, when 'showmatch' is
3994 set. Note that this is not in milliseconds, like other options that
3995 set a time. This is to be compatible with Nvi.
3996
3997 *'maxfuncdepth'* *'mfd'*
3998'maxfuncdepth' 'mfd' number (default 100)
3999 global
4000 {not in Vi}
4001 Maximum depth of function calls for user functions. This normally
4002 catches endless recursion. When using a recursive function with
4003 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4004 more memory, there is the danger of failing when memory is exhausted.
4005 See also |:function|.
4006
4007 *'maxmapdepth'* *'mmd'* *E223*
4008'maxmapdepth' 'mmd' number (default 1000)
4009 global
4010 {not in Vi}
4011 Maximum number of times a mapping is done without resulting in a
4012 character to be used. This normally catches endless mappings, like
4013 ":map x y" with ":map y x". It still does not catch ":map g wg",
4014 because the 'w' is used before the next mapping is done. See also
4015 |key-mapping|.
4016
4017 *'maxmem'* *'mm'*
4018'maxmem' 'mm' number (default between 256 to 5120 (system
4019 dependent) or half the amount of memory
4020 available)
4021 global
4022 {not in Vi}
4023 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4024 limit is reached allocating extra memory for a buffer will cause
4025 other memory to be freed. Maximum value 2000000. Use this to work
4026 without a limit. Also see 'maxmemtot'.
4027
4028 *'maxmemtot'* *'mmt'*
4029'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4030 dependent) or half the amount of memory
4031 available)
4032 global
4033 {not in Vi}
4034 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004035 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004036 'maxmem'.
4037
4038 *'menuitems'* *'mis'*
4039'menuitems' 'mis' number (default 25)
4040 global
4041 {not in Vi}
4042 {not available when compiled without the |+menu|
4043 feature}
4044 Maximum number of items to use in a menu. Used for menus that are
4045 generated from a list of items, e.g., the Buffers menu. Changing this
4046 option has no direct effect, the menu must be refreshed first.
4047
4048 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4049'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4050 local to buffer
4051 *'modelines'* *'mls'*
4052'modelines' 'mls' number (default 5)
4053 global
4054 {not in Vi}
4055 If 'modeline' is on 'modelines' gives the number of lines that is
4056 checked for set commands. If 'modeline' is off or 'modelines' is zero
4057 no lines are checked. See |modeline|.
4058 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4059 set and to the Vim default value when 'compatible' is reset.
4060
4061 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4062'modifiable' 'ma' boolean (default on)
4063 local to buffer
4064 {not in Vi} *E21*
4065 When off the buffer contents cannot be changed. The 'fileformat' and
4066 'fileencoding' options also can't be changed.
4067 Can be reset with the |-M| command line argument.
4068
4069 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4070'modified' 'mod' boolean (default off)
4071 local to buffer
4072 {not in Vi}
4073 When on, the buffer is considered to be modified. This option is set
4074 when:
4075 1. A change was made to the text since it was last written. Using the
4076 |undo| command to go back to the original text will reset the
4077 option. But undoing changes that were made before writing the
4078 buffer will set the option again, since the text is different from
4079 when it was written.
4080 2. 'fileformat' or 'fileencoding' is different from its original
4081 value. The original value is set when the buffer is read or
4082 written. A ":set nomodified" command also resets the original
4083 values to the current values and the 'modified' option will be
4084 reset.
4085 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4086 will be ignored.
4087
4088 *'more'* *'nomore'*
4089'more' boolean (Vim default: on, Vi default: off)
4090 global
4091 {not in Vi}
4092 When on, listings pause when the whole screen is filled. You will get
4093 the |more-prompt|. When this option is off there are no pauses, the
4094 listing continues until finished.
4095 NOTE: This option is set to the Vi default value when 'compatible' is
4096 set and to the Vim default value when 'compatible' is reset.
4097
4098 *'mouse'* *E538*
4099'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4100 global
4101 {not in Vi}
4102 Enable the use of the mouse. Only works for certain terminals
4103 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4104 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4105 The mouse can be enabled for different modes:
4106 n Normal mode
4107 v Visual mode
4108 i Insert mode
4109 c Command-line mode
4110 h all previous modes when editing a help file
4111 a all previous modes
4112 r for |hit-enter| and |more-prompt| prompt
4113 A auto-select in Visual mode
4114 Normally you would enable the mouse in all four modes with: >
4115 :set mouse=a
4116< When the mouse is not enabled, the GUI will still use the mouse for
4117 modeless selection. This doesn't move the text cursor.
4118
4119 See |mouse-using|. Also see |'clipboard'|.
4120
4121 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004122 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004123 the mouse buttons can still be used by keeping the shift key pressed.
4124 Also see the 'clipboard' option.
4125
4126 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4127'mousefocus' 'mousef' boolean (default off)
4128 global
4129 {not in Vi}
4130 {only works in the GUI}
4131 The window that the mouse pointer is on is automatically activated.
4132 When changing the window layout or window focus in another way, the
4133 mouse pointer is moved to the window with keyboard focus. Off is the
4134 default because it makes using the pull down menus a little goofy, as
4135 a pointer transit may activate a window unintentionally.
4136
4137 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4138'mousehide' 'mh' boolean (default on)
4139 global
4140 {not in Vi}
4141 {only works in the GUI}
4142 When on, the mouse pointer is hidden when characters are typed.
4143 The mouse pointer is restored when the mouse is moved.
4144
4145 *'mousemodel'* *'mousem'*
4146'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4147 global
4148 {not in Vi}
4149 Sets the model to use for the mouse. The name mostly specifies what
4150 the right mouse button is used for:
4151 extend Right mouse button extends a selection. This works
4152 like in an xterm.
4153 popup Right mouse button pops up a menu. The shifted left
4154 mouse button extends a selection. This works like
4155 with Microsoft Windows
4156 popup_setpos Like "popup", but the cursor will be moved to the
4157 position where the mouse was clicked, and thus the
4158 selected operation will act upon the clicked object.
4159 If clicking inside a selection, that selection will
4160 be acted upon, ie. no cursor move. This implies of
4161 course, that right clicking outside a selection will
4162 end Visual mode.
4163 Overview of what button does what for each model:
4164 mouse extend popup(_setpos) ~
4165 left click place cursor place cursor
4166 left drag start selection start selection
4167 shift-left search word extend selection
4168 right click extend selection popup menu (place cursor)
4169 right drag extend selection -
4170 middle click paste paste
4171
4172 In the "popup" model the right mouse button produces a pop-up menu.
4173 You need to define this first, see |popup-menu|.
4174
4175 Note that you can further refine the meaning of buttons with mappings.
4176 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4177 selection (because that's handled in the GUI code directly).
4178
4179 The 'mousemodel' option is set by the |:behave| command.
4180
4181 *'mouseshape'* *'mouses'* *E547*
4182'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
4183 m:no,ml:up-arrow,v:rightup-arrow"
4184 global
4185 {not in Vi}
4186 {only available when compiled with the |+mouseshape|
4187 feature}
4188 This option tells Vim what the mouse pointer should look like in
4189 different modes. The option is a comma separated list of parts, much
4190 like used for 'guicursor'. Each part consist of a mode/location-list
4191 and an argument-list:
4192 mode-list:shape,mode-list:shape,..
4193 The mode-list is a dash separated list of these modes/locations:
4194 In a normal window: ~
4195 n Normal mode
4196 v Visual mode
4197 ve Visual mode with 'selection' "exclusive" (same as 'v',
4198 if not specified)
4199 o Operator-pending mode
4200 i Insert mode
4201 r Replace mode
4202
4203 Others: ~
4204 c appending to the command-line
4205 ci inserting in the command-line
4206 cr replacing in the command-line
4207 m at the 'Hit ENTER' or 'More' prompts
4208 ml idem, but cursor in the last line
4209 e any mode, pointer below last window
4210 s any mode, pointer on a status line
4211 sd any mode, while dragging a status line
4212 vs any mode, pointer on a vertical separator line
4213 vd any mode, while dragging a vertical separator line
4214 a everywhere
4215
4216 The shape is one of the following:
4217 avail name looks like ~
4218 w x arrow Normal mouse pointer
4219 w x blank no pointer at all (use with care!)
4220 w x beam I-beam
4221 w x updown up-down sizing arrows
4222 w x leftright left-right sizing arrows
4223 w x busy The system's usual busy pointer
4224 w x no The system's usual 'no input' pointer
4225 x udsizing indicates up-down resizing
4226 x lrsizing indicates left-right resizing
4227 x crosshair like a big thin +
4228 x hand1 black hand
4229 x hand2 white hand
4230 x pencil what you write with
4231 x question big ?
4232 x rightup-arrow arrow pointing right-up
4233 w x up-arrow arrow pointing up
4234 x <number> any X11 pointer number (see X11/cursorfont.h)
4235
4236 The "avail" column contains a 'w' if the shape is available for Win32,
4237 x for X11.
4238 Any modes not specified or shapes not available use the normal mouse
4239 pointer.
4240
4241 Example: >
4242 :set mouseshape=s:udsizing,m:no
4243< will make the mouse turn to a sizing arrow over the status lines and
4244 indicate no input when the hit-enter prompt is displayed (since
4245 clicking the mouse has no effect in this state.)
4246
4247 *'mousetime'* *'mouset'*
4248'mousetime' 'mouset' number (default 500)
4249 global
4250 {not in Vi}
4251 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4252 time in msec between two mouse clicks for the second click to be
4253 recognized as a multi click.
4254
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004255 *'mzquantum'* *'mzq'*
4256'mzquantum' 'mzq' number (default 100)
4257 global
4258 {not in Vi}
4259 {not available when compiled without the |+mzscheme|
4260 feature}
4261 The number of milliseconds between polls for MzScheme threads.
4262 Negative or zero value means no thread scheduling.
4263
Bram Moolenaar071d4272004-06-13 20:20:40 +00004264 *'nrformats'* *'nf'*
4265'nrformats' 'nf' string (default "octal,hex")
4266 local to buffer
4267 {not in Vi}
4268 This defines what bases Vim will consider for numbers when using the
4269 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4270 respectively; see |CTRL-A| for more info on these commands.
4271 alpha if included, single alphabetical characters will be
4272 incremented or decremented. This is useful for a list with a
4273 letter index a), b), etc.
4274 octal if included, numbers that start with a zero will be considered
4275 to be octal. Example: Using CTRL-A on "007" results in "010".
4276 hex if included, numbers starting with "0x" or "0X" will be
4277 considered to be hexadecimal. Example: Using CTRL-X on
4278 "0x100" results in "0x0ff".
4279 Numbers which simply begin with a digit in the range 1-9 are always
4280 considered decimal. This also happens for numbers that are not
4281 recognized as octal or hex.
4282
4283 *'number'* *'nu'* *'nonumber'* *'nonu'*
4284'number' 'nu' boolean (default off)
4285 local to window
4286 Print the line number in front of each line. When the 'n' option is
4287 excluded from 'cpoptions' a wrapped line will not use the column of
4288 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004289 The 'numberwidth' option can be used to set the room used for the line
4290 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004291 When a long, wrapped line doesn't start with the first character, '-'
4292 characters are put before the number.
4293 See |hl-LineNr| for the highlighting used for the number.
4294
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004295 *'numberwidth'* *'nuw'*
4296'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4297 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004298 {not in Vi}
4299 {only available when compiled with the |+linebreak|
4300 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004301 Minimal number of columns to use for the line number. Only relevant
4302 when the 'number' option is set.
4303 Since one space is always between the number and the text, there is
4304 one less character for the number itself.
4305 The value is the minimum width. A bigger width is used when needed to
4306 fit the highest line number in the buffer. Thus with the Vim default
4307 of 4 there is room for a line number up to 999. When the buffer has
4308 1000 lines five columns will be used.
4309 The minimum value is 1, the maximum value is 10.
4310 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4311
Bram Moolenaar071d4272004-06-13 20:20:40 +00004312 *'osfiletype'* *'oft'* *E366*
4313'osfiletype' 'oft' string (RISC-OS default: "Text",
4314 others default: "")
4315 local to buffer
4316 {not in Vi}
4317 {only available when compiled with the |+osfiletype|
4318 feature}
4319 Some operating systems store extra information about files besides
4320 name, datestamp and permissions. This option contains the extra
4321 information, the nature of which will vary between systems.
4322 The value of this option is usually set when the file is loaded, and
4323 use to set the file type when file is written.
4324 It can affect the pattern matching of the automatic commands.
4325 |autocmd-osfiletypes|
4326
4327 *'paragraphs'* *'para'*
4328'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4329 global
4330 Specifies the nroff macros that separate paragraphs. These are pairs
4331 of two letters (see |object-motions|).
4332
4333 *'paste'* *'nopaste'*
4334'paste' boolean (default off)
4335 global
4336 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004337 Put Vim in Paste mode. This is useful if you want to cut or copy
4338 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004339 unexpected effects.
4340 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004341 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004342 knows about pasting and will mostly do the right thing without 'paste'
4343 being set. The same is true for a terminal where Vim handles the
4344 mouse clicks itself.
4345 When the 'paste' option is switched on (also when it was already on):
4346 - mapping in Insert mode and Command-line mode is disabled
4347 - abbreviations are disabled
4348 - 'textwidth' is set to 0
4349 - 'wrapmargin' is set to 0
4350 - 'autoindent' is reset
4351 - 'smartindent' is reset
4352 - 'softtabstop' is set to 0
4353 - 'revins' is reset
4354 - 'ruler' is reset
4355 - 'showmatch' is reset
4356 - 'formatoptions' is used like it is empty
4357 These options keep their value, but their effect is disabled:
4358 - 'lisp'
4359 - 'indentexpr'
4360 - 'cindent'
4361 NOTE: When you start editing another file while the 'paste' option is
4362 on, settings from the modelines or autocommands may change the
4363 settings again, causing trouble when pasting text. You might want to
4364 set the 'paste' option again.
4365 When the 'paste' option is reset the mentioned options are restored to
4366 the value before the moment 'paste' was switched from off to on.
4367 Resetting 'paste' before ever setting it does not have any effect.
4368 Since mapping doesn't work while 'paste' is active, you need to use
4369 the 'pastetoggle' option to toggle the 'paste' option with some key.
4370
4371 *'pastetoggle'* *'pt'*
4372'pastetoggle' 'pt' string (default "")
4373 global
4374 {not in Vi}
4375 When non-empty, specifies the key sequence that toggles the 'paste'
4376 option. This is like specifying a mapping: >
4377 :map {keys} :set invpaste<CR>
4378< Where {keys} is the value of 'pastetoggle'.
4379 The difference is that it will work even when 'paste' is set.
4380 'pastetoggle' works in Insert mode and Normal mode, but not in
4381 Command-line mode.
4382 Mappings are checked first, thus overrule 'pastetoggle'. However,
4383 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4384 this: >
4385 :map <F10> :set paste<CR>
4386 :map <F11> :set nopaste<CR>
4387 :imap <F10> <C-O>:set paste<CR>
4388 :imap <F11> <nop>
4389 :set pastetoggle=<F11>
4390< This will make <F10> start paste mode and <F11> stop paste mode.
4391 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4392 mode everything is inserted literally, except the 'pastetoggle' key
4393 sequence.
4394
4395 *'pex'* *'patchexpr'*
4396'patchexpr' 'pex' string (default "")
4397 global
4398 {not in Vi}
4399 {not available when compiled without the |+diff|
4400 feature}
4401 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004402 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004403
4404 *'patchmode'* *'pm'* *E206*
4405'patchmode' 'pm' string (default "")
4406 global
4407 {not in Vi}
4408 When non-empty the oldest version of a file is kept. This can be used
4409 to keep the original version of a file if you are changing files in a
4410 source distribution. Only the first time that a file is written a
4411 copy of the original file will be kept. The name of the copy is the
4412 name of the original file with the string in the 'patchmode' option
4413 appended. This option should start with a dot. Use a string like
4414 ".org". 'backupdir' must not be empty for this to work (Detail: The
4415 backup file is renamed to the patchmode file after the new file has
4416 been successfully written, that's why it must be possible to write a
4417 backup file). If there was no file to be backed up, an empty file is
4418 created.
4419 When the 'backupskip' pattern matches, a patchmode file is not made.
4420 Using 'patchmode' for compressed files appends the extension at the
4421 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4422 recognized as a compressed file.
4423
4424 *'path'* *'pa'* *E343* *E345* *E347*
4425'path' 'pa' string (default on Unix: ".,/usr/include,,"
4426 on OS/2: ".,/emx/include,,"
4427 other systems: ".,,")
4428 global or local to buffer |global-local|
4429 {not in Vi}
4430 This is a list of directories which will be searched when using the
4431 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4432 being searched for has a relative path (not starting with '/'). The
4433 directories in the 'path' option may be relative or absolute.
4434 - Use commas to separate directory names: >
4435 :set path=.,/usr/local/include,/usr/include
4436< - Spaces can also be used to separate directory names (for backwards
4437 compatibility with version 3.0). To have a space in a directory
4438 name, precede it with an extra backslash, and escape the space: >
4439 :set path=.,/dir/with\\\ space
4440< - To include a comma in a directory name precede it with an extra
4441 backslash: >
4442 :set path=.,/dir/with\\,comma
4443< - To search relative to the directory of the current file, use: >
4444 :set path=.
4445< - To search in the current directory use an empty string between two
4446 commas: >
4447 :set path=,,
4448< - A directory name may end in a ':' or '/'.
4449 - Environment variables are expanded |:set_env|.
4450 - When using |netrw.vim| URLs can be used. For example, adding
4451 "http://www.vim.org" will make ":find index.html" work.
4452 - Search upwards and downwards in a directory tree:
4453 1) "*" matches a sequence of characters, e.g.: >
4454 :set path=/usr/include/*
4455< means all subdirectories in /usr/include (but not /usr/include
4456 itself). >
4457 :set path=/usr/*c
4458< matches /usr/doc and /usr/src.
4459 2) "**" matches a subtree, up to 100 directories deep. Example: >
4460 :set path=/home/user_x/src/**
4461< means search in the whole subtree under "/home/usr_x/src".
4462 3) If the path ends with a ';', this path is the startpoint
4463 for upward search.
4464 See |file-searching| for more info and exact syntax.
4465 {not available when compiled without the |+path_extra| feature}
4466 - Careful with '\' characters, type two to get one in the option: >
4467 :set path=.,c:\\include
4468< Or just use '/' instead: >
4469 :set path=.,c:/include
4470< Don't forget "." or files won't even be found in the same directory as
4471 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004472 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004473 it is something like 256 or 1024 characters.
4474 You can check if all the include files are found, using the value of
4475 'path', see |:checkpath|.
4476 The use of |:set+=| and |:set-=| is preferred when adding or removing
4477 directories from the list. This avoids problems when a future version
4478 uses another default. To remove the current directory use: >
4479 :set path-=
4480< To add the current directory use: >
4481 :set path+=
4482< To use an environment variable, you probably need to replace the
4483 separator. Here is an example to append $INCL, in which directory
4484 names are separated with a semi-colon: >
4485 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4486< Replace the ';' with a ':' or whatever separator is used. Note that
4487 this doesn't work when $INCL contains a comma or white space.
4488
4489 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4490'preserveindent' 'pi' boolean (default off)
4491 local to buffer
4492 {not in Vi}
4493 When changing the indent of the current line, preserve as much of the
4494 indent structure as possible. Normally the indent is replaced by a
4495 series of tabs followed by spaces as required (unless |'expandtab'| is
4496 enabled, in which case only spaces are used). Enabling this option
4497 means the indent will preserve as many existing characters as possible
4498 for indenting, and only add additional tabs or spaces as required.
4499 NOTE: When using ">>" multiple times the resulting indent is a mix of
4500 tabs and spaces. You might not like this.
4501 NOTE: 'preserveindent' is reset when 'compatible' is set.
4502 Also see 'copyindent'.
4503 Use |:retab| to clean up white space.
4504
4505 *'previewheight'* *'pvh'*
4506'previewheight' 'pvh' number (default 12)
4507 global
4508 {not in Vi}
4509 {not available when compiled without the |+windows| or
4510 |+quickfix| feature}
4511 Default height for a preview window. Used for |:ptag| and associated
4512 commands. Used for |CTRL-W_}| when no count is given.
4513
4514 *'previewwindow'* *'nopreviewwindow'*
4515 *'pvw'* *'nopvw'* *E590*
4516'previewwindow' 'pvw' boolean (default off)
4517 local to window
4518 {not in Vi}
4519 {not available when compiled without the |+windows| or
4520 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004521 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004522 set. It's normally not set directly, but by using one of the commands
4523 |:ptag|, |:pedit|, etc.
4524
4525 *'printdevice'* *'pdev'*
4526'printdevice' 'pdev' string (default empty)
4527 global
4528 {not in Vi}
4529 {only available when compiled with the |+printer|
4530 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004531 The name of the printer to be used for |:hardcopy|.
4532 See |pdev-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004533
Bram Moolenaar8299df92004-07-10 09:47:34 +00004534 *'printencoding'* *'penc'*
4535'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004536 global
4537 {not in Vi}
4538 {only available when compiled with the |+printer|
4539 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004540 Sets the character encoding used when printing.
4541 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004542
4543 *'printexpr'* *'pexpr'*
4544'printexpr' 'pexpr' String (default: see below)
4545 global
4546 {not in Vi}
4547 {only available when compiled with the |+printer|
4548 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004549 Expression used to print the PostScript produced with |:hardcopy|.
4550 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004551
Bram Moolenaar8299df92004-07-10 09:47:34 +00004552 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004553'printfont' 'pfn' string (default "courier")
4554 global
4555 {not in Vi}
4556 {only available when compiled with the |+printer|
4557 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004558 The name of the font that will be used for |:hardcopy|.
4559 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004560
4561 *'printheader'* *'pheader'*
4562'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
4563 global
4564 {not in Vi}
4565 {only available when compiled with the |+printer|
4566 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004567 The format of the header produced in |:hardcopy| output.
4568 See |pheader-option|.
4569
4570 *'printmbcharset'* *'pmbcs'*
4571'printmbcharset' 'pmbcs' string (default "")
4572 global
4573 {not in Vi}
4574 {only available when compiled with the |+printer|
4575 and |+multi_byte| features}
4576 The CJK character set to be used for CJK output from |:hardcopy|.
4577 See |pmbcs-option|.
4578
4579 *'printmbfont'* *'pmbfn'*
4580'printmbfont' 'pmbfn' string (default "")
4581 global
4582 {not in Vi}
4583 {only available when compiled with the |+printer|
4584 and |+multi_byte| features}
4585 List of font names to be used for CJK output from |:hardcopy|.
4586 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004587
4588 *'printoptions'* *'popt'*
4589'printoptions' 'popt' string (default "")
4590 global
4591 {not in Vi}
4592 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004593 List of items that control the format of the output of |:hardcopy|.
4594 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004595
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004596 *'quoteescape''* *'qe'*
4597'quoteescape' 'qe' string (default "\")
4598 local to buffer
4599 {not in Vi}
4600 The characters that are used to escape quotes in a string. Used for
4601 objects like a', a" and a` |a'|.
4602 When one of the characters in this option is found inside a string,
4603 the following character will be skipped. The default value makes the
4604 text "foo\"bar\\" considered to be one string.
4605
Bram Moolenaar071d4272004-06-13 20:20:40 +00004606 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
4607'readonly' 'ro' boolean (default off)
4608 local to buffer
4609 If on, writes fail unless you use a '!'. Protects you from
4610 accidentally overwriting a file. Default on when Vim is started
4611 in read-only mode ("vim -R") or when the executable is called "view".
4612 {not in Vi:} When using the ":view" command the 'readonly' option is
4613 set for the newly edited buffer. When using ":w!" the 'readonly'
4614 option is reset for the current buffer.
4615
4616 *'remap'* *'noremap'*
4617'remap' boolean (default on)
4618 global
4619 Allows for mappings to work recursively. If you do not want this for
4620 a single entry, use the :noremap[!] command.
4621
4622 *'report'*
4623'report' number (default 2)
4624 global
4625 Threshold for reporting number of lines changed. When the number of
4626 changed lines is more than 'report' a message will be given for most
4627 ":" commands. If you want it always, set 'report' to 0.
4628 For the ":substitute" command the number of substitutions is used
4629 instead of the number of lines.
4630
4631 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
4632'restorescreen' 'rs' boolean (default on)
4633 global
4634 {not in Vi} {only in Windows 95/NT console version}
4635 When set, the screen contents is restored when exiting Vim. This also
4636 happens when executing external commands.
4637
4638 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
4639 options in your .vimrc. To disable restoring:
4640 set t_ti= t_te=
4641 To enable restoring (for an xterm):
4642 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
4643 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
4644
4645 *'revins'* *'ri'* *'norevins'* *'nori'*
4646'revins' 'ri' boolean (default off)
4647 global
4648 {not in Vi}
4649 {only available when compiled with the |+rightleft|
4650 feature}
4651 Inserting characters in Insert mode will work backwards. See "typing
4652 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
4653 command in Insert mode, when 'allowrevins' is set.
4654 NOTE: This option is reset when 'compatible' or 'paste' is set.
4655
4656 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
4657'rightleft' 'rl' boolean (default off)
4658 local to window
4659 {not in Vi}
4660 {only available when compiled with the |+rightleft|
4661 feature}
4662 When on, display orientation becomes right-to-left, i.e., characters
4663 that are stored in the file appear from the right to the left.
4664 Using this option, it is possible to edit files for languages that
4665 are written from the right to the left such as Hebrew and Arabic.
4666 This option is per window, so it is possible to edit mixed files
4667 simultaneously, or to view the same file in both ways (this is
4668 useful whenever you have a mixed text file with both right-to-left
4669 and left-to-right strings so that both sets are displayed properly
4670 in different windows). Also see |rileft.txt|.
4671
4672 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
4673'rightleftcmd' 'rlc' string (default "search")
4674 local to window
4675 {not in Vi}
4676 {only available when compiled with the |+rightleft|
4677 feature}
4678 Each word in this option enables the command line editing to work in
4679 right-to-left mode for a group of commands:
4680
4681 search "/" and "?" commands
4682
4683 This is useful for languages such as Hebrew, Arabic and Farsi.
4684 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
4685
4686 *'ruler'* *'ru'* *'noruler'* *'noru'*
4687'ruler' 'ru' boolean (default off)
4688 global
4689 {not in Vi}
4690 {not available when compiled without the
4691 |+cmdline_info| feature}
4692 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004693 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00004694 text in the file is shown on the far right:
4695 Top first line is visible
4696 Bot last line is visible
4697 All first and last line are visible
4698 45% relative position in the file
4699 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004700 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004701 ruler is shown there. Otherwise it is shown in the last line of the
4702 screen. If the statusline is given by 'statusline' (ie. not empty),
4703 this option takes precedence over 'ruler' and 'rulerformat'
4704 If the number of characters displayed is different from the number of
4705 bytes in the text (e.g., for a TAB or a multi-byte character), both
4706 the text column (byte number) and the screen column are shown,
4707 separated with a dash.
4708 For an empty line "0-1" is shown.
4709 For an empty buffer the line number will also be zero: "0,0-1".
4710 This option is reset when the 'paste' option is set.
4711 If you don't want to see the ruler all the time but want to know where
4712 you are, use "g CTRL-G" |g_CTRL-G|.
4713 NOTE: This option is reset when 'compatible' is set.
4714
4715 *'rulerformat'* *'ruf'*
4716'rulerformat' 'ruf' string (default empty)
4717 global
4718 {not in Vi}
4719 {not available when compiled without the |+statusline|
4720 feature}
4721 When this option is not empty, it determines the content of the ruler
4722 string, as displayed for the 'ruler' option.
4723 The format of this option, is like that of 'statusline'.
4724 The default ruler width is 17 characters. To make the ruler 15
4725 characters wide, put "%15(" at the start and "%)" at the end.
4726 Example: >
4727 :set rulerformat=%15(%c%V\ %p%%%)
4728<
4729 *'runtimepath'* *'rtp'* *vimfiles*
4730'runtimepath' 'rtp' string (default:
4731 Unix: "$HOME/.vim,
4732 $VIM/vimfiles,
4733 $VIMRUNTIME,
4734 $VIM/vimfiles/after,
4735 $HOME/.vim/after"
4736 Amiga: "home:vimfiles,
4737 $VIM/vimfiles,
4738 $VIMRUNTIME,
4739 $VIM/vimfiles/after,
4740 home:vimfiles/after"
4741 PC, OS/2: "$HOME/vimfiles,
4742 $VIM/vimfiles,
4743 $VIMRUNTIME,
4744 $VIM/vimfiles/after,
4745 $HOME/vimfiles/after"
4746 Macintosh: "$VIM:vimfiles,
4747 $VIMRUNTIME,
4748 $VIM:vimfiles:after"
4749 RISC-OS: "Choices:vimfiles,
4750 $VIMRUNTIME,
4751 Choices:vimfiles/after"
4752 VMS: "sys$login:vimfiles,
4753 $VIM/vimfiles,
4754 $VIMRUNTIME,
4755 $VIM/vimfiles/after,
4756 sys$login:vimfiles/after"
4757 global
4758 {not in Vi}
4759 This is a list of directories which will be searched for runtime
4760 files:
4761 filetype.vim filetypes by file name |new-filetype|
4762 scripts.vim filetypes by file contents |new-filetype-scripts|
4763 colors/ color scheme files |:colorscheme|
4764 compiler/ compiler files |:compiler|
4765 doc/ documentation |write-local-help|
4766 ftplugin/ filetype plugins |write-filetype-plugin|
4767 indent/ indent scripts |indent-expression|
4768 keymap/ key mapping files |mbyte-keymap|
4769 lang/ menu translations |:menutrans|
4770 menu.vim GUI menus |menu.vim|
4771 plugin/ plugin scripts |write-plugin|
4772 print/ files for printing |postscript-print-encoding|
4773 syntax/ syntax files |mysyntaxfile|
4774 tutor/ files for vimtutor |tutor|
4775
4776 And any other file searched for with the |:runtime| command.
4777
4778 The defaults for most systems are setup to search five locations:
4779 1. In your home directory, for your personal preferences.
4780 2. In a system-wide Vim directory, for preferences from the system
4781 administrator.
4782 3. In $VIMRUNTIME, for files distributed with Vim.
4783 *after-directory*
4784 4. In the "after" directory in the system-wide Vim directory. This is
4785 for the system administrator to overrule or add to the distributed
4786 defaults (rarely needed)
4787 5. In the "after" directory in your home directory. This is for
4788 personal preferences to overrule or add to the distributed defaults
4789 or system-wide settings (rarely needed).
4790
4791 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
4792 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004793 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004794 wildcards.
4795 See |:runtime|.
4796 Example: >
4797 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
4798< This will use the directory "~/vimruntime" first (containing your
4799 personal Vim runtime files), then "/mygroup/vim" (shared between a
4800 group of people) and finally "$VIMRUNTIME" (the distributed runtime
4801 files).
4802 You probably should always include $VIMRUNTIME somewhere, to use the
4803 distributed runtime files. You can put a directory before $VIMRUNTIME
4804 to find files which replace a distributed runtime files. You can put
4805 a directory after $VIMRUNTIME to find files which add to distributed
4806 runtime files.
4807 This option cannot be set from a |modeline| or in the |sandbox|, for
4808 security reasons.
4809
4810 *'scroll'* *'scr'*
4811'scroll' 'scr' number (default: half the window height)
4812 local to window
4813 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
4814 set to half the number of lines in the window when the window size
4815 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004816 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00004817 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
4818 the number of screen lines instead of file lines, makes a difference
4819 when lines wrap}
4820
4821 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
4822'scrollbind' 'scb' boolean (default off)
4823 local to window
4824 {not in Vi}
4825 {not available when compiled without the |+scrollbind|
4826 feature}
4827 See also |scroll-binding|. When this option is set, the current
4828 window scrolls as other scrollbind windows (windows that also have
4829 this option set) scroll. This option is useful for viewing the
4830 differences between two versions of a file, see 'diff'.
4831 See |'scrollopt'| for options that determine how this option should be
4832 interpreted.
4833 This option is mostly reset when splitting a window to edit another
4834 file. This means that ":split | edit file" results in two windows
4835 with scroll-binding, but ":split file" does not.
4836
4837 *'scrolljump'* *'sj'*
4838'scrolljump' 'sj' number (default 1)
4839 global
4840 {not in Vi}
4841 Minimal number of lines to scroll when the cursor gets off the
4842 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
4843 CTRL-D). Useful if your terminal scrolls very slowly.
4844 NOTE: This option is set to 1 when 'compatible' is set.
4845
4846 *'scrolloff'* *'so'*
4847'scrolloff' 'so' number (default 0)
4848 global
4849 {not in Vi}
4850 Minimal number of screen lines to keep above and below the cursor.
4851 This will make some context visible around where you are working. If
4852 you set it to a very large value (999) the cursor line will always be
4853 in the middle of the window (except at the start or end of the file or
4854 when long lines wrap).
4855 For scrolling horizontally see 'sidescrolloff'.
4856 NOTE: This option is set to 0 when 'compatible' is set.
4857
4858 *'scrollopt'* *'sbo'*
4859'scrollopt' 'sbo' string (default "ver,jump")
4860 global
4861 {not available when compiled without the |+scrollbind|
4862 feature}
4863 {not in Vi}
4864 This is a comma-separated list of words that specifies how
4865 'scrollbind' windows should behave.
4866 The following words are available:
4867 ver Bind vertical scrolling for 'scrollbind' windows
4868 hor Bind horizontal scrolling for 'scrollbind' windows
4869 jump Applies to the offset between two windows for vertical
4870 scrolling. This offset is the difference in the first
4871 displayed line of the bound windows. When moving
4872 around in a window, another 'scrollbind' window may
4873 reach a position before the start or after the end of
4874 the buffer. The offset is not changed though, when
4875 moving back the 'scrollbind' window will try to scroll
4876 to the desired position when possible.
4877 When now making that window the current one, two
4878 things can be done with the relative offset:
4879 1. When "jump" is not included, the relative offset is
4880 adjusted for the scroll position in the new current
4881 window. When going back to the other window, the
4882 the new relative offset will be used.
4883 2. When "jump" is included, the other windows are
4884 scrolled to keep the same relative offset. When
4885 going back to the other window, it still uses the
4886 same relative offset.
4887 Also see |scroll-binding|.
4888
4889 *'sections'* *'sect'*
4890'sections' 'sect' string (default "SHNHH HUnhsh")
4891 global
4892 Specifies the nroff macros that separate sections. These are pairs of
4893 two letters (See |object-motions|). The default makes a section start
4894 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
4895
4896 *'secure'* *'nosecure'* *E523*
4897'secure' boolean (default off)
4898 global
4899 {not in Vi}
4900 When on, ":autocmd", shell and write commands are not allowed in
4901 ".vimrc" and ".exrc" in the current directory and map commands are
4902 displayed. Switch it off only if you know that you will not run into
4903 problems, or when the 'exrc' option is off. On Unix this option is
4904 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004905 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00004906 'secure' at the end of your ~/.vimrc then.
4907 This option cannot be set from a |modeline| or in the |sandbox|, for
4908 security reasons.
4909
4910 *'selection'* *'sel'*
4911'selection' 'sel' string (default "inclusive")
4912 global
4913 {not in Vi}
4914 This option defines the behavior of the selection. It is only used
4915 in Visual and Select mode.
4916 Possible values:
4917 value past line inclusive ~
4918 old no yes
4919 inclusive yes yes
4920 exclusive yes no
4921 "past line" means that the cursor is allowed to be positioned one
4922 character past the line.
4923 "inclusive" means that the last character of the selection is included
4924 in an operation. For example, when "x" is used to delete the
4925 selection.
4926 Note that when "exclusive" is used and selecting from the end
4927 backwards, you cannot include the last character of a line, when
4928 starting in Normal mode and 'virtualedit' empty.
4929
4930 The 'selection' option is set by the |:behave| command.
4931
4932 *'selectmode'* *'slm'*
4933'selectmode' 'slm' string (default "")
4934 global
4935 {not in Vi}
4936 This is a comma separated list of words, which specifies when to start
4937 Select mode instead of Visual mode, when a selection is started.
4938 Possible values:
4939 mouse when using the mouse
4940 key when using shifted special keys
4941 cmd when using "v", "V" or CTRL-V
4942 See |Select-mode|.
4943 The 'selectmode' option is set by the |:behave| command.
4944
4945 *'sessionoptions'* *'ssop'*
4946'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
4947 help,options,winsize")
4948 global
4949 {not in Vi}
4950 {not available when compiled without the +mksession
4951 feature}
4952 Changes the effect of the |:mksession| command. It is a comma
4953 separated list of words. Each word enables saving and restoring
4954 something:
4955 word save and restore ~
4956 blank empty windows
4957 buffers hidden and unloaded buffers, not just those in windows
4958 curdir the current directory
4959 folds manually created folds, opened/closed folds and local
4960 fold options
4961 globals global variables that start with an uppercase letter
4962 and contain at least one lowercase letter.
4963 help the help window
4964 localoptions options and mappings local to a window or buffer (not
4965 global values for local options)
4966 options all options and mappings (also global values for local
4967 options)
4968 resize size of the Vim window: 'lines' and 'columns'
4969 sesdir the directory in which the session file is located
4970 will become the current directory (useful with
4971 projects accessed over a network from different
4972 systems)
4973 slash backslashes in file names replaced with forward
4974 slashes
4975 unix with Unix end-of-line format (single <NL>), even when
4976 on Windows or DOS
4977 winpos position of the whole Vim window
4978 winsize window sizes
4979
4980 Don't include both "curdir" and "sesdir".
4981 When "curdir" nor "sesdir" is included, file names are stored with
4982 absolute paths.
4983 "slash" and "unix" are useful on Windows when sharing session files
4984 with Unix. The Unix version of Vim cannot source dos format scripts,
4985 but the Windows version of Vim can source unix format scripts.
4986
4987 *'shell'* *'sh'* *E91*
4988'shell' 'sh' string (default $SHELL or "sh",
4989 MS-DOS and Win32: "command.com" or
4990 "cmd.exe", OS/2: "cmd")
4991 global
4992 Name of the shell to use for ! and :! commands. When changing the
4993 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
4994 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004995 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004996 See |option-backslash| about including spaces and backslashes.
4997 Environment variables are expanded |:set_env|.
4998 If the name of the shell contains a space, you might need to enclose
4999 it in quotes. Example: >
5000 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5001< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005002 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005003 "-f" is not inside the quotes, because it is not part of the command
5004 name. And Vim automagically recognizes the backslashes that are path
5005 separators.
5006 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5007 variable to change the way external commands are executed. See the
5008 libc.inf file of DJGPP.
5009 Under MS-Windows, when the executable ends in ".com" it must be
5010 included. Thus setting the shell to "command.com" or "4dos.com"
5011 works, but "command" and "4dos" do not work for all commands (e.g.,
5012 filtering).
5013 For unknown reasons, when using "4dos.com" the current directory is
5014 changed to "C:\". To avoid this set 'shell' like this: >
5015 :set shell=command.com\ /c\ 4dos
5016< This option cannot be set from a |modeline| or in the |sandbox|, for
5017 security reasons.
5018
5019 *'shellcmdflag'* *'shcf'*
5020'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5021 does not contain "sh" somewhere: "/c")
5022 global
5023 {not in Vi}
5024 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5025 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5026 systems, the default is set according to the value of 'shell', to
5027 reduce the need to set this option by the user. It's not used for
5028 OS/2 (EMX figures this out itself). See |option-backslash| about
5029 including spaces and backslashes. See |dos-shell|.
5030 This option cannot be set from a |modeline| or in the |sandbox|, for
5031 security reasons.
5032
5033 *'shellpipe'* *'sp'*
5034'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5035 global
5036 {not in Vi}
5037 {not available when compiled without the |+quickfix|
5038 feature}
5039 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005040 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005041 including spaces and backslashes.
5042 The name of the temporary file can be represented by "%s" if necessary
5043 (the file name is appended automatically if no %s appears in the value
5044 of this option).
5045 For the Amiga and MS-DOS the default is ">". The output is directly
5046 saved in a file and not echoed to the screen.
5047 For Unix the default it "| tee". The stdout of the compiler is saved
5048 in a file and echoed to the screen. If the 'shell' option is "csh" or
5049 "tcsh" after initializations, the default becomes "|& tee". If the
5050 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5051 "2>&1| tee". This means that stderr is also included.
5052 The initialization of this option is done after reading the ".vimrc"
5053 and the other initializations, so that when the 'shell' option is set
5054 there, the 'shellpipe' option changes automatically, unless it was
5055 explicitly set before.
5056 When 'shellpipe' is set to an empty string, no redirection of the
5057 ":make" output will be done. This is useful if you use a 'makeprg'
5058 that writes to 'makeef' by itself. If you want no piping, but do
5059 want to include the 'makeef', set 'shellpipe' to a single space.
5060 Don't forget to precede the space with a backslash: ":set sp=\ ".
5061 In the future pipes may be used for filtering and this option will
5062 become obsolete (at least for Unix).
5063 This option cannot be set from a |modeline| or in the |sandbox|, for
5064 security reasons.
5065
5066 *'shellquote'* *'shq'*
5067'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5068 contains "sh" somewhere: "\"")
5069 global
5070 {not in Vi}
5071 Quoting character(s), put around the command passed to the shell, for
5072 the "!" and ":!" commands. The redirection is kept outside of the
5073 quoting. See 'shellxquote' to include the redirection. It's
5074 probably not useful to set both options.
5075 This is an empty string by default. Only known to be useful for
5076 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5077 or bash, where it should be "\"". The default is adjusted according
5078 the value of 'shell', to reduce the need to set this option by the
5079 user. See |dos-shell|.
5080 This option cannot be set from a |modeline| or in the |sandbox|, for
5081 security reasons.
5082
5083 *'shellredir'* *'srr'*
5084'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5085 global
5086 {not in Vi}
5087 String to be used to put the output of a filter command in a temporary
5088 file. See also |:!|. See |option-backslash| about including spaces
5089 and backslashes.
5090 The name of the temporary file can be represented by "%s" if necessary
5091 (the file name is appended automatically if no %s appears in the value
5092 of this option).
5093 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5094 or "zsh" during initializations, the default becomes ">&". If the
5095 'shell' option is "sh", "ksh" or "bash" the default becomes
5096 ">%s 2>&1". This means that stderr is also included.
5097 For Win32, the Unix checks are done and additionally "cmd" is checked
5098 for, which makes the default ">%s 2>&1". Also, the same names with
5099 ".exe" appended are checked for.
5100 The initialization of this option is done after reading the ".vimrc"
5101 and the other initializations, so that when the 'shell' option is set
5102 there, the 'shellredir' option changes automatically unless it was
5103 explicitly set before.
5104 In the future pipes may be used for filtering and this option will
5105 become obsolete (at least for Unix).
5106 This option cannot be set from a |modeline| or in the |sandbox|, for
5107 security reasons.
5108
5109 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5110'shellslash' 'ssl' boolean (default off)
5111 global
5112 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5113 When set, a forward slash is used when expanding file names. This is
5114 useful when a Unix-like shell is used instead of command.com or
5115 cmd.exe. Backward slashes can still be typed, but they are changed to
5116 forward slashes by Vim.
5117 Note that setting or resetting this option has no effect for some
5118 existing file names, thus this option needs to be set before opening
5119 any file for best results. This might change in the future.
5120 'shellslash' only works when a backslash can be used as a path
5121 separator. To test if this is so use: >
5122 if exists('+shellslash')
5123<
5124 *'shelltype'* *'st'*
5125'shelltype' 'st' number (default 0)
5126 global
5127 {not in Vi} {only for the Amiga}
5128 On the Amiga this option influences the way how the commands work
5129 which use a shell.
5130 0 and 1: always use the shell
5131 2 and 3: use the shell only to filter lines
5132 4 and 5: use shell only for ':sh' command
5133 When not using the shell, the command is executed directly.
5134
5135 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5136 1 and 3: use "shell cmd" to start external commands
5137
5138 *'shellxquote'* *'sxq'*
5139'shellxquote' 'sxq' string (default: "";
5140 for Win32, when 'shell' contains "sh"
5141 somewhere: "\""
5142 for Unix, when using system(): "\"")
5143 global
5144 {not in Vi}
5145 Quoting character(s), put around the command passed to the shell, for
5146 the "!" and ":!" commands. Includes the redirection. See
5147 'shellquote' to exclude the redirection. It's probably not useful
5148 to set both options.
5149 This is an empty string by default. Known to be useful for
5150 third-party shells when using the Win32 version, such as the MKS Korn
5151 Shell or bash, where it should be "\"". The default is adjusted
5152 according the value of 'shell', to reduce the need to set this option
5153 by the user. See |dos-shell|.
5154 This option cannot be set from a |modeline| or in the |sandbox|, for
5155 security reasons.
5156
5157 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5158'shiftround' 'sr' boolean (default off)
5159 global
5160 {not in Vi}
5161 Round indent to multiple of 'shiftwidth'. Applies to > and <
5162 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5163 a multiple of 'shiftwidth' (this is Vi compatible).
5164 NOTE: This option is reset when 'compatible' is set.
5165
5166 *'shiftwidth'* *'sw'*
5167'shiftwidth' 'sw' number (default 8)
5168 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005169 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005170 |'cindent'|, |>>|, |<<|, etc.
5171
5172 *'shortmess'* *'shm'*
5173'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "")
5174 global
5175 {not in Vi}
5176 This option helps to avoid all the |hit-enter| prompts caused by file
5177 messages, for example with CTRL-G, and to avoid some other messages.
5178 It is a list of flags:
5179 flag meaning when present ~
5180 f use "(3 of 5)" instead of "(file 3 of 5)"
5181 i use "[noeol]" instead of "[Incomplete last line]"
5182 l use "999L, 888C" instead of "999 lines, 888 characters"
5183 m use "[+]" instead of "[Modified]"
5184 n use "[New]" instead of "[New File]"
5185 r use "[RO]" instead of "[readonly]"
5186 w use "[w]" instead of "written" for file write message
5187 and "[a]" instead of "appended" for ':w >> file' command
5188 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5189 "[unix format]" and "[mac]" instead of "[mac format]".
5190 a all of the above abbreviations
5191
5192 o overwrite message for writing a file with subsequent message
5193 for reading a file (useful for ":wn" or when 'autowrite' on)
5194 O message for reading a file overwrites any previous message.
5195 Also for quickfix message (e.g., ":cn").
5196 s don't give "search hit BOTTOM, continuing at TOP" or "search
5197 hit TOP, continuing at BOTTOM" messages
5198 t truncate file message at the start if it is too long to fit
5199 on the command-line, "<" will appear in the left most column.
5200 Ignored in Ex mode.
5201 T truncate other messages in the middle if they are too long to
5202 fit on the command line. "..." will appear in the middle.
5203 Ignored in Ex mode.
5204 W don't give "written" or "[w]" when writing a file
5205 A don't give the "ATTENTION" message when an existing swap file
5206 is found.
5207 I don't give the intro message when starting Vim |:intro|.
5208
5209 This gives you the opportunity to avoid that a change between buffers
5210 requires you to hit <Enter>, but still gives as useful a message as
5211 possible for the space available. To get the whole message that you
5212 would have got with 'shm' empty, use ":file!"
5213 Useful values:
5214 shm= No abbreviation of message.
5215 shm=a Abbreviation, but no loss of information.
5216 shm=at Abbreviation, and truncate message when necessary.
5217
5218 NOTE: This option is set to the Vi default value when 'compatible' is
5219 set and to the Vim default value when 'compatible' is reset.
5220
5221 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5222'shortname' 'sn' boolean (default off)
5223 local to buffer
5224 {not in Vi, not in MS-DOS versions}
5225 Filenames are assumed to be 8 characters plus one extension of 3
5226 characters. Multiple dots in file names are not allowed. When this
5227 option is on, dots in file names are replaced with underscores when
5228 adding an extension (".~" or ".swp"). This option is not available
5229 for MS-DOS, because then it would always be on. This option is useful
5230 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5231 or crossdos. When running the Win32 GUI version under Win32s, this
5232 option is always on by default.
5233
5234 *'showbreak'* *'sbr'* *E595*
5235'showbreak' 'sbr' string (default "")
5236 global
5237 {not in Vi}
5238 {not available when compiled without the |+linebreak|
5239 feature}
5240 String to put at the start of lines that have been wrapped. Useful
5241 values are "> " or "+++ ".
5242 Only printable single-cell characters are allowed, excluding <Tab> and
5243 comma (in a future version the comma might be used to separate the
5244 part that is shown at the end and at the start of a line).
5245 The characters are highlighted according to the '@' flag in
5246 'highlight'.
5247 Note that tabs after the showbreak will be displayed differently.
5248 If you want the 'showbreak' to appear in between line numbers, add the
5249 "n" flag to 'cpoptions'.
5250
5251 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5252'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5253 off)
5254 global
5255 {not in Vi}
5256 {not available when compiled without the
5257 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005258 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005259 terminal is slow.
5260 In Visual mode the size of the selected area is shown:
5261 - When selecting characters within a line, the number of characters.
5262 - When selecting more than one line, the number of lines.
5263 - When selecting a block, the size in screen characters: linesxcolumns.
5264 NOTE: This option is set to the Vi default value when 'compatible' is
5265 set and to the Vim default value when 'compatible' is reset.
5266
5267 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5268'showfulltag' 'sft' boolean (default off)
5269 global
5270 {not in Vi}
5271 When completing a word in insert mode (see |ins-completion|) from the
5272 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005273 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005274 matched a C function, you can see a template for what arguments are
5275 required (coding style permitting).
5276
5277 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5278'showmatch' 'sm' boolean (default off)
5279 global
5280 When a bracket is inserted, briefly jump to the matching one. The
5281 jump is only done if the match can be seen on the screen. The time to
5282 show the match can be set with 'matchtime'.
5283 A Beep is given if there is no match (no matter if the match can be
5284 seen or not). This option is reset when the 'paste' option is set.
5285 When the 'm' flag is not included in 'cpoptions', typing a character
5286 will immediately move the cursor back to where it belongs.
5287 See the "sm" field in 'guicursor' for setting the cursor shape and
5288 blinking when showing the match.
5289 The 'matchpairs' option can be used to specify the characters to show
5290 matches for. 'rightleft' and 'revins' are used to look for opposite
5291 matches.
5292 Note: For the use of the short form parental guidance is advised.
5293
5294 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5295'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5296 global
5297 If in Insert, Replace or Visual mode put a message on the last line.
5298 Use the 'M' flag in 'highlight' to set the type of highlighting for
5299 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005300 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005301 doesn't mean XIM is really active, especially when 'imactivatekey' is
5302 not set.
5303 NOTE: This option is set to the Vi default value when 'compatible' is
5304 set and to the Vim default value when 'compatible' is reset.
5305
5306 *'sidescroll'* *'ss'*
5307'sidescroll' 'ss' number (default 0)
5308 global
5309 {not in Vi}
5310 The minimal number of columns to scroll horizontally. Used only when
5311 the 'wrap' option is off and the cursor is moved off of the screen.
5312 When it is zero the cursor will be put in the middle of the screen.
5313 When using a slow terminal set it to a large number or 0. When using
5314 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5315 commands.
5316
5317 *'sidescrolloff'* *'siso'*
5318'sidescrolloff' 'siso' number (default 0)
5319 global
5320 {not in Vi}
5321 The minimal number of screen columns to keep to the left and to the
5322 right of the cursor if 'nowrap' is set. Setting this option to a value
5323 greater than 0 while having |'sidescroll'| also at a non-zero value
5324 makes some context visible in the line you are scrolling in
5325 horizontally (except at the end and beginning of the line). Setting
5326 this option to a large value (like 999) has the effect of keeping the
5327 cursor horizontally centered in the window, as long as one does not
5328 come too close to the beginning or end of the line.
5329 NOTE: This option is set to 0 when 'compatible' is set.
5330
5331 Example: Try this together with 'sidescroll' and 'listchars' as
5332 in the following example to never allow the cursor to move
5333 onto the "extends" character:
5334
5335 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5336 :set sidescrolloff=1
5337
5338
5339 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5340'smartcase' 'scs' boolean (default off)
5341 global
5342 {not in Vi}
5343 Override the 'ignorecase' option if the search pattern contains upper
5344 case characters. Only used when the search pattern is typed and
5345 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005346 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005347 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5348 recalling the search pattern from history and hitting <Enter>.
5349 NOTE: This option is reset when 'compatible' is set.
5350
5351 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5352'smartindent' 'si' boolean (default off)
5353 local to buffer
5354 {not in Vi}
5355 {not available when compiled without the
5356 |+smartindent| feature}
5357 Do smart autoindenting when starting a new line. Works for C-like
5358 programs, but can also be used for other languages. 'cindent' does
5359 something like this, works better in most cases, but is more strict,
5360 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5361 'indentexpr' is a more advanced alternative.
5362 Normally 'autoindent' should also be on when using 'smartindent'.
5363 An indent is automatically inserted:
5364 - After a line ending in '{'.
5365 - After a line starting with a keyword from 'cinwords'.
5366 - Before a line starting with '}' (only with the "O" command).
5367 When typing '}' as the first character in a new line, that line is
5368 given the same indent as the matching '{'.
5369 When typing '#' as the first character in a new line, the indent for
5370 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005371 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005372 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5373 When using the ">>" command, lines starting with '#' are not shifted
5374 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005375 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005376 is set smart indenting is disabled.
5377
5378 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5379'smarttab' 'sta' boolean (default off)
5380 global
5381 {not in Vi}
5382 When on, a <Tab> in front of a line inserts blanks according to
5383 'shiftwidth'. 'tabstop' is used in other places. A <BS> will delete
5384 a 'shiftwidth' worth of space at the start of the line.
5385 When off a <Tab> always inserts blanks according to 'tabstop'.
5386 'shiftwidth' is only used for shifting text left or right
5387 |shift-left-right|.
5388 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5389 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005390 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005391 NOTE: This option is reset when 'compatible' is set.
5392
5393 *'softtabstop'* *'sts'*
5394'softtabstop' 'sts' number (default 0)
5395 local to buffer
5396 {not in Vi}
5397 Number of spaces that a <Tab> counts for while performing editing
5398 operations, like inserting a <Tab> or using <BS>. It "feels" like
5399 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5400 used. This is useful to keep the 'ts' setting at its standard value
5401 of 8, while being able to edit like it is set to 'sts'. However,
5402 commands like "x" still work on the actual characters.
5403 When 'sts' is zero, this feature is off.
5404 'softtabstop' is set to 0 when the 'paste' option is set.
5405 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5406 spaces is minimized by using <Tab>s.
5407 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5408 set.
5409 NOTE: This option is set to 0 when 'compatible' is set.
5410
5411 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
5412'splitbelow' 'sb' boolean (default off)
5413 global
5414 {not in Vi}
5415 {not available when compiled without the +windows
5416 feature}
5417 When on, splitting a window will put the new window below the current
5418 one. |:split|
5419
5420 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
5421'splitright' 'spr' boolean (default off)
5422 global
5423 {not in Vi}
5424 {not available when compiled without the +vertsplit
5425 feature}
5426 When on, splitting a window will put the new window right of the
5427 current one. |:vsplit|
5428
5429 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
5430'startofline' 'sol' boolean (default on)
5431 global
5432 {not in Vi}
5433 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00005434 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005435 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00005436 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005437 with a linewise operator, with "%" with a count and to buffer changing
5438 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
5439 only has a line number, e.g., ":25" or ":+".
5440 In case of buffer changing commands the cursor is placed at the column
5441 where it was the last time the buffer was edited.
5442 NOTE: This option is set when 'compatible' is set.
5443
5444 *'statusline'* *'stl'* *E540* *E541* *E542*
5445'statusline' 'stl' string (default empty)
5446 global
5447 {not in Vi}
5448 {not available when compiled without the |+statusline|
5449 feature}
5450 When nonempty, this option determines the content of the status line.
5451 Also see |status-line|.
5452
5453 The option consists of printf style '%' items interspersed with
5454 normal text. Each status line item is of the form:
5455 %-0{minwid}.{maxwid}{item}
5456 All fields except the {item} is optional. A single percent sign can
5457 be given as "%%". Up to 80 items can be specified.
5458
5459 Note that the only effect of 'ruler' when this option is set (and
5460 'laststatus' is 2) is controlling the output of |CTRL-G|.
5461
5462 field meaning ~
5463 - Left justify the item. The default is right justified
5464 when minwid is larger than the length of the item.
5465 0 Leading zeroes in numeric items. Overridden by '-'.
5466 minwid Minimum width of the item, padding as set by '-' & '0'.
5467 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005468 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005469 on the left for text items. Numeric items will be
5470 shifted down to maxwid-2 digits followed by '>'number
5471 where number is the amount of missing digits, much like
5472 an exponential notation.
5473 item A one letter code as described below.
5474
5475 Following is a description of the possible statusline items. The
5476 second character in "item" is the type:
5477 N for number
5478 S for string
5479 F for flags as described below
5480 - not applicable
5481
5482 item meaning ~
5483 f S Path to the file in the buffer, relative to current directory.
5484 F S Full path to the file in the buffer.
5485 t S File name (tail) of file in the buffer.
5486 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
5487 M F Modified flag, text is ",+" or ",-".
5488 r F Readonly flag, text is " [RO]".
5489 R F Readonly flag, text is ",RO".
5490 h F Help buffer flag, text is " [help]".
5491 H F Help buffer flag, text is ",HLP".
5492 w F Preview window flag, text is " [Preview]".
5493 W F Preview window flag, text is ",PRV".
5494 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
5495 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
5496 {not available when compiled without |+autocmd| feature}
5497 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
5498 being used: "<keymap>"
5499 n N Buffer number.
5500 b N Value of byte under cursor.
5501 B N As above, in hexadecimal.
5502 o N Byte number in file of byte under cursor, first byte is 1.
5503 Mnemonic: Offset from start of file (with one added)
5504 {not available when compiled without |+byte_offset| feature}
5505 O N As above, in hexadecimal.
5506 N N Printer page number. (Only works in the 'printheader' option.)
5507 l N Line number.
5508 L N Number of lines in buffer.
5509 c N Column number.
5510 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005511 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005512 p N Percentage through file in lines as in |CTRL-G|.
5513 P S Percentage through file of displayed window. This is like the
5514 percentage described for 'ruler'. Always 3 in length.
5515 a S Argument list status as in default title. ({current} of {max})
5516 Empty if the argument file count is zero or one.
5517 { NF Evaluate expression between '{' and '}' and substitute result.
5518 ( - Start of item group. Can be used for setting the width and
5519 alignment of a section. Must be followed by %) somewhere.
5520 ) - End of item group. No width fields allowed.
5521 < - Where to truncate line if too long. Default is at the start.
5522 No width fields allowed.
5523 = - Separation point between left and right aligned items.
5524 No width fields allowed.
5525 * - Set highlight group to User{N}, where {N} is taken from the
5526 minwid field. eg. %1*. Restore normal highlight with %* or %0*.
5527 The difference between User{N} and StatusLine will be applied
5528 to StatusLineNC for the statusline of non-current windows.
5529 The number N must be between 1 and 9. See |hl-User1..9|
5530
5531 Display of flags are controlled by the following heuristic:
5532 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005533 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00005534 with a space it is assumed that it wants to separate itself from
5535 anything but other flags. That is: A leading comma is removed if the
5536 preceding character stems from plaintext. A leading space is removed
5537 if the preceding character stems from another active flag. This will
5538 make a nice display when flags are used like in the examples below.
5539
5540 When all items in a group becomes an empty string (ie. flags that are
5541 not set) and a minwid is not set for the group, the whole group will
5542 become empty. This will make a group like the following disappear
5543 completely from the statusline when none of the flags are set. >
5544 :set statusline=...%(\ [%M%R%H]%)...
5545<
5546 Beware that an expression is evaluated each and every time the status
5547 line is displayed. The current buffer and current window will be set
5548 temporarily to that of the window (and buffer) whose statusline is
5549 currently being drawn. The expression will evaluate in this context.
5550 The variable "actual_curbuf" is set to the 'bufnr()' number of the
5551 real current buffer. The expression is evaluated in the |sandbox|.
5552
5553 If the statusline is not updated when you want it (e.g., after setting
5554 a variable that's used in an expression), you can force an update by
5555 setting an option without changing its value. Example: >
5556 :let &ro = &ro
5557
5558< A result of all digits is regarded a number for display purposes.
5559 Otherwise the result is taken as flag text and applied to the rules
5560 described above.
5561
5562 Watch out for errors in expressions. They may render Vim unusable !
5563 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
5564 edit your .vimrc or whatever with "vim -u NONE" to get it right.
5565
5566 Examples:
5567 Emulate standard status line with 'ruler' set >
5568 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
5569< Similar, but add ASCII value of char under the cursor (like "ga") >
5570 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
5571< Display byte count and byte value, modified flag in red. >
5572 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
5573 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
5574< Display a ,GZ flag if a compressed file is loaded >
5575 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
5576< In the |:autocmd|'s: >
5577 :let b:gzflag = 1
5578< And: >
5579 :unlet b:gzflag
5580< And define this function: >
5581 :function VarExists(var, val)
5582 : if exists(a:var) | return a:val | else | return '' | endif
5583 :endfunction
5584<
5585 *'suffixes'* *'su'*
5586'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
5587 global
5588 {not in Vi}
5589 Files with these suffixes get a lower priority when multiple files
5590 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005591 suffixes. Spaces after the comma are ignored. A dot is also seen as
5592 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00005593 separator, precede it with a backslash (see |option-backslash| about
5594 including spaces and backslashes).
5595 See 'wildignore' for completely ignoring files.
5596 The use of |:set+=| and |:set-=| is preferred when adding or removing
5597 suffixes from the list. This avoids problems when a future version
5598 uses another default.
5599
5600 *'suffixesadd'* *'sua'*
5601'suffixesadd' 'sua' string (default "")
5602 local to buffer
5603 {not in Vi}
5604 {not available when compiled without the
5605 |+file_in_path| feature}
5606 Comma separated list of suffixes, which are used when searching for a
5607 file for the "gf", "[I", etc. commands. Example: >
5608 :set suffixesadd=.java
5609<
5610 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
5611'swapfile' 'swf' boolean (default on)
5612 local to buffer
5613 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005614 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00005615 swapfile is not wanted for a specific buffer. For example, with
5616 confidential information that even root must not be able to access.
5617 Careful: All text will be in memory:
5618 - Don't use this for big files.
5619 - Recovery will be impossible!
5620 A swapfile will only be present when |'updatecount'| is non-zero and
5621 'swapfile' is set.
5622 When 'swapfile' is reset, the swap file for the current buffer is
5623 immediately deleted. When 'swapfile' is set, and 'updatecount' is
5624 non-zero, a swap file is immediately created.
5625 Also see |swap-file| and |'swapsync'|.
5626
5627 This option is used together with 'bufhidden' and 'buftype' to
5628 specify special kinds of buffers. See |special-buffers|.
5629
5630 *'swapsync'* *'sws'*
5631'swapsync' 'sws' string (default "fsync")
5632 global
5633 {not in Vi}
5634 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005635 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005636 When this option is empty parts of the swap file may be in memory and
5637 not written to disk. When the system crashes you may lose more work.
5638 On Unix the system does a sync now and then without Vim asking for it,
5639 so the disadvantage of setting this option off is small. On some
5640 systems the swap file will not be written at all. For a unix system
5641 setting it to "sync" will use the sync() call instead of the default
5642 fsync(), which may work better on some systems.
5643
5644 *'switchbuf'* *'swb'*
5645'switchbuf' 'swb' string (default "")
5646 global
5647 {not in Vi}
5648 This option controls the behavior when switching between buffers.
5649 Possible values (comma separated list):
5650 useopen If included, jump to the first open window that
5651 contains the specified buffer (if there is one).
5652 Otherwise: Do not examine other windows.
5653 This setting is checked with |quickfix| commands, when
5654 jumping to errors (":cc", ":cn", "cp", etc.). It is
5655 also used in all buffer related split commands, for
5656 example ":sbuffer", ":sbnext", or ":sbrewind".
5657 split If included, split the current window before loading
5658 a buffer. Otherwise: do not split, use current window.
5659 Supported in |quickfix| commands that display errors.
5660
5661 *'syntax'* *'syn'*
5662'syntax' 'syn' string (default empty)
5663 local to buffer
5664 {not in Vi}
5665 {not available when compiled without the |+syntax|
5666 feature}
5667 When this option is set, the syntax with this name is loaded, unless
5668 syntax highlighting has been switched off with ":syntax off".
5669 Otherwise this option does not always reflect the current syntax (the
5670 b:current_syntax variable does).
5671 This option is most useful in a modeline, for a file which syntax is
5672 not automatically recognized. Example, for in an IDL file: >
5673 /* vim: set syntax=idl : */
5674< To switch off syntax highlighting for the current file, use: >
5675 :set syntax=OFF
5676< To switch syntax highlighting on according to the current value of the
5677 'filetype' option: >
5678 :set syntax=ON
5679< What actually happens when setting the 'syntax' option is that the
5680 Syntax autocommand event is triggered with the value as argument.
5681 This option is not copied to another buffer, independent of the 's' or
5682 'S' flag in 'cpoptions'.
5683
5684 *'tabstop'* *'ts'*
5685'tabstop' 'ts' number (default 8)
5686 local to buffer
5687 Number of spaces that a <Tab> in the file counts for. Also see
5688 |:retab| command, and 'softtabstop' option.
5689
5690 Note: Setting 'tabstop' to any other value than 8 can make your file
5691 appear wrong in many places (e.g., when printing it).
5692
5693 There are four main ways to use tabs in Vim:
5694 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
5695 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
5696 will use a mix of tabs and spaces, but typing Tab and BS will
5697 behave like a tab appears every 4 (or 3) characters.
5698 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
5699 'expandtab'. This way you will always insert spaces. The
5700 formatting will never be messed up when 'tabstop' is changed.
5701 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005702 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00005703 works when using Vim to edit the file.
5704 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
5705 'noexpandtab'. This should then work (for initial indents only)
5706 for any tabstop setting that people use. It might be nice to have
5707 tabs after the first non-blank inserted as spaces if you do this
5708 though. Otherwise aligned comments will be wrong when 'tabstop' is
5709 changed.
5710
5711 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
5712'tagbsearch' 'tbs' boolean (default on)
5713 global
5714 {not in Vi}
5715 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005716 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00005717 searching makes searching for a tag a LOT faster, but a linear search
5718 will find more tags if the tags file wasn't properly sorted.
5719 Vim normally assumes that your tags files are sorted, or indicate that
5720 they are not sorted. Only when this is not the case does the
5721 'tagbsearch' option need to be switched off.
5722
5723 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005724 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005725 certain files, or retry all files with a linear search. When
5726 'tagbsearch' is off, only a linear search is done.
5727
5728 Linear searching is done anyway, for one file, when Vim finds a line
5729 at the start of the file indicating that it's not sorted: >
5730 !_TAG_FILE_SORTED 0 /some command/
5731< [The whitespace before and after the '0' must be a single <Tab>]
5732
5733 When a binary search was done and no match was found in any of the
5734 files listed in 'tags', and 'ignorecase' is set or a pattern is used
5735 instead of a normal tag name, a retry is done with a linear search.
5736 Tags in unsorted tags files, and matches with different case will only
5737 be found in the retry.
5738
Bram Moolenaard4755bb2004-09-02 19:12:26 +00005739 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005740 linear search can be avoided for the 'ignorecase' case. Use a value
5741 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
5742 case-fold sorted with the -f switch to "sort" in most unices, as in
5743 the command: "sort -f -o tags tags". For "Exuberant ctags" version
5744 5.3 or higher the -f or --fold-case-sort switch can be used for this
5745 as well. Note that case must be folded to uppercase for this to work.
5746
5747 When 'tagbsearch' is off, tags searching is slower when a full match
5748 exists, but faster when no full match exists. Tags in unsorted tags
5749 files may only be found with 'tagbsearch' off.
5750 When the tags file is not sorted, or sorted in a wrong way (not on
5751 ASCII byte value), 'tagbsearch' should be off, or the line given above
5752 must be included in the tags file.
5753 This option doesn't affect commands that find all matching tags (e.g.,
5754 command-line completion and ":help").
5755 {Vi: always uses binary search in some versions}
5756
5757 *'taglength'* *'tl'*
5758'taglength' 'tl' number (default 0)
5759 global
5760 If non-zero, tags are significant up to this number of characters.
5761
5762 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
5763'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
5764 global
5765 {not in Vi}
5766 If on and using a tag file in another directory, file names in that
5767 tag file are relative to the directory where the tag file is.
5768 NOTE: This option is set to the Vi default value when 'compatible' is
5769 set and to the Vim default value when 'compatible' is reset.
5770
5771 *'tags'* *'tag'* *E433*
5772'tags' 'tag' string (default "./tags,tags", when compiled with
5773 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
5774 global or local to buffer |global-local|
5775 Filenames for the tag command, separated by spaces or commas. To
5776 include a space or comma in a file name, precede it with a backslash
5777 (see |option-backslash| about including spaces and backslashes).
5778 When a file name starts with "./", the '.' is replaced with the path
5779 of the current file. But only when the 'd' flag is not included in
5780 'cpoptions'. Environment variables are expanded |:set_env|. Also see
5781 |tags-option|.
5782 "*", "**" and other wildcards can be used to search for tags files in
5783 a directory tree. See |file-searching|. {not available when compiled
5784 without the |+path_extra| feature}
5785 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
5786 files are also supported. They are automatically recognized. The
5787 default value becomes "./tags,./TAGS,tags,TAGS", unless case
5788 differences are ignored (MS-Windows). |emacs-tags|
5789 The use of |:set+=| and |:set-=| is preferred when adding or removing
5790 file names from the list. This avoids problems when a future version
5791 uses another default.
5792 {Vi: default is "tags /usr/lib/tags"}
5793
5794 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
5795'tagstack' 'tgst' boolean (default on)
5796 global
5797 {not in all versions of Vi}
5798 When on, the |tagstack| is used normally. When off, a ":tag" or
5799 ":tselect" command with an argument will not push the tag onto the
5800 tagstack. A following ":tag" without an argument, a ":pop" command or
5801 any other command that uses the tagstack will use the unmodified
5802 tagstack, but does change the pointer to the active entry.
5803 Resetting this option is useful when using a ":tag" command in a
5804 mapping which should not change the tagstack.
5805
5806 *'term'* *E529* *E530* *E531*
5807'term' string (default is $TERM, if that fails:
5808 in the GUI: "builtin_gui"
5809 on Amiga: "amiga"
5810 on BeOS: "beos-ansi"
5811 on Mac: "mac-ansi"
5812 on MiNT: "vt52"
5813 on MS-DOS: "pcterm"
5814 on OS/2: "os2ansi"
5815 on Unix: "ansi"
5816 on VMS: "ansi"
5817 on Win 32: "win32")
5818 global
5819 Name of the terminal. Used for choosing the terminal control
5820 characters. Environment variables are expanded |:set_env|.
5821 For example: >
5822 :set term=$TERM
5823< See |termcap|.
5824
5825 *'termbidi'* *'tbidi'*
5826 *'notermbidi'* *'notbidi'*
5827'termbidi' 'tbidi' boolean (default off, on for "mlterm")
5828 global
5829 {not in Vi}
5830 {only available when compiled with the |+arabic|
5831 feature}
5832 The terminal is in charge of Bi-directionality of text (as specified
5833 by Unicode). The terminal is also expected to do the required shaping
5834 that some languages (such as Arabic) require.
5835 Setting this option implies that 'rightleft' will not be set when
5836 'arabic' is set and the value of 'arabicshape' will be ignored.
5837 Note that setting 'termbidi' has the immediate effect that
5838 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
5839 This option is reset when the GUI is started.
5840 For further details see |arabic.txt|.
5841
5842 *'termencoding'* *'tenc'*
5843'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
5844 Macintosh GUI: "macroman")
5845 global
5846 {only available when compiled with the |+multi_byte|
5847 feature}
5848 {not in Vi}
5849 Encoding used for the terminal. This specifies what character
5850 encoding the keyboard produces and the display will understand. For
5851 the GUI it only applies to the keyboard ('encoding' is used for the
5852 display).
5853 In the Win32 console version the default value is the console codepage
5854 when it differs from the ANSI codepage.
5855 *E617*
5856 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
5857 successfully initialized, 'termencoding' is forcibly set to "utf-8".
5858 Any attempts to set a different value will be rejected, and an error
5859 message is shown.
5860 For the Win32 GUI 'termencoding' is not used for typed characters,
5861 because the Win32 system always passes Unicode characters.
5862 When empty, the same encoding is used as for the 'encoding' option.
5863 This is the normal value.
5864 Not all combinations for 'termencoding' and 'encoding' are valid. See
5865 |encoding-table|.
5866 The value for this option must be supported by internal conversions or
5867 iconv(). When this is not possible no conversion will be done and you
5868 will probably experience problems with non-ASCII characters.
5869 Example: You are working with the locale set to euc-jp (Japanese) and
5870 want to edit a UTF-8 file: >
5871 :let &termencoding = &encoding
5872 :set encoding=utf-8
5873< You need to do this when your system has no locale support for UTF-8.
5874
5875 *'terse'* *'noterse'*
5876'terse' boolean (default off)
5877 global
5878 When set: Add 's' flag to 'shortmess' option (this makes the message
5879 for a search that hits the start or end of the file not being
5880 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
5881 shortens a lot of messages}
5882
5883 *'textauto'* *'ta'* *'notextauto'* *'nota'*
5884'textauto' 'ta' boolean (Vim default: on, Vi default: off)
5885 global
5886 {not in Vi}
5887 This option is obsolete. Use 'fileformats'.
5888 For backwards compatibility, when 'textauto' is set, 'fileformats' is
5889 set to the default value for the current system. When 'textauto' is
5890 reset, 'fileformats' is made empty.
5891 NOTE: This option is set to the Vi default value when 'compatible' is
5892 set and to the Vim default value when 'compatible' is reset.
5893
5894 *'textmode'* *'tx'* *'notextmode'* *'notx'*
5895'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
5896 others: default off)
5897 local to buffer
5898 {not in Vi}
5899 This option is obsolete. Use 'fileformat'.
5900 For backwards compatibility, when 'textmode' is set, 'fileformat' is
5901 set to "dos". When 'textmode' is reset, 'fileformat' is set to
5902 "unix".
5903
5904 *'textwidth'* *'tw'*
5905'textwidth' 'tw' number (default 0)
5906 local to buffer
5907 {not in Vi}
5908 Maximum width of text that is being inserted. A longer line will be
5909 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005910 this. 'textwidth' is set to 0 when the 'paste' option is set. When
5911 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00005912 'formatoptions' and |ins-textwidth|.
5913 NOTE: This option is set to 0 when 'compatible' is set.
5914
5915 *'thesaurus'* *'tsr'*
5916'thesaurus' 'tsr' string (default "")
5917 global or local to buffer |global-local|
5918 {not in Vi}
5919 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005920 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00005921 the file should contain words with similar meaning, separated by
5922 non-keyword characters (white space is preferred). Maximum line
5923 length is 510 bytes.
5924 To obtain a file to be used here, check out the wordlist FAQ at
5925 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005926 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00005927 after a comma are ignored, otherwise spaces are included in the file
5928 name. See |option-backslash| about using backslashes.
5929 The use of |:set+=| and |:set-=| is preferred when adding or removing
5930 directories from the list. This avoids problems when a future version
5931 uses another default.
5932 Backticks cannot be used in this option for security reasons.
5933
5934 *'tildeop'* *'top'* *'notildeop'* *'notop'*
5935'tildeop' 'top' boolean (default off)
5936 global
5937 {not in Vi}
5938 When on: The tilde command "~" behaves like an operator.
5939 NOTE: This option is reset when 'compatible' is set.
5940
5941 *'timeout'* *'to'* *'notimeout'* *'noto'*
5942'timeout' 'to' boolean (default on)
5943 global
5944 *'ttimeout'* *'nottimeout'*
5945'ttimeout' boolean (default off)
5946 global
5947 {not in Vi}
5948 These two options together determine the behavior when part of a
5949 mapped key sequence or keyboard code has been received:
5950
5951 'timeout' 'ttimeout' action ~
5952 off off do not time out
5953 on on or off time out on :mappings and key codes
5954 off on time out on key codes
5955
5956 If both options are off, Vim will wait until either the complete
5957 mapping or key sequence has been received, or it is clear that there
5958 is no mapping or key sequence for the received characters. For
5959 example: if you have mapped "vl" and Vim has received 'v', the next
5960 character is needed to see if the 'v' is followed by an 'l'.
5961 When one of the options is on, Vim will wait for about 1 second for
5962 the next character to arrive. After that the already received
5963 characters are interpreted as single characters. The waiting time can
5964 be changed with the 'timeoutlen' option.
5965 On slow terminals or very busy systems timing out may cause
5966 malfunctioning cursor keys. If both options are off, Vim waits
5967 forever after an entered <Esc> if there are key codes that start
5968 with <Esc>. You will have to type <Esc> twice. If you do not have
5969 problems with key codes, but would like to have :mapped key
5970 sequences not timing out in 1 second, set the 'ttimeout' option and
5971 reset the 'timeout' option.
5972
5973 NOTE: 'ttimeout' is reset when 'compatible' is set.
5974
5975 *'timeoutlen'* *'tm'*
5976'timeoutlen' 'tm' number (default 1000)
5977 global
5978 {not in all versions of Vi}
5979 *'ttimeoutlen'* *'ttm'*
5980'ttimeoutlen' 'ttm' number (default -1)
5981 global
5982 {not in Vi}
5983 The time in milliseconds that is waited for a key code or mapped key
5984 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
5985 when part of a command has been typed.
5986 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
5987 different timeout value for key codes is desired set 'ttimeoutlen' to
5988 a non-negative number.
5989
5990 ttimeoutlen mapping delay key code delay ~
5991 < 0 'timeoutlen' 'timeoutlen'
5992 >= 0 'timeoutlen' 'ttimeoutlen'
5993
5994 The timeout only happens when the 'timeout' and 'ttimeout' options
5995 tell so. A useful setting would be >
5996 :set timeout timeoutlen=3000 ttimeoutlen=100
5997< (time out on mapping after three seconds, time out on key codes after
5998 a tenth of a second).
5999
6000 *'title'* *'notitle'*
6001'title' boolean (default off, on when title can be restored)
6002 global
6003 {not in Vi}
6004 {not available when compiled without the |+title|
6005 feature}
6006 When on, the title of the window will be set to the value of
6007 'titlestring' (if it is not empty), or to:
6008 filename [+=-] (path) - VIM
6009 Where:
6010 filename the name of the file being edited
6011 - indicates the file cannot be modified, 'ma' off
6012 + indicates the file was modified
6013 = indicates the file is read-only
6014 =+ indicates the file is read-only and modified
6015 (path) is the path of the file being edited
6016 - VIM the server name |v:servername| or "VIM"
6017 Only works if the terminal supports setting window titles
6018 (currently Amiga console, Win32 console, all GUI versions and
6019 terminals with a non- empty 't_ts' option - these are Unix xterm and
6020 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6021 *X11*
6022 When Vim was compiled with HAVE_X11 defined, the original title will
6023 be restored if possible. The output of ":version" will include "+X11"
6024 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6025 works for the icon name |'icon'|.
6026 But: When Vim was started with the |-X| argument, restoring the title
6027 will not work (except in the GUI).
6028 If the title cannot be restored, it is set to the value of 'titleold'.
6029 You might want to restore the title outside of Vim then.
6030 When using an xterm from a remote machine you can use this command:
6031 rsh machine_name xterm -display $DISPLAY &
6032 then the WINDOWID environment variable should be inherited and the
6033 title of the window should change back to what it should be after
6034 exiting Vim.
6035
6036 *'titlelen'*
6037'titlelen' number (default 85)
6038 global
6039 {not in Vi}
6040 {not available when compiled without the |+title|
6041 feature}
6042 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006043 title. When the title is longer, only the end of the path name is
6044 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006045 Using a percentage makes this adapt to the width of the window. But
6046 it won't work perfectly, because the actual number of characters
6047 available also depends on the font used and other things in the title
6048 bar. When 'titlelen' is zero the full path is used. Otherwise,
6049 values from 1 to 30000 percent can be used.
6050 'titlelen' is also used for the 'titlestring' option.
6051
6052 *'titleold'*
6053'titleold' string (default "Thanks for flying Vim")
6054 global
6055 {not in Vi}
6056 {only available when compiled with the |+title|
6057 feature}
6058 This option will be used for the window title when exiting Vim if the
6059 original title cannot be restored. Only happens if 'title' is on or
6060 'titlestring' is not empty.
6061 *'titlestring'*
6062'titlestring' string (default "")
6063 global
6064 {not in Vi}
6065 {not available when compiled without the |+title|
6066 feature}
6067 When this option is not empty, it will be used for the title of the
6068 window. This happens only when the 'title' option is on.
6069 Only works if the terminal supports setting window titles (currently
6070 Amiga console, Win32 console, all GUI versions and terminals with a
6071 non-empty 't_ts' option).
6072 When Vim was compiled with HAVE_X11 defined, the original title will
6073 be restored if possible |X11|.
6074 When this option contains printf-style '%' items, they will be
6075 expanded according to the rules used for 'statusline'.
6076 Example: >
6077 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6078 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6079< The value of 'titlelen' is used to align items in the middle or right
6080 of the available space.
6081 Some people prefer to have the file name first: >
6082 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6083< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006084 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006085 separating space only when needed.
6086 NOTE: Use of special characters in 'titlestring' may cause the display
6087 to be garbled (e.g., when it contains a CR or NL character).
6088 {not available when compiled without the |+statusline| feature}
6089
6090 *'toolbar'* *'tb'*
6091'toolbar' 'tb' string (default "icons,tooltips")
6092 global
6093 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6094 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006095 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006096 possible values are:
6097 icons Toolbar buttons are shown with icons.
6098 text Toolbar buttons shown with text.
6099 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006100 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006101 tooltips Tooltips are active for toolbar buttons.
6102 Tooltips refer to the popup help text which appears after the mouse
6103 cursor is placed over a toolbar button for a brief moment.
6104
6105 If you want the toolbar to be shown with icons as well as text, do the
6106 following: >
6107 :set tb=icons,text
6108< Motif and Athena cannot display icons and text at the same time. They
6109 will show icons if both are requested.
6110
6111 If none of the strings specified in 'toolbar' are valid or if
6112 'toolbar' is empty, this option is ignored. If you want to disable
6113 the toolbar, you need to set the 'guioptions' option. For example: >
6114 :set guioptions-=T
6115< Also see |gui-toolbar|.
6116
6117 *'toolbariconsize'* *'tbis'*
6118'toolbariconsize' 'tbis' string (default "small")
6119 global
6120 {not in Vi}
6121 {only in the GTK+ 2 GUI}
6122 Controls the size of toolbar icons. The possible values are:
6123 tiny Use tiny toolbar icons.
6124 small Use small toolbar icons (default).
6125 medium Use medium-sized toolbar icons.
6126 large Use large toolbar icons.
6127 The exact dimensions in pixels of the various icon sizes depend on
6128 the current theme. Common dimensions are large=32x32, medium=24x24,
6129 small=20x20 and tiny=16x16.
6130
6131 If 'toolbariconsize' is empty, the global default size as determined
6132 by user preferences or the current theme is used.
6133
6134 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6135'ttybuiltin' 'tbi' boolean (default on)
6136 global
6137 {not in Vi}
6138 When on, the builtin termcaps are searched before the external ones.
6139 When off the builtin termcaps are searched after the external ones.
6140 When this option is changed, you should set the 'term' option next for
6141 the change to take effect, for example: >
6142 :set notbi term=$TERM
6143< See also |termcap|.
6144 Rationale: The default for this option is "on", because the builtin
6145 termcap entries are generally better (many systems contain faulty
6146 xterm entries...).
6147
6148 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6149'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6150 sun-cmd, screen, rxvt, dtterm or
6151 iris-ansi; also on when running Vim in
6152 a DOS console)
6153 global
6154 {not in Vi}
6155 Indicates a fast terminal connection. More characters will be sent to
6156 the screen for redrawing, instead of using insert/delete line
6157 commands. Improves smoothness of redrawing when there are multiple
6158 windows and the terminal does not support a scrolling region.
6159 Also enables the extra writing of characters at the end of each screen
6160 line for lines that wrap. This helps when using copy/paste with the
6161 mouse in an xterm and other terminals.
6162
6163 *'ttymouse'* *'ttym'*
6164'ttymouse' 'ttym' string (default depends on 'term')
6165 global
6166 {not in Vi}
6167 {only in Unix and VMS, doesn't work in the GUI; not
6168 available when compiled without |+mouse|}
6169 Name of the terminal type for which mouse codes are to be recognized.
6170 Currently these three strings are valid:
6171 *xterm-mouse*
6172 xterm xterm-like mouse handling. The mouse generates
6173 "<Esc>[Mscr", where "scr" is three bytes:
6174 "s" = button state
6175 "c" = column plus 33
6176 "r" = row plus 33
6177 xterm2 Works like "xterm", but with the xterm reporting the
6178 mouse position while the mouse is dragged. This works
6179 much faster and more precise. Your xterm must at
6180 least at patchlevel 88 / XFree 3.3.3 for this to
6181 work. See below for how Vim detects this
6182 automatically.
6183 *netterm-mouse*
6184 netterm NetTerm mouse handling. The mouse generates
6185 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6186 for the row and column.
6187 *dec-mouse*
6188 dec DEC terminal mouse handling. The mouse generates a
6189 rather complex sequence, starting with "<Esc>[".
6190 *jsbterm-mouse*
6191 jsbterm JSB term mouse handling.
6192 *pterm-mouse*
6193 pterm QNX pterm mouse handling.
6194
6195 The mouse handling must be enabled at compile time |+mouse_xterm|
6196 |+mouse_dec| |+mouse_netterm|.
6197 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6198 recognized, if enabled at compile time. DEC terminal mouse codes
6199 are recognized if enabled at compile time, and 'ttymouse' is not
6200 "xterm" (because the xterm and dec mouse codes conflict).
6201 This option is automatically set to "xterm", when the 'term' option is
6202 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6203 or "xterm2" already. The main use of this option is to set it to
6204 "xterm", when the terminal name doesn't start with "xterm", but it can
6205 handle xterm mouse codes.
6206 The "xterm2" value will be set if the xterm version is reported to be
6207 95 of higher. This only works when compiled with the |+termresponse|
6208 feature and if |t_RV| is set to the escape sequence to request the
6209 xterm version number. Otherwise "xterm2" must be set explicitly.
6210 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6211 t_RV to an empty string: >
6212 :set t_RV=
6213<
6214 *'ttyscroll'* *'tsl'*
6215'ttyscroll' 'tsl' number (default 999)
6216 global
6217 Maximum number of lines to scroll the screen. If there are more lines
6218 to scroll the window is redrawn. For terminals where scrolling is
6219 very slow and redrawing is not slow this can be set to a small number,
6220 e.g., 3, to speed up displaying.
6221
6222 *'ttytype'* *'tty'*
6223'ttytype' 'tty' string (default from $TERM)
6224 global
6225 Alias for 'term', see above.
6226
6227 *'undolevels'* *'ul'*
6228'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
6229 Win32 and OS/2)
6230 global
6231 {not in Vi}
6232 Maximum number of changes that can be undone. Since undo information
6233 is kept in memory, higher numbers will cause more memory to be used
6234 (nevertheless, a single change can use an unlimited amount of memory).
6235 Set to 0 for Vi compatibility: One level of undo and "u" undoes
6236 itself: >
6237 set ul=0
6238< But you can also get Vi compatibility by including the 'u' flag in
6239 'cpoptions', and still be able to use CTRL-R to repeat undo.
6240 Set to a negative number for no undo at all: >
6241 set ul=-1
6242< This helps when you run out of memory for a single change.
6243 Also see |undo-two-ways|.
6244
6245 *'updatecount'* *'uc'*
6246'updatecount' 'uc' number (default: 200)
6247 global
6248 {not in Vi}
6249 After typing this many characters the swap file will be written to
6250 disk. When zero, no swap file will be created at all (see chapter on
6251 recovery |crash-recovery|). 'updatecount' is set to zero by starting
6252 Vim with the "-n" option, see |startup|. When editing in readonly
6253 mode this option will be initialized to 10000.
6254 The swapfile can be disabled per buffer with |'swapfile'|.
6255 When 'updatecount' is set from zero to non-zero, swap files are
6256 created for all buffers that have 'swapfile' set. When 'updatecount'
6257 is set to zero, existing swap files are not deleted.
6258 Also see |'swapsync'|.
6259 This option has no meaning in buffers where |'buftype'| is "nofile"
6260 or "nowrite".
6261
6262 *'updatetime'* *'ut'*
6263'updatetime' 'ut' number (default 4000)
6264 global
6265 {not in Vi}
6266 If this many milliseconds nothing is typed the swap file will be
6267 written to disk (see |crash-recovery|). Also used for the
6268 |CursorHold| autocommand event.
6269
6270 *'verbose'* *'vbs'*
6271'verbose' 'vbs' number (default 0)
6272 global
6273 {not in Vi, although some versions have a boolean
6274 verbose option}
6275 When bigger than zero, Vim will give messages about what it is doing.
6276 Currently, these messages are given:
6277 >= 1 When the viminfo file is read or written.
6278 >= 2 When a file is ":source"'ed.
6279 >= 5 Every searched tags file.
6280 >= 8 Files for which a group of autocommands is executed.
6281 >= 9 Every executed autocommand.
6282 >= 12 Every executed function.
6283 >= 13 When an exception is thrown, caught, finished, or discarded.
6284 >= 14 Anything pending in a ":finally" clause.
6285 >= 15 Every executed Ex command (truncated at 200 characters).
6286
6287 This option can also be set with the "-V" argument. See |-V|.
6288 This option is also set by the |:verbose| command.
6289
6290 *'viewdir'* *'vdir'*
6291'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
6292 "$VIM/vimfiles/view",
6293 for Unix: "~/.vim/view",
6294 for Macintosh: "$VIM:vimfiles:view"
6295 for VMS: "sys$login:vimfiles/view"
6296 for RiscOS: "Choices:vimfiles/view")
6297 global
6298 {not in Vi}
6299 {not available when compiled without the +mksession
6300 feature}
6301 Name of the directory where to store files for |:mkview|.
6302 This option cannot be set from a |modeline| or in the |sandbox|, for
6303 security reasons.
6304
6305 *'viewoptions'* *'vop'*
6306'viewoptions' 'vop' string (default: "folds,options,cursor")
6307 global
6308 {not in Vi}
6309 {not available when compiled without the +mksession
6310 feature}
6311 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006312 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006313 word save and restore ~
6314 cursor cursor position in file and in window
6315 folds manually created folds, opened/closed folds and local
6316 fold options
6317 options options and mappings local to a window or buffer (not
6318 global values for local options)
6319 slash backslashes in file names replaced with forward
6320 slashes
6321 unix with Unix end-of-line format (single <NL>), even when
6322 on Windows or DOS
6323
6324 "slash" and "unix" are useful on Windows when sharing view files
6325 with Unix. The Unix version of Vim cannot source dos format scripts,
6326 but the Windows version of Vim can source unix format scripts.
6327
6328 *'viminfo'* *'vi'* *E526* *E527* *E528*
6329'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
6330 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
6331 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
6332 for others: '20,<50,s10,h)
6333 global
6334 {not in Vi}
6335 {not available when compiled without the |+viminfo|
6336 feature}
6337 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006338 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00006339 separated list of parameters, each consisting of a single character
6340 identifying the particular parameter, followed by a number or string
6341 which specifies the value of that parameter. If a particular
6342 character is left out, then the default value is used for that
6343 parameter. The following is a list of the identifying characters and
6344 the effect of their value.
6345 CHAR VALUE ~
6346 ! When included, save and restore global variables that start
6347 with an uppercase letter, and don't contain a lowercase
6348 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
6349 and "_K_L_M" are not.
6350 " Maximum number of lines saved for each register. Old name of
6351 the '<' item, with the disadvantage that you need to put a
6352 backslash before the ", otherwise it will be recognized as the
6353 start of a comment!
6354 % When included, save and restore the buffer list. If Vim is
6355 started with a file name argument, the buffer list is not
6356 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006357 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00006358 without a file name and buffers for help files are not written
6359 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00006360 When followed by a number, the number specifies the maximum
6361 number of buffers that are stored. Without a number all
6362 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006363 ' Maximum number of previously edited files for which the marks
6364 are remembered. This parameter must always be included when
6365 'viminfo' is non-empty.
6366 Including this item also means that the |jumplist| and the
6367 |changelist| are stored in the viminfo file.
6368 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006369 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00006370 patterns are also saved. When not included, the value of
6371 'history' is used.
6372 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006373 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006374 < Maximum number of lines saved for each register. If zero then
6375 registers are not saved. When not included, all lines are
6376 saved. '"' is the old name for this item.
6377 Also see the 's' item below: limit specified in Kbyte.
6378 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006379 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006380 c When included, convert the text in the viminfo file from the
6381 'encoding' used when writing the file to the current
6382 'encoding'. See |viminfo-encoding|.
6383 f Whether file marks need to be stored. If zero, file marks ('0
6384 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006385 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00006386 cursor position (when exiting or when doing ":wviminfo").
6387 h Disable the effect of 'hlsearch' when loading the viminfo
6388 file. When not included, it depends on whether ":nohlsearch"
6389 has been used since the last search command.
6390 n Name of the viminfo file. The name must immediately follow
6391 the 'n'. Must be the last one! If the "-i" argument was
6392 given when starting Vim, that file name overrides the one
6393 given here with 'viminfo'. Environment variables are expanded
6394 when opening the file, not when setting the option.
6395 r Removable media. The argument is a string (up to the next
6396 ','). This parameter can be given several times. Each
6397 specifies the start of a path for which no marks will be
6398 stored. This is to avoid removable media. For MS-DOS you
6399 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
6400 also use it for temp files, e.g., for Unix: "r/tmp". Case is
6401 ignored. Maximum length of each 'r' argument is 50
6402 characters.
6403 s Maximum size of an item in Kbyte. If zero then registers are
6404 not saved. Currently only applies to registers. The default
6405 "s10" will exclude registers with more than 10 Kbyte of text.
6406 Also see the '<' item above: line count limit.
6407
6408 Example: >
6409 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
6410<
6411 '50 Marks will be remembered for the last 50 files you
6412 edited.
6413 <1000 Contents of registers (up to 1000 lines each) will be
6414 remembered.
6415 s100 Registers with more than 100 Kbyte text are skipped.
6416 :0 Command-line history will not be saved.
6417 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
6418 no / Since '/' is not specified, the default will be used,
6419 that is, save all of the search history, and also the
6420 previous search and substitute patterns.
6421 no % The buffer list will not be saved nor read back.
6422 no h 'hlsearch' highlighting will be restored.
6423
6424 When setting 'viminfo' from an empty value you can use |:rviminfo| to
6425 load the contents of the file, this is not done automatically.
6426
6427 This option cannot be set from a |modeline| or in the |sandbox|, for
6428 security reasons.
6429
6430 *'virtualedit'* *'ve'*
6431'virtualedit' 've' string (default "")
6432 global
6433 {not in Vi}
6434 {not available when compiled without the
6435 |+virtualedit| feature}
6436 A comma separated list of these words:
6437 block Allow virtual editing in Visual block mode.
6438 insert Allow virtual editing in Insert mode.
6439 all Allow virtual editing in all modes.
6440 Virtual editing means that the cursor can be positioned where there is
6441 no actual character. This can be halfway into a Tab or beyond the end
6442 of the line. Useful for selecting a rectangle in Visual mode and
6443 editing a table.
6444
6445 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
6446'visualbell' 'vb' boolean (default off)
6447 global
6448 {not in Vi}
6449 Use visual bell instead of beeping. The terminal code to display the
6450 visual bell is given with 't_vb'. When no beep or flash is wanted,
6451 use ":set vb t_vb=".
6452 Note: When the GUI starts, 't_vb' is reset to its default value. You
6453 might want to set it again in your |gvimrc|.
6454 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
6455 for 20 msec. If you want to use a different time, use "<Esc>|40f",
6456 where 40 is the time in msec.
6457 Does not work on the Amiga, you always get a screen flash.
6458 Also see 'errorbells'.
6459
6460 *'warn'* *'nowarn'*
6461'warn' boolean (default on)
6462 global
6463 Give a warning message when a shell command is used while the buffer
6464 has been changed.
6465
6466 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
6467'weirdinvert' 'wiv' boolean (default off)
6468 global
6469 {not in Vi}
6470 This option has the same effect as the 't_xs' termcap option.
6471 It is provided for backwards compatibility with version 4.x.
6472 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
6473 vice versa. Has no effect when the GUI is running.
6474
6475 *'whichwrap'* *'ww'*
6476'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
6477 global
6478 {not in Vi}
6479 Allow specified keys that move the cursor left/right to move to the
6480 previous/next line when the cursor is on the first/last character in
6481 the line. Concatenate characters to allow this for these keys:
6482 char key mode ~
6483 b <BS> Normal and Visual
6484 s <Space> Normal and Visual
6485 h "h" Normal and Visual
6486 l "l" Normal and Visual
6487 < <Left> Normal and Visual
6488 > <Right> Normal and Visual
6489 ~ "~" Normal
6490 [ <Left> Insert and Replace
6491 ] <Right> Insert and Replace
6492 For example: >
6493 :set ww=<,>,[,]
6494< allows wrap only when cursor keys are used.
6495 When the movement keys are used in combination with a delete or change
6496 operator, the <EOL> also counts for a character. This makes "3h"
6497 different from "3dh" when the cursor crosses the end of a line. This
6498 is also true for "x" and "X", because they do the same as "dl" and
6499 "dh". If you use this, you may also want to use the mapping
6500 ":map <BS> X" to make backspace delete the character in front of the
6501 cursor.
6502 When 'l' is included, you get a side effect: "yl" on an empty line
6503 will include the <EOL>, so that "p" will insert a new line.
6504 NOTE: This option is set to the Vi default value when 'compatible' is
6505 set and to the Vim default value when 'compatible' is reset.
6506
6507 *'wildchar'* *'wc'*
6508'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
6509 global
6510 {not in Vi}
6511 Character you have to type to start wildcard expansion in the
6512 command-line, as specified with 'wildmode'.
6513 The character is not recognized when used inside a macro. See
6514 'wildcharm' for that.
6515 Although 'wc' is a number option, you can set it to a special key: >
6516 :set wc=<Esc>
6517< NOTE: This option is set to the Vi default value when 'compatible' is
6518 set and to the Vim default value when 'compatible' is reset.
6519
6520 *'wildcharm'* *'wcm'*
6521'wildcharm' 'wcm' number (default: none (0))
6522 global
6523 {not in Vi}
6524 'wildcharm' works exactly like 'wildchar', except that it is
6525 recognized when used inside a macro. You can find "spare" command-line
6526 keys suitable for this option by looking at |ex-edit-index|. Normally
6527 you'll never actually type 'wildcharm', just use it in mappings that
6528 automatically invoke completion mode, e.g.: >
6529 :set wcm=<C-Z>
6530 :cmap ss so $vim/sessions/*.vim<C-Z>
6531< Then after typing :ss you can use CTRL-P & CTRL-N.
6532
6533 *'wildignore'* *'wig'*
6534'wildignore' 'wig' string (default "")
6535 global
6536 {not in Vi}
6537 {not available when compiled without the |+wildignore|
6538 feature}
6539 A list of file patterns. A file that matches with one of these
6540 patterns is ignored when completing file or directory names.
6541 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
6542 Also see 'suffixes'.
6543 Example: >
6544 :set wildignore=*.o,*.obj
6545< The use of |:set+=| and |:set-=| is preferred when adding or removing
6546 a pattern from the list. This avoids problems when a future version
6547 uses another default.
6548
6549 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
6550'wildmenu' 'wmnu' boolean (default off)
6551 global
6552 {not in Vi}
6553 {not available if compiled without the |+wildmenu|
6554 feature}
6555 When 'wildmenu' is on, command-line completion operates in an enhanced
6556 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
6557 the possible matches are shown just above the command line, with the
6558 first match highlighted (overwriting the status line, if there is
6559 one). Keys that show the previous/next match, such as <Tab> or
6560 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
6561 When 'wildmode' is used, "wildmenu" mode is used where "full" is
6562 specified. "longest" and "list" do not start "wildmenu" mode.
6563 If there are more matches than can fit in the line, a ">" is shown on
6564 the right and/or a "<" is shown on the left. The status line scrolls
6565 as needed.
6566 The "wildmenu" mode is abandoned when a key is hit that is not used
6567 for selecting a completion.
6568 While the "wildmenu" is active the following keys have special
6569 meanings:
6570
6571 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
6572 <Down> - in filename/menu name completion: move into a
6573 subdirectory or submenu.
6574 <CR> - in menu completion, when the cursor is just after a
6575 dot: move into a submenu.
6576 <Up> - in filename/menu name completion: move up into
6577 parent directory or parent menu.
6578
6579 This makes the menus accessible from the console |console-menus|.
6580
6581 If you prefer the <Left> and <Right> keys to move the cursor instead
6582 of selecting a different match, use this: >
6583 :cnoremap <Left> <Space><BS><Left>
6584 :cnoremap <Right> <Space><BS><Right>
6585<
6586 The "WildMenu" highlighting is used for displaying the current match
6587 |hl-WildMenu|.
6588
6589 *'wildmode'* *'wim'*
6590'wildmode' 'wim' string (Vim default: "full")
6591 global
6592 {not in Vi}
6593 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006594 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00006595 part specifies what to do for each consecutive use of 'wildchar. The
6596 first part specifies the behavior for the first use of 'wildchar',
6597 The second part for the second use, etc.
6598 These are the possible values for each part:
6599 "" Complete only the first match.
6600 "full" Complete the next full match. After the last match,
6601 the original string is used and then the first match
6602 again.
6603 "longest" Complete till longest common string. If this doesn't
6604 result in a longer string, use the next part.
6605 "longest:full" Like "longest", but also start 'wildmenu' if it is
6606 enabled.
6607 "list" When more than one match, list all matches.
6608 "list:full" When more than one match, list all matches and
6609 complete first match.
6610 "list:longest" When more than one match, list all matches and
6611 complete till longest common string.
6612 When there is only a single match, it is fully completed in all cases.
6613
6614 Examples: >
6615 :set wildmode=full
6616< Complete first full match, next match, etc. (the default) >
6617 :set wildmode=longest,full
6618< Complete longest common string, then each full match >
6619 :set wildmode=list:full
6620< List all matches and complete each full match >
6621 :set wildmode=list,full
6622< List all matches without completing, then each full match >
6623 :set wildmode=longest,list
6624< Complete longest common string, then list alternatives.
6625
6626 *'winaltkeys'* *'wak'*
6627'winaltkeys' 'wak' string (default "menu")
6628 global
6629 {not in Vi}
6630 {only used in Win32, Motif, GTK and Photon GUI}
6631 Some GUI versions allow the access to menu entries by using the ALT
6632 key in combination with a character that appears underlined in the
6633 menu. This conflicts with the use of the ALT key for mappings and
6634 entering special characters. This option tells what to do:
6635 no Don't use ALT keys for menus. ALT key combinations can be
6636 mapped, but there is no automatic handling. This can then be
6637 done with the |:simalt| command.
6638 yes ALT key handling is done by the windowing system. ALT key
6639 combinations cannot be mapped.
6640 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006641 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00006642 keys can be mapped.
6643 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
6644 key is never used for the menu.
6645 In the Win32 version, the <F10> key is handled like this too, since
6646 Windows uses it to select a menu.
6647
6648 *'winheight'* *'wh'* *E591*
6649'winheight' 'wh' number (default 1)
6650 global
6651 {not in Vi}
6652 {not available when compiled without the +windows
6653 feature}
6654 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006655 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006656 current window is smaller, its size is increased, at the cost of the
6657 height of other windows. Set it to 999 to make the current window
6658 always fill the screen (although this has the drawback that ":all"
6659 will create only two windows). Set it to a small number for normal
6660 editing.
6661 Minimum value is 1.
6662 The height is not adjusted after one of the commands to change the
6663 height of the current window.
6664 'winheight' applies to the current window. Use 'winminheight' to set
6665 the minimal height for other windows.
6666
6667 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
6668'winfixheight' 'wfh' boolean (default off)
6669 local to window
6670 {not in Vi}
6671 {not available when compiled without the +windows
6672 feature}
6673 Keep the window height when windows are opened or closed and
6674 'equalalways' is set. Set by default for the |preview-window| and
6675 |quickfix-window|.
6676 The height may be changed anyway when running out of room.
6677
6678 *'winminheight'* *'wmh'*
6679'winminheight' 'wmh' number (default 1)
6680 global
6681 {not in Vi}
6682 {not available when compiled without the +windows
6683 feature}
6684 The minimal height of a window, when it's not the current window.
6685 This is a hard minimum, windows will never become smaller.
6686 When set to zero, windows may be "squashed" to zero lines (i.e. just a
6687 status bar) if necessary. They will return to at least one line when
6688 they become active (since the cursor has to have somewhere to go.)
6689 Use 'winheight' to set the minimal height of the current window.
6690 This option is only checked when making a window smaller. Don't use a
6691 large number, it will cause errors when opening more than a few
6692 windows. A value of 0 to 3 is reasonable.
6693
6694 *'winminwidth'* *'wmw'*
6695'winminwidth' 'wmw' number (default 1)
6696 global
6697 {not in Vi}
6698 {not available when compiled without the +vertsplit
6699 feature}
6700 The minimal width of a window, when it's not the current window.
6701 This is a hard minimum, windows will never become smaller.
6702 When set to zero, windows may be "squashed" to zero columns (i.e. just
6703 a vertical separator) if necessary. They will return to at least one
6704 line when they become active (since the cursor has to have somewhere
6705 to go.)
6706 Use 'winwidth' to set the minimal width of the current window.
6707 This option is only checked when making a window smaller. Don't use a
6708 large number, it will cause errors when opening more than a few
6709 windows. A value of 0 to 12 is reasonable.
6710
6711 *'winwidth'* *'wiw'* *E592*
6712'winwidth' 'wiw' number (default 20)
6713 global
6714 {not in Vi}
6715 {not available when compiled without the +vertsplit
6716 feature}
6717 Minimal number of columns for the current window. This is not a hard
6718 minimum, Vim will use fewer columns if there is not enough room. If
6719 the current window is smaller, its size is increased, at the cost of
6720 the width of other windows. Set it to 999 to make the current window
6721 always fill the screen. Set it to a small number for normal editing.
6722 The width is not adjusted after one of the commands to change the
6723 width of the current window.
6724 'winwidth' applies to the current window. Use 'winminwidth' to set
6725 the minimal width for other windows.
6726
6727 *'wrap'* *'nowrap'*
6728'wrap' boolean (default on)
6729 local to window
6730 {not in Vi}
6731 This option changes how text is displayed. It doesn't change the text
6732 in the buffer, see 'textwidth' for that.
6733 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006734 displaying continues on the next line. When off lines will not wrap
6735 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00006736 moved to a part that is not shown, the screen will scroll
6737 horizontally.
6738 The line will be broken in the middle of a word if necessary. See
6739 'linebreak' to get the break at a word boundary.
6740 To make scrolling horizontally a bit more useful, try this: >
6741 :set sidescroll=5
6742 :set listchars+=precedes:<,extends:>
6743< See 'sidescroll', 'listchars' and |wrap-off|.
6744
6745 *'wrapmargin'* *'wm'*
6746'wrapmargin' 'wm' number (default 0)
6747 local to buffer
6748 Number of characters from the right window border where wrapping
6749 starts. When typing text beyond this limit, an <EOL> will be inserted
6750 and inserting continues on the next line.
6751 Options that add a margin, such as 'number' and 'foldcolumn', cause
6752 the text width to be further reduced. This is Vi compatible.
6753 When 'textwidth' is non-zero, this option is not used.
6754 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
6755 and less usefully}
6756
6757 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
6758'wrapscan' 'ws' boolean (default on) *E384* *E385*
6759 global
6760 Searches wrap around the end of the file.
6761
6762 *'write'* *'nowrite'*
6763'write' boolean (default on)
6764 global
6765 {not in Vi}
6766 Allows writing files. When not set, writing a file is not allowed.
6767 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006768 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00006769 argument. Filtering text is still possible, even though this requires
6770 writing a temporary file.
6771
6772 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
6773'writeany' 'wa' boolean (default off)
6774 global
6775 Allows writing to any file with no need for "!" override.
6776
6777 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
6778'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
6779 otherwise)
6780 global
6781 {not in Vi}
6782 Make a backup before overwriting a file. The backup is removed after
6783 the file was successfully written, unless the 'backup' option is
6784 also on. Reset this option if your file system is almost full. See
6785 |backup-table| for another explanation.
6786 When the 'backupskip' pattern matches, a backup is not made anyway.
6787 NOTE: This option is set to the default value when 'compatible' is
6788 set.
6789
6790 *'writedelay'* *'wd'*
6791'writedelay' 'wd' number (default 0)
6792 global
6793 {not in Vi}
6794 The number of microseconds to wait for each character sent to the
6795 screen. When non-zero, characters are sent to the terminal one by
6796 one. For MS-DOS pcterm this does not work. For debugging purposes.
6797
6798 vim:tw=78:ts=8:ft=help:norl: