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