blob: 877ac1a76ac1a549abe728cdf04d0bad58295772 [file] [log] [blame]
Bram Moolenaar3991dab2006-03-27 17:01:56 +00001*options.txt* For Vim version 7.0c. Last change: 2006 Mar 26
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==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
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
Bram Moolenaara5792f52005-11-23 21:25:05 +000079 are removed. When adding a flag that was already
80 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000081 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000082 {not in Vi}
83
84:se[t] {option}^={value} *:set^=*
85 Multiply the {value} to a number option, or prepend
86 the {value} to a string option. When the option is a
87 comma separated list, a comma is added, unless the
88 value was empty.
89 Also see |:set-args| above.
90 {not in Vi}
91
92:se[t] {option}-={value} *:set-=*
93 Subtract the {value} from a number option, or remove
94 the {value} from a string option, if it is there.
95 If the {value} is not found in a string option, there
96 is no error or warning. When the option is a comma
97 separated list, a comma is deleted, unless the option
98 becomes empty.
99 When the option is a list of flags, {value} must be
100 exactly as they appear in the option. Remove flags
101 one by one to avoid problems.
102 Also see |:set-args| above.
103 {not in Vi}
104
105The {option} arguments to ":set" may be repeated. For example: >
106 :set ai nosi sw=3 ts=3
107If you make an error in one of the arguments, an error message will be given
108and the following arguments will be ignored.
109
110 *:set-verbose*
111When 'verbose' is non-zero, displaying an option value will also tell where it
112was last set. Example: >
113 :verbose set shiftwidth cindent?
114 shiftwidth=4
115 Last set from modeline
116 cindent
117 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim
118This is only done when specific option values are requested, not for ":set
119all" or ":set" without an argument.
120When the option was set by hand there is no "Last set" message. There is only
121one value for all local options with the same name. Thus the message applies
122to the option name, not necessarily its value.
123When the option was set while executing a function, user command or
124autocommand, the script in which it was defined is reported.
125Note that an option may also have been set as a side effect of setting
126'compatible'.
127{not available when compiled without the +eval feature}
128
129 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000130For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000131override the value from the termcap. You can then use it in a mapping. If
132the "xx" part contains special characters, use the <t_xx> form: >
133 :set <t_#4>=^[Ot
134This can also be used to translate a special code for a normal key. For
135example, if Alt-b produces <Esc>b, use this: >
136 :set <M-b>=^[b
137(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
138The advantage over a mapping is that it works in all situations.
139
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000140The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
141security reasons.
142
Bram Moolenaar071d4272004-06-13 20:20:40 +0000143The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000144at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000145"set all" probably does not fit on the screen, causing Vim to give the
146|more-prompt|.
147
148 *option-backslash*
149To include white space in a string option value it has to be preceded with a
150backslash. To include a backslash you have to use two. Effectively this
151means that the number of backslashes in an option value is halved (rounded
152down).
153A few examples: >
154 :set tags=tags\ /usr/tags results in "tags /usr/tags"
155 :set tags=tags\\,file results in "tags\,file"
156 :set tags=tags\\\ file results in "tags\ file"
157
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000158The "|" character separates a ":set" command from a following command. To
159include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000160'titlestring' option to "hi|there": >
161 :set titlestring=hi\|there
162This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
163 :set titlestring=hi|set iconstring=there
164
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000165Similarly, the double quote character starts a comment. To include the '"' in
166the option value, use '\"' instead. This example sets the 'titlestring'
167option to 'hi "there"': >
168 :set titlestring=hi\ \"there\"
169
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000170For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000171precise: For options that expect a file name (those where environment
172variables are expanded) a backslash before a normal file name character is not
173removed. But a backslash before a special character (space, backslash, comma,
174etc.) is used like explained above.
175There is one special situation, when the value starts with "\\": >
176 :set dir=\\machine\path results in "\\machine\path"
177 :set dir=\\\\machine\\path results in "\\machine\path"
178 :set dir=\\path\\file results in "\\path\file" (wrong!)
179For the first one the start is kept, but for the second one the backslashes
180are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000181halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000182result which is probably not what you want. Avoid it.
183
184 *add-option-flags* *remove-option-flags*
185 *E539* *E550* *E551* *E552*
186Some options are a list of flags. When you want to add a flag to such an
187option, without changing the existing ones, you can do it like this: >
188 :set guioptions+=a
189Remove a flag from an option like this: >
190 :set guioptions-=a
191This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000192Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
194doesn't appear.
195
196 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000197Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000198environment variable exists the '$' and the following environment variable
199name is replaced with its value. If it does not exist the '$' and the name
200are not modified. Any non-id character (not a letter, digit or '_') may
201follow the environment variable name. That character and what follows is
202appended to the value of the environment variable. Examples: >
203 :set term=$TERM.new
204 :set path=/usr/$INCLUDE,$HOME/include,.
205When adding or removing a string from an option with ":set opt-=val" or ":set
206opt+=val" the expansion is done before the adding or removing.
207
208
209Handling of local options *local-options*
210
211Some of the options only apply to a window or buffer. Each window or buffer
212has its own copy of this option, thus can each have their own value. This
213allows you to set 'list' in one window but not in another. And set
214'shiftwidth' to 3 in one buffer and 4 in another.
215
216The following explains what happens to these local options in specific
217situations. You don't really need to know all of this, since Vim mostly uses
218the option values you would expect. Unfortunately, doing what the user
219expects is a bit complicated...
220
221When splitting a window, the local options are copied to the new window. Thus
222right after the split the contents of the two windows look the same.
223
224When editing a new buffer, its local option values must be initialized. Since
225the local options of the current buffer might be specifically for that buffer,
226these are not used. Instead, for each buffer-local option there also is a
227global value, which is used for new buffers. With ":set" both the local and
228global value is changed. With "setlocal" only the local value is changed,
229thus this value is not used when editing a new buffer.
230
231When editing a buffer that has been edited before, the last used window
232options are used again. If this buffer has been edited in this window, the
233values from back then are used. Otherwise the values from the window where
234the buffer was edited last are used.
235
236It's possible to set a local window option specifically for a type of buffer.
237When you edit another buffer in the same window, you don't want to keep
238using these local window options. Therefore Vim keeps a global value of the
239local window options, which is used when editing another buffer. Each window
240has its own copy of these values. Thus these are local to the window, but
241global to all buffers in the window. With this you can do: >
242 :e one
243 :set list
244 :e two
245Now the 'list' option will also be set in "two", since with the ":set list"
246command you have also set the global value. >
247 :set nolist
248 :e one
249 :setlocal list
250 :e two
251Now the 'list' option is not set, because ":set nolist" resets the global
252value, ":setlocal list" only changes the local value and ":e two" gets the
253global value. Note that if you do this next: >
254 :e one
255You will not get back the 'list' value as it was the last time you edited
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000256"one". The options local to a window are not remembered for each buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000257
258 *:setl* *:setlocal*
259:setl[ocal] ... Like ":set" but set only the value local to the
260 current buffer or window. Not all options have a
261 local value. If the option does not have a local
262 value the global value is set.
263 With the "all" argument: display all local option's
264 local values.
265 Without argument: Display all local option's local
266 values which are different from the default.
267 When displaying a specific local option, show the
268 local value. For a global option the global value is
269 shown (but that might change in the future).
270 {not in Vi}
271
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000272:setl[ocal] {option}< Set the local value of {option} to its global value by
273 copying the value.
274 {not in Vi}
275
276:se[t] {option}< Set the local value of {option} to its global value by
277 making it empty. Only makes sense for |global-local|
278 options.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000279 {not in Vi}
280
281 *:setg* *:setglobal*
282:setg[lobal] ... Like ":set" but set only the global value for a local
283 option without changing the local value.
284 When displaying an option, the global value is shown.
285 With the "all" argument: display all local option's
286 global values.
287 Without argument: display all local option's global
288 values which are different from the default.
289 {not in Vi}
290
291For buffer-local and window-local options:
292 Command global value local value ~
293 :set option=value set set
294 :setlocal option=value - set
295:setglobal option=value set -
296 :set option? - display
297 :setlocal option? - display
298:setglobal option? display -
299
300
301Global options with a local value *global-local*
302
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000303Options are global when you mostly use one value for all buffers and windows.
304For some global options it's useful to sometimes have a different local value.
305You can set the local value with ":setlocal". That buffer or window will then
306use the local value, while other buffers and windows continue using the global
307value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000308
309For example, you have two windows, both on C source code. They use the global
310'makeprg' option. If you do this in one of the two windows: >
311 :set makeprg=gmake
312then the other window will switch to the same value. There is no need to set
313the 'makeprg' option in the other C source window too.
314However, if you start editing a Perl file in a new window, you want to use
315another 'makeprog' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000316files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000317 :setlocal makeprg=perlmake
318You can switch back to using the global value by making the local value empty: >
319 :setlocal makeprg=
320This only works for a string option. For a boolean option you need to use the
321"<" flag, like this: >
322 :setlocal autoread<
323Note that for non-boolean options using "<" copies the global value to the
324local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000325when the global value changes later). You can also use: >
326 :set path<
327This will make the local value of 'path' empty, so that the global value is
328used. Thus it does the same as: >
329 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000330Note: In the future more global options can be made global-local. Using
331":setlocal" on a global option might work differently then.
332
333
334Setting the filetype
335
336:setf[iletype] {filetype} *:setf* *:setfiletype*
337 Set the 'filetype' option to {filetype}, but only if
338 not done yet in a sequence of (nested) autocommands.
339 This is short for: >
340 :if !did_filetype()
341 : setlocal filetype={filetype}
342 :endif
343< This command is used in a filetype.vim file to avoid
344 setting the 'filetype' option twice, causing different
345 settings and syntax files to be loaded.
346 {not in Vi}
347
348:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
349:opt[ions] Open a window for viewing and setting all options.
350 Options are grouped by function.
351 Offers short help for each option. Hit <CR> on the
352 short help to open a help window with more help for
353 the option.
354 Modify the value of the option and hit <CR> on the
355 "set" line to set the new value. For window and
356 buffer specific options, the last accessed window is
357 used to set the option value in, unless this is a help
358 window, in which case the window below help window is
359 used (skipping the option-window).
360 {not available when compiled without the |+eval| or
361 |+autocmd| features}
362
363 *$HOME*
364Using "~" is like using "$HOME", but it is only recognized at the start of an
365option and after a space or comma.
366
367On Unix systems "~user" can be used too. It is replaced by the home directory
368of user "user". Example: >
369 :set path=~mool/include,/usr/include,.
370
371On Unix systems the form "${HOME}" can be used too. The name between {} can
372contain non-id characters then. Note that if you want to use this for the
373"gf" command, you need to add the '{' and '}' characters to 'isfname'.
374
375NOTE: expanding environment variables and "~/" is only done with the ":set"
376command, not when assigning a value to an option with ":let".
377
378
379Note the maximum length of an expanded option is limited. How much depends on
380the system, mostly it is something like 256 or 1024 characters.
381
382 *:fix* *:fixdel*
383:fix[del] Set the value of 't_kD':
384 't_kb' is 't_kD' becomes ~
385 CTRL-? CTRL-H
386 not CTRL-? CTRL-?
387
388 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
389
390 If your delete key terminal code is wrong, but the
391 code for backspace is alright, you can put this in
392 your .vimrc: >
393 :fixdel
394< This works no matter what the actual code for
395 backspace is.
396
397 If the backspace key terminal code is wrong you can
398 use this: >
399 :if &term == "termname"
400 : set t_kb=^V<BS>
401 : fixdel
402 :endif
403< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000404 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000405 with your terminal name.
406
407 If your <Delete> key sends a strange key sequence (not
408 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
409 :if &term == "termname"
410 : set t_kD=^V<Delete>
411 :endif
412< Where "^V" is CTRL-V and "<Delete>" is the delete key
413 (don't type eight characters!). Replace "termname"
414 with your terminal name.
415
416 *Linux-backspace*
417 Note about Linux: By default the backspace key
418 produces CTRL-?, which is wrong. You can fix it by
419 putting this line in your rc.local: >
420 echo "keycode 14 = BackSpace" | loadkeys
421<
422 *NetBSD-backspace*
423 Note about NetBSD: If your backspace doesn't produce
424 the right code, try this: >
425 xmodmap -e "keycode 22 = BackSpace"
426< If this works, add this in your .Xmodmap file: >
427 keysym 22 = BackSpace
428< You need to restart for this to take effect.
429
430==============================================================================
4312. Automatically setting options *auto-setting*
432
433Besides changing options with the ":set" command, there are three alternatives
434to set options automatically for one or more files:
435
4361. When starting Vim initializations are read from various places. See
437 |initialization|. Most of them are performed for all editing sessions,
438 and some of them depend on the directory where Vim is started.
439 You can create an initialization file with |:mkvimrc|, |:mkview| and
440 |:mksession|.
4412. If you start editing a new file, the automatic commands are executed.
442 This can be used to set options for files matching a particular pattern and
443 many other things. See |autocommand|.
4443. If you start editing a new file, and the 'modeline' option is on, a
445 number of lines at the beginning and end of the file are checked for
446 modelines. This is explained here.
447
448 *modeline* *vim:* *vi:* *ex:* *E520*
449There are two forms of modelines. The first form:
450 [text]{white}{vi:|vim:|ex:}[white]{options}
451
452[text] any text or empty
453{white} at least one blank character (<Space> or <Tab>)
454{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
455[white] optional white space
456{options} a list of option settings, separated with white space or ':',
457 where each part between ':' is the argument for a ":set"
458 command
459
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000460Example:
461 vi:noai:sw=3 ts=6 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000462
463The second form (this is compatible with some versions of Vi):
464
465 [text]{white}{vi:|vim:|ex:}[white]se[t] {options}:[text]
466
467[text] any text or empty
468{white} at least one blank character (<Space> or <Tab>)
469{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
470[white] optional white space
471se[t] the string "set " or "se " (note the space)
472{options} a list of options, separated with white space, which is the
473 argument for a ":set" command
474: a colon
475[text] any text or empty
476
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000477Example:
478 /* vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000479
480The white space before {vi:|vim:|ex:} is required. This minimizes the chance
481that a normal word like "lex:" is caught. There is one exception: "vi:" and
482"vim:" can also be at the start of the line (for compatibility with version
4833.0). Using "ex:" at the start of the line will be ignored (this could be
484short for "example:").
485
486 *modeline-local*
487The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000488buffer and window that contain the file. Although it's possible to set global
489options from a modeline, this is unusual. If you have two windows open and
490the files in it set the same global option to a different value, the result
491depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000492
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000493When editing a file that was already loaded, only the window-local options
494from the modeline are used. Thus if you manually changed a buffer-local
495option after opening the file, it won't be changed if you edit the same buffer
496in another window. But window-local options will be set.
497
Bram Moolenaar071d4272004-06-13 20:20:40 +0000498 *modeline-version*
499If the modeline is only to be used for some versions of Vim, the version
500number can be specified where "vim:" is used:
501 vim{vers}: version {vers} or later
502 vim<{vers}: version before {vers}
503 vim={vers}: version {vers}
504 vim>{vers}: version after {vers}
505{vers} is 600 for Vim 6.0 (hundred times the major version plus minor).
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000506For example, to use a modeline only for Vim 6.0 and later:
507 /* vim600: set foldmethod=marker: */ ~
508To use a modeline for Vim before version 5.7:
509 /* vim<570: set sw=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000510There can be no blanks between "vim" and the ":".
511
512
513The number of lines that are checked can be set with the 'modelines' option.
514If 'modeline' is off or 'modelines' is 0 no lines are checked.
515
516Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000517like:
518 /* vi:ts=4: */ ~
519will give an error message for the trailing "*/". This line is OK:
520 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000521
522If an error is detected the rest of the line is skipped.
523
524If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000525backslash in front of the ':' will be removed. Example:
526 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000527This sets the 'dir' option to "c:\tmp". Only a single backslash before the
528':' is removed. Thus to include "\:" you have to specify "\\:".
529
530No other commands than "set" are supported, for security reasons (somebody
531might create a Trojan horse text file with modelines).
532
533Hint: If you would like to do something else than setting an option, you could
534define an autocommand that checks the file for a specific string. For
535example: >
536 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
537And define a function SetVar() that does something with the line containing
538"VAR".
539
540==============================================================================
5413. Options summary *option-summary*
542
543In the list below all the options are mentioned with their full name and with
544an abbreviation if there is one. Both forms may be used.
545
546In this document when a boolean option is "set" that means that ":set option"
547is entered. When an option is "reset", ":set nooption" is used.
548
549For some options there are two default values: The "Vim default", which is
550used when 'compatible' is not set, and the "Vi default", which is used when
551'compatible' is set.
552
553Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000554are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000555different value in each window. For example the 'list' option can be set in
556one window and reset in another for the same text, giving both types of view
557at the same time. There are a few options that are specific to a certain
558file. These can have a different value for each file or buffer. For example
559the 'textwidth' option can be 78 for a normal text file and 0 for a C
560program.
561
562 global one option for all buffers and windows
563 local to window each window has its own copy of this option
564 local to buffer each buffer has its own copy of this option
565
566When creating a new window the option values from the currently active window
567are used as a default value for the window-specific options. For the
568buffer-specific options this depends on the 's' and 'S' flags in the
569'cpoptions' option. If 's' is included (which is the default) the values for
570buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000571first entered. If 'S' is present the options are copied each time the buffer
572is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000573present, the options are copied from the currently active buffer when the
574buffer is created.
575
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000576Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000577
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000578Not all options are supported in all versions. This depends on the supported
579features and sometimes on the system. A remark about this is in curly braces
580below. When an option is not supported it may still be set without getting an
581error, this is called a hidden option. You can't get the value of a hidden
582option though, it is not stored.
583
584To test if option "foo" can be used with ":set" use something like this: >
585 if exists('&foo')
586This also returns true for a hidden option. To test if option "foo" is really
587supported use something like this: >
588 if exists('+foo')
589<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000590 *E355*
591A jump table for the options with a short description can be found at |Q_op|.
592
593 *'aleph'* *'al'* *aleph* *Aleph*
594'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
595 global
596 {not in Vi}
597 {only available when compiled with the |+rightleft|
598 feature}
599 The ASCII code for the first letter of the Hebrew alphabet. The
600 routine that maps the keyboard in Hebrew mode, both in Insert mode
601 (when hkmap is set) and on the command-line (when hitting CTRL-_)
602 outputs the Hebrew characters in the range [aleph..aleph+26].
603 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
604 See |rileft.txt|.
605
606 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
607'allowrevins' 'ari' boolean (default off)
608 global
609 {not in Vi}
610 {only available when compiled with the |+rightleft|
611 feature}
612 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
613 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
614 into reverse Insert mode, and don't know how to get out. See
615 'revins'.
616 NOTE: This option is reset when 'compatible' is set.
617
618 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
619'altkeymap' 'akm' boolean (default off)
620 global
621 {not in Vi}
622 {only available when compiled with the |+farsi|
623 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000624 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000625 the keyboard map between Farsi and English, when 'allowrevins' set.
626
Bram Moolenaar582fd852005-03-28 20:58:01 +0000627 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000628 is useful to start the Vim in native mode i.e. English (left-to-right
629 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000630 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000631
632 *'ambiwidth'* *'ambw'*
633'ambiwidth' 'ambw' string (default: "single")
634 global
635 {not in Vi}
636 {only available when compiled with the |+multi_byte|
637 feature}
638 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
639 Tells Vim what to do with characters with East Asian Width Class
640 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
641 letters, Cyrillic letters).
642
643 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000644 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000645 expected by most users.
646 "double": Use twice the width of ASCII characters.
647
648 There are a number of CJK fonts for which the width of glyphs for
649 those characters are solely based on how many octets they take in
650 legacy/traditional CJK encodings. In those encodings, Euro,
651 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000652 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000653 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000654 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000655 Vim is running inside a terminal (emulators) that uses a CJK font
656 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
657 this option should be set to "double" to match the width perceived
658 by Vim with the width of glyphs in the font. Perhaps it also has
659 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
660 when the system locale is set to one of CJK locales. See Unicode
661 Standard Annex #11 (http://www.unicode.org/reports/tr11).
662
663 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
664'antialias' 'anti' boolean (default: off)
665 global
666 {not in Vi}
667 {only available when compiled with GUI enabled
668 on Mac OS X}
669 This option only has an effect in the GUI version of Vim on Mac OS X
670 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
671 which can be easier to read at certain sizes on certain displays.
672 Setting this option can sometimes cause problems if 'guifont' is set
673 to its default (empty string).
674
675 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
676'autochdir' 'acd' boolean (default off)
677 global
678 {not in Vi}
679 {only available when compiled with the
680 |+netbeans_intg| or |+sun_workshop| feature}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000681 When on, Vim will change the current working directory whenever you
682 open a file, switch buffers, delete a buffer or open/close a window.
683 It will change to the directory containing the file which was opened
684 or selected.
685 This option is provided for backward compatibility with the Vim
686 released with Sun ONE Studio 4 Enterprise Edition.
687 Note: When this option is on some plugins may not work. The directory
688 browser sets if off.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000689
690 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
691'arabic' 'arab' boolean (default off)
692 local to window
693 {not in Vi}
694 {only available when compiled with the |+arabic|
695 feature}
696 This option can be set to start editing Arabic text.
697 Setting this option will:
698 - Set the 'rightleft' option, unless 'termbidi' is set.
699 - Set the 'arabicshape' option, unless 'termbidi' is set.
700 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
701 between typing English and Arabic key mapping.
702 - Set the 'delcombine' option
703 Note that 'encoding' must be "utf-8" for working with Arabic text.
704
705 Resetting this option will:
706 - Reset the 'rightleft' option.
707 - Disable the use of 'keymap' (without changing its value).
708 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
709 option.
710 Also see |arabic.txt|.
711
712 *'arabicshape'* *'arshape'*
713 *'noarabicshape'* *'noarshape'*
714'arabicshape' 'arshape' boolean (default on)
715 global
716 {not in Vi}
717 {only available when compiled with the |+arabic|
718 feature}
719 When on and 'termbidi' is off, the required visual character
720 corrections that need to take place for displaying the Arabic language
721 take affect. Shaping, in essence, gets enabled; the term is a broad
722 one which encompasses:
723 a) the changing/morphing of characters based on their location
724 within a word (initial, medial, final and stand-alone).
725 b) the enabling of the ability to compose characters
726 c) the enabling of the required combining of some characters
727 When disabled the character display reverts back to each character's
728 true stand-alone form.
729 Arabic is a complex language which requires other settings, for
730 further details see |arabic.txt|.
731
732 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
733'autoindent' 'ai' boolean (default off)
734 local to buffer
735 Copy indent from current line when starting a new line (typing <CR>
736 in Insert mode or when using the "o" or "O" command). If you do not
737 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000738 <Esc> or <CR>, the indent is deleted again. Moving the cursor to
739 another line has the same effect, unless the 'I' flag is included in
740 'cpoptions'.
741 When autoindent is on, formatting (with the "gq" command or when you
742 reach 'textwidth' in Insert mode) uses the indentation of the first
743 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000744 When 'smartindent' or 'cindent' is on the indent is changed in
745 a different way.
746 The 'autoindent' option is reset when the 'paste' option is set.
747 {small difference from Vi: After the indent is deleted when typing
748 <Esc> or <CR>, the cursor position when moving up or down is after the
749 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
750
751 *'autoread'* *'ar'* *'noautoread'* *'noar'*
752'autoread' 'ar' boolean (default off)
753 global or local to buffer |global-local|
754 {not in Vi}
755 When a file has been detected to have been changed outside of Vim and
756 it has not been changed inside of Vim, automatically read it again.
757 When the file has been deleted this is not done. |timestamp|
758 If this option has a local value, use this command to switch back to
759 using the global value: >
760 :set autoread<
761<
762 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
763'autowrite' 'aw' boolean (default off)
764 global
765 Write the contents of the file, if it has been modified, on each
766 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
767 :make, CTRL-] and CTRL-^ command; and when a CTRL-O, CTRL-I,
768 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
769 Note that for some commands the 'autowrite' option is not used, see
770 'autowriteall' for that.
771
772 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
773'autowriteall' 'awa' boolean (default off)
774 global
775 {not in Vi}
776 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
777 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
778 Setting this option also implies that Vim behaves like 'autowrite' has
779 been set.
780
781 *'background'* *'bg'*
782'background' 'bg' string (default "dark" or "light")
783 global
784 {not in Vi}
785 When set to "dark", Vim will try to use colors that look good on a
786 dark background. When set to "light", Vim will try to use colors that
787 look good on a light background. Any other value is illegal.
788 Vim tries to set the default value according to the terminal used.
789 This will not always be correct.
790 Setting this option does not change the background color, it tells Vim
791 what the background color looks like. For changing the background
792 color, see |:hi-normal|.
793
794 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000795 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000796 change.
797 When a color scheme is loaded (the "colors_name" variable is set)
798 setting 'background' will cause the color scheme to be reloaded. If
799 the color scheme adjusts to the value of 'background' this will work.
800 However, if the color scheme sets 'background' itself the effect may
801 be undone. First delete the "colors_name" variable when needed.
802
803 When setting 'background' to the default value with: >
804 :set background&
805< Vim will guess the value. In the GUI this should work correctly,
806 in other cases Vim might not be able to guess the right value.
807
808 When starting the GUI, the default value for 'background' will be
809 "light". When the value is not set in the .gvimrc, and Vim detects
810 that the background is actually quite dark, 'background' is set to
811 "dark". But this happens only AFTER the .gvimrc file has been read
812 (because the window needs to be opened to find the actual background
813 color). To get around this, force the GUI window to be opened by
814 putting a ":gui" command in the .gvimrc file, before where the value
815 of 'background' is used (e.g., before ":syntax on").
816 Normally this option would be set in the .vimrc file. Possibly
817 depending on the terminal name. Example: >
818 :if &term == "pcterm"
819 : set background=dark
820 :endif
821< When this option is set, the default settings for the highlight groups
822 will change. To use other settings, place ":highlight" commands AFTER
823 the setting of the 'background' option.
824 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
825 to select the colors for syntax highlighting. After changing this
826 option, you must load syntax.vim again to see the result. This can be
827 done with ":syntax on".
828
829 *'backspace'* *'bs'*
830'backspace' 'bs' string (default "")
831 global
832 {not in Vi}
833 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
834 mode. This is a list of items, separated by commas. Each item allows
835 a way to backspace over something:
836 value effect ~
837 indent allow backspacing over autoindent
838 eol allow backspacing over line breaks (join lines)
839 start allow backspacing over the start of insert; CTRL-W and CTRL-U
840 stop once at the start of insert.
841
842 When the value is empty, Vi compatible backspacing is used.
843
844 For backwards compatibility with version 5.4 and earlier:
845 value effect ~
846 0 same as ":set backspace=" (Vi compatible)
847 1 same as ":set backspace=indent,eol"
848 2 same as ":set backspace=indent,eol,start"
849
850 See |:fixdel| if your <BS> or <Del> key does not do what you want.
851 NOTE: This option is set to "" when 'compatible' is set.
852
853 *'backup'* *'bk'* *'nobackup'* *'nobk'*
854'backup' 'bk' boolean (default off)
855 global
856 {not in Vi}
857 Make a backup before overwriting a file. Leave it around after the
858 file has been successfully written. If you do not want to keep the
859 backup file, but you do want a backup while the file is being
860 written, reset this option and set the 'writebackup' option (this is
861 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000862 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000863 |backup-table| for more explanations.
864 When the 'backupskip' pattern matches, a backup is not made anyway.
865 When 'patchmode' is set, the backup may be renamed to become the
866 oldest version of a file.
867 NOTE: This option is reset when 'compatible' is set.
868
869 *'backupcopy'* *'bkc'*
870'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
871 global
872 {not in Vi}
873 When writing a file and a backup is made, this option tells how it's
874 done. This is a comma separated list of words.
875
876 The main values are:
877 "yes" make a copy of the file and overwrite the original one
878 "no" rename the file and write a new one
879 "auto" one of the previous, what works best
880
881 Extra values that can be combined with the ones above are:
882 "breaksymlink" always break symlinks when writing
883 "breakhardlink" always break hardlinks when writing
884
885 Making a copy and overwriting the original file:
886 - Takes extra time to copy the file.
887 + When the file has special attributes, is a (hard/symbolic) link or
888 has a resource fork, all this is preserved.
889 - When the file is a link the backup will have the name of the link,
890 not of the real file.
891
892 Renaming the file and writing a new one:
893 + It's fast.
894 - Sometimes not all attributes of the file can be copied to the new
895 file.
896 - When the file is a link the new file will not be a link.
897
898 The "auto" value is the middle way: When Vim sees that renaming file
899 is possible without side effects (the attributes can be passed on and
900 and the file is not a link) that is used. When problems are expected,
901 a copy will be made.
902
903 The "breaksymlink" and "breakhardlink" values can be used in
904 combination with any of "yes", "no" and "auto". When included, they
905 force Vim to always break either symbolic or hard links by doing
906 exactly what the "no" option does, renaming the original file to
907 become the backup and writing a new file in its place. This can be
908 useful for example in source trees where all the files are symbolic or
909 hard links and any changes should stay in the local source tree, not
910 be propagated back to the original source.
911 *crontab*
912 One situation where "no" and "auto" will cause problems: A program
913 that opens a file, invokes Vim to edit that file, and then tests if
914 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000915 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000916 example.
917
918 When a copy is made, the original file is truncated and then filled
919 with the new text. This means that protection bits, owner and
920 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000921 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922 group of the backup is set to the group of the original file. If this
923 fails, the protection bits for the group are made the same as for
924 others.
925
926 When the file is renamed this is the other way around: The backup has
927 the same attributes of the original file, and the newly written file
928 is owned by the current user. When the file was a (hard/symbolic)
929 link, the new file will not! That's why the "auto" value doesn't
930 rename when the file is a link. The owner and group of the newly
931 written file will be set to the same ones as the original file, but
932 the system may refuse to do this. In that case the "auto" value will
933 again not rename the file.
934
935 *'backupdir'* *'bdir'*
936'backupdir' 'bdir' string (default for Amiga: ".,t:",
937 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
938 for Unix: ".,~/tmp,~/")
939 global
940 {not in Vi}
941 List of directories for the backup file, separated with commas.
942 - The backup file will be created in the first directory in the list
943 where this is possible.
944 - Empty means that no backup file will be created ('patchmode' is
945 impossible!). Writing may fail because of this.
946 - A directory "." means to put the backup file in the same directory
947 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000948 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000949 put the backup file relative to where the edited file is. The
950 leading "." is replaced with the path name of the edited file.
951 ("." inside a directory name has no special meaning).
952 - Spaces after the comma are ignored, other spaces are considered part
953 of the directory name. To have a space at the start of a directory
954 name, precede it with a backslash.
955 - To include a comma in a directory name precede it with a backslash.
956 - A directory name may end in an '/'.
957 - Environment variables are expanded |:set_env|.
958 - Careful with '\' characters, type one before a space, type two to
959 get one in the option (see |option-backslash|), for example: >
960 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
961< - For backwards compatibility with Vim version 3.0 a '>' at the start
962 of the option is removed.
963 See also 'backup' and 'writebackup' options.
964 If you want to hide your backup files on Unix, consider this value: >
965 :set backupdir=./.backup,~/.backup,.,/tmp
966< You must create a ".backup" directory in each directory and in your
967 home directory for this to work properly.
968 The use of |:set+=| and |:set-=| is preferred when adding or removing
969 directories from the list. This avoids problems when a future version
970 uses another default.
971 This option cannot be set from a |modeline| or in the |sandbox|, for
972 security reasons.
973
974 *'backupext'* *'bex'* *E589*
975'backupext' 'bex' string (default "~", for VMS: "_")
976 global
977 {not in Vi}
978 String which is appended to a file name to make the name of the
979 backup file. The default is quite unusual, because this avoids
980 accidentally overwriting existing files with a backup file. You might
981 prefer using ".bak", but make sure that you don't have files with
982 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000983 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000984
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +0000985 If you like to keep a lot of backups, you could use a BufWritePre
986 autocommand to change 'backupext' just before writing the file to
987 include a timestamp. >
988 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
989< Use 'backupdir' to put the backup in a different directory.
990
Bram Moolenaar071d4272004-06-13 20:20:40 +0000991 *'backupskip'* *'bsk'*
992'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
993 global
994 {not in Vi}
995 {not available when compiled without the |+wildignore|
996 feature}
997 A list of file patterns. When one of the patterns matches with the
998 name of the file which is written, no backup file is created. Both
999 the specified file name and the full path name of the file are used.
1000 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1001 Watch out for special characters, see |option-backslash|.
1002 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001003 default value. "/tmp/*" is only used for Unix.
Bram Moolenaara5792f52005-11-23 21:25:05 +00001004 Note that the default also makes sure that "crontab -e" works (when a
1005 backup would be made by renaming the original file crontab won't see
1006 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001007
1008 *'balloondelay'* *'bdlay'*
1009'balloondelay' 'bdlay' number (default: 600)
1010 global
1011 {not in Vi}
1012 {only available when compiled with the |+balloon_eval|
1013 feature}
1014 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1015
1016 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1017'ballooneval' 'beval' boolean (default off)
1018 global
1019 {not in Vi}
1020 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001021 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001022 Switch on the |balloon-eval| functionality.
1023
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001024 *'balloonexpr'* *'bexpr'*
1025'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001026 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001027 {not in Vi}
1028 {only available when compiled with the |+balloon_eval|
1029 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001030 Expression for text to show in evaluation balloon. It is only used
1031 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001032
1033 v:beval_bufnr number of the buffer in which balloon is going to show
1034 v:beval_winnr number of the window
1035 v:beval_lnum line number
1036 v:beval_col column number (byte index)
1037 v:beval_text word under or after the mouse pointer
1038
1039 The evaluation of the expression must not have side effects!
1040 Example: >
1041 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001042 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001043 \', column ' . v:beval_col .
1044 \ ' of file ' . bufname(v:beval_bufnr) .
1045 \ ' on word "' . v:beval_text . '"'
1046 endfunction
1047 set bexpr=MyBalloonExpr()
1048 set ballooneval
1049<
1050 NOTE: The balloon is displayed only if the cursor is on a text
1051 character. If the result of evaluating 'balloonexpr' is not empty,
1052 Vim does not try to send a message to an external debugger (Netbeans
1053 or Sun Workshop).
1054
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001055 The expression may be evaluated in the |sandbox|, see
1056 |sandbox-option|.
1057
1058 It is not allowed to change text or jump to another window while
1059 evaluating 'balloonexpr' |textlock|.
1060
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001061 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001062 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001063< When they are supported "\n" characters will start a new line. If the
1064 expression evaluates to a |List| this is equal to using each List item
1065 as a string and putting "\n" in between them.
1066
Bram Moolenaar071d4272004-06-13 20:20:40 +00001067 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1068'binary' 'bin' boolean (default off)
1069 local to buffer
1070 {not in Vi}
1071 This option should be set before editing a binary file. You can also
1072 use the |-b| Vim argument. When this option is switched on a few
1073 options will be changed (also when it already was on):
1074 'textwidth' will be set to 0
1075 'wrapmargin' will be set to 0
1076 'modeline' will be off
1077 'expandtab' will be off
1078 Also, 'fileformat' and 'fileformats' options will not be used, the
1079 file is read and written like 'fileformat' was "unix" (a single <NL>
1080 separates lines).
1081 The 'fileencoding' and 'fileencodings' options will not be used, the
1082 file is read without conversion.
1083 NOTE: When you start editing a(nother) file while the 'bin' option is
1084 on, settings from autocommands may change the settings again (e.g.,
1085 'textwidth'), causing trouble when editing. You might want to set
1086 'bin' again when the file has been loaded.
1087 The previous values of these options are remembered and restored when
1088 'bin' is switched from on to off. Each buffer has its own set of
1089 saved option values.
1090 To edit a file with 'binary' set you can use the |++bin| argument.
1091 This avoids you have to do ":set bin", which would have effect for all
1092 files you edit.
1093 When writing a file the <EOL> for the last line is only written if
1094 there was one in the original file (normally Vim appends an <EOL> to
1095 the last line if there is none; this would make the file longer). See
1096 the 'endofline' option.
1097
1098 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1099'bioskey' 'biosk' boolean (default on)
1100 global
1101 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001102 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001103 better to detect CTRL-C, but only works for the console. When using a
1104 terminal over a serial port reset this option.
1105 Also see |'conskey'|.
1106
1107 *'bomb'* *'nobomb'*
1108'bomb' boolean (default off)
1109 local to buffer
1110 {not in Vi}
1111 {only available when compiled with the |+multi_byte|
1112 feature}
1113 When writing a file and the following conditions are met, a BOM (Byte
1114 Order Mark) is prepended to the file:
1115 - this option is on
1116 - the 'binary' option is off
1117 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1118 endian variants.
1119 Some applications use the BOM to recognize the encoding of the file.
1120 Often used for UCS-2 files on MS-Windows. For other applications it
1121 causes trouble, for example: "cat file1 file2" makes the BOM of file2
1122 appear halfway the resulting file.
1123 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1124 check for the presence of the BOM is done and 'bomb' set accordingly.
1125 Unless 'binary' is set, it is removed from the first line, so that you
1126 don't see it when editing. When you don't change the options, the BOM
1127 will be restored when writing the file.
1128
1129 *'breakat'* *'brk'*
1130'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1131 global
1132 {not in Vi}
1133 {not available when compiled without the |+linebreak|
1134 feature}
1135 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001136 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1137 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001138
1139 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001140'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001141 global
1142 {not in Vi} {only for Motif and Win32 GUI}
1143 Which directory to use for the file browser:
1144 last Use same directory as with last file browser.
1145 buffer Use the directory of the related buffer.
1146 current Use the current directory.
1147 {path} Use the specified directory
1148
1149 *'bufhidden'* *'bh'*
1150'bufhidden' 'bh' string (default: "")
1151 local to buffer
1152 {not in Vi}
1153 {not available when compiled without the |+quickfix|
1154 feature}
1155 This option specifies what happens when a buffer is no longer
1156 displayed in a window:
1157 <empty> follow the global 'hidden' option
1158 hide hide the buffer (don't unload it), also when 'hidden'
1159 is not set
1160 unload unload the buffer, also when 'hidden' is set or using
1161 |:hide|
1162 delete delete the buffer from the buffer list, also when
1163 'hidden' is set or using |:hide|, like using
1164 |:bdelete|
1165 wipe wipe out the buffer from the buffer list, also when
1166 'hidden' is set or using |:hide|, like using
1167 |:bwipeout|
1168
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001169 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1170 are lost without a warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001171 This option is used together with 'buftype' and 'swapfile' to specify
1172 special kinds of buffers. See |special-buffers|.
1173
1174 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1175'buflisted' 'bl' boolean (default: on)
1176 local to buffer
1177 {not in Vi}
1178 When this option is set, the buffer shows up in the buffer list. If
1179 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1180 This option is reset by Vim for buffers that are only used to remember
1181 a file name or marks. Vim sets it when starting to edit a buffer.
1182 But not when moving to a buffer with ":buffer".
1183
1184 *'buftype'* *'bt'* *E382*
1185'buftype' 'bt' string (default: "")
1186 local to buffer
1187 {not in Vi}
1188 {not available when compiled without the |+quickfix|
1189 feature}
1190 The value of this option specifies the type of a buffer:
1191 <empty> normal buffer
1192 nofile buffer which is not related to a file and will not be
1193 written
1194 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001195 acwrite buffer which will always be written with BufWriteCmd
1196 autocommands. {not available when compiled without the
1197 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001198 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001199 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001200 help help buffer (you are not supposed to set this
1201 manually)
1202
1203 This option is used together with 'bufhidden' and 'swapfile' to
1204 specify special kinds of buffers. See |special-buffers|.
1205
1206 Be careful with changing this option, it can have many side effects!
1207
Bram Moolenaar280f1262006-01-30 00:14:18 +00001208 A "quickfix" buffer is only used for the error list and the location
1209 list. This value is set by the |:cwindow| and |:lwindow| commands and
1210 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001211
1212 "nofile" and "nowrite" buffers are similar:
1213 both: The buffer is not to be written to disk, ":w" doesn't
1214 work (":w filename" does work though).
1215 both: The buffer is never considered to be |'modified'|.
1216 There is no warning when the changes will be lost, for
1217 example when you quit Vim.
1218 both: A swap file is only created when using too much memory
1219 (when 'swapfile' has been reset there is never a swap
1220 file).
1221 nofile only: The buffer name is fixed, it is not handled like a
1222 file name. It is not modified in response to a |:cd|
1223 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001224 *E676*
1225 "acwrite" implies that the buffer name is not related to a file, like
1226 "nofile", but it will be written. Thus, in contrast to "nofile" and
1227 "nowrite", ":w" does work and a modified buffer can't be abandoned
1228 without saving. For writing there must be matching |BufWriteCmd|,
1229 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001230
1231 *'casemap'* *'cmp'*
1232'casemap' 'cmp' string (default: "internal,keepascii")
1233 global
1234 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001235 {only available when compiled with the |+multi_byte|
1236 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001237 Specifies details about changing the case of letters. It may contain
1238 these words, separated by a comma:
1239 internal Use internal case mapping functions, the current
1240 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001241 matters when 'encoding' is a Unicode encoding,
1242 "latin1" or "iso-8859-15". When "internal" is
1243 omitted, the towupper() and towlower() system library
1244 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001245 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1246 case mapping, the current locale is not effective.
1247 This probably only matters for Turkish.
1248
1249 *'cdpath'* *'cd'* *E344* *E346*
1250'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1251 global
1252 {not in Vi}
1253 {not available when compiled without the
1254 |+file_in_path| feature}
1255 This is a list of directories which will be searched when using the
1256 |:cd| and |:lcd| commands, provided that the directory being searched
1257 for has a relative path (not starting with "/", "./" or "../").
1258 The 'cdpath' option's value has the same form and semantics as
1259 |'path'|. Also see |file-searching|.
1260 The default value is taken from $CDPATH, with a "," prepended to look
1261 in the current directory first.
1262 If the default value taken from $CDPATH is not what you want, include
1263 a modified version of the following command in your vimrc file to
1264 override it: >
1265 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1266< This option cannot be set from a |modeline| or in the |sandbox|, for
1267 security reasons.
1268 (parts of 'cdpath' can be passed to the shell to expand file names).
1269
1270 *'cedit'*
1271'cedit' string (Vi default: "", Vim default: CTRL-F)
1272 global
1273 {not in Vi}
1274 {not available when compiled without the |+vertsplit|
1275 feature}
1276 The key used in Command-line Mode to open the command-line window.
1277 The default is CTRL-F when 'compatible' is off.
1278 Only non-printable keys are allowed.
1279 The key can be specified as a single character, but it is difficult to
1280 type. The preferred way is to use the <> notation. Examples: >
1281 :set cedit=<C-Y>
1282 :set cedit=<Esc>
1283< |Nvi| also has this option, but it only uses the first character.
1284 See |cmdwin|.
1285
1286 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1287'charconvert' 'ccv' string (default "")
1288 global
1289 {only available when compiled with the |+multi_byte|
1290 feature and the |+eval| feature}
1291 {not in Vi}
1292 An expression that is used for character encoding conversion. It is
1293 evaluated when a file that is to be read or has been written has a
1294 different encoding from what is desired.
1295 'charconvert' is not used when the internal iconv() function is
1296 supported and is able to do the conversion. Using iconv() is
1297 preferred, because it is much faster.
1298 'charconvert' is not used when reading stdin |--|, because there is no
1299 file to convert from. You will have to save the text in a file first.
1300 The expression must return zero or an empty string for success,
1301 non-zero for failure.
1302 The possible encoding names encountered are in 'encoding'.
1303 Additionally, names given in 'fileencodings' and 'fileencoding' are
1304 used.
1305 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1306 is done internally by Vim, 'charconvert' is not used for this.
1307 'charconvert' is also used to convert the viminfo file, if the 'c'
1308 flag is present in 'viminfo'. Also used for Unicode conversion.
1309 Example: >
1310 set charconvert=CharConvert()
1311 fun CharConvert()
1312 system("recode "
1313 \ . v:charconvert_from . ".." . v:charconvert_to
1314 \ . " <" . v:fname_in . " >" v:fname_out)
1315 return v:shell_error
1316 endfun
1317< The related Vim variables are:
1318 v:charconvert_from name of the current encoding
1319 v:charconvert_to name of the desired encoding
1320 v:fname_in name of the input file
1321 v:fname_out name of the output file
1322 Note that v:fname_in and v:fname_out will never be the same.
1323 Note that v:charconvert_from and v:charconvert_to may be different
1324 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1325 Encryption is not done by Vim when using 'charconvert'. If you want
1326 to encrypt the file after conversion, 'charconvert' should take care
1327 of this.
1328 This option cannot be set from a |modeline| or in the |sandbox|, for
1329 security reasons.
1330
1331 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1332'cindent' 'cin' boolean (default off)
1333 local to buffer
1334 {not in Vi}
1335 {not available when compiled without the |+cindent|
1336 feature}
1337 Enables automatic C program indenting See 'cinkeys' to set the keys
1338 that trigger reindenting in insert mode and 'cinoptions' to set your
1339 preferred indent style.
1340 If 'indentexpr' is not empty, it overrules 'cindent'.
1341 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1342 the "=" operator indents using this algorithm rather than calling an
1343 external program.
1344 See |C-indenting|.
1345 When you don't like the way 'cindent' works, try the 'smartindent'
1346 option or 'indentexpr'.
1347 This option is not used when 'paste' is set.
1348 NOTE: This option is reset when 'compatible' is set.
1349
1350 *'cinkeys'* *'cink'*
1351'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1352 local to buffer
1353 {not in Vi}
1354 {not available when compiled without the |+cindent|
1355 feature}
1356 A list of keys that, when typed in Insert mode, cause reindenting of
1357 the current line. Only used if 'cindent' is on and 'indentexpr' is
1358 empty.
1359 For the format of this option see |cinkeys-format|.
1360 See |C-indenting|.
1361
1362 *'cinoptions'* *'cino'*
1363'cinoptions' 'cino' string (default "")
1364 local to buffer
1365 {not in Vi}
1366 {not available when compiled without the |+cindent|
1367 feature}
1368 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1369 program. See |cinoptions-values| for the values of this option, and
1370 |C-indenting| for info on C indenting in general.
1371
1372
1373 *'cinwords'* *'cinw'*
1374'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1375 local to buffer
1376 {not in Vi}
1377 {not available when compiled without both the
1378 |+cindent| and the |+smartindent| features}
1379 These keywords start an extra indent in the next line when
1380 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1381 an appropriate place (inside {}).
1382 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1383 matter, include the keyword both the uppercase and lowercase:
1384 "if,If,IF".
1385
1386 *'clipboard'* *'cb'*
1387'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1388 for X-windows, "" otherwise)
1389 global
1390 {not in Vi}
1391 {only in GUI versions or when the |+xterm_clipboard|
1392 feature is included}
1393 This option is a list of comma separated names.
1394 These names are recognized:
1395
1396 unnamed When included, Vim will use the clipboard register '*'
1397 for all yank, delete, change and put operations which
1398 would normally go to the unnamed register. When a
1399 register is explicitly specified, it will always be
1400 used regardless of whether "unnamed" is in 'clipboard'
1401 or not. The clipboard register can always be
1402 explicitly accessed using the "* notation. Also see
1403 |gui-clipboard|.
1404
1405 autoselect Works like the 'a' flag in 'guioptions': If present,
1406 then whenever Visual mode is started, or the Visual
1407 area extended, Vim tries to become the owner of the
1408 windowing system's global selection or put the
1409 selected text on the clipboard used by the selection
1410 register "*. See |guioptions_a| and |quotestar| for
1411 details. When the GUI is active, the 'a' flag in
1412 'guioptions' is used, when the GUI is not active, this
1413 "autoselect" flag is used.
1414 Also applies to the modeless selection.
1415
1416 autoselectml Like "autoselect", but for the modeless selection
1417 only. Compare to the 'A' flag in 'guioptions'.
1418
1419 exclude:{pattern}
1420 Defines a pattern that is matched against the name of
1421 the terminal 'term'. If there is a match, no
1422 connection will be made to the X server. This is
1423 useful in this situation:
1424 - Running Vim in a console.
1425 - $DISPLAY is set to start applications on another
1426 display.
1427 - You do not want to connect to the X server in the
1428 console, but do want this in a terminal emulator.
1429 To never connect to the X server use: >
1430 exclude:.*
1431< This has the same effect as using the |-X| argument.
1432 Note that when there is no connection to the X server
1433 the window title won't be restored and the clipboard
1434 cannot be accessed.
1435 The value of 'magic' is ignored, {pattern} is
1436 interpreted as if 'magic' was on.
1437 The rest of the option value will be used for
1438 {pattern}, this must be the last entry.
1439
1440 *'cmdheight'* *'ch'*
1441'cmdheight' 'ch' number (default 1)
1442 global
1443 {not in Vi}
1444 Number of screen lines to use for the command-line. Helps avoiding
1445 |hit-enter| prompts.
1446
1447 *'cmdwinheight'* *'cwh'*
1448'cmdwinheight' 'cwh' number (default 7)
1449 global
1450 {not in Vi}
1451 {not available when compiled without the |+vertsplit|
1452 feature}
1453 Number of screen lines to use for the command-line window. |cmdwin|
1454
1455 *'columns'* *'co'* *E594*
1456'columns' 'co' number (default 80 or terminal width)
1457 global
1458 {not in Vi}
1459 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001460 initialization and does not have to be set by hand. Also see
1461 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001462 When Vim is running in the GUI or in a resizable window, setting this
1463 option will cause the window size to be changed. When you only want
1464 to use the size for the GUI, put the command in your |gvimrc| file.
1465 When you set this option and Vim is unable to change the physical
1466 number of columns of the display, the display may be messed up.
Bram Moolenaarf4d11452005-12-02 00:46:37 +00001467 Mimimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001468
1469 *'comments'* *'com'* *E524* *E525*
1470'comments' 'com' string (default
1471 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1472 local to buffer
1473 {not in Vi}
1474 {not available when compiled without the |+comments|
1475 feature}
1476 A comma separated list of strings that can start a comment line. See
1477 |format-comments|. See |option-backslash| about using backslashes to
1478 insert a space.
1479
1480 *'commentstring'* *'cms'* *E537*
1481'commentstring' 'cms' string (default "/*%s*/")
1482 local to buffer
1483 {not in Vi}
1484 {not available when compiled without the |+folding|
1485 feature}
1486 A template for a comment. The "%s" in the value is replaced with the
1487 comment text. Currently only used to add markers for folding, see
1488 |fold-marker|.
1489
1490 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaard042c562005-06-30 22:04:15 +00001491'compatible' 'cp' boolean (default on, off when a .vimrc or .gvimrc file
1492 is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001493 global
1494 {not in Vi}
1495 This option has the effect of making Vim either more Vi-compatible, or
1496 make Vim behave in a more useful way.
1497 This is a special kind of option, because when it's set or reset,
1498 other options are also changed as a side effect. CAREFUL: Setting or
1499 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001500 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001501 set this option in your vimrc file, you should probably put it at the
1502 very start.
1503 By default this option is on and the Vi defaults are used for the
1504 options. This default was chosen for those people who want to use Vim
1505 just like Vi, and don't even (want to) know about the 'compatible'
1506 option.
Bram Moolenaard042c562005-06-30 22:04:15 +00001507 When a ".vimrc" or ".gvimrc" file is found while Vim is starting up,
1508 this option is switched off, and all options that have not been
1509 modified will be set to the Vim defaults. Effectively, this means
1510 that when a ".vimrc" or ".gvimrc" file exists, Vim will use the Vim
1511 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
1512 happen for the system-wide vimrc or gvimrc file). Also see
1513 |compatible-default| and |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001514 You can also set this option with the "-C" argument, and reset it with
1515 "-N". See |-C| and |-N|.
1516 Switching this option off makes the Vim defaults be used for options
1517 that have a different Vi and Vim default value. See the options
1518 marked with a '+' below. Other options are not modified.
1519 At the moment this option is set, several other options will be set
1520 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001521 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001522 editing.
1523 See also 'cpoptions'.
1524
1525 option + set value effect ~
1526
1527 'allowrevins' off no CTRL-_ command
1528 'backupcopy' Unix: "yes" backup file is a copy
1529 others: "auto" copy or rename backup file
1530 'backspace' "" normal backspace
1531 'backup' off no backup file
1532 'cindent' off no C code indentation
1533 'cedit' + "" no key to open the |cmdwin|
1534 'cpoptions' + (all flags) Vi-compatible flags
1535 'cscopetag' off don't use cscope for ":tag"
1536 'cscopetagorder' 0 see |cscopetagorder|
1537 'cscopeverbose' off see |cscopeverbose|
1538 'digraph' off no digraphs
1539 'esckeys' + off no <Esc>-keys in Insert mode
1540 'expandtab' off tabs not expanded to spaces
1541 'fileformats' + "" no automatic file format detection,
1542 "dos,unix" except for DOS, Windows and OS/2
1543 'formatoptions' + "vt" Vi compatible formatting
1544 'gdefault' off no default 'g' flag for ":s"
1545 'history' + 0 no commandline history
1546 'hkmap' off no Hebrew keyboard mapping
1547 'hkmapp' off no phonetic Hebrew keyboard mapping
1548 'hlsearch' off no highlighting of search matches
1549 'incsearch' off no incremental searching
1550 'indentexpr' "" no indenting by expression
1551 'insertmode' off do not start in Insert mode
1552 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1553 characters and '_'
1554 'joinspaces' on insert 2 spaces after period
1555 'modeline' + off no modelines
1556 'more' + off no pauses in listings
1557 'revins' off no reverse insert
1558 'ruler' off no ruler
1559 'scrolljump' 1 no jump scroll
1560 'scrolloff' 0 no scroll offset
1561 'shiftround' off indent not rounded to shiftwidth
1562 'shortmess' + "" no shortening of messages
1563 'showcmd' + off command characters not shown
1564 'showmode' + off current mode not shown
1565 'smartcase' off no automatic ignore case switch
1566 'smartindent' off no smart indentation
1567 'smarttab' off no smart tab size
1568 'softtabstop' 0 tabs are always 'tabstop' positions
1569 'startofline' on goto startofline with some commands
1570 'tagrelative' + off tag file names are not relative
1571 'textauto' + off no automatic textmode detection
1572 'textwidth' 0 no automatic line wrap
1573 'tildeop' off tilde is not an operator
1574 'ttimeout' off no terminal timeout
1575 'whichwrap' + "" left-right movements don't wrap
1576 'wildchar' + CTRL-E only when the current value is <Tab>
1577 use CTRL-E for cmdline completion
1578 'writebackup' on or off depends on +writebackup feature
1579
1580 *'complete'* *'cpt'* *E535*
1581'complete' 'cpt' string (default: ".,w,b,u,t,i")
1582 local to buffer
1583 {not in Vi}
1584 This option specifies how keyword completion |ins-completion| works
1585 when CTRL-P or CTRL-N are used. It is also used for whole-line
1586 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1587 and the places to scan. It is a comma separated list of flags:
1588 . scan the current buffer ('wrapscan' is ignored)
1589 w scan buffers from other windows
1590 b scan other loaded buffers that are in the buffer list
1591 u scan the unloaded buffers that are in the buffer list
1592 U scan the buffers that are not in the buffer list
1593 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001594 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001595 k{dict} scan the file {dict}. Several "k" flags can be given,
1596 patterns are valid too. For example: >
1597 :set cpt=k/usr/dict/*,k~/spanish
1598< s scan the files given with the 'thesaurus' option
1599 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1600 are valid too.
1601 i scan current and included files
1602 d scan current and included files for defined name or macro
1603 |i_CTRL-X_CTRL-D|
1604 ] tag completion
1605 t same as "]"
1606
1607 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1608 not executed, this may lead to unexpected completions from some files
1609 (gzipped files for example). Unloaded buffers are not scanned for
1610 whole-line completion.
1611
1612 The default is ".,w,b,u,t,i", which means to scan:
1613 1. the current buffer
1614 2. buffers in other windows
1615 3. other loaded buffers
1616 4. unloaded buffers
1617 5. tags
1618 6. included files
1619
1620 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001621 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1622 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001623
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001624 *'completefunc'* *'cfu'*
1625'completefunc' 'cfu' string (default: empty)
1626 local to buffer
1627 {not in Vi}
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001628 {not available when compiled without the +eval
1629 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001630 This option specifies a function to be used for Insert mode completion
1631 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001632 See |complete-functions| for an explanation of how the function is
1633 invoked and what it should return.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001634
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001635
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001636 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001637'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001638 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001639 {not available when compiled without the
1640 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001641 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001642 A comma separated list of options for Insert mode completion
1643 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001644
1645 menu Use a popup menu to show the possible completions. The
1646 menu is only shown when there is more than one match and
1647 sufficient colors are available. |ins-completion-menu|
1648
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001649 menuone Use the popup menu also when there is only one match.
1650 Useful when there is additional information about the
1651 match, e.g., what file it comes from.
1652
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001653 longest Only insert the longest common text of the matches. Use
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001654 CTRL-L to add more characters. Whether case is ignored
Bram Moolenaard1f56e62006-02-22 21:25:37 +00001655 depends on the kind of completion. For buffer text the
1656 'ignorecase' option is used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001657
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001658 preview Show extra information about the currently selected
1659 completion in the preview window.
1660
Bram Moolenaar071d4272004-06-13 20:20:40 +00001661 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1662'confirm' 'cf' boolean (default off)
1663 global
1664 {not in Vi}
1665 When 'confirm' is on, certain operations that would normally
1666 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1667 instead raise a |dialog| asking if you wish to save the current
1668 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1669 If 'confirm' is off you can still activate confirmation for one
1670 command only (this is most useful in mappings) with the |:confirm|
1671 command.
1672 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1673
1674 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1675'conskey' 'consk' boolean (default off)
1676 global
1677 {not in Vi} {only for MS-DOS}
1678 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001679 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001680 three methods of console input are available:
1681 'conskey' 'bioskey' action ~
1682 on on or off direct console input
1683 off on BIOS
1684 off off STDIN
1685
1686 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1687'copyindent' 'ci' boolean (default off)
1688 local to buffer
1689 {not in Vi}
1690 Copy the structure of the existing lines indent when autoindenting a
1691 new line. Normally the new indent is reconstructed by a series of
1692 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1693 in which case only spaces are used). Enabling this option makes the
1694 new line copy whatever characters were used for indenting on the
1695 existing line. If the new indent is greater than on the existing
1696 line, the remaining space is filled in the normal manner.
1697 NOTE: 'copyindent' is reset when 'compatible' is set.
1698 Also see 'preserveindent'.
1699
1700 *'cpoptions'* *'cpo'*
1701'cpoptions' 'cpo' string (Vim default: "aABceFs",
1702 Vi default: all flags)
1703 global
1704 {not in Vi}
1705 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001706 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001707 not being vi-compatible is mostly or sometimes preferred.
1708 'cpoptions' stands for "compatible-options".
1709 Commas can be added for readability.
1710 To avoid problems with flags that are added in the future, use the
1711 "+=" and "-=" feature of ":set" |add-option-flags|.
1712 NOTE: This option is set to the Vi default value when 'compatible' is
1713 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001714 NOTE: This option is set to the POSIX default value at startup when
1715 the Vi default value would be used and the $VIM_POSIX environment
1716 variable exists |posix|. This means tries to behave like the POSIX
1717 specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001718
1719 contains behavior ~
1720 *cpo-a*
1721 a When included, a ":read" command with a file name
1722 argument will set the alternate file name for the
1723 current window.
1724 *cpo-A*
1725 A When included, a ":write" command with a file name
1726 argument will set the alternate file name for the
1727 current window.
1728 *cpo-b*
1729 b "\|" in a ":map" command is recognized as the end of
1730 the map command. The '\' is included in the mapping,
1731 the text after the '|' is interpreted as the next
1732 command. Use a CTRL-V instead of a backslash to
1733 include the '|' in the mapping. Applies to all
1734 mapping, abbreviation, menu and autocmd commands.
1735 See also |map_bar|.
1736 *cpo-B*
1737 B A backslash has no special meaning in mappings,
1738 abbreviations and the "to" part of the menu commands.
1739 Remove this flag to be able to use a backslash like a
1740 CTRL-V. For example, the command ":map X \<Esc>"
1741 results in X being mapped to:
1742 'B' included: "\^[" (^[ is a real <Esc>)
1743 'B' excluded: "<Esc>" (5 characters)
1744 ('<' excluded in both cases)
1745 *cpo-c*
1746 c Searching continues at the end of any match at the
1747 cursor position, but not further than the start of the
1748 next line. When not present searching continues
1749 one character from the cursor position. With 'c'
1750 "abababababab" only gets three matches when repeating
1751 "/abab", without 'c' there are five matches.
1752 *cpo-C*
1753 C Do not concatenate sourced lines that start with a
1754 backslash. See |line-continuation|.
1755 *cpo-d*
1756 d Using "./" in the 'tags' option doesn't mean to use
1757 the tags file relative to the current file, but the
1758 tags file in the current directory.
1759 *cpo-D*
1760 D Can't use CTRL-K to enter a digraph after Normal mode
1761 commands with a character argument, like |r|, |f| and
1762 |t|.
1763 *cpo-e*
1764 e When executing a register with ":@r", always add a
1765 <CR> to the last line, also when the register is not
1766 linewise. If this flag is not present, the register
1767 is not linewise and the last line does not end in a
1768 <CR>, then the last line is put on the command-line
1769 and can be edited before hitting <CR>.
1770 *cpo-E*
1771 E It is an error when using "y", "d", "c", "g~", "gu" or
1772 "gU" on an Empty region. The operators only work when
1773 at least one character is to be operate on. Example:
1774 This makes "y0" fail in the first column.
1775 *cpo-f*
1776 f When included, a ":read" command with a file name
1777 argument will set the file name for the current buffer,
1778 if the current buffer doesn't have a file name yet.
1779 *cpo-F*
1780 F When included, a ":write" command with a file name
1781 argument will set the file name for the current
1782 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001783 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784 *cpo-g*
1785 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001786 *cpo-H*
1787 H When using "I" on a line with only blanks, insert
1788 before the last blank. Without this flag insert after
1789 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001790 *cpo-i*
1791 i When included, interrupting the reading of a file will
1792 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001793 *cpo-I*
1794 I When moving the cursor up or down just after inserting
1795 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001796 *cpo-j*
1797 j When joining lines, only add two spaces after a '.',
1798 not after '!' or '?'. Also see 'joinspaces'.
1799 *cpo-J*
1800 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001801 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001802 white space.
1803 *cpo-k*
1804 k Disable the recognition of raw key codes in
1805 mappings, abbreviations, and the "to" part of menu
1806 commands. For example, if <Key> sends ^[OA (where ^[
1807 is <Esc>), the command ":map X ^[OA" results in X
1808 being mapped to:
1809 'k' included: "^[OA" (3 characters)
1810 'k' excluded: "<Key>" (one key code)
1811 Also see the '<' flag below.
1812 *cpo-K*
1813 K Don't wait for a key code to complete when it is
1814 halfway a mapping. This breaks mapping <F1><F1> when
1815 only part of the second <F1> has been read. It
1816 enables cancelling the mapping by typing <F1><Esc>.
1817 *cpo-l*
1818 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001819 literally, only "\]", "\^", "\-" and "\\" are special.
1820 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001821 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1822 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001823 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001824 *cpo-L*
1825 L When the 'list' option is set, 'wrapmargin',
1826 'textwidth', 'softtabstop' and Virtual Replace mode
1827 (see |gR|) count a <Tab> as two characters, instead of
1828 the normal behavior of a <Tab>.
1829 *cpo-m*
1830 m When included, a showmatch will always wait half a
1831 second. When not included, a showmatch will wait half
1832 a second or until a character is typed. |'showmatch'|
1833 *cpo-M*
1834 M When excluded, "%" matching will take backslashes into
1835 account. Thus in "( \( )" and "\( ( \)" the outer
1836 parenthesis match. When included "%" ignores
1837 backslashes, which is Vi compatible.
1838 *cpo-n*
1839 n When included, the column used for 'number' will also
1840 be used for text of wrapped lines.
1841 *cpo-o*
1842 o Line offset to search command is not remembered for
1843 next search.
1844 *cpo-O*
1845 O Don't complain if a file is being overwritten, even
1846 when it didn't exist when editing it. This is a
1847 protection against a file unexpectedly created by
1848 someone else. Vi didn't complain about this.
1849 *cpo-p*
1850 p Vi compatible Lisp indenting. When not present, a
1851 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001852 *cpo-P*
1853 P When included, a ":write" command that appends to a
1854 file will set the file name for the current buffer, if
1855 the current buffer doesn't have a file name yet and
1856 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001857 *cpo-q*
1858 q When joining multiple lines leave the cursor at the
1859 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001860 *cpo-r*
1861 r Redo ("." command) uses "/" to repeat a search
1862 command, instead of the actually used search string.
1863 *cpo-R*
1864 R Remove marks from filtered lines. Without this flag
1865 marks are kept like |:keepmarks| was used.
1866 *cpo-s*
1867 s Set buffer options when entering the buffer for the
1868 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001869 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001870 set when the buffer is created.
1871 *cpo-S*
1872 S Set buffer options always when entering a buffer
1873 (except 'readonly', 'fileformat', 'filetype' and
1874 'syntax'). This is the (most) Vi compatible setting.
1875 The options are set to the values in the current
1876 buffer. When you change an option and go to another
1877 buffer, the value is copied. Effectively makes the
1878 buffer options global to all buffers.
1879
1880 's' 'S' copy buffer options
1881 no no when buffer created
1882 yes no when buffer first entered (default)
1883 X yes each time when buffer entered (vi comp.)
1884 *cpo-t*
1885 t Search pattern for the tag command is remembered for
1886 "n" command. Otherwise Vim only puts the pattern in
1887 the history for search pattern, but doesn't change the
1888 last used search pattern.
1889 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001890 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001891 *cpo-v*
1892 v Backspaced characters remain visible on the screen in
1893 Insert mode. Without this flag the characters are
1894 erased from the screen right away. With this flag the
1895 screen newly typed text overwrites backspaced
1896 characters.
1897 *cpo-w*
1898 w When using "cw" on a blank character, only change one
1899 character and not all blanks until the start of the
1900 next word.
1901 *cpo-W*
1902 W Don't overwrite a readonly file. When omitted, ":w!"
1903 overwrites a readonly file, if possible.
1904 *cpo-x*
1905 x <Esc> on the command-line executes the command-line.
1906 The default in Vim is to abandon the command-line,
1907 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001908 *cpo-X*
1909 X When using a count with "R" the replaced text is
1910 deleted only once. Also when repeating "R" with "."
1911 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001912 *cpo-y*
1913 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001914 *cpo-Z*
1915 Z When using "w!" while the 'readonly' option is set,
1916 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001917 *cpo-!*
1918 ! When redoing a filter command, use the last used
1919 external command, whatever it was. Otherwise the last
1920 used -filter- command is used.
1921 *cpo-$*
1922 $ When making a change to one line, don't redisplay the
1923 line, but put a '$' at the end of the changed text.
1924 The changed text will be overwritten when you type the
1925 new text. The line is redisplayed if you type any
1926 command that moves the cursor from the insertion
1927 point.
1928 *cpo-%*
1929 % Vi-compatible matching is done for the "%" command.
1930 Does not recognize "#if", "#endif", etc.
1931 Does not recognize "/*" and "*/".
1932 Parens inside single and double quotes are also
1933 counted, causing a string that contains a paren to
1934 disturb the matching. For example, in a line like
1935 "if (strcmp("foo(", s))" the first paren does not
1936 match the last one. When this flag is not included,
1937 parens inside single and double quotes are treated
1938 specially. When matching a paren outside of quotes,
1939 everything inside quotes is ignored. When matching a
1940 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001941 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001942 This flag is also used for other features, such as
1943 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001944 *cpo--*
1945 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001946 it would go above the first line or below the last
1947 line. Without it the cursor moves to the first or
1948 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001949 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001950 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001951 *cpo-+*
1952 + When included, a ":write file" command will reset the
1953 'modified' flag of the buffer, even though the buffer
1954 itself may still be different from its file.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001955 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001956 * Use ":*" in the same way as ":@". When not included,
1957 ":*" is an alias for ":'<,'>", select the Visual area.
1958 *cpo-<*
1959 < Disable the recognition of special key codes in |<>|
1960 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001961 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001962 ":map X <Tab>" results in X being mapped to:
1963 '<' included: "<Tab>" (5 characters)
1964 '<' excluded: "^I" (^I is a real <Tab>)
1965 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001966 *cpo->*
1967 > When appending to a register, put a line break before
1968 the appended text.
1969
1970 POSIX flags. These are not included in the Vi default value, except
1971 when $VIM_POSIX was set on startup. |posix|
1972
1973 contains behavior ~
1974 *cpo-#*
1975 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001976 *cpo-&*
1977 & When ":preserve" was used keep the swap file when
1978 exiting normally while this buffer is still loaded.
1979 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001980 *cpo-\*
1981 \ Backslash in a [] range in a search pattern is taken
1982 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00001983 '\' included: "/[ \-]" finds <Space>, '\' and '-'
1984 '\' excluded: "/[ \-]" finds <Space> and '-'
1985 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001986 *cpo-/*
1987 / When "%" is used as the replacement string in a |:s|
1988 command, use the previous replacement string. |:s%|
1989 *cpo-{*
1990 { The |{| and |}| commands also stop at a "{" character
1991 at the start of a line.
1992 *cpo-.*
1993 . The ":chdir" and ":cd" commands fail if the current
1994 buffer is modified, unless ! is used. Vim doesn't
1995 need this, since it remembers the full path of an
1996 opened file.
1997 *cpo-bar*
1998 | The value of the $LINES and $COLUMNS environment
1999 variables overrule the terminal size values obtained
2000 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002001
Bram Moolenaar071d4272004-06-13 20:20:40 +00002002
2003 *'cscopepathcomp'* *'cspc'*
2004'cscopepathcomp' 'cspc' number (default 0)
2005 global
2006 {not available when compiled without the |+cscope|
2007 feature}
2008 {not in Vi}
2009 Determines how many components of the path to show in a list of tags.
2010 See |cscopepathcomp|.
2011
2012 *'cscopeprg'* *'csprg'*
2013'cscopeprg' 'csprg' string (default "cscope")
2014 global
2015 {not available when compiled without the |+cscope|
2016 feature}
2017 {not in Vi}
2018 Specifies the command to execute cscope. See |cscopeprg|.
2019 This option cannot be set from a |modeline| or in the |sandbox|, for
2020 security reasons.
2021
2022 *'cscopequickfix'* *'csqf'*
2023'cscopequickfix' 'csqf' string (default "")
2024 global
2025 {not available when compiled without the |+cscope|
2026 or |+quickfix| features}
2027 {not in Vi}
2028 Specifies whether to use quickfix window to show cscope results.
2029 See |cscopequickfix|.
2030
2031 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2032'cscopetag' 'cst' boolean (default off)
2033 global
2034 {not available when compiled without the |+cscope|
2035 feature}
2036 {not in Vi}
2037 Use cscope for tag commands. See |cscope-options|.
2038 NOTE: This option is reset when 'compatible' is set.
2039
2040 *'cscopetagorder'* *'csto'*
2041'cscopetagorder' 'csto' number (default 0)
2042 global
2043 {not available when compiled without the |+cscope|
2044 feature}
2045 {not in Vi}
2046 Determines the order in which ":cstag" performs a search. See
2047 |cscopetagorder|.
2048 NOTE: This option is set to 0 when 'compatible' is set.
2049
2050 *'cscopeverbose'* *'csverb'*
2051 *'nocscopeverbose'* *'nocsverb'*
2052'cscopeverbose' 'csverb' boolean (default off)
2053 global
2054 {not available when compiled without the |+cscope|
2055 feature}
2056 {not in Vi}
2057 Give messages when adding a cscope database. See |cscopeverbose|.
2058 NOTE: This option is reset when 'compatible' is set.
2059
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002060
2061 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2062'cursorcolumn' 'cuc' boolean (default off)
2063 local to window
2064 {not in Vi}
2065 {not available when compiled without the |+syntax|
2066 feature}
2067 Highlight the screen column of the cursor with CursorColumn
2068 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2069 slower.
2070
2071 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2072'cursorline' 'cul' boolean (default off)
2073 local to window
2074 {not in Vi}
2075 {not available when compiled without the |+syntax|
2076 feature}
2077 Highlight the screen line of the cursor with CursorLine
2078 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2079 redrawing slower.
2080
2081
Bram Moolenaar071d4272004-06-13 20:20:40 +00002082 *'debug'*
2083'debug' string (default "")
2084 global
2085 {not in Vi}
2086 When set to "msg", error messages that would otherwise be omitted will
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002087 be given anyway. This is useful when debugging 'foldexpr',
2088 'formatexpr' or 'indentexpr'.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002089 When set to "beep", a message will be given when otherwise only a beep
2090 would be produced.
2091 The values can be combined, separated by a comma.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002092
2093 *'define'* *'def'*
2094'define' 'def' string (default "^\s*#\s*define")
2095 global or local to buffer |global-local|
2096 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002097 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002098 pattern, just like for the "/" command. This option is used for the
2099 commands like "[i" and "[d" |include-search|. The 'isident' option is
2100 used to recognize the defined name after the match:
2101 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2102 See |option-backslash| about inserting backslashes to include a space
2103 or backslash.
2104 The default value is for C programs. For C++ this value would be
2105 useful, to include const type declarations: >
2106 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2107< When using the ":set" command, you need to double the backslashes!
2108
2109 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2110'delcombine' 'deco' boolean (default off)
2111 global
2112 {not in Vi}
2113 {only available when compiled with the |+multi_byte|
2114 feature}
2115 If editing Unicode and this option is set, backspace and Normal mode
2116 "x" delete each combining character on its own. When it is off (the
2117 default) the character along with its combining characters are
2118 deleted.
2119 Note: When 'delcombine' is set "xx" may work different from "2x"!
2120
2121 This is useful for Arabic, Hebrew and many other languages where one
2122 may have combining characters overtop of base characters, and want
2123 to remove only the combining ones.
2124
2125 *'dictionary'* *'dict'*
2126'dictionary' 'dict' string (default "")
2127 global or local to buffer |global-local|
2128 {not in Vi}
2129 List of file names, separated by commas, that are used to lookup words
2130 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2131 contain a list of words. This can be one word per line, or several
2132 words per line, separated by non-keyword characters (white space is
2133 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002134 When this option is empty, or an entry "spell" is present, spell
2135 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002136 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002137 after a comma are ignored, otherwise spaces are included in the file
2138 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002139 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002140 Where to find a list of words?
2141 - On FreeBSD, there is the file "/usr/share/dict/words".
2142 - In the Simtel archive, look in the "msdos/linguist" directory.
2143 - In "miscfiles" of the GNU collection.
2144 The use of |:set+=| and |:set-=| is preferred when adding or removing
2145 directories from the list. This avoids problems when a future version
2146 uses another default.
2147 Backticks cannot be used in this option for security reasons.
2148
2149 *'diff'* *'nodiff'*
2150'diff' boolean (default off)
2151 local to window
2152 {not in Vi}
2153 {not available when compiled without the |+diff|
2154 feature}
2155 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002156 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002157
2158 *'dex'* *'diffexpr'*
2159'diffexpr' 'dex' string (default "")
2160 global
2161 {not in Vi}
2162 {not available when compiled without the |+diff|
2163 feature}
2164 Expression which is evaluated to obtain an ed-style diff file from two
2165 versions of a file. See |diff-diffexpr|.
2166 This option cannot be set from a |modeline| or in the |sandbox|, for
2167 security reasons.
2168
2169 *'dip'* *'diffopt'*
2170'diffopt' 'dip' string (default "filler")
2171 global
2172 {not in Vi}
2173 {not available when compiled without the |+diff|
2174 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002175 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002176 All are optional. Items must be separated by a comma.
2177
2178 filler Show filler lines, to keep the text
2179 synchronized with a window that has inserted
2180 lines at the same position. Mostly useful
2181 when windows are side-by-side and 'scrollbind'
2182 is set.
2183
2184 context:{n} Use a context of {n} lines between a change
2185 and a fold that contains unchanged lines.
2186 When omitted a context of six lines is used.
2187 See |fold-diff|.
2188
2189 icase Ignore changes in case of text. "a" and "A"
2190 are considered the same. Adds the "-i" flag
2191 to the "diff" command if 'diffexpr' is empty.
2192
2193 iwhite Ignore changes in amount of white space. Adds
2194 the "-b" flag to the "diff" command if
2195 'diffexpr' is empty. Check the documentation
2196 of the "diff" command for what this does
2197 exactly. It should ignore adding trailing
2198 white space, but not leading white space.
2199
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002200 horizontal Start diff mode with horizontal splits (unless
2201 explicitly specified otherwise).
2202
2203 vertical Start diff mode with vertical splits (unless
2204 explicitly specified otherwise).
2205
2206 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2207 starting diff mode. Without this 2 is used.
2208
Bram Moolenaar071d4272004-06-13 20:20:40 +00002209 Examples: >
2210
2211 :set diffopt=filler,context:4
2212 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002213 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002214<
2215 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2216'digraph' 'dg' boolean (default off)
2217 global
2218 {not in Vi}
2219 {not available when compiled without the |+digraphs|
2220 feature}
2221 Enable the entering of digraphs in Insert mode with {char1} <BS>
2222 {char2}. See |digraphs|.
2223 NOTE: This option is reset when 'compatible' is set.
2224
2225 *'directory'* *'dir'*
2226'directory' 'dir' string (default for Amiga: ".,t:",
2227 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2228 for Unix: ".,~/tmp,/var/tmp,/tmp")
2229 global
2230 List of directory names for the swap file, separated with commas.
2231 - The swap file will be created in the first directory where this is
2232 possible.
2233 - Empty means that no swap file will be used (recovery is
2234 impossible!).
2235 - A directory "." means to put the swap file in the same directory as
2236 the edited file. On Unix, a dot is prepended to the file name, so
2237 it doesn't show in a directory listing. On MS-Windows the "hidden"
2238 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002239 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002240 put the swap file relative to where the edited file is. The leading
2241 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002242 - For Unix and Win32, if a directory ends in two path separators "//"
2243 or "\\", the swap file name will be built from the complete path to
2244 the file with all path separators substituted to percent '%' signs.
2245 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002246 - Spaces after the comma are ignored, other spaces are considered part
2247 of the directory name. To have a space at the start of a directory
2248 name, precede it with a backslash.
2249 - To include a comma in a directory name precede it with a backslash.
2250 - A directory name may end in an ':' or '/'.
2251 - Environment variables are expanded |:set_env|.
2252 - Careful with '\' characters, type one before a space, type two to
2253 get one in the option (see |option-backslash|), for example: >
2254 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2255< - For backwards compatibility with Vim version 3.0 a '>' at the start
2256 of the option is removed.
2257 Using "." first in the list is recommended. This means that editing
2258 the same file twice will result in a warning. Using "/tmp" on Unix is
2259 discouraged: When the system crashes you lose the swap file.
2260 "/var/tmp" is often not cleared when rebooting, thus is a better
2261 choice than "/tmp". But it can contain a lot of files, your swap
2262 files get lost in the crowd. That is why a "tmp" directory in your
2263 home directory is tried first.
2264 The use of |:set+=| and |:set-=| is preferred when adding or removing
2265 directories from the list. This avoids problems when a future version
2266 uses another default.
2267 This option cannot be set from a |modeline| or in the |sandbox|, for
2268 security reasons.
2269 {Vi: directory to put temp file in, defaults to "/tmp"}
2270
2271 *'display'* *'dy'*
2272'display' 'dy' string (default "")
2273 global
2274 {not in Vi}
2275 Change the way text is displayed. This is comma separated list of
2276 flags:
2277 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002278 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002279 last line that doesn't fit is replaced with "@" lines.
2280 uhex Show unprintable characters hexadecimal as <xx>
2281 instead of using ^C and ~C.
2282
2283 *'eadirection'* *'ead'*
2284'eadirection' 'ead' string (default "both")
2285 global
2286 {not in Vi}
2287 {not available when compiled without the +vertsplit
2288 feature}
2289 Tells when the 'equalalways' option applies:
2290 ver vertically, width of windows is not affected
2291 hor horizontally, height of windows is not affected
2292 both width and height of windows is affected
2293
2294 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2295'edcompatible' 'ed' boolean (default off)
2296 global
2297 Makes the 'g' and 'c' flags of the ":substitute" command to be
2298 toggled each time the flag is given. See |complex-change|. See
2299 also 'gdefault' option.
2300 Switching this option on is discouraged!
2301
2302 *'encoding'* *'enc'* *E543*
2303'encoding' 'enc' string (default: "latin1" or value from $LANG)
2304 global
2305 {only available when compiled with the |+multi_byte|
2306 feature}
2307 {not in Vi}
2308 Sets the character encoding used inside Vim. It applies to text in
2309 the buffers, registers, Strings in expressions, text stored in the
2310 viminfo file, etc. It sets the kind of characters which Vim can work
2311 with. See |encoding-names| for the possible values.
2312
2313 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002314 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002315 It should normally be kept at its default value, or set when Vim
2316 starts up. See |multibyte|.
2317
2318 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2319 "utf-8". Although care has been taken to allow different values of
2320 'encoding', "utf-8" is the natural choice for the environment and
2321 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002322 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002323 versions, and to avoid changing the encoding of newly created files
2324 without your knowledge (in case 'fileencodings' is empty).
2325
2326 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002327 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002328 iconv() or as specified with 'charconvert'.
2329
2330 Normally 'encoding' will be equal to your current locale. This will
2331 be the default if Vim recognizes your environment settings. If
2332 'encoding' is not set to the current locale, 'termencoding' must be
2333 set to convert typed and displayed text. See |encoding-table|.
2334
2335 When you set this option, it fires the |EncodingChanged| autocommand
2336 event so that you can set up fonts if necessary.
2337
2338 When the option is set, the value is converted to lowercase. Thus
2339 you can set it with uppercase values too. Underscores are translated
2340 to '-' signs.
2341 When the encoding is recognized, it is changed to the standard name.
2342 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2343 "iso-8859-2" and "utf8" becomes "utf-8".
2344
2345 Note: "latin1" is also used when the encoding could not be detected.
2346 This only works when editing files in the same encoding! When the
2347 actual character set is not latin1, make sure 'fileencoding' and
2348 'fileencodings' are empty. When conversion is needed, switch to using
2349 utf-8.
2350
2351 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2352 You don't notice this while editing, but it does matter for the
2353 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2354 setting 'encoding' to one of these values instead of utf-8 only has
2355 effect for encoding used for files when 'fileencoding' is empty.
2356
Bram Moolenaar661b1822005-07-28 22:36:45 +00002357 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2358 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002359
2360 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2361'endofline' 'eol' boolean (default on)
2362 local to buffer
2363 {not in Vi}
2364 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002365 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002366 option is automatically set when starting to edit a new file, unless
2367 the file does not have an <EOL> for the last line in the file, in
2368 which case it is reset. Normally you don't have to set or reset this
2369 option. When 'binary' is off the value is not used when writing the
2370 file. When 'binary' is on it is used to remember the presence of a
2371 <EOL> for the last line in the file, so that when you write the file
2372 the situation from the original file can be kept. But you can change
2373 it if you want to.
2374
2375 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2376'equalalways' 'ea' boolean (default on)
2377 global
2378 {not in Vi}
2379 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002380 splitting or closing a window. This also happens the moment the
2381 option is switched on. When off, splitting a window will reduce the
2382 size of the current window and leave the other windows the same. When
2383 closing a window the extra lines are given to the window next to it
2384 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002385 When mixing vertically and horizontally split windows, a minimal size
2386 is computed and some windows may be larger if there is room. The
2387 'eadirection' option tells in which direction the size is affected.
2388 Changing the height of a window can be avoided by setting
2389 'winfixheight'.
2390
2391 *'equalprg'* *'ep'*
2392'equalprg' 'ep' string (default "")
2393 global or local to buffer |global-local|
2394 {not in Vi}
2395 External program to use for "=" command. When this option is empty
2396 the internal formatting functions are used ('lisp', 'cindent' or
2397 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002398 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002399 about including spaces and backslashes.
2400 This option cannot be set from a |modeline| or in the |sandbox|, for
2401 security reasons.
2402
2403 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2404'errorbells' 'eb' boolean (default off)
2405 global
2406 Ring the bell (beep or screen flash) for error messages. This only
2407 makes a difference for error messages, the bell will be used always
2408 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002409 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002410 screen flash or do nothing.
2411
2412 *'errorfile'* *'ef'*
2413'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2414 others: "errors.err")
2415 global
2416 {not in Vi}
2417 {not available when compiled without the |+quickfix|
2418 feature}
2419 Name of the errorfile for the QuickFix mode (see |:cf|).
2420 When the "-q" command-line argument is used, 'errorfile' is set to the
2421 following argument. See |-q|.
2422 NOT used for the ":make" command. See 'makeef' for that.
2423 Environment variables are expanded |:set_env|.
2424 See |option-backslash| about including spaces and backslashes.
2425 This option cannot be set from a |modeline| or in the |sandbox|, for
2426 security reasons.
2427
2428 *'errorformat'* *'efm'*
2429'errorformat' 'efm' string (default is very long)
2430 global or local to buffer |global-local|
2431 {not in Vi}
2432 {not available when compiled without the |+quickfix|
2433 feature}
2434 Scanf-like description of the format for the lines in the error file
2435 (see |errorformat|).
2436
2437 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2438'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2439 global
2440 {not in Vi}
2441 Function keys that start with an <Esc> are recognized in Insert
2442 mode. When this option is off, the cursor and function keys cannot be
2443 used in Insert mode if they start with an <Esc>. The advantage of
2444 this is that the single <Esc> is recognized immediately, instead of
2445 after one second. Instead of resetting this option, you might want to
2446 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2447 when 'esckeys' is off, you can still map anything, but the cursor keys
2448 won't work by default.
2449 NOTE: This option is set to the Vi default value when 'compatible' is
2450 set and to the Vim default value when 'compatible' is reset.
2451
2452 *'eventignore'* *'ei'*
2453'eventignore' 'ei' string (default "")
2454 global
2455 {not in Vi}
2456 {not available when compiled without the |+autocmd|
2457 feature}
2458 A list of autocommand event names, which are to be ignored.
2459 When set to "all", all autocommand events are ignored, autocommands
2460 will not be executed.
2461 Otherwise this is a comma separated list of event names. Example: >
2462 :set ei=WinEnter,WinLeave
2463<
2464 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2465'expandtab' 'et' boolean (default off)
2466 local to buffer
2467 {not in Vi}
2468 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002469 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002470 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2471 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2472 NOTE: This option is reset when 'compatible' is set.
2473
2474 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2475'exrc' 'ex' boolean (default off)
2476 global
2477 {not in Vi}
2478 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2479 directory. If you switch this option on you should also consider
2480 setting the 'secure' option (see |initialization|). Using a local
2481 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2482 also see |.vimrc| and |gui-init|.
2483 This option cannot be set from a |modeline| or in the |sandbox|, for
2484 security reasons.
2485
2486 *'fileencoding'* *'fenc'* *E213*
2487'fileencoding' 'fenc' string (default: "")
2488 local to buffer
2489 {only available when compiled with the |+multi_byte|
2490 feature}
2491 {not in Vi}
2492 Sets the character encoding for the file of this buffer.
2493 When 'fileencoding' is different from 'encoding', conversion will be
2494 done when reading and writing the file.
2495 When 'fileencoding' is empty, the same value as 'encoding' will be
2496 used (no conversion when reading or writing a file).
2497 WARNING: Conversion can cause loss of information! When
2498 'encoding' is "utf-8" conversion is most likely done in a way
2499 that the reverse conversion results in the same text. When
2500 'encoding' is not "utf-8" some characters may be lost!
2501 See 'encoding' for the possible values. Additionally, values may be
2502 specified that can be handled by the converter, see
2503 |mbyte-conversion|.
2504 When reading a file 'fileencoding' will be set from 'fileencodings'.
2505 To read a file in a certain encoding it won't work by setting
2506 'fileencoding', use the |++enc| argument.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002507 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002508 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2509 When the option is set, the value is converted to lowercase. Thus
2510 you can set it with uppercase values too. '_' characters are
2511 replaced with '-'. If a name is recognized from the list for
2512 'encoding', it is replaced by the standard name. For example
2513 "ISO8859-2" becomes "iso-8859-2".
2514 When this option is set, after starting to edit a file, the 'modified'
2515 option is set, because the file would be different when written.
2516 If you do this in a modeline, you might want to set 'nomodified' to
2517 avoid this.
2518 This option can not be changed when 'modifiable' is off.
2519
2520 *'fe'*
2521 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002522 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002523 old short name was 'fe', which is no longer used.
2524
2525 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002526'fileencodings' 'fencs' string (default: "ucs-bom",
2527 "ucs-bom,utf-8,default,latin1" when
2528 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002529 global
2530 {only available when compiled with the |+multi_byte|
2531 feature}
2532 {not in Vi}
2533 This is a list of character encodings considered when starting to edit
2534 an existing file. When a file is read, Vim tries to use the first
2535 mentioned character encoding. If an error is detected, the next one
2536 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002537 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002538 an empty string, which means the value of 'encoding' is used.
2539 WARNING: Conversion can cause loss of information! When
2540 'encoding' is "utf-8" (or one of the other Unicode variants)
2541 conversion is most likely done in a way that the reverse
2542 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002543 "utf-8" some non-ASCII characters may be lost! You can use
2544 the |++bad| argument to specify what is done with characters
2545 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002546 For an empty file or a file with only ASCII characters most encodings
2547 will work and the first entry of 'fileencodings' will be used (except
2548 "ucs-bom", which requires the BOM to be present). If you prefer
2549 another encoding use an BufReadPost autocommand event to test if your
2550 preferred encoding is to be used. Example: >
2551 au BufReadPost * if search('\S', 'w') == 0 |
2552 \ set fenc=iso-2022-jp | endif
2553< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2554 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002555 When the |++enc| argument is used then the value of 'fileencodings' is
2556 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002557 Note that 'fileencodings' is not used for a new file, the global value
2558 of 'fileencoding' is used instead. You can set it with: >
2559 :setglobal fenc=iso-8859-2
2560< This means that a non-existing file may get a different encoding than
2561 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002562 The special value "ucs-bom" can be used to check for a Unicode BOM
2563 (Byte Order Mark) at the start of the file. It must not be preceded
2564 by "utf-8" or another Unicode encoding for this to work properly.
2565 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2566 because Vim cannot detect an error, thus the encoding is always
2567 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002568 The special value "default" can be used for the encoding from the
2569 environment. This is the default value for 'encoding'. It is useful
2570 when 'encoding' is set to "utf-8" and your environment uses a
2571 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002572 When 'encoding' is "utf-8" and a file contains an illegal byte
2573 sequence it won't be recognized as UTF-8. You can use the |8g8|
2574 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002575 WRONG VALUES: WHAT'S WRONG:
2576 latin1,utf-8 "latin1" will always be used
2577 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2578 file
2579 cp1250,latin1 "cp1250" will always be used
2580 If 'fileencodings' is empty, 'fileencoding' is not modified.
2581 See 'fileencoding' for the possible values.
2582 Setting this option does not have an effect until the next time a file
2583 is read.
2584
2585 *'fileformat'* *'ff'*
2586'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2587 Unix default: "unix",
2588 Macintosh default: "mac")
2589 local to buffer
2590 {not in Vi}
2591 This gives the <EOL> of the current buffer, which is used for
2592 reading/writing the buffer from/to a file:
2593 dos <CR> <NL>
2594 unix <NL>
2595 mac <CR>
2596 When "dos" is used, CTRL-Z at the end of a file is ignored.
2597 See |file-formats| and |file-read|.
2598 For the character encoding of the file see 'fileencoding'.
2599 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2600 works like it was set to "unix'.
2601 This option is set automatically when starting to edit a file and
2602 'fileformats' is not empty and 'binary' is off.
2603 When this option is set, after starting to edit a file, the 'modified'
2604 option is set, because the file would be different when written.
2605 This option can not be changed when 'modifiable' is off.
2606 For backwards compatibility: When this option is set to "dos",
2607 'textmode' is set, otherwise 'textmode' is reset.
2608
2609 *'fileformats'* *'ffs'*
2610'fileformats' 'ffs' string (default:
2611 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2612 Vim Unix: "unix,dos",
2613 Vim Mac: "mac,unix,dos",
2614 Vi Cygwin: "unix,dos",
2615 Vi others: "")
2616 global
2617 {not in Vi}
2618 This gives the end-of-line (<EOL>) formats that will be tried when
2619 starting to edit a new buffer and when reading a file into an existing
2620 buffer:
2621 - When empty, the format defined with 'fileformat' will be used
2622 always. It is not set automatically.
2623 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002624 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002625 'fileformats' name will be used when a file is read into an existing
2626 buffer, no matter what 'fileformat' for that buffer is set to.
2627 - When more than one name is present, separated by commas, automatic
2628 <EOL> detection will be done when reading a file. When starting to
2629 edit a file, a check is done for the <EOL>:
2630 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2631 'fileformat' is set to "dos".
2632 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002633 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002634 preceding <CR>, "unix" is preferred over "dos".
2635 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2636 This means that "mac" is only chosen when "unix" is not present,
2637 or when no <NL> is found in the file, and when "dos" is not
2638 present, or no <CR><NL> is present in the file.
2639 Also if "unix" was first chosen, but the first <CR> is before
2640 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2641 the file, then 'fileformat' is set to "mac".
2642 4. If 'fileformat' is still not set, the first name from
2643 'fileformats' is used.
2644 When reading a file into an existing buffer, the same is done, but
2645 this happens like 'fileformat' has been set appropriately for that
2646 file only, the option is not changed.
2647 When 'binary' is set, the value of 'fileformats' is not used.
2648
2649 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2650 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2651 done:
2652 - When 'fileformats' is empty, there is no automatic detection. Dos
2653 format will be used.
2654 - When 'fileformats' is set to one or more names, automatic detection
2655 is done. This is based on the first <NL> in the file: If there is a
2656 <CR> in front of it, Dos format is used, otherwise Unix format is
2657 used.
2658 Also see |file-formats|.
2659 For backwards compatibility: When this option is set to an empty
2660 string or one format (no comma is included), 'textauto' is reset,
2661 otherwise 'textauto' is set.
2662 NOTE: This option is set to the Vi default value when 'compatible' is
2663 set and to the Vim default value when 'compatible' is reset.
2664
2665 *'filetype'* *'ft'*
2666'filetype' 'ft' string (default: "")
2667 local to buffer
2668 {not in Vi}
2669 {not available when compiled without the |+autocmd|
2670 feature}
2671 When this option is set, the FileType autocommand event is triggered.
2672 All autocommands that match with the value of this option will be
2673 executed. Thus the value of 'filetype' is used in place of the file
2674 name.
2675 Otherwise this option does not always reflect the current file type.
2676 This option is normally set when the file type is detected. To enable
2677 this use the ":filetype on" command. |:filetype|
2678 Setting this option to a different value is most useful in a modeline,
2679 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002680 Example, for in an IDL file:
2681 /* vim: set filetype=idl : */ ~
2682 |FileType| |filetypes|
2683 When a dot appears in the value then this separates two filetype
2684 names. Example:
2685 /* vim: set filetype=c.doxygen : */ ~
2686 This will use the "c" filetype first, then the "doxygen" filetype.
2687 This works both for filetype plugins and for syntax files. More than
2688 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002689 Do not confuse this option with 'osfiletype', which is for the file
2690 type that is actually stored with the file.
2691 This option is not copied to another buffer, independent of the 's' or
2692 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002693 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002694
2695 *'fillchars'* *'fcs'*
2696'fillchars' 'fcs' string (default "vert:|,fold:-")
2697 global
2698 {not in Vi}
2699 {not available when compiled without the |+windows|
2700 and |+folding| features}
2701 Characters to fill the statuslines and vertical separators.
2702 It is a comma separated list of items:
2703
2704 item default Used for ~
2705 stl:c ' ' or '^' statusline of the current window
2706 stlnc:c ' ' or '-' statusline of the non-current windows
2707 vert:c '|' vertical separators |:vsplit|
2708 fold:c '-' filling 'foldtext'
2709 diff:c '-' deleted lines of the 'diff' option
2710
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002711 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002712 "stlnc" the space will be used when there is highlighting, '^' or '-'
2713 otherwise.
2714
2715 Example: >
2716 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2717< This is similar to the default, except that these characters will also
2718 be used when there is highlighting.
2719
2720 The highlighting used for these items:
2721 item highlight group ~
2722 stl:c StatusLine |hl-StatusLine|
2723 stlnc:c StatusLineNC |hl-StatusLineNC|
2724 vert:c VertSplit |hl-VertSplit|
2725 fold:c Folded |hl-Folded|
2726 diff:c DiffDelete |hl-DiffDelete|
2727
2728 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2729'fkmap' 'fk' boolean (default off) *E198*
2730 global
2731 {not in Vi}
2732 {only available when compiled with the |+rightleft|
2733 feature}
2734 When on, the keyboard is mapped for the Farsi character set.
2735 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002736 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002737
2738 *'foldclose'* *'fcl'*
2739'foldclose' 'fcl' string (default "")
2740 global
2741 {not in Vi}
2742 {not available when compiled without the |+folding|
2743 feature}
2744 When set to "all", a fold is closed when the cursor isn't in it and
2745 its level is higher than 'foldlevel'. Useful if you want folds to
2746 automatically close when moving out of them.
2747
2748 *'foldcolumn'* *'fdc'*
2749'foldcolumn' 'fdc' number (default 0)
2750 local to window
2751 {not in Vi}
2752 {not available when compiled without the |+folding|
2753 feature}
2754 When non-zero, a column with the specified width is shown at the side
2755 of the window which indicates open and closed folds. The maximum
2756 value is 12.
2757 See |folding|.
2758
2759 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2760'foldenable' 'fen' boolean (default on)
2761 local to window
2762 {not in Vi}
2763 {not available when compiled without the |+folding|
2764 feature}
2765 When off, all folds are open. This option can be used to quickly
2766 switch between showing all text unfolded and viewing the text with
2767 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002768 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002769 'foldenable' is off.
2770 This option is set by commands that create a new fold or close a fold.
2771 See |folding|.
2772
2773 *'foldexpr'* *'fde'*
2774'foldexpr' 'fde' string (default: "0")
2775 local to window
2776 {not in Vi}
2777 {not available when compiled without the |+folding|
2778 or |+eval| feature}
2779 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002780 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002781
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002782 The expression may be evaluated in the |sandbox|, see
2783 |sandbox-option|.
2784
2785 It is not allowed to change text or jump to another window while
2786 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002787
2788 *'foldignore'* *'fdi'*
2789'foldignore' 'fdi' string (default: "#")
2790 local to window
2791 {not in Vi}
2792 {not available when compiled without the |+folding|
2793 feature}
2794 Used only when 'foldmethod' is "indent". Lines starting with
2795 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002796 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002797 The default "#" works well for C programs. See |fold-indent|.
2798
2799 *'foldlevel'* *'fdl'*
2800'foldlevel' 'fdl' number (default: 0)
2801 local to window
2802 {not in Vi}
2803 {not available when compiled without the |+folding|
2804 feature}
2805 Sets the fold level: Folds with a higher level will be closed.
2806 Setting this option to zero will close all folds. Higher numbers will
2807 close fewer folds.
2808 This option is set by commands like |zm|, |zM| and |zR|.
2809 See |fold-foldlevel|.
2810
2811 *'foldlevelstart'* *'fdls'*
2812'foldlevelstart' 'fdls' number (default: -1)
2813 global
2814 {not in Vi}
2815 {not available when compiled without the |+folding|
2816 feature}
2817 Sets 'foldlevel' when starting to edit another buffer in a window.
2818 Useful to always start editing with all folds closed (value zero),
2819 some folds closed (one) or no folds closed (99).
2820 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002821 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002822 ignores this option and closes all folds.
2823 It is also done before BufReadPre autocommands, to allow an autocmd to
2824 overrule the 'foldlevel' value for specific files.
2825 When the value is negative, it is not used.
2826
2827 *'foldmarker'* *'fmr'* *E536*
2828'foldmarker' 'fmr' string (default: "{{{,}}}")
2829 local to window
2830 {not in Vi}
2831 {not available when compiled without the |+folding|
2832 feature}
2833 The start and end marker used when 'foldmethod' is "marker". There
2834 must be one comma, which separates the start and end marker. The
2835 marker is a literal string (a regular expression would be too slow).
2836 See |fold-marker|.
2837
2838 *'foldmethod'* *'fdm'*
2839'foldmethod' 'fdm' string (default: "manual")
2840 local to window
2841 {not in Vi}
2842 {not available when compiled without the |+folding|
2843 feature}
2844 The kind of folding used for the current window. Possible values:
2845 |fold-manual| manual Folds are created manually.
2846 |fold-indent| indent Lines with equal indent form a fold.
2847 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2848 |fold-marker| marker Markers are used to specify folds.
2849 |fold-syntax| syntax Syntax highlighting items specify folds.
2850 |fold-diff| diff Fold text that is not changed.
2851
2852 *'foldminlines'* *'fml'*
2853'foldminlines' 'fml' number (default: 1)
2854 local to window
2855 {not in Vi}
2856 {not available when compiled without the |+folding|
2857 feature}
2858 Sets the minimum number of screen lines for a fold to be displayed
2859 closed. Also for manually closed folds.
2860 Note that this only has an effect of what is displayed. After using
2861 "zc" to close a fold, which is displayed open because it's smaller
2862 than 'foldminlines', a following "zc" may close a containing fold.
2863
2864 *'foldnestmax'* *'fdn'*
2865'foldnestmax' 'fdn' number (default: 20)
2866 local to window
2867 {not in Vi}
2868 {not available when compiled without the |+folding|
2869 feature}
2870 Sets the maximum nesting of folds for the "indent" and "syntax"
2871 methods. This avoids that too many folds will be created. Using more
2872 than 20 doesn't work, because the internal limit is 20.
2873
2874 *'foldopen'* *'fdo'*
2875'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2876 search,tag,undo")
2877 global
2878 {not in Vi}
2879 {not available when compiled without the |+folding|
2880 feature}
2881 Specifies for which type of commands folds will be opened, if the
2882 command moves the cursor into a closed fold. It is a comma separated
2883 list of items.
2884 item commands ~
2885 all any
2886 block "(", "{", "[[", "[{", etc.
2887 hor horizontal movements: "l", "w", "fx", etc.
2888 insert any command in Insert mode
2889 jump far jumps: "G", "gg", etc.
2890 mark jumping to a mark: "'m", CTRL-O, etc.
2891 percent "%"
2892 quickfix ":cn", ":crew", ":make", etc.
2893 search search for a pattern: "/", "n", "*", "gd", etc.
2894 (not for a search pattern in a ":" command)
2895 tag jumping to a tag: ":ta", CTRL-T, etc.
2896 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002897 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002898 the |zv| command to the mapping to get the same effect.
2899 When a movement command is used for an operator (e.g., "dl" or "y%")
2900 this option is not used. This means the operator will include the
2901 whole closed fold.
2902 Note that vertical movements are not here, because it would make it
2903 very difficult to move onto a closed fold.
2904 In insert mode the folds containing the cursor will always be open
2905 when text is inserted.
2906 To close folds you can re-apply 'foldlevel' with the |zx| command or
2907 set the 'foldclose' option to "all".
2908
2909 *'foldtext'* *'fdt'*
2910'foldtext' 'fdt' string (default: "foldtext()")
2911 local to window
2912 {not in Vi}
2913 {not available when compiled without the |+folding|
2914 feature}
2915 An expression which is used to specify the text displayed for a closed
2916 fold. See |fold-foldtext|.
2917
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002918 The expression may be evaluated in the |sandbox|, see
2919 |sandbox-option|.
2920
2921 It is not allowed to change text or jump to another window while
2922 evaluating 'foldtext' |textlock|.
2923
Bram Moolenaar071d4272004-06-13 20:20:40 +00002924 *'formatoptions'* *'fo'*
2925'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2926 local to buffer
2927 {not in Vi}
2928 This is a sequence of letters which describes how automatic
2929 formatting is to be done. See |fo-table|. When the 'paste' option is
2930 on, no formatting is done (like 'formatoptions' is empty). Commas can
2931 be inserted for readability.
2932 To avoid problems with flags that are added in the future, use the
2933 "+=" and "-=" feature of ":set" |add-option-flags|.
2934 NOTE: This option is set to the Vi default value when 'compatible' is
2935 set and to the Vim default value when 'compatible' is reset.
2936
Bram Moolenaar86b68352004-12-27 21:59:20 +00002937 *'formatlistpat'* *'flp'*
2938'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
2939 local to buffer
2940 {not in Vi}
2941 A pattern that is used to recognize a list header. This is used for
2942 the "n" flag in 'formatoptions'.
2943 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00002944 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00002945 while still checking more characters. There must be a character
2946 following the pattern, when it matches the whole line it is handled
2947 like there is no match.
2948 The default recognizes a number, followed by an optional punctuation
2949 character and white space.
2950
Bram Moolenaar071d4272004-06-13 20:20:40 +00002951 *'formatprg'* *'fp'*
2952'formatprg' 'fp' string (default "")
2953 global
2954 {not in Vi}
2955 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002956 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00002957 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00002958 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002959 If the 'formatexpr' option is not empty it will be used instead.
2960 Otherwise, if 'formatprg' option is an empty string, the internal
2961 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00002962 Environment variables are expanded |:set_env|. See |option-backslash|
2963 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002964 The expression may be evaluated in the |sandbox|, see
2965 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002966
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002967 *'formatexpr'* *'fex'*
2968'formatexpr' 'fex' string (default "")
2969 local to buffer
2970 {not in Vi}
2971 {not available when compiled without the |+eval|
2972 feature}
2973 Expression which is evaluated to format a range of lines for the |gq|
2974 operator. The |v:lnum| variable holds the first line to be formatted,
2975 |v:count| the number of lines to be formatted.
2976 When this option is empty 'formatprg' is used.
2977 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00002978 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002979< This will invoke the mylang#Format() function in the
2980 autoload/mylang.vim file in 'runtimepath'. |autoload|
2981
2982 The expression is also evaluated when 'textwidth' is set and adding
2983 text beyond that limit. This happens under the same conditions as
2984 when internal formatting is used. Make sure the cursor is kept in the
2985 same spot relative to the text then! The |mode()| function will
2986 return "i" or "R" in this situation. When the function returns
2987 non-zero Vim will fall back to using the internal format mechanism.
2988
2989 The expression may be evaluated in the |sandbox|, see
2990 |sandbox-option|.
2991
2992 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002993'fsync' 'fs' boolean (default on)
2994 global
2995 {not in Vi}
2996 When on, the library function fsync() will be called after writing a
2997 file. This will flush a file to disk, ensuring that it is safely
2998 written even on filesystems which do metadata-only journaling. This
2999 will force the harddrive to spin up on Linux systems running in laptop
3000 mode, so it may be undesirable in some situations. Be warned that
3001 turning this off increases the chances of data loss after a crash. On
3002 systems without an fsync() implementation, this variable is always
3003 off.
3004 Also see 'swapsync' for controlling fsync() on swap files.
3005
Bram Moolenaar071d4272004-06-13 20:20:40 +00003006 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3007'gdefault' 'gd' boolean (default off)
3008 global
3009 {not in Vi}
3010 When on, the ":substitute" flag 'g' is default on. This means that
3011 all matches in a line are substituted instead of one. When a 'g' flag
3012 is given to a ":substitute" command, this will toggle the substitution
3013 of all or one match. See |complex-change|.
3014
3015 command 'gdefault' on 'gdefault' off ~
3016 :s/// subst. all subst. one
3017 :s///g subst. one subst. all
3018 :s///gg subst. all subst. one
3019
3020 NOTE: This option is reset when 'compatible' is set.
3021
3022 *'grepformat'* *'gfm'*
3023'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3024 global
3025 {not in Vi}
3026 Format to recognize for the ":grep" command output.
3027 This is a scanf-like string that uses the same format as the
3028 'errorformat' option: see |errorformat|.
3029
3030 *'grepprg'* *'gp'*
3031'grepprg' 'gp' string (default "grep -n ",
3032 Unix: "grep -n $* /dev/null",
3033 Win32: "findstr /n" or "grep -n",
3034 VMS: "SEARCH/NUMBERS ")
3035 global or local to buffer |global-local|
3036 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003037 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003038 and '#' characters, which are expanded like when used in a command-
3039 line. The placeholder "$*" is allowed to specify where the arguments
3040 will be included. Environment variables are expanded |:set_env|. See
3041 |option-backslash| about including spaces and backslashes.
3042 When your "grep" accepts the "-H" argument, use this to make ":grep"
3043 also work well with a single file: >
3044 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003045< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003046 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3047 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003048 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003049 apply equally to 'grepprg'.
3050 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3051 otherwise it's "grep -n".
3052 This option cannot be set from a |modeline| or in the |sandbox|, for
3053 security reasons.
3054
3055 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3056'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3057 ve:ver35-Cursor,
3058 o:hor50-Cursor,
3059 i-ci:ver25-Cursor/lCursor,
3060 r-cr:hor20-Cursor/lCursor,
3061 sm:block-Cursor
3062 -blinkwait175-blinkoff150-blinkon175",
3063 for MS-DOS and Win32 console:
3064 "n-v-c:block,o:hor50,i-ci:hor15,
3065 r-cr:hor30,sm:block")
3066 global
3067 {not in Vi}
3068 {only available when compiled with GUI enabled, and
3069 for MS-DOS and Win32 console}
3070 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003071 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003072 the height of the cursor can be changed. This can be done by
3073 specifying a block cursor, or a percentage for a vertical or
3074 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003075 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003076
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003077 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003078 mode-list and an argument-list:
3079 mode-list:argument-list,mode-list:argument-list,..
3080 The mode-list is a dash separated list of these modes:
3081 n Normal mode
3082 v Visual mode
3083 ve Visual mode with 'selection' "exclusive" (same as 'v',
3084 if not specified)
3085 o Operator-pending mode
3086 i Insert mode
3087 r Replace mode
3088 c Command-line Normal (append) mode
3089 ci Command-line Insert mode
3090 cr Command-line Replace mode
3091 sm showmatch in Insert mode
3092 a all modes
3093 The argument-list is a dash separated list of these arguments:
3094 hor{N} horizontal bar, {N} percent of the character height
3095 ver{N} vertical bar, {N} percent of the character width
3096 block block cursor, fills the whole character
3097 [only one of the above three should be present]
3098 blinkwait{N} *cursor-blinking*
3099 blinkon{N}
3100 blinkoff{N}
3101 blink times for cursor: blinkwait is the delay before
3102 the cursor starts blinking, blinkon is the time that
3103 the cursor is shown and blinkoff is the time that the
3104 cursor is not shown. The times are in msec. When one
3105 of the numbers is zero, there is no blinking. The
3106 default is: "blinkwait700-blinkon400-blinkoff250".
3107 These numbers are used for a missing entry. This
3108 means that blinking is enabled by default. To switch
3109 blinking off you can use "blinkon0". The cursor only
3110 blinks when Vim is waiting for input, not while
3111 executing a command.
3112 To make the cursor blink in an xterm, see
3113 |xterm-blink|.
3114 {group-name}
3115 a highlight group name, that sets the color and font
3116 for the cursor
3117 {group-name}/{group-name}
3118 Two highlight group names, the first is used when
3119 no language mappings are used, the other when they
3120 are. |language-mapping|
3121
3122 Examples of parts:
3123 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3124 block cursor with colors from the "nCursor"
3125 highlight group
3126 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3127 In Insert and Command-line Insert mode, use a
3128 30% vertical bar cursor with colors from the
3129 "iCursor" highlight group. Blink a bit
3130 faster.
3131
3132 The 'a' mode is different. It will set the given argument-list for
3133 all modes. It does not reset anything to defaults. This can be used
3134 to do a common setting for all modes. For example, to switch off
3135 blinking: "a:blinkon0"
3136
3137 Examples of cursor highlighting: >
3138 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3139 :highlight Cursor gui=NONE guifg=bg guibg=fg
3140<
3141 *'guifont'* *'gfn'*
3142 *E235* *E596* *E610* *E611*
3143'guifont' 'gfn' string (default "")
3144 global
3145 {not in Vi}
3146 {only available when compiled with GUI enabled}
3147 This is a list of fonts which will be used for the GUI version of Vim.
3148 In its simplest form the value is just one font name. When
3149 the font cannot be found you will get an error message. To try other
3150 font names a list can be specified, font names separated with commas.
3151 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003152
Bram Moolenaar05159a02005-02-26 23:04:13 +00003153 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3154 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003155
Bram Moolenaar071d4272004-06-13 20:20:40 +00003156 Spaces after a comma are ignored. To include a comma in a font name
3157 precede it with a backslash. Setting an option requires an extra
3158 backslash before a space and a backslash. See also
3159 |option-backslash|. For example: >
3160 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003161< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003162 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003163
3164 If none of the fonts can be loaded, Vim will keep the current setting.
3165 If an empty font list is given, Vim will try using other resource
3166 settings (for X, it will use the Vim.font resource), and finally it
3167 will try some builtin default which should always be there ("7x13" in
3168 the case of X). The font names given should be "normal" fonts. Vim
3169 will try to find the related bold and italic fonts.
3170
Bram Moolenaar05159a02005-02-26 23:04:13 +00003171 For Win32, GTK, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003172 :set guifont=*
3173< will bring up a font requester, where you can pick the font you want.
3174
3175 The font name depends on the GUI used. See |setting-guifont| for a
3176 way to set 'guifont' for various systems.
3177
Bram Moolenaar071d4272004-06-13 20:20:40 +00003178 For the GTK+ 2 GUI the font name looks like this: >
3179 :set guifont=Andale\ Mono\ 11
3180< That's all. XLFDs are no longer accepted.
Bram Moolenaar05159a02005-02-26 23:04:13 +00003181
3182 For Mac OSX you can use something like this: >
3183 :set guifont=Monaco:h10
3184< *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003185 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003186 width). An exception is GTK 2: all fonts are accepted, but
3187 mono-spaced fonts look best.
3188
Bram Moolenaar071d4272004-06-13 20:20:40 +00003189 To preview a font on X11, you might be able to use the "xfontsel"
3190 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003191
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192 For the Win32 GUI *E244* *E245*
3193 - takes these options in the font name:
3194 hXX - height is XX (points, can be floating-point)
3195 wXX - width is XX (points, can be floating-point)
3196 b - bold
3197 i - italic
3198 u - underline
3199 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003200 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003201 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3202 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3203 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003204 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003205
3206 Use a ':' to separate the options.
3207 - A '_' can be used in the place of a space, so you don't need to use
3208 backslashes to escape the spaces.
3209 - Examples: >
3210 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3211 :set guifont=Andale_Mono:h7.5:w4.5
3212< See also |font-sizes|.
3213
3214 *'guifontset'* *'gfs'*
3215 *E250* *E252* *E234* *E597* *E598*
3216'guifontset' 'gfs' string (default "")
3217 global
3218 {not in Vi}
3219 {only available when compiled with GUI enabled and
3220 with the |+xfontset| feature}
3221 {not available in the GTK+ 2 GUI}
3222 When not empty, specifies two (or more) fonts to be used. The first
3223 one for normal English, the second one for your special language. See
3224 |xfontset|.
3225 Setting this option also means that all font names will be handled as
3226 a fontset name. Also the ones used for the "font" argument of the
3227 |:highlight| command.
3228 The fonts must match with the current locale. If fonts for the
3229 character sets that the current locale uses are not included, setting
3230 'guifontset' will fail.
3231 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3232 the comma-separated names are alternative names, one of which will be
3233 used. In 'guifontset' the whole string is one fontset name,
3234 including the commas. It is not possible to specify alternative
3235 fontset names.
3236 This example works on many X11 systems: >
3237 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3238<
3239 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3240'guifontwide' 'gfw' string (default "")
3241 global
3242 {not in Vi}
3243 {only available when compiled with GUI enabled}
3244 When not empty, specifies a comma-separated list of fonts to be used
3245 for double-width characters. The first font that can be loaded is
3246 used.
3247 Note: The size of these fonts must be exactly twice as wide as the one
3248 specified with 'guifont' and the same height.
3249
3250 All GUI versions but GTK+ 2:
3251
3252 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3253 'guifontset' is empty or invalid.
3254 When 'guifont' is set and a valid font is found in it and
3255 'guifontwide' is empty Vim will attempt to find a matching
3256 double-width font and set 'guifontwide' to it.
3257
3258 GTK+ 2 GUI only: *guifontwide_gtk2*
3259
3260 If set and valid, 'guifontwide' is always used for double width
3261 characters, even if 'encoding' is not set to "utf-8".
3262 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003263 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003264 font for characters not available in 'guifont'. Thus you do not need
3265 to set 'guifontwide' at all unless you want to override the choice
3266 made by Pango/Xft.
3267
3268 *'guiheadroom'* *'ghr'*
3269'guiheadroom' 'ghr' number (default 50)
3270 global
3271 {not in Vi} {only for GTK and X11 GUI}
3272 The number of pixels subtracted from the screen height when fitting
3273 the GUI window on the screen. Set this before the GUI is started,
3274 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003275 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003276 lines will be left for window decorations and other items on the
3277 screen. Set it to a negative value to allow windows taller than the
3278 screen.
3279
3280 *'guioptions'* *'go'*
3281'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003282 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003283 global
3284 {not in Vi}
3285 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003286 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003287 sequence of letters which describes what components and options of the
3288 GUI should be used.
3289 To avoid problems with flags that are added in the future, use the
3290 "+=" and "-=" feature of ":set" |add-option-flags|.
3291
3292 Valid letters are as follows:
3293 *guioptions_a*
3294 'a' Autoselect: If present, then whenever VISUAL mode is started,
3295 or the Visual area extended, Vim tries to become the owner of
3296 the windowing system's global selection. This means that the
3297 Visually highlighted text is available for pasting into other
3298 applications as well as into Vim itself. When the Visual mode
3299 ends, possibly due to an operation on the text, or when an
3300 application wants to paste the selection, the highlighted text
3301 is automatically yanked into the "* selection register.
3302 Thus the selection is still available for pasting into other
3303 applications after the VISUAL mode has ended.
3304 If not present, then Vim won't become the owner of the
3305 windowing system's global selection unless explicitly told to
3306 by a yank or delete operation for the "* register.
3307 The same applies to the modeless selection.
3308
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003309 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003310 applies to the modeless selection.
3311
3312 'guioptions' autoselect Visual autoselect modeless ~
3313 "" - -
3314 "a" yes yes
3315 "A" - yes
3316 "aA" yes yes
3317
3318 'c' Use console dialogs instead of popup dialogs for simple
3319 choices.
3320
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003321 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003322 'guitablabel' can be used to change the text in the labels.
3323 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00003324 The GUI tabs are only supported on some systens, currently
3325 only for GTK.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003326
Bram Moolenaar071d4272004-06-13 20:20:40 +00003327 'f' Foreground: Don't use fork() to detach the GUI from the shell
3328 where it was started. Use this for programs that wait for the
3329 editor to finish (e.g., an e-mail program). Alternatively you
3330 can use "gvim -f" or ":gui -f" to start the GUI in the
3331 foreground. |gui-fork|
3332 Note: Set this option in the vimrc file. The forking may have
3333 happened already when the gvimrc file is read.
3334
3335 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3336 corner of the window. It's black&white on non-GTK, because of
3337 limitations of X11. For a color icon, see |X11-icon|.
3338
3339 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003340 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003341 that this flag must be added in the .vimrc file, before
3342 switching on syntax or filetype recognition (when the .gvimrc
3343 file is sourced the system menu has already been loaded; the
3344 ":syntax on" and ":filetype on" commands load the menu too).
3345 'g' Grey menu items: Make menu items that are not active grey. If
3346 'g' is not included inactive menu items are not shown at all.
3347 Exception: Athena will always use grey menu items.
3348
3349 't' Include tearoff menu items. Currently only works for Win32,
3350 GTK+, and Motif 1.2 GUI.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003351 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
3352 and Athena GUIs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003353
3354 'r' Right-hand scrollbar is always present.
3355 'R' Right-hand scrollbar is present when there is a vertically
3356 split window.
3357 'l' Left-hand scrollbar is always present.
3358 'L' Left-hand scrollbar is present when there is a vertically
3359 split window.
3360 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3361 the longest visible line, or on the cursor line if the 'h'
3362 flag is included. |gui-horiz-scroll|
3363 'h' Limit horizontal scrollbar size to the length of the cursor
3364 line. Reduces computations. |gui-horiz-scroll|
3365
3366 And yes, you may even have scrollbars on the left AND the right if
3367 you really want to :-). See |gui-scrollbars| for more information.
3368
3369 'v' Use a vertical button layout for dialogs. When not included,
3370 a horizontal layout is preferred, but when it doesn't fit a
3371 vertical layout is used anyway.
3372 'p' Use Pointer callbacks for X11 GUI. This is required for some
3373 window managers. If the cursor is not blinking or hollow at
3374 the right moment, try adding this flag. This must be done
3375 before starting the GUI. Set it in your gvimrc. Adding or
3376 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003377 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003378
3379 *'guipty'* *'noguipty'*
3380'guipty' boolean (default on)
3381 global
3382 {not in Vi}
3383 {only available when compiled with GUI enabled}
3384 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3385 I/O to/from shell commands. See |gui-pty|.
3386
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003387 *'guitablabel'* *'gtl'*
3388'guitablabel' 'gtl' string (default empty)
3389 global
3390 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003391 {only available when compiled with GUI enabled and
3392 with the +windows feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003393 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003394 pages line. When empty Vim will use a default label. See
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003395 |setting-guitablabel| for more info.
3396
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003397 The format of this option is like that of 'statusline'.
3398
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003399 Only used when the GUI tab pages line is displayed. 'e' must be
3400 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3401 used.
3402
Bram Moolenaar071d4272004-06-13 20:20:40 +00003403 *'helpfile'* *'hf'*
3404'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3405 (others) "$VIMRUNTIME/doc/help.txt")
3406 global
3407 {not in Vi}
3408 Name of the main help file. All distributed help files should be
3409 placed together in one directory. Additionally, all "doc" directories
3410 in 'runtimepath' will be used.
3411 Environment variables are expanded |:set_env|. For example:
3412 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003413 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003414 spaces and backslashes.
3415 This option cannot be set from a |modeline| or in the |sandbox|, for
3416 security reasons.
3417
3418 *'helpheight'* *'hh'*
3419'helpheight' 'hh' number (default 20)
3420 global
3421 {not in Vi}
3422 {not available when compiled without the +windows
3423 feature}
3424 Minimal initial height of the help window when it is opened with the
3425 ":help" command. The initial height of the help window is half of the
3426 current window, or (when the 'ea' option is on) the same as other
3427 windows. When the height is less than 'helpheight', the height is
3428 set to 'helpheight'. Set to zero to disable.
3429
3430 *'helplang'* *'hlg'*
3431'helplang' 'hlg' string (default: messages language or empty)
3432 global
3433 {only available when compiled with the |+multi_lang|
3434 feature}
3435 {not in Vi}
3436 Comma separated list of languages. Vim will use the first language
3437 for which the desired help can be found. The English help will always
3438 be used as a last resort. You can add "en" to prefer English over
3439 another language, but that will only find tags that exist in that
3440 language and not in the English help.
3441 Example: >
3442 :set helplang=de,it
3443< This will first search German, then Italian and finally English help
3444 files.
3445 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3446 try to find the tag in the current language before using this option.
3447 See |help-translated|.
3448
3449 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3450'hidden' 'hid' boolean (default off)
3451 global
3452 {not in Vi}
3453 When off a buffer is unloaded when it is |abandon|ed. When on a
3454 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3455 displayed in another window, it does not become hidden, of course.
3456 The commands that move through the buffer list sometimes make a buffer
3457 hidden although the 'hidden' option is off: When the buffer is
3458 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003459 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003460 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003461 This option is set for one command with ":hide {command}" |:hide|.
3462 WARNING: It's easy to forget that you have changes in hidden buffers.
3463 Think twice when using ":q!" or ":qa!".
3464
3465 *'highlight'* *'hl'*
3466'highlight' 'hl' string (default (as a single string):
3467 "8:SpecialKey,@:NonText,d:Directory,
3468 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3469 M:ModeMsg,n:LineNr,r:Question,
3470 s:StatusLine,S:StatusLineNC,c:VertSplit
3471 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3472 f:Folded,F:FoldColumn,A:DiffAdd,
3473 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003474 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003475 R:SpellRare,L:SpellLocal,
3476 +:Pmenu,=:PmenuSel,
3477 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003478 global
3479 {not in Vi}
3480 This option can be used to set highlighting mode for various
3481 occasions. It is a comma separated list of character pairs. The
3482 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003483 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003484 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3485 |hl-NonText| @ '~' and '@' at the end of the window and
3486 characters from 'showbreak'
3487 |hl-Directory| d directories in CTRL-D listing and other special
3488 things in listings
3489 |hl-ErrorMsg| e error messages
3490 h (obsolete, ignored)
3491 |hl-IncSearch| i 'incsearch' highlighting
3492 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3493 |hl-MoreMsg| m |more-prompt|
3494 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3495 |hl-LineNr| n line number for ":number" and ":#" commands
3496 |hl-Question| r |hit-enter| prompt and yes/no questions
3497 |hl-StatusLine| s status line of current window |status-line|
3498 |hl-StatusLineNC| S status lines of not-current windows
3499 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3500 |hl-VertSplit| c column used to separate vertically split windows
3501 |hl-Visual| v Visual mode
3502 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3503 Selection" Only X11 Gui's |gui-x11| and
3504 |xterm-clipboard|.
3505 |hl-WarningMsg| w warning messages
3506 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3507 |hl-Folded| f line used for closed folds
3508 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003509 |hl-DiffAdd| A added line in diff mode
3510 |hl-DiffChange| C changed line in diff mode
3511 |hl-DiffDelete| D deleted line in diff mode
3512 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003513 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003514 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003515 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003516 |hl-SpellRare| R rare word |spell|
3517 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003518 |hl-Pmenu| + popup menu normal line
3519 |hl-PmenuSel| = popup menu normal line
3520 |hl-PmenuSbar| x popup menu scrollbar
3521 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003522
3523 The display modes are:
3524 r reverse (termcap entry "mr" and "me")
3525 i italic (termcap entry "ZH" and "ZR")
3526 b bold (termcap entry "md" and "me")
3527 s standout (termcap entry "so" and "se")
3528 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003529 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003530 n no highlighting
3531 - no highlighting
3532 : use a highlight group
3533 The default is used for occasions that are not included.
3534 If you want to change what the display modes do, see |dos-colors|
3535 for an example.
3536 When using the ':' display mode, this must be followed by the name of
3537 a highlight group. A highlight group can be used to define any type
3538 of highlighting, including using color. See |:highlight| on how to
3539 define one. The default uses a different group for each occasion.
3540 See |highlight-default| for the default highlight groups.
3541
3542 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3543'hlsearch' 'hls' boolean (default off)
3544 global
3545 {not in Vi}
3546 {not available when compiled without the
3547 |+extra_search| feature}
3548 When there is a previous search pattern, highlight all its matches.
3549 The type of highlighting used can be set with the 'l' occasion in the
3550 'highlight' option. This uses the "Search" highlight group by
3551 default. Note that only the matching text is highlighted, any offsets
3552 are not applied.
3553 See also: 'incsearch' and |:match|.
3554 When you get bored looking at the highlighted matches, you can turn it
3555 off with |:nohlsearch|. As soon as you use a search command, the
3556 highlighting comes back.
3557 When the search pattern can match an end-of-line, Vim will try to
3558 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003559 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560 line below a closed fold. A match in a previous line which is not
3561 drawn may not continue in an newly drawn line.
3562 NOTE: This option is reset when 'compatible' is set.
3563
3564 *'history'* *'hi'*
3565'history' 'hi' number (Vim default: 20, Vi default: 0)
3566 global
3567 {not in Vi}
3568 A history of ":" commands, and a history of previous search patterns
3569 are remembered. This option decides how many entries may be stored in
3570 each of these histories (see |cmdline-editing|).
3571 NOTE: This option is set to the Vi default value when 'compatible' is
3572 set and to the Vim default value when 'compatible' is reset.
3573
3574 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3575'hkmap' 'hk' boolean (default off)
3576 global
3577 {not in Vi}
3578 {only available when compiled with the |+rightleft|
3579 feature}
3580 When on, the keyboard is mapped for the Hebrew character set.
3581 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3582 toggle this option. See |rileft.txt|.
3583 NOTE: This option is reset when 'compatible' is set.
3584
3585 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3586'hkmapp' 'hkp' boolean (default off)
3587 global
3588 {not in Vi}
3589 {only available when compiled with the |+rightleft|
3590 feature}
3591 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3592 This is useful if you have a non-Hebrew keyboard.
3593 See |rileft.txt|.
3594 NOTE: This option is reset when 'compatible' is set.
3595
3596 *'icon'* *'noicon'*
3597'icon' boolean (default off, on when title can be restored)
3598 global
3599 {not in Vi}
3600 {not available when compiled without the |+title|
3601 feature}
3602 When on, the icon text of the window will be set to the value of
3603 'iconstring' (if it is not empty), or to the name of the file
3604 currently being edited. Only the last part of the name is used.
3605 Overridden by the 'iconstring' option.
3606 Only works if the terminal supports setting window icons (currently
3607 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3608 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3609 builtin termcap).
3610 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003611 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003612 X11.
3613
3614 *'iconstring'*
3615'iconstring' string (default "")
3616 global
3617 {not in Vi}
3618 {not available when compiled without the |+title|
3619 feature}
3620 When this option is not empty, it will be used for the icon text of
3621 the window. This happens only when the 'icon' option is on.
3622 Only works if the terminal supports setting window icon text
3623 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3624 Does not work for MS Windows.
3625 When Vim was compiled with HAVE_X11 defined, the original icon will be
3626 restored if possible |X11|.
3627 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003628 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003629 'titlestring' for example settings.
3630 {not available when compiled without the |+statusline| feature}
3631
3632 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3633'ignorecase' 'ic' boolean (default off)
3634 global
3635 Ignore case in search patterns. Also used when searching in the tags
3636 file.
3637 Also see 'smartcase'.
3638 Can be overruled by using "\c" or "\C" in the pattern, see
3639 |/ignorecase|.
3640
3641 *'imactivatekey'* *'imak'*
3642'imactivatekey' 'imak' string (default "")
3643 global
3644 {not in Vi}
3645 {only available when compiled with |+xim| and
3646 |+GUI_GTK|}
3647 Specifies the key that your Input Method in X-Windows uses for
3648 activation. When this is specified correctly, vim can fully control
3649 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3650 You can't use this option to change the activation key, the option
3651 tells Vim what the key is.
3652 Format:
3653 [MODIFIER_FLAG-]KEY_STRING
3654
3655 These characters can be used for MODIFIER_FLAG (case is ignored):
3656 S Shift key
3657 L Lock key
3658 C Control key
3659 1 Mod1 key
3660 2 Mod2 key
3661 3 Mod3 key
3662 4 Mod4 key
3663 5 Mod5 key
3664 Combinations are allowed, for example "S-C-space" or "SC-space" are
3665 both shift+ctrl+space.
3666 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3667
3668 Example: >
3669 :set imactivatekey=S-space
3670< "S-space" means shift+space. This is the activation key for kinput2 +
3671 canna (Japanese), and ami (Korean).
3672
3673 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3674'imcmdline' 'imc' boolean (default off)
3675 global
3676 {not in Vi}
3677 {only available when compiled with the |+xim|
3678 |+multi_byte_ime| or |global-ime| feature}
3679 When set the Input Method is always on when starting to edit a command
3680 line, unless entering a search pattern (see 'imsearch' for that).
3681 Setting this option is useful when your input method allows entering
3682 English characters directly, e.g., when it's used to type accented
3683 characters with dead keys.
3684
3685 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3686'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3687 global
3688 {not in Vi}
3689 {only available when compiled with the |+xim|
3690 |+multi_byte_ime| or |global-ime| feature}
3691 When set the Input Method is never used. This is useful to disable
3692 the IM when it doesn't work properly.
3693 Currently this option is on by default for SGI/IRIX machines. This
3694 may change in later releases.
3695
3696 *'iminsert'* *'imi'*
3697'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3698 local to buffer
3699 {not in Vi}
3700 Specifies whether :lmap or an Input Method (IM) is to be used in
3701 Insert mode. Valid values:
3702 0 :lmap is off and IM is off
3703 1 :lmap is ON and IM is off
3704 2 :lmap is off and IM is ON
3705 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3706 or |global-ime|.
3707 To always reset the option to zero when leaving Insert mode with <Esc>
3708 this can be used: >
3709 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3710< This makes :lmap and IM turn off automatically when leaving Insert
3711 mode.
3712 Note that this option changes when using CTRL-^ in Insert mode
3713 |i_CTRL-^|.
3714 The value is set to 1 when setting 'keymap' to a valid keymap name.
3715 It is also used for the argument of commands like "r" and "f".
3716 The value 0 may not work correctly with Athena and Motif with some XIM
3717 methods. Use 'imdisable' to disable XIM then.
3718
3719 *'imsearch'* *'ims'*
3720'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3721 local to buffer
3722 {not in Vi}
3723 Specifies whether :lmap or an Input Method (IM) is to be used when
3724 entering a search pattern. Valid values:
3725 -1 the value of 'iminsert' is used, makes it look like
3726 'iminsert' is also used when typing a search pattern
3727 0 :lmap is off and IM is off
3728 1 :lmap is ON and IM is off
3729 2 :lmap is off and IM is ON
3730 Note that this option changes when using CTRL-^ in Command-line mode
3731 |c_CTRL-^|.
3732 The value is set to 1 when it is not -1 and setting the 'keymap'
3733 option to a valid keymap name.
3734 The value 0 may not work correctly with Athena and Motif with some XIM
3735 methods. Use 'imdisable' to disable XIM then.
3736
3737 *'include'* *'inc'*
3738'include' 'inc' string (default "^\s*#\s*include")
3739 global or local to buffer |global-local|
3740 {not in Vi}
3741 {not available when compiled without the
3742 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003743 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003744 pattern, just like for the "/" command (See |pattern|). The default
3745 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003746 "]I", "[d", etc.
3747 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003748 comes after the matched pattern. But if "\zs" appears in the pattern
3749 then the text matched from "\zs" to the end, or until "\ze" if it
3750 appears, is used as the file name. Use this to include characters
3751 that are not in 'isfname', such as a space. You can then use
3752 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003753 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003754
3755 *'includeexpr'* *'inex'*
3756'includeexpr' 'inex' string (default "")
3757 local to buffer
3758 {not in Vi}
3759 {not available when compiled without the
3760 |+find_in_path| or |+eval| feature}
3761 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003762 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003763 :set includeexpr=substitute(v:fname,'\\.','/','g')
3764< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003765
Bram Moolenaar071d4272004-06-13 20:20:40 +00003766 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003767 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003768 Also used for |<cfile>|.
3769
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003770 The expression may be evaluated in the |sandbox|, see
3771 |sandbox-option|.
3772
3773 It is not allowed to change text or jump to another window while
3774 evaluating 'includeexpr' |textlock|.
3775
Bram Moolenaar071d4272004-06-13 20:20:40 +00003776 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3777'incsearch' 'is' boolean (default off)
3778 global
3779 {not in Vi}
3780 {not available when compiled without the
3781 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003782 While typing a search command, show where the pattern, as it was typed
3783 so far, matches. The matched string is highlighted. If the pattern
3784 is invalid or not found, nothing is shown. The screen will be updated
3785 often, this is only useful on fast terminals.
3786 Note that the match will be shown, but the cursor will return to its
3787 original position when no match is found and when pressing <Esc>. You
3788 still need to finish the search command with <Enter> to move the
3789 cursor to the match.
3790 The highlighting can be set with the 'i' flag in 'highlight'.
3791 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00003792 CTRL-L can be used to add one character from after the current match
3793 to the command line.
3794 CTRL-R CTRL-W can be used to add the word at the end of the current
3795 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003796 NOTE: This option is reset when 'compatible' is set.
3797
3798 *'indentexpr'* *'inde'*
3799'indentexpr' 'inde' string (default "")
3800 local to buffer
3801 {not in Vi}
3802 {not available when compiled without the |+cindent|
3803 or |+eval| features}
3804 Expression which is evaluated to obtain the proper indent for a line.
3805 It is used when a new line is created, for the |=| operator and
3806 in Insert mode as specified with the 'indentkeys' option.
3807 When this option is not empty, it overrules the 'cindent' and
3808 'smartindent' indenting.
3809 When 'paste' is set this option is not used for indenting.
3810 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003811 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003812 when the expression is evaluated (but it may be moved around).
3813 The expression must return the number of spaces worth of indent. It
3814 can return "-1" to keep the current indent (this means 'autoindent' is
3815 used for the indent).
3816 Functions useful for computing the indent are |indent()|, |cindent()|
3817 and |lispindent()|.
3818 The evaluation of the expression must not have side effects! It must
3819 not change the text, jump to another window, etc. Afterwards the
3820 cursor position is always restored, thus the cursor may be moved.
3821 Normally this option would be set to call a function: >
3822 :set indentexpr=GetMyIndent()
3823< Error messages will be suppressed, unless the 'debug' option contains
3824 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003825 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003826 NOTE: This option is made empty when 'compatible' is set.
3827
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003828 The expression may be evaluated in the |sandbox|, see
3829 |sandbox-option|.
3830
3831 It is not allowed to change text or jump to another window while
3832 evaluating 'indentexpr' |textlock|.
3833
3834
Bram Moolenaar071d4272004-06-13 20:20:40 +00003835 *'indentkeys'* *'indk'*
3836'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3837 local to buffer
3838 {not in Vi}
3839 {not available when compiled without the |+cindent|
3840 feature}
3841 A list of keys that, when typed in Insert mode, cause reindenting of
3842 the current line. Only happens if 'indentexpr' isn't empty.
3843 The format is identical to 'cinkeys', see |indentkeys-format|.
3844 See |C-indenting| and |indent-expression|.
3845
3846 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3847'infercase' 'inf' boolean (default off)
3848 local to buffer
3849 {not in Vi}
3850 When doing keyword completion in insert mode |ins-completion|, and
3851 'ignorecase' is also on, the case of the match is adjusted. If the
3852 typed text contains a lowercase letter where the match has an upper
3853 case letter, the completed part is made lowercase. If the typed text
3854 has no lowercase letters and the match has a lowercase letter where
3855 the typed text has an uppercase letter, and there is a letter before
3856 it, the completed part is made uppercase.
3857
3858 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3859'insertmode' 'im' boolean (default off)
3860 global
3861 {not in Vi}
3862 Makes Vim work in a way that Insert mode is the default mode. Useful
3863 if you want to use Vim as a modeless editor. Used for |evim|.
3864 These Insert mode commands will be useful:
3865 - Use the cursor keys to move around.
3866 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3867 this is a mapping, it is executed as if 'insertmode' was off.
3868 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003869 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00003870 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
3871 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003872
3873 These items change when 'insertmode' is set:
3874 - when starting to edit of a file, Vim goes to Insert mode.
3875 - <Esc> in Insert mode is a no-op and beeps.
3876 - <Esc> in Normal mode makes Vim go to Insert mode.
3877 - CTRL-L in Insert mode is a command, it is not inserted.
3878 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3879 However, when <Esc> is used inside a mapping, it behaves like
3880 'insertmode' was not set. This was done to be able to use the same
3881 mappings with 'insertmode' set or not set.
3882 When executing commands with |:normal| 'insertmode' is not used.
3883
3884 NOTE: This option is reset when 'compatible' is set.
3885
3886 *'isfname'* *'isf'*
3887'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3888 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3889 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3890 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3891 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3892 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3893 global
3894 {not in Vi}
3895 The characters specified by this option are included in file names and
3896 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003897 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003898 Multi-byte characters 256 and above are always included, only the
3899 characters up to 255 are specified with this option.
3900 For UTF-8 the characters 0xa0 to 0xff are included as well.
3901
3902 Note that on systems using a backslash as path separator, Vim tries to
3903 do its best to make it work as you would expect. That is a bit
3904 tricky, since Vi originally used the backslash to escape special
3905 characters. Vim will not remove a backslash in front of a normal file
3906 name character on these systems, but it will on Unix and alikes. The
3907 '&' and '^' are not included by default, because these are special for
3908 cmd.exe.
3909
3910 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003911 Each part can be a single character number or a range. A range is two
3912 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913 decimal number between 0 and 255 or the ASCII character itself (does
3914 not work for digits). Example:
3915 "_,-,128-140,#-43" (include '_' and '-' and the range
3916 128 to 140 and '#' to 43)
3917 If a part starts with '^', the following character number or range
3918 will be excluded from the option. The option is interpreted from left
3919 to right. Put the excluded character after the range where it is
3920 included. To include '^' itself use it as the last character of the
3921 option or the end of a range. Example:
3922 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3923 If the character is '@', all characters where isalpha() returns TRUE
3924 are included. Normally these are the characters a to z and A to Z,
3925 plus accented characters. To include '@' itself use "@-@". Examples:
3926 "@,^a-z" All alphabetic characters, excluding lower
3927 case letters.
3928 "a-z,A-Z,@-@" All letters plus the '@' character.
3929 A comma can be included by using it where a character number is
3930 expected. Example:
3931 "48-57,,,_" Digits, comma and underscore.
3932 A comma can be excluded by prepending a '^'. Example:
3933 " -~,^,,9" All characters from space to '~', excluding
3934 comma, plus <Tab>.
3935 See |option-backslash| about including spaces and backslashes.
3936
3937 *'isident'* *'isi'*
3938'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3939 "@,48-57,_,128-167,224-235"
3940 otherwise: "@,48-57,_,192-255")
3941 global
3942 {not in Vi}
3943 The characters given by this option are included in identifiers.
3944 Identifiers are used in recognizing environment variables and after a
3945 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00003946 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00003947 option.
3948 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003949 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003950 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3951
3952 *'iskeyword'* *'isk'*
3953'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3954 "@,48-57,_,128-167,224-235"
3955 otherwise: "@,48-57,_,192-255"
3956 Vi default: "@,48-57,_")
3957 local to buffer
3958 {not in Vi}
3959 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003960 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003961 'isfname' for a description of the format of this option. For C
3962 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3963 For a help file it is set to all non-blank printable characters except
3964 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3965 command).
3966 When the 'lisp' option is on the '-' character is always included.
3967 NOTE: This option is set to the Vi default value when 'compatible' is
3968 set and to the Vim default value when 'compatible' is reset.
3969
3970 *'isprint'* *'isp'*
3971'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3972 "@,~-255"; otherwise: "@,161-255")
3973 global
3974 {not in Vi}
3975 The characters given by this option are displayed directly on the
3976 screen. It is also used for "\p" in a |pattern|. The characters from
3977 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3978 even when they are not included in 'isprint' or excluded. See
3979 'isfname' for a description of the format of this option.
3980
3981 Non-printable characters are displayed with two characters:
3982 0 - 31 "^@" - "^_"
3983 32 - 126 always single characters
3984 127 "^?"
3985 128 - 159 "~@" - "~_"
3986 160 - 254 "| " - "|~"
3987 255 "~?"
3988 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3989 displayed as <xx>, with the hexadecimal value of the byte.
3990 When 'display' contains "uhex" all unprintable characters are
3991 displayed as <xx>.
3992 The NonText highlighting will be used for unprintable characters.
3993 |hl-NonText|
3994
3995 Multi-byte characters 256 and above are always included, only the
3996 characters up to 255 are specified with this option. When a character
3997 is printable but it is not available in the current font, a
3998 replacement character will be shown.
3999 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4000 There is no option to specify these characters.
4001
4002 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4003'joinspaces' 'js' boolean (default on)
4004 global
4005 {not in Vi}
4006 Insert two spaces after a '.', '?' and '!' with a join command.
4007 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4008 Otherwise only one space is inserted.
4009 NOTE: This option is set when 'compatible' is set.
4010
4011 *'key'*
4012'key' string (default "")
4013 local to buffer
4014 {not in Vi}
4015 The key that is used for encrypting and decrypting the current buffer.
4016 See |encryption|.
4017 Careful: Do not set the key value by hand, someone might see the typed
4018 key. Use the |:X| command. But you can make 'key' empty: >
4019 :set key=
4020< It is not possible to get the value of this option with ":set key" or
4021 "echo &key". This is to avoid showing it to someone who shouldn't
4022 know. It also means you cannot see it yourself once you have set it,
4023 be careful not to make a typing error!
4024
4025 *'keymap'* *'kmp'* *E544*
4026'keymap' 'kmp' string (default "")
4027 local to buffer
4028 {not in Vi}
4029 {only available when compiled with the |+keymap|
4030 feature}
4031 Name of a keyboard mapping. See |mbyte-keymap|.
4032 Setting this option to a valid keymap name has the side effect of
4033 setting 'iminsert' to one, so that the keymap becomes effective.
4034 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004035 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004036
4037 *'keymodel'* *'km'*
4038'keymodel' 'km' string (default "")
4039 global
4040 {not in Vi}
4041 List of comma separated words, which enable special things that keys
4042 can do. These values can be used:
4043 startsel Using a shifted special key starts selection (either
4044 Select mode or Visual mode, depending on "key" being
4045 present in 'selectmode').
4046 stopsel Using a not-shifted special key stops selection.
4047 Special keys in this context are the cursor keys, <End>, <Home>,
4048 <PageUp> and <PageDown>.
4049 The 'keymodel' option is set by the |:behave| command.
4050
4051 *'keywordprg'* *'kp'*
4052'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4053 OS/2: "view /", VMS: "help")
4054 global or local to buffer |global-local|
4055 {not in Vi}
4056 Program to use for the |K| command. Environment variables are
4057 expanded |:set_env|. ":help" may be used to access the Vim internal
4058 help. (Note that previously setting the global option to the empty
4059 value did this, which is now deprecated.)
4060 When "man" is used, Vim will automatically translate a count for the
4061 "K" command to a section number. Also for "man -s", in which case the
4062 "-s" is removed when there is no count.
4063 See |option-backslash| about including spaces and backslashes.
4064 Example: >
4065 :set keywordprg=man\ -s
4066< This option cannot be set from a |modeline| or in the |sandbox|, for
4067 security reasons.
4068
4069 *'langmap'* *'lmap'* *E357* *E358*
4070'langmap' 'lmap' string (default "")
4071 global
4072 {not in Vi}
4073 {only available when compiled with the |+langmap|
4074 feature}
4075 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004076 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004077 inserted directly. When in command mode the 'langmap' option takes
4078 care of translating these special characters to the original meaning
4079 of the key. This means you don't have to change the keyboard mode to
4080 be able to execute Normal mode commands.
4081 This is the opposite of the 'keymap' option, where characters are
4082 mapped in Insert mode.
4083 This only works for 8-bit characters. The value of 'langmap' may be
4084 specified with multi-byte characters (e.g., UTF-8), but only the lower
4085 8 bits of each character will be used.
4086
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004087 Example (for Greek, in UTF-8): *greek* >
4088 :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
Bram Moolenaar071d4272004-06-13 20:20:40 +00004089< Example (exchanges meaning of z and y for commands): >
4090 :set langmap=zy,yz,ZY,YZ
4091<
4092 The 'langmap' option is a list of parts, separated with commas. Each
4093 part can be in one of two forms:
4094 1. A list of pairs. Each pair is a "from" character immediately
4095 followed by the "to" character. Examples: "aA", "aAbBcC".
4096 2. A list of "from" characters, a semi-colon and a list of "to"
4097 characters. Example: "abc;ABC"
4098 Example: "aA,fgh;FGH,cCdDeE"
4099 Special characters need to be preceded with a backslash. These are
4100 ";", ',' and backslash itself.
4101
4102 This will allow you to activate vim actions without having to switch
4103 back and forth between the languages. Your language characters will
4104 be understood as normal vim English characters (according to the
4105 langmap mappings) in the following cases:
4106 o Normal/Visual mode (commands, buffer/register names, user mappings)
4107 o Insert/Replace Mode: Register names after CTRL-R
4108 o Insert/Replace Mode: Mappings
4109 Characters entered in Command-line mode will NOT be affected by
4110 this option. Note that this option can be changed at any time
4111 allowing to switch between mappings for different languages/encodings.
4112 Use a mapping to avoid having to type it each time!
4113
4114 *'langmenu'* *'lm'*
4115'langmenu' 'lm' string (default "")
4116 global
4117 {not in Vi}
4118 {only available when compiled with the |+menu| and
4119 |+multi_lang| features}
4120 Language to use for menu translation. Tells which file is loaded
4121 from the "lang" directory in 'runtimepath': >
4122 "lang/menu_" . &langmenu . ".vim"
4123< (without the spaces). For example, to always use the Dutch menus, no
4124 matter what $LANG is set to: >
4125 :set langmenu=nl_NL.ISO_8859-1
4126< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004127 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128 If your $LANG is set to a non-English language but you do want to use
4129 the English menus: >
4130 :set langmenu=none
4131< This option must be set before loading menus, switching on filetype
4132 detection or syntax highlighting. Once the menus are defined setting
4133 this option has no effect. But you could do this: >
4134 :source $VIMRUNTIME/delmenu.vim
4135 :set langmenu=de_DE.ISO_8859-1
4136 :source $VIMRUNTIME/menu.vim
4137< Warning: This deletes all menus that you defined yourself!
4138
4139 *'laststatus'* *'ls'*
4140'laststatus' 'ls' number (default 1)
4141 global
4142 {not in Vi}
4143 The value of this option influences when the last window will have a
4144 status line:
4145 0: never
4146 1: only if there are at least two windows
4147 2: always
4148 The screen looks nicer with a status line if you have several
4149 windows, but it takes another screen line. |status-line|
4150
4151 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4152'lazyredraw' 'lz' boolean (default off)
4153 global
4154 {not in Vi}
4155 When this option is set, the screen will not be redrawn while
4156 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004157 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004158 update use |:redraw|.
4159
4160 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4161'linebreak' 'lbr' boolean (default off)
4162 local to window
4163 {not in Vi}
4164 {not available when compiled without the |+linebreak|
4165 feature}
4166 If on Vim will wrap long lines at a character in 'breakat' rather
4167 than at the last character that fits on the screen. Unlike
4168 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4169 it only affects the way the file is displayed, not its contents. The
4170 value of 'showbreak' is used to put in front of wrapped lines.
4171 This option is not used when the 'wrap' option is off or 'list' is on.
4172 Note that <Tab> characters after an <EOL> are mostly not displayed
4173 with the right amount of white space.
4174
4175 *'lines'* *E593*
4176'lines' number (default 24 or terminal height)
4177 global
4178 Number of lines of the Vim window.
4179 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004180 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004181 When Vim is running in the GUI or in a resizable window, setting this
4182 option will cause the window size to be changed. When you only want
4183 to use the size for the GUI, put the command in your |gvimrc| file.
4184 Vim limits the number of lines to what fits on the screen. You can
4185 use this command to get the tallest window possible: >
4186 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004187< Minimum value is 2, maximum value is 1000.
4188 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004189 When you set this option and Vim is unable to change the physical
4190 number of lines of the display, the display may be messed up.
4191
4192 *'linespace'* *'lsp'*
4193'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4194 global
4195 {not in Vi}
4196 {only in the GUI}
4197 Number of pixel lines inserted between characters. Useful if the font
4198 uses the full character cell height, making lines touch each other.
4199 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004200 With some fonts there can be too much room between lines (to have
4201 space for ascents and descents). Then it makes sense to set
4202 'linespace' to a negative value. This may cause display problems
4203 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004204
4205 *'lisp'* *'nolisp'*
4206'lisp' boolean (default off)
4207 local to buffer
4208 {not available when compiled without the |+lispindent|
4209 feature}
4210 Lisp mode: When <Enter> is typed in insert mode set the indent for
4211 the next line to Lisp standards (well, sort of). Also happens with
4212 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4213 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4214 better. Also see 'lispwords'.
4215 The '-' character is included in keyword characters. Redefines the
4216 "=" operator to use this same indentation algorithm rather than
4217 calling an external program if 'equalprg' is empty.
4218 This option is not used when 'paste' is set.
4219 {Vi: Does it a little bit differently}
4220
4221 *'lispwords'* *'lw'*
4222'lispwords' 'lw' string (default is very long)
4223 global
4224 {not in Vi}
4225 {not available when compiled without the |+lispindent|
4226 feature}
4227 Comma separated list of words that influence the Lisp indenting.
4228 |'lisp'|
4229
4230 *'list'* *'nolist'*
4231'list' boolean (default off)
4232 local to window
4233 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
4234 see the difference between tabs and spaces and for trailing blanks.
4235 Note that this will also affect formatting (set with 'textwidth' or
4236 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
4237 changing the way tabs are displayed.
4238
4239 *'listchars'* *'lcs'*
4240'listchars' 'lcs' string (default "eol:$")
4241 global
4242 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004243 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004244 settings.
4245 eol:c Character to show at the end of each line. When
4246 omitted, there is no extra character at the end of the
4247 line.
4248 tab:xy Two characters to be used to show a Tab. The first
4249 char is used once. The second char is repeated to
4250 fill the space that the Tab normally occupies.
4251 "tab:>-" will show a Tab that takes four spaces as
4252 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004253 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004254 trailing spaces are blank.
4255 extends:c Character to show in the last column, when 'wrap' is
4256 off and the line continues beyond the right of the
4257 screen.
4258 precedes:c Character to show in the first column, when 'wrap'
4259 is off and there is text preceding the character
4260 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004261 nbsp:c Character to show for a non-breakable space (character
4262 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004263
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004264 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004265 be used when 'encoding' is "utf-8", otherwise only printable
4266 characters are allowed.
4267
4268 Examples: >
4269 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004270 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004271 :set lcs=extends:>,precedes:<
4272< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004273 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004274
4275 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4276'loadplugins' 'lpl' boolean (default on)
4277 global
4278 {not in Vi}
4279 When on the plugin scripts are loaded when starting up |load-plugins|.
4280 This option can be reset in your |vimrc| file to disable the loading
4281 of plugins.
4282 Note that using the "-u NONE" and "--noplugin" command line arguments
4283 reset this option. |-u| |--noplugin|
4284
4285 *'magic'* *'nomagic'*
4286'magic' boolean (default on)
4287 global
4288 Changes the special characters that can be used in search patterns.
4289 See |pattern|.
4290 NOTE: To avoid portability problems with using patterns, always keep
4291 this option at the default "on". Only switch it off when working with
4292 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004293 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004294
4295 *'makeef'* *'mef'*
4296'makeef' 'mef' string (default: "")
4297 global
4298 {not in Vi}
4299 {not available when compiled without the |+quickfix|
4300 feature}
4301 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4302 and the |:grep| command.
4303 When it is empty, an internally generated temp file will be used.
4304 When "##" is included, it is replaced by a number to make the name
4305 unique. This makes sure that the ":make" command doesn't overwrite an
4306 existing file.
4307 NOT used for the ":cf" command. See 'errorfile' for that.
4308 Environment variables are expanded |:set_env|.
4309 See |option-backslash| about including spaces and backslashes.
4310 This option cannot be set from a |modeline| or in the |sandbox|, for
4311 security reasons.
4312
4313 *'makeprg'* *'mp'*
4314'makeprg' 'mp' string (default "make", VMS: "MMS")
4315 global or local to buffer |global-local|
4316 {not in Vi}
4317 Program to use for the ":make" command. See |:make_makeprg|. This
4318 option may contain '%' and '#' characters, which are expanded like
4319 when used in a command-line. Environment variables are expanded
4320 |:set_env|. See |option-backslash| about including spaces and
4321 backslashes. Note that a '|' must be escaped twice: once for ":set"
4322 and once for the interpretation of a command. When you use a filter
4323 called "myfilter" do it like this: >
4324 :set makeprg=gmake\ \\\|\ myfilter
4325< The placeholder "$*" can be given (even multiple times) to specify
4326 where the arguments will be included, for example: >
4327 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4328< This option cannot be set from a |modeline| or in the |sandbox|, for
4329 security reasons.
4330
4331 *'matchpairs'* *'mps'*
4332'matchpairs' 'mps' string (default "(:),{:},[:]")
4333 local to buffer
4334 {not in Vi}
4335 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004336 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00004337 must be different. The characters must be separated by a colon. The
4338 pairs must be separated by a comma. Example for including '<' and '>'
4339 (HTML): >
4340 :set mps+=<:>
4341
4342< A more exotic example, to jump between the '=' and ';' in an
4343 assignment, useful for languages like C and Java: >
4344 :au FileType c,cpp,java set mps+==:;
4345
4346< For a more advanced way of using "%", see the matchit.vim plugin in
4347 the $VIMRUNTIME/macros directory. |add-local-help|
4348
4349 *'matchtime'* *'mat'*
4350'matchtime' 'mat' number (default 5)
4351 global
4352 {not in Vi}{in Nvi}
4353 Tenths of a second to show the matching paren, when 'showmatch' is
4354 set. Note that this is not in milliseconds, like other options that
4355 set a time. This is to be compatible with Nvi.
4356
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004357 *'maxcombine'* *'mco'*
4358'maxcombine' 'mco' number (default 2)
4359 global
4360 {not in Vi}
4361 {only available when compiled with the |+multi_byte|
4362 feature}
4363 The maximum number of combining characters supported for displaying.
4364 Only used when 'encoding' is "utf-8".
4365 The default is OK for most languages. Hebrew may require 4.
4366 Maximum value is 6.
4367 Even when this option is set to 2 you can still edit text with more
4368 combining characters, you just can't see them. Use |g8| or |ga|.
4369 See |mbyte-combining|.
4370
Bram Moolenaar071d4272004-06-13 20:20:40 +00004371 *'maxfuncdepth'* *'mfd'*
4372'maxfuncdepth' 'mfd' number (default 100)
4373 global
4374 {not in Vi}
4375 Maximum depth of function calls for user functions. This normally
4376 catches endless recursion. When using a recursive function with
4377 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4378 more memory, there is the danger of failing when memory is exhausted.
4379 See also |:function|.
4380
4381 *'maxmapdepth'* *'mmd'* *E223*
4382'maxmapdepth' 'mmd' number (default 1000)
4383 global
4384 {not in Vi}
4385 Maximum number of times a mapping is done without resulting in a
4386 character to be used. This normally catches endless mappings, like
4387 ":map x y" with ":map y x". It still does not catch ":map g wg",
4388 because the 'w' is used before the next mapping is done. See also
4389 |key-mapping|.
4390
4391 *'maxmem'* *'mm'*
4392'maxmem' 'mm' number (default between 256 to 5120 (system
4393 dependent) or half the amount of memory
4394 available)
4395 global
4396 {not in Vi}
4397 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4398 limit is reached allocating extra memory for a buffer will cause
4399 other memory to be freed. Maximum value 2000000. Use this to work
4400 without a limit. Also see 'maxmemtot'.
4401
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004402 *'maxmempattern'* *'mmp'*
4403'maxmempattern' 'mmp' number (default 1000)
4404 global
4405 {not in Vi}
4406 Maximum amount of memory (in Kbyte) to use for pattern matching.
4407 Maximum value 2000000. Use this to work without a limit.
4408 *E363*
4409 When Vim runs into the limit it gives an error message mostly behaves
4410 like CTRL-C was typed.
4411 Running into the limit often means that the pattern is very
4412 inefficient or too complex. This may already happen with the pattern
4413 "\(.\)*" on a very long line. ".*" works much better.
4414 Vim may run out of memory before hitting the 'maxmempattern' limit.
4415
Bram Moolenaar071d4272004-06-13 20:20:40 +00004416 *'maxmemtot'* *'mmt'*
4417'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4418 dependent) or half the amount of memory
4419 available)
4420 global
4421 {not in Vi}
4422 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004423 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004424 'maxmem'.
4425
4426 *'menuitems'* *'mis'*
4427'menuitems' 'mis' number (default 25)
4428 global
4429 {not in Vi}
4430 {not available when compiled without the |+menu|
4431 feature}
4432 Maximum number of items to use in a menu. Used for menus that are
4433 generated from a list of items, e.g., the Buffers menu. Changing this
4434 option has no direct effect, the menu must be refreshed first.
4435
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004436 *'mkspellmem'* *'msm'*
4437'mkspellmem' 'msm' string (default "460000,2000,500")
4438 global
4439 {not in Vi}
4440 {not available when compiled without the |+syntax|
4441 feature}
4442 Parameters for |:mkspell|. This tunes when to start compressing the
4443 word tree. Compression can be slow when there are many words, but
4444 it's needed to avoid running out of memory. The amount of memory used
4445 per word depends very much on how similar the words are, that's why
4446 this tuning is complicated.
4447
4448 There are three numbers, separated by commas:
4449 {start},{inc},{added}
4450
4451 For most languages the uncompressed word tree fits in memory. {start}
4452 gives the amount of memory in Kbyte that can be used before any
4453 compression is done. It should be a bit smaller than the amount of
4454 memory that is available to Vim.
4455
4456 When going over the {start} limit the {inc} number specifies the
4457 amount of memory in Kbyte that can be allocated before another
4458 compression is done. A low number means compression is done after
4459 less words are added, which is slow. A high number means more memory
4460 will be allocated.
4461
4462 After doing compression, {added} times 1024 words can be added before
4463 the {inc} limit is ignored and compression is done when any extra
4464 amount of memory is needed. A low number means there is a smaller
4465 chance of hitting the {inc} limit, less memory is used but it's
4466 slower.
4467
4468 The languages for which these numbers are important are Italian and
4469 Hungarian. The default works for when you have about 512 Mbyte. If
4470 you have 1 Gbyte you could use: >
4471 :set mkspellmem=900000,3000,800
4472< If you have less than 512 Mbyte |:mkspell| may fail for some
4473 languages, no matter what you set 'mkspellmem' to.
4474
Bram Moolenaar071d4272004-06-13 20:20:40 +00004475 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4476'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4477 local to buffer
4478 *'modelines'* *'mls'*
4479'modelines' 'mls' number (default 5)
4480 global
4481 {not in Vi}
4482 If 'modeline' is on 'modelines' gives the number of lines that is
4483 checked for set commands. If 'modeline' is off or 'modelines' is zero
4484 no lines are checked. See |modeline|.
4485 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4486 set and to the Vim default value when 'compatible' is reset.
4487
4488 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4489'modifiable' 'ma' boolean (default on)
4490 local to buffer
4491 {not in Vi} *E21*
4492 When off the buffer contents cannot be changed. The 'fileformat' and
4493 'fileencoding' options also can't be changed.
4494 Can be reset with the |-M| command line argument.
4495
4496 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4497'modified' 'mod' boolean (default off)
4498 local to buffer
4499 {not in Vi}
4500 When on, the buffer is considered to be modified. This option is set
4501 when:
4502 1. A change was made to the text since it was last written. Using the
4503 |undo| command to go back to the original text will reset the
4504 option. But undoing changes that were made before writing the
4505 buffer will set the option again, since the text is different from
4506 when it was written.
4507 2. 'fileformat' or 'fileencoding' is different from its original
4508 value. The original value is set when the buffer is read or
4509 written. A ":set nomodified" command also resets the original
4510 values to the current values and the 'modified' option will be
4511 reset.
4512 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4513 will be ignored.
4514
4515 *'more'* *'nomore'*
4516'more' boolean (Vim default: on, Vi default: off)
4517 global
4518 {not in Vi}
4519 When on, listings pause when the whole screen is filled. You will get
4520 the |more-prompt|. When this option is off there are no pauses, the
4521 listing continues until finished.
4522 NOTE: This option is set to the Vi default value when 'compatible' is
4523 set and to the Vim default value when 'compatible' is reset.
4524
4525 *'mouse'* *E538*
4526'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4527 global
4528 {not in Vi}
4529 Enable the use of the mouse. Only works for certain terminals
4530 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4531 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4532 The mouse can be enabled for different modes:
4533 n Normal mode
4534 v Visual mode
4535 i Insert mode
4536 c Command-line mode
4537 h all previous modes when editing a help file
4538 a all previous modes
4539 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004540 Normally you would enable the mouse in all four modes with: >
4541 :set mouse=a
4542< When the mouse is not enabled, the GUI will still use the mouse for
4543 modeless selection. This doesn't move the text cursor.
4544
4545 See |mouse-using|. Also see |'clipboard'|.
4546
4547 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004548 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004549 the mouse buttons can still be used by keeping the shift key pressed.
4550 Also see the 'clipboard' option.
4551
4552 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4553'mousefocus' 'mousef' boolean (default off)
4554 global
4555 {not in Vi}
4556 {only works in the GUI}
4557 The window that the mouse pointer is on is automatically activated.
4558 When changing the window layout or window focus in another way, the
4559 mouse pointer is moved to the window with keyboard focus. Off is the
4560 default because it makes using the pull down menus a little goofy, as
4561 a pointer transit may activate a window unintentionally.
4562
4563 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4564'mousehide' 'mh' boolean (default on)
4565 global
4566 {not in Vi}
4567 {only works in the GUI}
4568 When on, the mouse pointer is hidden when characters are typed.
4569 The mouse pointer is restored when the mouse is moved.
4570
4571 *'mousemodel'* *'mousem'*
4572'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4573 global
4574 {not in Vi}
4575 Sets the model to use for the mouse. The name mostly specifies what
4576 the right mouse button is used for:
4577 extend Right mouse button extends a selection. This works
4578 like in an xterm.
4579 popup Right mouse button pops up a menu. The shifted left
4580 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004581 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004582 popup_setpos Like "popup", but the cursor will be moved to the
4583 position where the mouse was clicked, and thus the
4584 selected operation will act upon the clicked object.
4585 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004586 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004587 course, that right clicking outside a selection will
4588 end Visual mode.
4589 Overview of what button does what for each model:
4590 mouse extend popup(_setpos) ~
4591 left click place cursor place cursor
4592 left drag start selection start selection
4593 shift-left search word extend selection
4594 right click extend selection popup menu (place cursor)
4595 right drag extend selection -
4596 middle click paste paste
4597
4598 In the "popup" model the right mouse button produces a pop-up menu.
4599 You need to define this first, see |popup-menu|.
4600
4601 Note that you can further refine the meaning of buttons with mappings.
4602 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4603 selection (because that's handled in the GUI code directly).
4604
4605 The 'mousemodel' option is set by the |:behave| command.
4606
4607 *'mouseshape'* *'mouses'* *E547*
4608'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004609 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004610 global
4611 {not in Vi}
4612 {only available when compiled with the |+mouseshape|
4613 feature}
4614 This option tells Vim what the mouse pointer should look like in
4615 different modes. The option is a comma separated list of parts, much
4616 like used for 'guicursor'. Each part consist of a mode/location-list
4617 and an argument-list:
4618 mode-list:shape,mode-list:shape,..
4619 The mode-list is a dash separated list of these modes/locations:
4620 In a normal window: ~
4621 n Normal mode
4622 v Visual mode
4623 ve Visual mode with 'selection' "exclusive" (same as 'v',
4624 if not specified)
4625 o Operator-pending mode
4626 i Insert mode
4627 r Replace mode
4628
4629 Others: ~
4630 c appending to the command-line
4631 ci inserting in the command-line
4632 cr replacing in the command-line
4633 m at the 'Hit ENTER' or 'More' prompts
4634 ml idem, but cursor in the last line
4635 e any mode, pointer below last window
4636 s any mode, pointer on a status line
4637 sd any mode, while dragging a status line
4638 vs any mode, pointer on a vertical separator line
4639 vd any mode, while dragging a vertical separator line
4640 a everywhere
4641
4642 The shape is one of the following:
4643 avail name looks like ~
4644 w x arrow Normal mouse pointer
4645 w x blank no pointer at all (use with care!)
4646 w x beam I-beam
4647 w x updown up-down sizing arrows
4648 w x leftright left-right sizing arrows
4649 w x busy The system's usual busy pointer
4650 w x no The system's usual 'no input' pointer
4651 x udsizing indicates up-down resizing
4652 x lrsizing indicates left-right resizing
4653 x crosshair like a big thin +
4654 x hand1 black hand
4655 x hand2 white hand
4656 x pencil what you write with
4657 x question big ?
4658 x rightup-arrow arrow pointing right-up
4659 w x up-arrow arrow pointing up
4660 x <number> any X11 pointer number (see X11/cursorfont.h)
4661
4662 The "avail" column contains a 'w' if the shape is available for Win32,
4663 x for X11.
4664 Any modes not specified or shapes not available use the normal mouse
4665 pointer.
4666
4667 Example: >
4668 :set mouseshape=s:udsizing,m:no
4669< will make the mouse turn to a sizing arrow over the status lines and
4670 indicate no input when the hit-enter prompt is displayed (since
4671 clicking the mouse has no effect in this state.)
4672
4673 *'mousetime'* *'mouset'*
4674'mousetime' 'mouset' number (default 500)
4675 global
4676 {not in Vi}
4677 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4678 time in msec between two mouse clicks for the second click to be
4679 recognized as a multi click.
4680
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004681 *'mzquantum'* *'mzq'*
4682'mzquantum' 'mzq' number (default 100)
4683 global
4684 {not in Vi}
4685 {not available when compiled without the |+mzscheme|
4686 feature}
4687 The number of milliseconds between polls for MzScheme threads.
4688 Negative or zero value means no thread scheduling.
4689
Bram Moolenaar071d4272004-06-13 20:20:40 +00004690 *'nrformats'* *'nf'*
4691'nrformats' 'nf' string (default "octal,hex")
4692 local to buffer
4693 {not in Vi}
4694 This defines what bases Vim will consider for numbers when using the
4695 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4696 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004697 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004698 incremented or decremented. This is useful for a list with a
4699 letter index a), b), etc.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004700 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004701 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004702 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004703 considered to be hexadecimal. Example: Using CTRL-X on
4704 "0x100" results in "0x0ff".
4705 Numbers which simply begin with a digit in the range 1-9 are always
4706 considered decimal. This also happens for numbers that are not
4707 recognized as octal or hex.
4708
4709 *'number'* *'nu'* *'nonumber'* *'nonu'*
4710'number' 'nu' boolean (default off)
4711 local to window
4712 Print the line number in front of each line. When the 'n' option is
4713 excluded from 'cpoptions' a wrapped line will not use the column of
4714 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004715 The 'numberwidth' option can be used to set the room used for the line
4716 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004717 When a long, wrapped line doesn't start with the first character, '-'
4718 characters are put before the number.
4719 See |hl-LineNr| for the highlighting used for the number.
4720
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004721 *'numberwidth'* *'nuw'*
4722'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4723 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004724 {not in Vi}
4725 {only available when compiled with the |+linebreak|
4726 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004727 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00004728 when the 'number' option is set or printing lines with a line number.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004729 Since one space is always between the number and the text, there is
4730 one less character for the number itself.
4731 The value is the minimum width. A bigger width is used when needed to
4732 fit the highest line number in the buffer. Thus with the Vim default
4733 of 4 there is room for a line number up to 999. When the buffer has
4734 1000 lines five columns will be used.
4735 The minimum value is 1, the maximum value is 10.
4736 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4737
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004738 *'omnifunc'* *'ofu'*
4739'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00004740 local to buffer
4741 {not in Vi}
4742 {not available when compiled without the +eval
4743 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00004744 This option specifies a function to be used for Insert mode omni
4745 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00004746 See |complete-functions| for an explanation of how the function is
4747 invoked and what it should return.
Bram Moolenaare344bea2005-09-01 20:46:49 +00004748
4749
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00004750 *'operatorfunc'* *'opfunc'*
4751'operatorfunc' 'opfunc' string (default: empty)
4752 global
4753 {not in Vi}
4754 This option specifies a function to be called by the |g@| operator.
4755 See |:map-operator| for more info and an example.
4756
4757 This option cannot be set from a |modeline| or in the |sandbox|, for
4758 security reasons.
4759
4760
Bram Moolenaar071d4272004-06-13 20:20:40 +00004761 *'osfiletype'* *'oft'* *E366*
4762'osfiletype' 'oft' string (RISC-OS default: "Text",
4763 others default: "")
4764 local to buffer
4765 {not in Vi}
4766 {only available when compiled with the |+osfiletype|
4767 feature}
4768 Some operating systems store extra information about files besides
4769 name, datestamp and permissions. This option contains the extra
4770 information, the nature of which will vary between systems.
4771 The value of this option is usually set when the file is loaded, and
4772 use to set the file type when file is written.
4773 It can affect the pattern matching of the automatic commands.
4774 |autocmd-osfiletypes|
4775
4776 *'paragraphs'* *'para'*
4777'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4778 global
4779 Specifies the nroff macros that separate paragraphs. These are pairs
4780 of two letters (see |object-motions|).
4781
4782 *'paste'* *'nopaste'*
4783'paste' boolean (default off)
4784 global
4785 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004786 Put Vim in Paste mode. This is useful if you want to cut or copy
4787 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004788 unexpected effects.
4789 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004790 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004791 knows about pasting and will mostly do the right thing without 'paste'
4792 being set. The same is true for a terminal where Vim handles the
4793 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004794 This option is reset when starting the GUI. Thus if you set it in
4795 your .vimrc it will work in a terminal, but not in the GUI. Setting
4796 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4797 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004798 When the 'paste' option is switched on (also when it was already on):
4799 - mapping in Insert mode and Command-line mode is disabled
4800 - abbreviations are disabled
4801 - 'textwidth' is set to 0
4802 - 'wrapmargin' is set to 0
4803 - 'autoindent' is reset
4804 - 'smartindent' is reset
4805 - 'softtabstop' is set to 0
4806 - 'revins' is reset
4807 - 'ruler' is reset
4808 - 'showmatch' is reset
4809 - 'formatoptions' is used like it is empty
4810 These options keep their value, but their effect is disabled:
4811 - 'lisp'
4812 - 'indentexpr'
4813 - 'cindent'
4814 NOTE: When you start editing another file while the 'paste' option is
4815 on, settings from the modelines or autocommands may change the
4816 settings again, causing trouble when pasting text. You might want to
4817 set the 'paste' option again.
4818 When the 'paste' option is reset the mentioned options are restored to
4819 the value before the moment 'paste' was switched from off to on.
4820 Resetting 'paste' before ever setting it does not have any effect.
4821 Since mapping doesn't work while 'paste' is active, you need to use
4822 the 'pastetoggle' option to toggle the 'paste' option with some key.
4823
4824 *'pastetoggle'* *'pt'*
4825'pastetoggle' 'pt' string (default "")
4826 global
4827 {not in Vi}
4828 When non-empty, specifies the key sequence that toggles the 'paste'
4829 option. This is like specifying a mapping: >
4830 :map {keys} :set invpaste<CR>
4831< Where {keys} is the value of 'pastetoggle'.
4832 The difference is that it will work even when 'paste' is set.
4833 'pastetoggle' works in Insert mode and Normal mode, but not in
4834 Command-line mode.
4835 Mappings are checked first, thus overrule 'pastetoggle'. However,
4836 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4837 this: >
4838 :map <F10> :set paste<CR>
4839 :map <F11> :set nopaste<CR>
4840 :imap <F10> <C-O>:set paste<CR>
4841 :imap <F11> <nop>
4842 :set pastetoggle=<F11>
4843< This will make <F10> start paste mode and <F11> stop paste mode.
4844 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4845 mode everything is inserted literally, except the 'pastetoggle' key
4846 sequence.
4847
4848 *'pex'* *'patchexpr'*
4849'patchexpr' 'pex' string (default "")
4850 global
4851 {not in Vi}
4852 {not available when compiled without the |+diff|
4853 feature}
4854 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004855 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004856
4857 *'patchmode'* *'pm'* *E206*
4858'patchmode' 'pm' string (default "")
4859 global
4860 {not in Vi}
4861 When non-empty the oldest version of a file is kept. This can be used
4862 to keep the original version of a file if you are changing files in a
4863 source distribution. Only the first time that a file is written a
4864 copy of the original file will be kept. The name of the copy is the
4865 name of the original file with the string in the 'patchmode' option
4866 appended. This option should start with a dot. Use a string like
4867 ".org". 'backupdir' must not be empty for this to work (Detail: The
4868 backup file is renamed to the patchmode file after the new file has
4869 been successfully written, that's why it must be possible to write a
4870 backup file). If there was no file to be backed up, an empty file is
4871 created.
4872 When the 'backupskip' pattern matches, a patchmode file is not made.
4873 Using 'patchmode' for compressed files appends the extension at the
4874 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4875 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004876 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004877
4878 *'path'* *'pa'* *E343* *E345* *E347*
4879'path' 'pa' string (default on Unix: ".,/usr/include,,"
4880 on OS/2: ".,/emx/include,,"
4881 other systems: ".,,")
4882 global or local to buffer |global-local|
4883 {not in Vi}
4884 This is a list of directories which will be searched when using the
4885 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4886 being searched for has a relative path (not starting with '/'). The
4887 directories in the 'path' option may be relative or absolute.
4888 - Use commas to separate directory names: >
4889 :set path=.,/usr/local/include,/usr/include
4890< - Spaces can also be used to separate directory names (for backwards
4891 compatibility with version 3.0). To have a space in a directory
4892 name, precede it with an extra backslash, and escape the space: >
4893 :set path=.,/dir/with\\\ space
4894< - To include a comma in a directory name precede it with an extra
4895 backslash: >
4896 :set path=.,/dir/with\\,comma
4897< - To search relative to the directory of the current file, use: >
4898 :set path=.
4899< - To search in the current directory use an empty string between two
4900 commas: >
4901 :set path=,,
4902< - A directory name may end in a ':' or '/'.
4903 - Environment variables are expanded |:set_env|.
4904 - When using |netrw.vim| URLs can be used. For example, adding
4905 "http://www.vim.org" will make ":find index.html" work.
4906 - Search upwards and downwards in a directory tree:
4907 1) "*" matches a sequence of characters, e.g.: >
4908 :set path=/usr/include/*
4909< means all subdirectories in /usr/include (but not /usr/include
4910 itself). >
4911 :set path=/usr/*c
4912< matches /usr/doc and /usr/src.
4913 2) "**" matches a subtree, up to 100 directories deep. Example: >
4914 :set path=/home/user_x/src/**
4915< means search in the whole subtree under "/home/usr_x/src".
4916 3) If the path ends with a ';', this path is the startpoint
4917 for upward search.
4918 See |file-searching| for more info and exact syntax.
4919 {not available when compiled without the |+path_extra| feature}
4920 - Careful with '\' characters, type two to get one in the option: >
4921 :set path=.,c:\\include
4922< Or just use '/' instead: >
4923 :set path=.,c:/include
4924< Don't forget "." or files won't even be found in the same directory as
4925 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004926 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004927 it is something like 256 or 1024 characters.
4928 You can check if all the include files are found, using the value of
4929 'path', see |:checkpath|.
4930 The use of |:set+=| and |:set-=| is preferred when adding or removing
4931 directories from the list. This avoids problems when a future version
4932 uses another default. To remove the current directory use: >
4933 :set path-=
4934< To add the current directory use: >
4935 :set path+=
4936< To use an environment variable, you probably need to replace the
4937 separator. Here is an example to append $INCL, in which directory
4938 names are separated with a semi-colon: >
4939 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4940< Replace the ';' with a ':' or whatever separator is used. Note that
4941 this doesn't work when $INCL contains a comma or white space.
4942
4943 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4944'preserveindent' 'pi' boolean (default off)
4945 local to buffer
4946 {not in Vi}
4947 When changing the indent of the current line, preserve as much of the
4948 indent structure as possible. Normally the indent is replaced by a
4949 series of tabs followed by spaces as required (unless |'expandtab'| is
4950 enabled, in which case only spaces are used). Enabling this option
4951 means the indent will preserve as many existing characters as possible
4952 for indenting, and only add additional tabs or spaces as required.
4953 NOTE: When using ">>" multiple times the resulting indent is a mix of
4954 tabs and spaces. You might not like this.
4955 NOTE: 'preserveindent' is reset when 'compatible' is set.
4956 Also see 'copyindent'.
4957 Use |:retab| to clean up white space.
4958
4959 *'previewheight'* *'pvh'*
4960'previewheight' 'pvh' number (default 12)
4961 global
4962 {not in Vi}
4963 {not available when compiled without the |+windows| or
4964 |+quickfix| feature}
4965 Default height for a preview window. Used for |:ptag| and associated
4966 commands. Used for |CTRL-W_}| when no count is given.
4967
4968 *'previewwindow'* *'nopreviewwindow'*
4969 *'pvw'* *'nopvw'* *E590*
4970'previewwindow' 'pvw' boolean (default off)
4971 local to window
4972 {not in Vi}
4973 {not available when compiled without the |+windows| or
4974 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004975 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004976 set. It's normally not set directly, but by using one of the commands
4977 |:ptag|, |:pedit|, etc.
4978
4979 *'printdevice'* *'pdev'*
4980'printdevice' 'pdev' string (default empty)
4981 global
4982 {not in Vi}
4983 {only available when compiled with the |+printer|
4984 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004985 The name of the printer to be used for |:hardcopy|.
4986 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004987 This option cannot be set from a |modeline| or in the |sandbox|, for
4988 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004989
Bram Moolenaar8299df92004-07-10 09:47:34 +00004990 *'printencoding'* *'penc'*
4991'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004992 global
4993 {not in Vi}
4994 {only available when compiled with the |+printer|
4995 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004996 Sets the character encoding used when printing.
4997 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004998
4999 *'printexpr'* *'pexpr'*
5000'printexpr' 'pexpr' String (default: see below)
5001 global
5002 {not in Vi}
5003 {only available when compiled with the |+printer|
5004 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005005 Expression used to print the PostScript produced with |:hardcopy|.
5006 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005007
Bram Moolenaar8299df92004-07-10 09:47:34 +00005008 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005009'printfont' 'pfn' string (default "courier")
5010 global
5011 {not in Vi}
5012 {only available when compiled with the |+printer|
5013 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005014 The name of the font that will be used for |:hardcopy|.
5015 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005016
5017 *'printheader'* *'pheader'*
5018'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5019 global
5020 {not in Vi}
5021 {only available when compiled with the |+printer|
5022 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005023 The format of the header produced in |:hardcopy| output.
5024 See |pheader-option|.
5025
5026 *'printmbcharset'* *'pmbcs'*
5027'printmbcharset' 'pmbcs' string (default "")
5028 global
5029 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005030 {only available when compiled with the |+printer|,
5031 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005032 The CJK character set to be used for CJK output from |:hardcopy|.
5033 See |pmbcs-option|.
5034
5035 *'printmbfont'* *'pmbfn'*
5036'printmbfont' 'pmbfn' string (default "")
5037 global
5038 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005039 {only available when compiled with the |+printer|,
5040 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005041 List of font names to be used for CJK output from |:hardcopy|.
5042 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005043
5044 *'printoptions'* *'popt'*
5045'printoptions' 'popt' string (default "")
5046 global
5047 {not in Vi}
5048 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005049 List of items that control the format of the output of |:hardcopy|.
5050 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005051
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005052 *'prompt'* *'noprompt'*
5053'prompt' boolean (default on)
5054 global
5055 When on a ":" prompt is used in Ex mode.
5056
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005057 *'pumheight'* *'ph'*
5058'pumheight' 'ph' number (default 0)
5059 global
5060 {not available when compiled without the
5061 |+insert_expand| feature}
5062 {not in Vi}
5063 Determines the maximum number of items to show in the popup menu.
5064 When zero as much space as available is used.
5065 |ins-completion-menu|.
5066
5067
Bram Moolenaar677ee682005-01-27 14:41:15 +00005068 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005069'quoteescape' 'qe' string (default "\")
5070 local to buffer
5071 {not in Vi}
5072 The characters that are used to escape quotes in a string. Used for
5073 objects like a', a" and a` |a'|.
5074 When one of the characters in this option is found inside a string,
5075 the following character will be skipped. The default value makes the
5076 text "foo\"bar\\" considered to be one string.
5077
Bram Moolenaar071d4272004-06-13 20:20:40 +00005078 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5079'readonly' 'ro' boolean (default off)
5080 local to buffer
5081 If on, writes fail unless you use a '!'. Protects you from
5082 accidentally overwriting a file. Default on when Vim is started
5083 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005084 When using ":w!" the 'readonly' option is reset for the current
5085 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005086 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005087 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005088
5089 *'remap'* *'noremap'*
5090'remap' boolean (default on)
5091 global
5092 Allows for mappings to work recursively. If you do not want this for
5093 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005094 NOTE: To avoid portability problems with Vim scripts, always keep
5095 this option at the default "on". Only switch it off when working with
5096 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005097
5098 *'report'*
5099'report' number (default 2)
5100 global
5101 Threshold for reporting number of lines changed. When the number of
5102 changed lines is more than 'report' a message will be given for most
5103 ":" commands. If you want it always, set 'report' to 0.
5104 For the ":substitute" command the number of substitutions is used
5105 instead of the number of lines.
5106
5107 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5108'restorescreen' 'rs' boolean (default on)
5109 global
5110 {not in Vi} {only in Windows 95/NT console version}
5111 When set, the screen contents is restored when exiting Vim. This also
5112 happens when executing external commands.
5113
5114 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5115 options in your .vimrc. To disable restoring:
5116 set t_ti= t_te=
5117 To enable restoring (for an xterm):
5118 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5119 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5120
5121 *'revins'* *'ri'* *'norevins'* *'nori'*
5122'revins' 'ri' boolean (default off)
5123 global
5124 {not in Vi}
5125 {only available when compiled with the |+rightleft|
5126 feature}
5127 Inserting characters in Insert mode will work backwards. See "typing
5128 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5129 command in Insert mode, when 'allowrevins' is set.
5130 NOTE: This option is reset when 'compatible' or 'paste' is set.
5131
5132 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5133'rightleft' 'rl' boolean (default off)
5134 local to window
5135 {not in Vi}
5136 {only available when compiled with the |+rightleft|
5137 feature}
5138 When on, display orientation becomes right-to-left, i.e., characters
5139 that are stored in the file appear from the right to the left.
5140 Using this option, it is possible to edit files for languages that
5141 are written from the right to the left such as Hebrew and Arabic.
5142 This option is per window, so it is possible to edit mixed files
5143 simultaneously, or to view the same file in both ways (this is
5144 useful whenever you have a mixed text file with both right-to-left
5145 and left-to-right strings so that both sets are displayed properly
5146 in different windows). Also see |rileft.txt|.
5147
5148 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
5149'rightleftcmd' 'rlc' string (default "search")
5150 local to window
5151 {not in Vi}
5152 {only available when compiled with the |+rightleft|
5153 feature}
5154 Each word in this option enables the command line editing to work in
5155 right-to-left mode for a group of commands:
5156
5157 search "/" and "?" commands
5158
5159 This is useful for languages such as Hebrew, Arabic and Farsi.
5160 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5161
5162 *'ruler'* *'ru'* *'noruler'* *'noru'*
5163'ruler' 'ru' boolean (default off)
5164 global
5165 {not in Vi}
5166 {not available when compiled without the
5167 |+cmdline_info| feature}
5168 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005169 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005170 text in the file is shown on the far right:
5171 Top first line is visible
5172 Bot last line is visible
5173 All first and last line are visible
5174 45% relative position in the file
5175 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005176 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005177 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005178 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005179 this option takes precedence over 'ruler' and 'rulerformat'
5180 If the number of characters displayed is different from the number of
5181 bytes in the text (e.g., for a TAB or a multi-byte character), both
5182 the text column (byte number) and the screen column are shown,
5183 separated with a dash.
5184 For an empty line "0-1" is shown.
5185 For an empty buffer the line number will also be zero: "0,0-1".
5186 This option is reset when the 'paste' option is set.
5187 If you don't want to see the ruler all the time but want to know where
5188 you are, use "g CTRL-G" |g_CTRL-G|.
5189 NOTE: This option is reset when 'compatible' is set.
5190
5191 *'rulerformat'* *'ruf'*
5192'rulerformat' 'ruf' string (default empty)
5193 global
5194 {not in Vi}
5195 {not available when compiled without the |+statusline|
5196 feature}
5197 When this option is not empty, it determines the content of the ruler
5198 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005199 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005200 The default ruler width is 17 characters. To make the ruler 15
5201 characters wide, put "%15(" at the start and "%)" at the end.
5202 Example: >
5203 :set rulerformat=%15(%c%V\ %p%%%)
5204<
5205 *'runtimepath'* *'rtp'* *vimfiles*
5206'runtimepath' 'rtp' string (default:
5207 Unix: "$HOME/.vim,
5208 $VIM/vimfiles,
5209 $VIMRUNTIME,
5210 $VIM/vimfiles/after,
5211 $HOME/.vim/after"
5212 Amiga: "home:vimfiles,
5213 $VIM/vimfiles,
5214 $VIMRUNTIME,
5215 $VIM/vimfiles/after,
5216 home:vimfiles/after"
5217 PC, OS/2: "$HOME/vimfiles,
5218 $VIM/vimfiles,
5219 $VIMRUNTIME,
5220 $VIM/vimfiles/after,
5221 $HOME/vimfiles/after"
5222 Macintosh: "$VIM:vimfiles,
5223 $VIMRUNTIME,
5224 $VIM:vimfiles:after"
5225 RISC-OS: "Choices:vimfiles,
5226 $VIMRUNTIME,
5227 Choices:vimfiles/after"
5228 VMS: "sys$login:vimfiles,
5229 $VIM/vimfiles,
5230 $VIMRUNTIME,
5231 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005232 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005233 global
5234 {not in Vi}
5235 This is a list of directories which will be searched for runtime
5236 files:
5237 filetype.vim filetypes by file name |new-filetype|
5238 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005239 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005240 colors/ color scheme files |:colorscheme|
5241 compiler/ compiler files |:compiler|
5242 doc/ documentation |write-local-help|
5243 ftplugin/ filetype plugins |write-filetype-plugin|
5244 indent/ indent scripts |indent-expression|
5245 keymap/ key mapping files |mbyte-keymap|
5246 lang/ menu translations |:menutrans|
5247 menu.vim GUI menus |menu.vim|
5248 plugin/ plugin scripts |write-plugin|
5249 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005250 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005251 syntax/ syntax files |mysyntaxfile|
5252 tutor/ files for vimtutor |tutor|
5253
5254 And any other file searched for with the |:runtime| command.
5255
5256 The defaults for most systems are setup to search five locations:
5257 1. In your home directory, for your personal preferences.
5258 2. In a system-wide Vim directory, for preferences from the system
5259 administrator.
5260 3. In $VIMRUNTIME, for files distributed with Vim.
5261 *after-directory*
5262 4. In the "after" directory in the system-wide Vim directory. This is
5263 for the system administrator to overrule or add to the distributed
5264 defaults (rarely needed)
5265 5. In the "after" directory in your home directory. This is for
5266 personal preferences to overrule or add to the distributed defaults
5267 or system-wide settings (rarely needed).
5268
5269 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5270 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005271 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005272 wildcards.
5273 See |:runtime|.
5274 Example: >
5275 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5276< This will use the directory "~/vimruntime" first (containing your
5277 personal Vim runtime files), then "/mygroup/vim" (shared between a
5278 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5279 files).
5280 You probably should always include $VIMRUNTIME somewhere, to use the
5281 distributed runtime files. You can put a directory before $VIMRUNTIME
5282 to find files which replace a distributed runtime files. You can put
5283 a directory after $VIMRUNTIME to find files which add to distributed
5284 runtime files.
5285 This option cannot be set from a |modeline| or in the |sandbox|, for
5286 security reasons.
5287
5288 *'scroll'* *'scr'*
5289'scroll' 'scr' number (default: half the window height)
5290 local to window
5291 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5292 set to half the number of lines in the window when the window size
5293 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005294 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005295 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5296 the number of screen lines instead of file lines, makes a difference
5297 when lines wrap}
5298
5299 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5300'scrollbind' 'scb' boolean (default off)
5301 local to window
5302 {not in Vi}
5303 {not available when compiled without the |+scrollbind|
5304 feature}
5305 See also |scroll-binding|. When this option is set, the current
5306 window scrolls as other scrollbind windows (windows that also have
5307 this option set) scroll. This option is useful for viewing the
5308 differences between two versions of a file, see 'diff'.
5309 See |'scrollopt'| for options that determine how this option should be
5310 interpreted.
5311 This option is mostly reset when splitting a window to edit another
5312 file. This means that ":split | edit file" results in two windows
5313 with scroll-binding, but ":split file" does not.
5314
5315 *'scrolljump'* *'sj'*
5316'scrolljump' 'sj' number (default 1)
5317 global
5318 {not in Vi}
5319 Minimal number of lines to scroll when the cursor gets off the
5320 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5321 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005322 When set to a negative number from -1 to -100 this is used as the
5323 percentage of the window height. Thus -50 scrolls half the window
5324 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005325 NOTE: This option is set to 1 when 'compatible' is set.
5326
5327 *'scrolloff'* *'so'*
5328'scrolloff' 'so' number (default 0)
5329 global
5330 {not in Vi}
5331 Minimal number of screen lines to keep above and below the cursor.
5332 This will make some context visible around where you are working. If
5333 you set it to a very large value (999) the cursor line will always be
5334 in the middle of the window (except at the start or end of the file or
5335 when long lines wrap).
5336 For scrolling horizontally see 'sidescrolloff'.
5337 NOTE: This option is set to 0 when 'compatible' is set.
5338
5339 *'scrollopt'* *'sbo'*
5340'scrollopt' 'sbo' string (default "ver,jump")
5341 global
5342 {not available when compiled without the |+scrollbind|
5343 feature}
5344 {not in Vi}
5345 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005346 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5347 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005348 The following words are available:
5349 ver Bind vertical scrolling for 'scrollbind' windows
5350 hor Bind horizontal scrolling for 'scrollbind' windows
5351 jump Applies to the offset between two windows for vertical
5352 scrolling. This offset is the difference in the first
5353 displayed line of the bound windows. When moving
5354 around in a window, another 'scrollbind' window may
5355 reach a position before the start or after the end of
5356 the buffer. The offset is not changed though, when
5357 moving back the 'scrollbind' window will try to scroll
5358 to the desired position when possible.
5359 When now making that window the current one, two
5360 things can be done with the relative offset:
5361 1. When "jump" is not included, the relative offset is
5362 adjusted for the scroll position in the new current
5363 window. When going back to the other window, the
5364 the new relative offset will be used.
5365 2. When "jump" is included, the other windows are
5366 scrolled to keep the same relative offset. When
5367 going back to the other window, it still uses the
5368 same relative offset.
5369 Also see |scroll-binding|.
5370
5371 *'sections'* *'sect'*
5372'sections' 'sect' string (default "SHNHH HUnhsh")
5373 global
5374 Specifies the nroff macros that separate sections. These are pairs of
5375 two letters (See |object-motions|). The default makes a section start
5376 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5377
5378 *'secure'* *'nosecure'* *E523*
5379'secure' boolean (default off)
5380 global
5381 {not in Vi}
5382 When on, ":autocmd", shell and write commands are not allowed in
5383 ".vimrc" and ".exrc" in the current directory and map commands are
5384 displayed. Switch it off only if you know that you will not run into
5385 problems, or when the 'exrc' option is off. On Unix this option is
5386 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005387 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005388 'secure' at the end of your ~/.vimrc then.
5389 This option cannot be set from a |modeline| or in the |sandbox|, for
5390 security reasons.
5391
5392 *'selection'* *'sel'*
5393'selection' 'sel' string (default "inclusive")
5394 global
5395 {not in Vi}
5396 This option defines the behavior of the selection. It is only used
5397 in Visual and Select mode.
5398 Possible values:
5399 value past line inclusive ~
5400 old no yes
5401 inclusive yes yes
5402 exclusive yes no
5403 "past line" means that the cursor is allowed to be positioned one
5404 character past the line.
5405 "inclusive" means that the last character of the selection is included
5406 in an operation. For example, when "x" is used to delete the
5407 selection.
5408 Note that when "exclusive" is used and selecting from the end
5409 backwards, you cannot include the last character of a line, when
5410 starting in Normal mode and 'virtualedit' empty.
5411
5412 The 'selection' option is set by the |:behave| command.
5413
5414 *'selectmode'* *'slm'*
5415'selectmode' 'slm' string (default "")
5416 global
5417 {not in Vi}
5418 This is a comma separated list of words, which specifies when to start
5419 Select mode instead of Visual mode, when a selection is started.
5420 Possible values:
5421 mouse when using the mouse
5422 key when using shifted special keys
5423 cmd when using "v", "V" or CTRL-V
5424 See |Select-mode|.
5425 The 'selectmode' option is set by the |:behave| command.
5426
5427 *'sessionoptions'* *'ssop'*
5428'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
5429 help,options,winsize")
5430 global
5431 {not in Vi}
5432 {not available when compiled without the +mksession
5433 feature}
5434 Changes the effect of the |:mksession| command. It is a comma
5435 separated list of words. Each word enables saving and restoring
5436 something:
5437 word save and restore ~
5438 blank empty windows
5439 buffers hidden and unloaded buffers, not just those in windows
5440 curdir the current directory
5441 folds manually created folds, opened/closed folds and local
5442 fold options
5443 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005444 and contain at least one lowercase letter. Only
5445 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005446 help the help window
5447 localoptions options and mappings local to a window or buffer (not
5448 global values for local options)
5449 options all options and mappings (also global values for local
5450 options)
5451 resize size of the Vim window: 'lines' and 'columns'
5452 sesdir the directory in which the session file is located
5453 will become the current directory (useful with
5454 projects accessed over a network from different
5455 systems)
5456 slash backslashes in file names replaced with forward
5457 slashes
5458 unix with Unix end-of-line format (single <NL>), even when
5459 on Windows or DOS
5460 winpos position of the whole Vim window
5461 winsize window sizes
5462
5463 Don't include both "curdir" and "sesdir".
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00005464 There is no option to include tab pages yet, only the current tab page
5465 is stored in the session. |tab-page|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005466 When "curdir" nor "sesdir" is included, file names are stored with
5467 absolute paths.
5468 "slash" and "unix" are useful on Windows when sharing session files
5469 with Unix. The Unix version of Vim cannot source dos format scripts,
5470 but the Windows version of Vim can source unix format scripts.
5471
5472 *'shell'* *'sh'* *E91*
5473'shell' 'sh' string (default $SHELL or "sh",
5474 MS-DOS and Win32: "command.com" or
5475 "cmd.exe", OS/2: "cmd")
5476 global
5477 Name of the shell to use for ! and :! commands. When changing the
5478 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5479 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005480 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005481 See |option-backslash| about including spaces and backslashes.
5482 Environment variables are expanded |:set_env|.
5483 If the name of the shell contains a space, you might need to enclose
5484 it in quotes. Example: >
5485 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5486< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005487 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005488 "-f" is not inside the quotes, because it is not part of the command
5489 name. And Vim automagically recognizes the backslashes that are path
5490 separators.
5491 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5492 variable to change the way external commands are executed. See the
5493 libc.inf file of DJGPP.
5494 Under MS-Windows, when the executable ends in ".com" it must be
5495 included. Thus setting the shell to "command.com" or "4dos.com"
5496 works, but "command" and "4dos" do not work for all commands (e.g.,
5497 filtering).
5498 For unknown reasons, when using "4dos.com" the current directory is
5499 changed to "C:\". To avoid this set 'shell' like this: >
5500 :set shell=command.com\ /c\ 4dos
5501< This option cannot be set from a |modeline| or in the |sandbox|, for
5502 security reasons.
5503
5504 *'shellcmdflag'* *'shcf'*
5505'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5506 does not contain "sh" somewhere: "/c")
5507 global
5508 {not in Vi}
5509 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5510 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5511 systems, the default is set according to the value of 'shell', to
5512 reduce the need to set this option by the user. It's not used for
5513 OS/2 (EMX figures this out itself). See |option-backslash| about
5514 including spaces and backslashes. See |dos-shell|.
5515 This option cannot be set from a |modeline| or in the |sandbox|, for
5516 security reasons.
5517
5518 *'shellpipe'* *'sp'*
5519'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5520 global
5521 {not in Vi}
5522 {not available when compiled without the |+quickfix|
5523 feature}
5524 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005525 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005526 including spaces and backslashes.
5527 The name of the temporary file can be represented by "%s" if necessary
5528 (the file name is appended automatically if no %s appears in the value
5529 of this option).
5530 For the Amiga and MS-DOS the default is ">". The output is directly
5531 saved in a file and not echoed to the screen.
5532 For Unix the default it "| tee". The stdout of the compiler is saved
5533 in a file and echoed to the screen. If the 'shell' option is "csh" or
5534 "tcsh" after initializations, the default becomes "|& tee". If the
5535 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5536 "2>&1| tee". This means that stderr is also included.
5537 The initialization of this option is done after reading the ".vimrc"
5538 and the other initializations, so that when the 'shell' option is set
5539 there, the 'shellpipe' option changes automatically, unless it was
5540 explicitly set before.
5541 When 'shellpipe' is set to an empty string, no redirection of the
5542 ":make" output will be done. This is useful if you use a 'makeprg'
5543 that writes to 'makeef' by itself. If you want no piping, but do
5544 want to include the 'makeef', set 'shellpipe' to a single space.
5545 Don't forget to precede the space with a backslash: ":set sp=\ ".
5546 In the future pipes may be used for filtering and this option will
5547 become obsolete (at least for Unix).
5548 This option cannot be set from a |modeline| or in the |sandbox|, for
5549 security reasons.
5550
5551 *'shellquote'* *'shq'*
5552'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5553 contains "sh" somewhere: "\"")
5554 global
5555 {not in Vi}
5556 Quoting character(s), put around the command passed to the shell, for
5557 the "!" and ":!" commands. The redirection is kept outside of the
5558 quoting. See 'shellxquote' to include the redirection. It's
5559 probably not useful to set both options.
5560 This is an empty string by default. Only known to be useful for
5561 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5562 or bash, where it should be "\"". The default is adjusted according
5563 the value of 'shell', to reduce the need to set this option by the
5564 user. See |dos-shell|.
5565 This option cannot be set from a |modeline| or in the |sandbox|, for
5566 security reasons.
5567
5568 *'shellredir'* *'srr'*
5569'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5570 global
5571 {not in Vi}
5572 String to be used to put the output of a filter command in a temporary
5573 file. See also |:!|. See |option-backslash| about including spaces
5574 and backslashes.
5575 The name of the temporary file can be represented by "%s" if necessary
5576 (the file name is appended automatically if no %s appears in the value
5577 of this option).
5578 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5579 or "zsh" during initializations, the default becomes ">&". If the
5580 'shell' option is "sh", "ksh" or "bash" the default becomes
5581 ">%s 2>&1". This means that stderr is also included.
5582 For Win32, the Unix checks are done and additionally "cmd" is checked
5583 for, which makes the default ">%s 2>&1". Also, the same names with
5584 ".exe" appended are checked for.
5585 The initialization of this option is done after reading the ".vimrc"
5586 and the other initializations, so that when the 'shell' option is set
5587 there, the 'shellredir' option changes automatically unless it was
5588 explicitly set before.
5589 In the future pipes may be used for filtering and this option will
5590 become obsolete (at least for Unix).
5591 This option cannot be set from a |modeline| or in the |sandbox|, for
5592 security reasons.
5593
5594 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5595'shellslash' 'ssl' boolean (default off)
5596 global
5597 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5598 When set, a forward slash is used when expanding file names. This is
5599 useful when a Unix-like shell is used instead of command.com or
5600 cmd.exe. Backward slashes can still be typed, but they are changed to
5601 forward slashes by Vim.
5602 Note that setting or resetting this option has no effect for some
5603 existing file names, thus this option needs to be set before opening
5604 any file for best results. This might change in the future.
5605 'shellslash' only works when a backslash can be used as a path
5606 separator. To test if this is so use: >
5607 if exists('+shellslash')
5608<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005609 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5610'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5611 global
5612 {not in Vi}
5613 When on, use temp files for shell commands. When off use a pipe.
5614 When using a pipe is not possible temp files are used anyway.
5615 Currently a pipe is only supported on Unix. You can check it with: >
5616 :if has("filterpipe")
5617< The advantage of using a pipe is that nobody can read the temp file
5618 and the 'shell' command does not need to support redirection.
5619 The advantage of using a temp file is that the file type and encoding
5620 can be detected.
5621 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5622 |FilterWritePost| autocommands event are not triggered when
5623 'shelltemp' is off.
5624
Bram Moolenaar071d4272004-06-13 20:20:40 +00005625 *'shelltype'* *'st'*
5626'shelltype' 'st' number (default 0)
5627 global
5628 {not in Vi} {only for the Amiga}
5629 On the Amiga this option influences the way how the commands work
5630 which use a shell.
5631 0 and 1: always use the shell
5632 2 and 3: use the shell only to filter lines
5633 4 and 5: use shell only for ':sh' command
5634 When not using the shell, the command is executed directly.
5635
5636 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5637 1 and 3: use "shell cmd" to start external commands
5638
5639 *'shellxquote'* *'sxq'*
5640'shellxquote' 'sxq' string (default: "";
5641 for Win32, when 'shell' contains "sh"
5642 somewhere: "\""
5643 for Unix, when using system(): "\"")
5644 global
5645 {not in Vi}
5646 Quoting character(s), put around the command passed to the shell, for
5647 the "!" and ":!" commands. Includes the redirection. See
5648 'shellquote' to exclude the redirection. It's probably not useful
5649 to set both options.
5650 This is an empty string by default. Known to be useful for
5651 third-party shells when using the Win32 version, such as the MKS Korn
5652 Shell or bash, where it should be "\"". The default is adjusted
5653 according the value of 'shell', to reduce the need to set this option
5654 by the user. See |dos-shell|.
5655 This option cannot be set from a |modeline| or in the |sandbox|, for
5656 security reasons.
5657
5658 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5659'shiftround' 'sr' boolean (default off)
5660 global
5661 {not in Vi}
5662 Round indent to multiple of 'shiftwidth'. Applies to > and <
5663 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5664 a multiple of 'shiftwidth' (this is Vi compatible).
5665 NOTE: This option is reset when 'compatible' is set.
5666
5667 *'shiftwidth'* *'sw'*
5668'shiftwidth' 'sw' number (default 8)
5669 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005670 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005671 |'cindent'|, |>>|, |<<|, etc.
5672
5673 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005674'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5675 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005676 global
5677 {not in Vi}
5678 This option helps to avoid all the |hit-enter| prompts caused by file
5679 messages, for example with CTRL-G, and to avoid some other messages.
5680 It is a list of flags:
5681 flag meaning when present ~
5682 f use "(3 of 5)" instead of "(file 3 of 5)"
5683 i use "[noeol]" instead of "[Incomplete last line]"
5684 l use "999L, 888C" instead of "999 lines, 888 characters"
5685 m use "[+]" instead of "[Modified]"
5686 n use "[New]" instead of "[New File]"
5687 r use "[RO]" instead of "[readonly]"
5688 w use "[w]" instead of "written" for file write message
5689 and "[a]" instead of "appended" for ':w >> file' command
5690 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5691 "[unix format]" and "[mac]" instead of "[mac format]".
5692 a all of the above abbreviations
5693
5694 o overwrite message for writing a file with subsequent message
5695 for reading a file (useful for ":wn" or when 'autowrite' on)
5696 O message for reading a file overwrites any previous message.
5697 Also for quickfix message (e.g., ":cn").
5698 s don't give "search hit BOTTOM, continuing at TOP" or "search
5699 hit TOP, continuing at BOTTOM" messages
5700 t truncate file message at the start if it is too long to fit
5701 on the command-line, "<" will appear in the left most column.
5702 Ignored in Ex mode.
5703 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005704 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005705 Ignored in Ex mode.
5706 W don't give "written" or "[w]" when writing a file
5707 A don't give the "ATTENTION" message when an existing swap file
5708 is found.
5709 I don't give the intro message when starting Vim |:intro|.
5710
5711 This gives you the opportunity to avoid that a change between buffers
5712 requires you to hit <Enter>, but still gives as useful a message as
5713 possible for the space available. To get the whole message that you
5714 would have got with 'shm' empty, use ":file!"
5715 Useful values:
5716 shm= No abbreviation of message.
5717 shm=a Abbreviation, but no loss of information.
5718 shm=at Abbreviation, and truncate message when necessary.
5719
5720 NOTE: This option is set to the Vi default value when 'compatible' is
5721 set and to the Vim default value when 'compatible' is reset.
5722
5723 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5724'shortname' 'sn' boolean (default off)
5725 local to buffer
5726 {not in Vi, not in MS-DOS versions}
5727 Filenames are assumed to be 8 characters plus one extension of 3
5728 characters. Multiple dots in file names are not allowed. When this
5729 option is on, dots in file names are replaced with underscores when
5730 adding an extension (".~" or ".swp"). This option is not available
5731 for MS-DOS, because then it would always be on. This option is useful
5732 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5733 or crossdos. When running the Win32 GUI version under Win32s, this
5734 option is always on by default.
5735
5736 *'showbreak'* *'sbr'* *E595*
5737'showbreak' 'sbr' string (default "")
5738 global
5739 {not in Vi}
5740 {not available when compiled without the |+linebreak|
5741 feature}
5742 String to put at the start of lines that have been wrapped. Useful
5743 values are "> " or "+++ ".
5744 Only printable single-cell characters are allowed, excluding <Tab> and
5745 comma (in a future version the comma might be used to separate the
5746 part that is shown at the end and at the start of a line).
5747 The characters are highlighted according to the '@' flag in
5748 'highlight'.
5749 Note that tabs after the showbreak will be displayed differently.
5750 If you want the 'showbreak' to appear in between line numbers, add the
5751 "n" flag to 'cpoptions'.
5752
5753 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5754'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5755 off)
5756 global
5757 {not in Vi}
5758 {not available when compiled without the
5759 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005760 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005761 terminal is slow.
5762 In Visual mode the size of the selected area is shown:
5763 - When selecting characters within a line, the number of characters.
5764 - When selecting more than one line, the number of lines.
5765 - When selecting a block, the size in screen characters: linesxcolumns.
5766 NOTE: This option is set to the Vi default value when 'compatible' is
5767 set and to the Vim default value when 'compatible' is reset.
5768
5769 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5770'showfulltag' 'sft' boolean (default off)
5771 global
5772 {not in Vi}
5773 When completing a word in insert mode (see |ins-completion|) from the
5774 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005775 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005776 matched a C function, you can see a template for what arguments are
5777 required (coding style permitting).
5778
5779 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5780'showmatch' 'sm' boolean (default off)
5781 global
5782 When a bracket is inserted, briefly jump to the matching one. The
5783 jump is only done if the match can be seen on the screen. The time to
5784 show the match can be set with 'matchtime'.
5785 A Beep is given if there is no match (no matter if the match can be
5786 seen or not). This option is reset when the 'paste' option is set.
5787 When the 'm' flag is not included in 'cpoptions', typing a character
5788 will immediately move the cursor back to where it belongs.
5789 See the "sm" field in 'guicursor' for setting the cursor shape and
5790 blinking when showing the match.
5791 The 'matchpairs' option can be used to specify the characters to show
5792 matches for. 'rightleft' and 'revins' are used to look for opposite
5793 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005794 Also see the matchparen plugin for highlighting the match when moving
5795 around |pi_paren.txt|.
5796 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005797
5798 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5799'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5800 global
5801 If in Insert, Replace or Visual mode put a message on the last line.
5802 Use the 'M' flag in 'highlight' to set the type of highlighting for
5803 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005804 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005805 doesn't mean XIM is really active, especially when 'imactivatekey' is
5806 not set.
5807 NOTE: This option is set to the Vi default value when 'compatible' is
5808 set and to the Vim default value when 'compatible' is reset.
5809
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00005810 *'showtabline'* *'stal'*
5811'showtabline' 'stal' number (default 1)
5812 global
5813 {not in Vi}
5814 {not available when compiled without the +windows
5815 feature}
5816 The value of this option specifies when the line with tab page labels
5817 will be displayed:
5818 0: never
5819 1: only if there are at least two tab pages
5820 2: always
5821 This is both for the GUI and non-GUI implementation of the tab pages
5822 line.
5823 See |tab-page| for more information about tab pages.
5824
Bram Moolenaar071d4272004-06-13 20:20:40 +00005825 *'sidescroll'* *'ss'*
5826'sidescroll' 'ss' number (default 0)
5827 global
5828 {not in Vi}
5829 The minimal number of columns to scroll horizontally. Used only when
5830 the 'wrap' option is off and the cursor is moved off of the screen.
5831 When it is zero the cursor will be put in the middle of the screen.
5832 When using a slow terminal set it to a large number or 0. When using
5833 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5834 commands.
5835
5836 *'sidescrolloff'* *'siso'*
5837'sidescrolloff' 'siso' number (default 0)
5838 global
5839 {not in Vi}
5840 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005841 right of the cursor if 'nowrap' is set. Setting this option to a
5842 value greater than 0 while having |'sidescroll'| also at a non-zero
5843 value makes some context visible in the line you are scrolling in
5844 horizontally (except at beginning of the line). Setting this option
5845 to a large value (like 999) has the effect of keeping the cursor
5846 horizontally centered in the window, as long as one does not come too
5847 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005848 NOTE: This option is set to 0 when 'compatible' is set.
5849
5850 Example: Try this together with 'sidescroll' and 'listchars' as
5851 in the following example to never allow the cursor to move
5852 onto the "extends" character:
5853
5854 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5855 :set sidescrolloff=1
5856
5857
5858 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5859'smartcase' 'scs' boolean (default off)
5860 global
5861 {not in Vi}
5862 Override the 'ignorecase' option if the search pattern contains upper
5863 case characters. Only used when the search pattern is typed and
5864 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005865 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005866 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5867 recalling the search pattern from history and hitting <Enter>.
5868 NOTE: This option is reset when 'compatible' is set.
5869
5870 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5871'smartindent' 'si' boolean (default off)
5872 local to buffer
5873 {not in Vi}
5874 {not available when compiled without the
5875 |+smartindent| feature}
5876 Do smart autoindenting when starting a new line. Works for C-like
5877 programs, but can also be used for other languages. 'cindent' does
5878 something like this, works better in most cases, but is more strict,
5879 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5880 'indentexpr' is a more advanced alternative.
5881 Normally 'autoindent' should also be on when using 'smartindent'.
5882 An indent is automatically inserted:
5883 - After a line ending in '{'.
5884 - After a line starting with a keyword from 'cinwords'.
5885 - Before a line starting with '}' (only with the "O" command).
5886 When typing '}' as the first character in a new line, that line is
5887 given the same indent as the matching '{'.
5888 When typing '#' as the first character in a new line, the indent for
5889 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005890 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005891 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5892 When using the ">>" command, lines starting with '#' are not shifted
5893 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005894 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005895 is set smart indenting is disabled.
5896
5897 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5898'smarttab' 'sta' boolean (default off)
5899 global
5900 {not in Vi}
5901 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00005902 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
5903 <BS> will delete a 'shiftwidth' worth of space at the start of the
5904 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005905 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00005906 'softtabstop'. 'shiftwidth' is only used for shifting text left or
5907 right |shift-left-right|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005908 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5909 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005910 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005911 NOTE: This option is reset when 'compatible' is set.
5912
5913 *'softtabstop'* *'sts'*
5914'softtabstop' 'sts' number (default 0)
5915 local to buffer
5916 {not in Vi}
5917 Number of spaces that a <Tab> counts for while performing editing
5918 operations, like inserting a <Tab> or using <BS>. It "feels" like
5919 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5920 used. This is useful to keep the 'ts' setting at its standard value
5921 of 8, while being able to edit like it is set to 'sts'. However,
5922 commands like "x" still work on the actual characters.
5923 When 'sts' is zero, this feature is off.
5924 'softtabstop' is set to 0 when the 'paste' option is set.
5925 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5926 spaces is minimized by using <Tab>s.
5927 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5928 set.
5929 NOTE: This option is set to 0 when 'compatible' is set.
5930
Bram Moolenaar217ad922005-03-20 22:37:15 +00005931 *'spell'* *'nospell'*
5932'spell' boolean (default off)
5933 local to window
5934 {not in Vi}
5935 {not available when compiled without the |+syntax|
5936 feature}
5937 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005938 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005939
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005940 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005941'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005942 local to buffer
5943 {not in Vi}
5944 {not available when compiled without the |+syntax|
5945 feature}
5946 Pattern to locate the end of a sentence. The following word will be
5947 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005948 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005949 When this check is not wanted make this option empty.
5950 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005951 Be careful with special characters, see |option-backslash| about
5952 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005953 To set this option automatically depending on the language, see
5954 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005955
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005956 *'spellfile'* *'spf'*
5957'spellfile' 'spf' string (default empty)
5958 local to buffer
5959 {not in Vi}
5960 {not available when compiled without the |+syntax|
5961 feature}
5962 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00005963 commands. It must end in ".{encoding}.add". You need to include the
5964 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005965 *E765*
5966 It may also be a comma separated list of names. A count before the
5967 |zg| and |zw| commands can be used to access each. This allows using
5968 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005969 When a word is added while this option is empty Vim will set it for
5970 you: Using the first "spell" directory in 'runtimepath' that is
Bram Moolenaar3b506942005-06-23 22:36:45 +00005971 writable and the first language name that appears in 'spelllang',
5972 ignoring the region.
5973 The resulting ".spl" file will be used for spell checking, it does not
5974 have to appear in 'spelllang'.
5975 Normally one file is used for all regions, but you can add the region
5976 name if you want to. However, it will then only be used when
5977 'spellfile' is set to it, for entries in 'spelllang' only files
5978 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00005979 This option cannot be set from a |modeline| or in the |sandbox|, for
5980 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005981
Bram Moolenaar217ad922005-03-20 22:37:15 +00005982 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005983'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00005984 local to buffer
5985 {not in Vi}
5986 {not available when compiled without the |+syntax|
5987 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00005988 A comma separated list of word list names. When the 'spell' option is
5989 on spellchecking will be done for these languages. Example: >
5990 set spelllang=en_us,nl,medical
5991< This means US English, Dutch and medical words are recognized. Words
5992 that are not recognized will be highlighted.
5993 The word list name must not include a comma or dot. Using a dash is
5994 recommended to separate the two letter language name from a
5995 specification. Thus "en-rare" is used for rare English words.
5996 A region name must come last and have the form "_xx", where "xx" is
5997 the two-letter, lower case region name. You can use more than one
5998 region by listing them: "en_us,en_ca" supports both US and Canadian
5999 English, but not words specific for Australia, New Zealand or Great
6000 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006001 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006002 As a special case the name of a .spl file can be given as-is. The
6003 first "_xx" in the name is removed and used as the region name
6004 (_xx is an underscore, two letters and followed by a non-letter).
6005 This is mainly for testing purposes. You must make sure the correct
6006 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006007 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006008 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6009 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006010 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006011
Bram Moolenaar98692072006-02-04 00:57:42 +00006012 If the |spellfile.vim| plugin is active and you use a language name
6013 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6014 will ask you if you want to download the file.
6015
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006016 After this option has been set successfully, Vim will source the files
6017 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006018 up to the first comma, dot or underscore.
6019 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006020
6021
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006022 *'spellsuggest'* *'sps'*
6023'spellsuggest' 'sps' string (default "best")
6024 global
6025 {not in Vi}
6026 {not available when compiled without the |+syntax|
6027 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006028 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006029 the |spellsuggest()| function. This is a comma-separated list of
6030 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006031
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006032 best Internal method that works best for English. Finds
6033 changes like "fast" and uses a bit of sound-a-like
6034 scoring to improve the ordering.
6035
6036 double Internal method that uses two methods and mixes the
6037 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006038 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006039 word. That only works when the language specifies
6040 sound folding. Can be slow and doesn't always give
6041 better results.
6042
6043 fast Internal method that only checks for simple changes:
6044 character inserts/deletes/swaps. Works well for
6045 simple typing mistakes.
6046
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006047 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006048 Not used for |spellsuggest()|. The number of
6049 suggestions is never more than the value of 'lines'
6050 minus two.
6051
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006052 file:{filename} Read file {filename}, which must have two columns,
6053 separated by a slash. The first column contains the
6054 bad word, the second column the suggested good word.
6055 Example:
6056 theribal/terrible ~
6057 Use this for common mistakes that do not appear at the
6058 top of the suggestion list with the internal methods.
6059 Lines without a slash are ignored, use this for
6060 comments.
6061 The file is used for all languages.
6062
6063 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6064 trouble with spaces. |v:val| holds the badly spelled
6065 word. The expression must evaluate to a List of
6066 Lists, each with a suggestion and a score.
6067 Example:
6068 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006069 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006070 internal methods use. A lower score is better.
6071 This may invoke |spellsuggest()| if you temporarily
6072 set 'spellsuggest' to exclude the "expr:" part.
6073 Errors are silently ignored, unless you set the
6074 'verbose' option to a non-zero value.
6075
6076 Only one of "best", "double" or "fast" may be used. The others may
6077 appear several times in any order. Example: >
6078 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6079<
6080 This option cannot be set from a |modeline| or in the |sandbox|, for
6081 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006082
6083
Bram Moolenaar071d4272004-06-13 20:20:40 +00006084 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6085'splitbelow' 'sb' boolean (default off)
6086 global
6087 {not in Vi}
6088 {not available when compiled without the +windows
6089 feature}
6090 When on, splitting a window will put the new window below the current
6091 one. |:split|
6092
6093 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6094'splitright' 'spr' boolean (default off)
6095 global
6096 {not in Vi}
6097 {not available when compiled without the +vertsplit
6098 feature}
6099 When on, splitting a window will put the new window right of the
6100 current one. |:vsplit|
6101
6102 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6103'startofline' 'sol' boolean (default on)
6104 global
6105 {not in Vi}
6106 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006107 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006108 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006109 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006110 with a linewise operator, with "%" with a count and to buffer changing
6111 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6112 only has a line number, e.g., ":25" or ":+".
6113 In case of buffer changing commands the cursor is placed at the column
6114 where it was the last time the buffer was edited.
6115 NOTE: This option is set when 'compatible' is set.
6116
6117 *'statusline'* *'stl'* *E540* *E541* *E542*
6118'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006119 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006120 {not in Vi}
6121 {not available when compiled without the |+statusline|
6122 feature}
6123 When nonempty, this option determines the content of the status line.
6124 Also see |status-line|.
6125
6126 The option consists of printf style '%' items interspersed with
6127 normal text. Each status line item is of the form:
6128 %-0{minwid}.{maxwid}{item}
6129 All fields except the {item} is optional. A single percent sign can
6130 be given as "%%". Up to 80 items can be specified.
6131
Bram Moolenaar238a5642006-02-21 22:12:05 +00006132 When the option starts with "%!" then it is used as an expression,
6133 evaluated and the result is used as the option value. Example: >
6134 :set statusline=%!MyStatusLine()
6135< The result can contain %{} items that will be evaluated too.
6136
6137 When there is error while evaluating the option then it will be made
6138 empty to avoid further errors. Otherwise screen updating would loop.
6139
Bram Moolenaar071d4272004-06-13 20:20:40 +00006140 Note that the only effect of 'ruler' when this option is set (and
6141 'laststatus' is 2) is controlling the output of |CTRL-G|.
6142
6143 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006144 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006145 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006146 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006147 minwid Minimum width of the item, padding as set by '-' & '0'.
6148 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006149 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006150 on the left for text items. Numeric items will be
6151 shifted down to maxwid-2 digits followed by '>'number
6152 where number is the amount of missing digits, much like
6153 an exponential notation.
6154 item A one letter code as described below.
6155
6156 Following is a description of the possible statusline items. The
6157 second character in "item" is the type:
6158 N for number
6159 S for string
6160 F for flags as described below
6161 - not applicable
6162
6163 item meaning ~
6164 f S Path to the file in the buffer, relative to current directory.
6165 F S Full path to the file in the buffer.
6166 t S File name (tail) of file in the buffer.
6167 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
6168 M F Modified flag, text is ",+" or ",-".
6169 r F Readonly flag, text is " [RO]".
6170 R F Readonly flag, text is ",RO".
6171 h F Help buffer flag, text is " [help]".
6172 H F Help buffer flag, text is ",HLP".
6173 w F Preview window flag, text is " [Preview]".
6174 W F Preview window flag, text is ",PRV".
6175 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
6176 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6177 {not available when compiled without |+autocmd| feature}
6178 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6179 being used: "<keymap>"
6180 n N Buffer number.
6181 b N Value of byte under cursor.
6182 B N As above, in hexadecimal.
6183 o N Byte number in file of byte under cursor, first byte is 1.
6184 Mnemonic: Offset from start of file (with one added)
6185 {not available when compiled without |+byte_offset| feature}
6186 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006187 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006188 l N Line number.
6189 L N Number of lines in buffer.
6190 c N Column number.
6191 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006192 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006193 p N Percentage through file in lines as in |CTRL-G|.
6194 P S Percentage through file of displayed window. This is like the
6195 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006196 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006197 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006198 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006199 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006200 ( - Start of item group. Can be used for setting the width and
6201 alignment of a section. Must be followed by %) somewhere.
6202 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006203 T N For 'tabline': start of tab page N label. Use %T after the last
6204 label. This information is used for mouse clicks.
6205 X N For 'tabline': start of close tab N label. Use %X after the
6206 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6207 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006208 < - Where to truncate line if too long. Default is at the start.
6209 No width fields allowed.
6210 = - Separation point between left and right aligned items.
6211 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006212 # - Set highlight group. The name must follow and then a # again.
6213 Thus use %#HLname# for highlight group HLname. The same
6214 highlighting is used, also for the statusline of non-current
6215 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006216 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006217 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006218 The difference between User{N} and StatusLine will be applied
6219 to StatusLineNC for the statusline of non-current windows.
6220 The number N must be between 1 and 9. See |hl-User1..9|
6221
6222 Display of flags are controlled by the following heuristic:
6223 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006224 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00006225 with a space it is assumed that it wants to separate itself from
6226 anything but other flags. That is: A leading comma is removed if the
6227 preceding character stems from plaintext. A leading space is removed
Bram Moolenaar582fd852005-03-28 20:58:01 +00006228 if the preceding character stems from another active flag. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006229 make a nice display when flags are used like in the examples below.
6230
Bram Moolenaar582fd852005-03-28 20:58:01 +00006231 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006232 not set) and a minwid is not set for the group, the whole group will
6233 become empty. This will make a group like the following disappear
6234 completely from the statusline when none of the flags are set. >
6235 :set statusline=...%(\ [%M%R%H]%)...
6236<
6237 Beware that an expression is evaluated each and every time the status
6238 line is displayed. The current buffer and current window will be set
6239 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006240 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006241 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006242 real current buffer.
6243
6244 The 'statusline' option may be evaluated in the |sandbox|, see
6245 |sandbox-option|.
6246
6247 It is not allowed to change text or jump to another window while
6248 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006249
6250 If the statusline is not updated when you want it (e.g., after setting
6251 a variable that's used in an expression), you can force an update by
6252 setting an option without changing its value. Example: >
6253 :let &ro = &ro
6254
6255< A result of all digits is regarded a number for display purposes.
6256 Otherwise the result is taken as flag text and applied to the rules
6257 described above.
6258
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006259 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006260 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6261 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6262
6263 Examples:
6264 Emulate standard status line with 'ruler' set >
6265 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6266< Similar, but add ASCII value of char under the cursor (like "ga") >
6267 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6268< Display byte count and byte value, modified flag in red. >
6269 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6270 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6271< Display a ,GZ flag if a compressed file is loaded >
6272 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6273< In the |:autocmd|'s: >
6274 :let b:gzflag = 1
6275< And: >
6276 :unlet b:gzflag
6277< And define this function: >
6278 :function VarExists(var, val)
6279 : if exists(a:var) | return a:val | else | return '' | endif
6280 :endfunction
6281<
6282 *'suffixes'* *'su'*
6283'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6284 global
6285 {not in Vi}
6286 Files with these suffixes get a lower priority when multiple files
6287 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006288 suffixes. Spaces after the comma are ignored. A dot is also seen as
6289 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006290 separator, precede it with a backslash (see |option-backslash| about
6291 including spaces and backslashes).
6292 See 'wildignore' for completely ignoring files.
6293 The use of |:set+=| and |:set-=| is preferred when adding or removing
6294 suffixes from the list. This avoids problems when a future version
6295 uses another default.
6296
6297 *'suffixesadd'* *'sua'*
6298'suffixesadd' 'sua' string (default "")
6299 local to buffer
6300 {not in Vi}
6301 {not available when compiled without the
6302 |+file_in_path| feature}
6303 Comma separated list of suffixes, which are used when searching for a
6304 file for the "gf", "[I", etc. commands. Example: >
6305 :set suffixesadd=.java
6306<
6307 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6308'swapfile' 'swf' boolean (default on)
6309 local to buffer
6310 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006311 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006312 swapfile is not wanted for a specific buffer. For example, with
6313 confidential information that even root must not be able to access.
6314 Careful: All text will be in memory:
6315 - Don't use this for big files.
6316 - Recovery will be impossible!
6317 A swapfile will only be present when |'updatecount'| is non-zero and
6318 'swapfile' is set.
6319 When 'swapfile' is reset, the swap file for the current buffer is
6320 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6321 non-zero, a swap file is immediately created.
6322 Also see |swap-file| and |'swapsync'|.
6323
6324 This option is used together with 'bufhidden' and 'buftype' to
6325 specify special kinds of buffers. See |special-buffers|.
6326
6327 *'swapsync'* *'sws'*
6328'swapsync' 'sws' string (default "fsync")
6329 global
6330 {not in Vi}
6331 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006332 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006333 When this option is empty parts of the swap file may be in memory and
6334 not written to disk. When the system crashes you may lose more work.
6335 On Unix the system does a sync now and then without Vim asking for it,
6336 so the disadvantage of setting this option off is small. On some
6337 systems the swap file will not be written at all. For a unix system
6338 setting it to "sync" will use the sync() call instead of the default
6339 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006340 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006341
6342 *'switchbuf'* *'swb'*
6343'switchbuf' 'swb' string (default "")
6344 global
6345 {not in Vi}
6346 This option controls the behavior when switching between buffers.
6347 Possible values (comma separated list):
6348 useopen If included, jump to the first open window that
6349 contains the specified buffer (if there is one).
6350 Otherwise: Do not examine other windows.
6351 This setting is checked with |quickfix| commands, when
6352 jumping to errors (":cc", ":cn", "cp", etc.). It is
6353 also used in all buffer related split commands, for
6354 example ":sbuffer", ":sbnext", or ":sbrewind".
6355 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006356 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006357 Supported in |quickfix| commands that display errors.
6358
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006359 *'synmaxcol'* *'smc'*
6360'synmaxcol' 'smc' number (default 3000)
6361 local to buffer
6362 {not in Vi}
6363 {not available when compiled without the |+syntax|
6364 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006365 Maximum column in which to search for syntax items. In long lines the
6366 text after this column is not highlighted and following lines may not
6367 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006368 This helps to avoid very slow redrawing for an XML file that is one
6369 long line.
6370 Set to zero to remove the limit.
6371
Bram Moolenaar071d4272004-06-13 20:20:40 +00006372 *'syntax'* *'syn'*
6373'syntax' 'syn' string (default empty)
6374 local to buffer
6375 {not in Vi}
6376 {not available when compiled without the |+syntax|
6377 feature}
6378 When this option is set, the syntax with this name is loaded, unless
6379 syntax highlighting has been switched off with ":syntax off".
6380 Otherwise this option does not always reflect the current syntax (the
6381 b:current_syntax variable does).
6382 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006383 not automatically recognized. Example, in an IDL file:
6384 /* vim: set syntax=idl : */ ~
6385 When a dot appears in the value then this separates two filetype
6386 names. Example:
6387 /* vim: set syntax=c.doxygen : */ ~
6388 This will use the "c" syntax first, then the "doxygen" syntax.
6389 Note that the second one must be prepared to be loaded as an addition,
6390 otherwise it will be skipped. More than one dot may appear.
6391 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006392 :set syntax=OFF
6393< To switch syntax highlighting on according to the current value of the
6394 'filetype' option: >
6395 :set syntax=ON
6396< What actually happens when setting the 'syntax' option is that the
6397 Syntax autocommand event is triggered with the value as argument.
6398 This option is not copied to another buffer, independent of the 's' or
6399 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006400 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006401
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006402 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006403'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006404 global
6405 {not in Vi}
6406 {not available when compiled without the +windows
6407 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006408 When nonempty, this option determines the content of the tab pages
6409 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006410 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006411
6412 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006413 option and only when there is no GUI tab line. When 'e' is in
6414 'guioptions' and the GUI supports a tab line 'guitablabel' is used
6415 instead.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006416
6417 The value is evaluated like with 'statusline'. You can use
6418 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006419 the text to be displayed. Use "%1T" for the first label, "%2T" for
6420 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006421
6422 Keep in mind that only one of the tab pages is the current one, others
6423 are invisible and you can't jump to their windows.
6424
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006425
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006426 *'tabpagemax'* *'tpm'*
6427'tabpagemax' 'tpm' number (default 10)
6428 global
6429 {not in Vi}
6430 {not available when compiled without the +windows
6431 feature}
6432 Maximum number of tab pages to be opened by the |-p| command line
6433 argument or the ":tab all" command. |tabpage|
6434
6435
6436 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006437'tabstop' 'ts' number (default 8)
6438 local to buffer
6439 Number of spaces that a <Tab> in the file counts for. Also see
6440 |:retab| command, and 'softtabstop' option.
6441
6442 Note: Setting 'tabstop' to any other value than 8 can make your file
6443 appear wrong in many places (e.g., when printing it).
6444
6445 There are four main ways to use tabs in Vim:
6446 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6447 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
6448 will use a mix of tabs and spaces, but typing Tab and BS will
6449 behave like a tab appears every 4 (or 3) characters.
6450 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6451 'expandtab'. This way you will always insert spaces. The
6452 formatting will never be messed up when 'tabstop' is changed.
6453 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006454 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006455 works when using Vim to edit the file.
6456 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6457 'noexpandtab'. This should then work (for initial indents only)
6458 for any tabstop setting that people use. It might be nice to have
6459 tabs after the first non-blank inserted as spaces if you do this
6460 though. Otherwise aligned comments will be wrong when 'tabstop' is
6461 changed.
6462
6463 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6464'tagbsearch' 'tbs' boolean (default on)
6465 global
6466 {not in Vi}
6467 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006468 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006469 searching makes searching for a tag a LOT faster, but a linear search
6470 will find more tags if the tags file wasn't properly sorted.
6471 Vim normally assumes that your tags files are sorted, or indicate that
6472 they are not sorted. Only when this is not the case does the
6473 'tagbsearch' option need to be switched off.
6474
6475 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006476 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006477 certain files, or retry all files with a linear search. When
6478 'tagbsearch' is off, only a linear search is done.
6479
6480 Linear searching is done anyway, for one file, when Vim finds a line
6481 at the start of the file indicating that it's not sorted: >
6482 !_TAG_FILE_SORTED 0 /some command/
6483< [The whitespace before and after the '0' must be a single <Tab>]
6484
6485 When a binary search was done and no match was found in any of the
6486 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6487 instead of a normal tag name, a retry is done with a linear search.
6488 Tags in unsorted tags files, and matches with different case will only
6489 be found in the retry.
6490
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006491 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006492 linear search can be avoided for the 'ignorecase' case. Use a value
6493 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6494 case-fold sorted with the -f switch to "sort" in most unices, as in
6495 the command: "sort -f -o tags tags". For "Exuberant ctags" version
6496 5.3 or higher the -f or --fold-case-sort switch can be used for this
6497 as well. Note that case must be folded to uppercase for this to work.
6498
6499 When 'tagbsearch' is off, tags searching is slower when a full match
6500 exists, but faster when no full match exists. Tags in unsorted tags
6501 files may only be found with 'tagbsearch' off.
6502 When the tags file is not sorted, or sorted in a wrong way (not on
6503 ASCII byte value), 'tagbsearch' should be off, or the line given above
6504 must be included in the tags file.
6505 This option doesn't affect commands that find all matching tags (e.g.,
6506 command-line completion and ":help").
6507 {Vi: always uses binary search in some versions}
6508
6509 *'taglength'* *'tl'*
6510'taglength' 'tl' number (default 0)
6511 global
6512 If non-zero, tags are significant up to this number of characters.
6513
6514 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6515'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6516 global
6517 {not in Vi}
6518 If on and using a tag file in another directory, file names in that
6519 tag file are relative to the directory where the tag file is.
6520 NOTE: This option is set to the Vi default value when 'compatible' is
6521 set and to the Vim default value when 'compatible' is reset.
6522
6523 *'tags'* *'tag'* *E433*
6524'tags' 'tag' string (default "./tags,tags", when compiled with
6525 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6526 global or local to buffer |global-local|
6527 Filenames for the tag command, separated by spaces or commas. To
6528 include a space or comma in a file name, precede it with a backslash
6529 (see |option-backslash| about including spaces and backslashes).
6530 When a file name starts with "./", the '.' is replaced with the path
6531 of the current file. But only when the 'd' flag is not included in
6532 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6533 |tags-option|.
6534 "*", "**" and other wildcards can be used to search for tags files in
6535 a directory tree. See |file-searching|. {not available when compiled
6536 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006537 The |tagfiles()| function can be used to get a list of the file names
6538 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006539 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6540 files are also supported. They are automatically recognized. The
6541 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6542 differences are ignored (MS-Windows). |emacs-tags|
6543 The use of |:set+=| and |:set-=| is preferred when adding or removing
6544 file names from the list. This avoids problems when a future version
6545 uses another default.
6546 {Vi: default is "tags /usr/lib/tags"}
6547
6548 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6549'tagstack' 'tgst' boolean (default on)
6550 global
6551 {not in all versions of Vi}
6552 When on, the |tagstack| is used normally. When off, a ":tag" or
6553 ":tselect" command with an argument will not push the tag onto the
6554 tagstack. A following ":tag" without an argument, a ":pop" command or
6555 any other command that uses the tagstack will use the unmodified
6556 tagstack, but does change the pointer to the active entry.
6557 Resetting this option is useful when using a ":tag" command in a
6558 mapping which should not change the tagstack.
6559
6560 *'term'* *E529* *E530* *E531*
6561'term' string (default is $TERM, if that fails:
6562 in the GUI: "builtin_gui"
6563 on Amiga: "amiga"
6564 on BeOS: "beos-ansi"
6565 on Mac: "mac-ansi"
6566 on MiNT: "vt52"
6567 on MS-DOS: "pcterm"
6568 on OS/2: "os2ansi"
6569 on Unix: "ansi"
6570 on VMS: "ansi"
6571 on Win 32: "win32")
6572 global
6573 Name of the terminal. Used for choosing the terminal control
6574 characters. Environment variables are expanded |:set_env|.
6575 For example: >
6576 :set term=$TERM
6577< See |termcap|.
6578
6579 *'termbidi'* *'tbidi'*
6580 *'notermbidi'* *'notbidi'*
6581'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6582 global
6583 {not in Vi}
6584 {only available when compiled with the |+arabic|
6585 feature}
6586 The terminal is in charge of Bi-directionality of text (as specified
6587 by Unicode). The terminal is also expected to do the required shaping
6588 that some languages (such as Arabic) require.
6589 Setting this option implies that 'rightleft' will not be set when
6590 'arabic' is set and the value of 'arabicshape' will be ignored.
6591 Note that setting 'termbidi' has the immediate effect that
6592 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6593 This option is reset when the GUI is started.
6594 For further details see |arabic.txt|.
6595
6596 *'termencoding'* *'tenc'*
6597'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6598 Macintosh GUI: "macroman")
6599 global
6600 {only available when compiled with the |+multi_byte|
6601 feature}
6602 {not in Vi}
6603 Encoding used for the terminal. This specifies what character
6604 encoding the keyboard produces and the display will understand. For
6605 the GUI it only applies to the keyboard ('encoding' is used for the
6606 display).
6607 In the Win32 console version the default value is the console codepage
6608 when it differs from the ANSI codepage.
6609 *E617*
6610 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6611 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6612 Any attempts to set a different value will be rejected, and an error
6613 message is shown.
6614 For the Win32 GUI 'termencoding' is not used for typed characters,
6615 because the Win32 system always passes Unicode characters.
6616 When empty, the same encoding is used as for the 'encoding' option.
6617 This is the normal value.
6618 Not all combinations for 'termencoding' and 'encoding' are valid. See
6619 |encoding-table|.
6620 The value for this option must be supported by internal conversions or
6621 iconv(). When this is not possible no conversion will be done and you
6622 will probably experience problems with non-ASCII characters.
6623 Example: You are working with the locale set to euc-jp (Japanese) and
6624 want to edit a UTF-8 file: >
6625 :let &termencoding = &encoding
6626 :set encoding=utf-8
6627< You need to do this when your system has no locale support for UTF-8.
6628
6629 *'terse'* *'noterse'*
6630'terse' boolean (default off)
6631 global
6632 When set: Add 's' flag to 'shortmess' option (this makes the message
6633 for a search that hits the start or end of the file not being
6634 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6635 shortens a lot of messages}
6636
6637 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6638'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6639 global
6640 {not in Vi}
6641 This option is obsolete. Use 'fileformats'.
6642 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6643 set to the default value for the current system. When 'textauto' is
6644 reset, 'fileformats' is made empty.
6645 NOTE: This option is set to the Vi default value when 'compatible' is
6646 set and to the Vim default value when 'compatible' is reset.
6647
6648 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6649'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6650 others: default off)
6651 local to buffer
6652 {not in Vi}
6653 This option is obsolete. Use 'fileformat'.
6654 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6655 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6656 "unix".
6657
6658 *'textwidth'* *'tw'*
6659'textwidth' 'tw' number (default 0)
6660 local to buffer
6661 {not in Vi}
6662 Maximum width of text that is being inserted. A longer line will be
6663 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006664 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6665 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006666 'formatoptions' and |ins-textwidth|.
6667 NOTE: This option is set to 0 when 'compatible' is set.
6668
6669 *'thesaurus'* *'tsr'*
6670'thesaurus' 'tsr' string (default "")
6671 global or local to buffer |global-local|
6672 {not in Vi}
6673 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006674 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006675 the file should contain words with similar meaning, separated by
6676 non-keyword characters (white space is preferred). Maximum line
6677 length is 510 bytes.
6678 To obtain a file to be used here, check out the wordlist FAQ at
6679 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006680 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006681 after a comma are ignored, otherwise spaces are included in the file
6682 name. See |option-backslash| about using backslashes.
6683 The use of |:set+=| and |:set-=| is preferred when adding or removing
6684 directories from the list. This avoids problems when a future version
6685 uses another default.
6686 Backticks cannot be used in this option for security reasons.
6687
6688 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6689'tildeop' 'top' boolean (default off)
6690 global
6691 {not in Vi}
6692 When on: The tilde command "~" behaves like an operator.
6693 NOTE: This option is reset when 'compatible' is set.
6694
6695 *'timeout'* *'to'* *'notimeout'* *'noto'*
6696'timeout' 'to' boolean (default on)
6697 global
6698 *'ttimeout'* *'nottimeout'*
6699'ttimeout' boolean (default off)
6700 global
6701 {not in Vi}
6702 These two options together determine the behavior when part of a
6703 mapped key sequence or keyboard code has been received:
6704
6705 'timeout' 'ttimeout' action ~
6706 off off do not time out
6707 on on or off time out on :mappings and key codes
6708 off on time out on key codes
6709
6710 If both options are off, Vim will wait until either the complete
6711 mapping or key sequence has been received, or it is clear that there
6712 is no mapping or key sequence for the received characters. For
6713 example: if you have mapped "vl" and Vim has received 'v', the next
6714 character is needed to see if the 'v' is followed by an 'l'.
6715 When one of the options is on, Vim will wait for about 1 second for
6716 the next character to arrive. After that the already received
6717 characters are interpreted as single characters. The waiting time can
6718 be changed with the 'timeoutlen' option.
6719 On slow terminals or very busy systems timing out may cause
6720 malfunctioning cursor keys. If both options are off, Vim waits
6721 forever after an entered <Esc> if there are key codes that start
6722 with <Esc>. You will have to type <Esc> twice. If you do not have
6723 problems with key codes, but would like to have :mapped key
6724 sequences not timing out in 1 second, set the 'ttimeout' option and
6725 reset the 'timeout' option.
6726
6727 NOTE: 'ttimeout' is reset when 'compatible' is set.
6728
6729 *'timeoutlen'* *'tm'*
6730'timeoutlen' 'tm' number (default 1000)
6731 global
6732 {not in all versions of Vi}
6733 *'ttimeoutlen'* *'ttm'*
6734'ttimeoutlen' 'ttm' number (default -1)
6735 global
6736 {not in Vi}
6737 The time in milliseconds that is waited for a key code or mapped key
6738 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6739 when part of a command has been typed.
6740 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6741 different timeout value for key codes is desired set 'ttimeoutlen' to
6742 a non-negative number.
6743
6744 ttimeoutlen mapping delay key code delay ~
6745 < 0 'timeoutlen' 'timeoutlen'
6746 >= 0 'timeoutlen' 'ttimeoutlen'
6747
6748 The timeout only happens when the 'timeout' and 'ttimeout' options
6749 tell so. A useful setting would be >
6750 :set timeout timeoutlen=3000 ttimeoutlen=100
6751< (time out on mapping after three seconds, time out on key codes after
6752 a tenth of a second).
6753
6754 *'title'* *'notitle'*
6755'title' boolean (default off, on when title can be restored)
6756 global
6757 {not in Vi}
6758 {not available when compiled without the |+title|
6759 feature}
6760 When on, the title of the window will be set to the value of
6761 'titlestring' (if it is not empty), or to:
6762 filename [+=-] (path) - VIM
6763 Where:
6764 filename the name of the file being edited
6765 - indicates the file cannot be modified, 'ma' off
6766 + indicates the file was modified
6767 = indicates the file is read-only
6768 =+ indicates the file is read-only and modified
6769 (path) is the path of the file being edited
6770 - VIM the server name |v:servername| or "VIM"
6771 Only works if the terminal supports setting window titles
6772 (currently Amiga console, Win32 console, all GUI versions and
6773 terminals with a non- empty 't_ts' option - these are Unix xterm and
6774 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6775 *X11*
6776 When Vim was compiled with HAVE_X11 defined, the original title will
6777 be restored if possible. The output of ":version" will include "+X11"
6778 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6779 works for the icon name |'icon'|.
6780 But: When Vim was started with the |-X| argument, restoring the title
6781 will not work (except in the GUI).
6782 If the title cannot be restored, it is set to the value of 'titleold'.
6783 You might want to restore the title outside of Vim then.
6784 When using an xterm from a remote machine you can use this command:
6785 rsh machine_name xterm -display $DISPLAY &
6786 then the WINDOWID environment variable should be inherited and the
6787 title of the window should change back to what it should be after
6788 exiting Vim.
6789
6790 *'titlelen'*
6791'titlelen' number (default 85)
6792 global
6793 {not in Vi}
6794 {not available when compiled without the |+title|
6795 feature}
6796 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006797 title. When the title is longer, only the end of the path name is
6798 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006799 Using a percentage makes this adapt to the width of the window. But
6800 it won't work perfectly, because the actual number of characters
6801 available also depends on the font used and other things in the title
6802 bar. When 'titlelen' is zero the full path is used. Otherwise,
6803 values from 1 to 30000 percent can be used.
6804 'titlelen' is also used for the 'titlestring' option.
6805
6806 *'titleold'*
6807'titleold' string (default "Thanks for flying Vim")
6808 global
6809 {not in Vi}
6810 {only available when compiled with the |+title|
6811 feature}
6812 This option will be used for the window title when exiting Vim if the
6813 original title cannot be restored. Only happens if 'title' is on or
6814 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006815 This option cannot be set from a |modeline| or in the |sandbox|, for
6816 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006817 *'titlestring'*
6818'titlestring' string (default "")
6819 global
6820 {not in Vi}
6821 {not available when compiled without the |+title|
6822 feature}
6823 When this option is not empty, it will be used for the title of the
6824 window. This happens only when the 'title' option is on.
6825 Only works if the terminal supports setting window titles (currently
6826 Amiga console, Win32 console, all GUI versions and terminals with a
6827 non-empty 't_ts' option).
6828 When Vim was compiled with HAVE_X11 defined, the original title will
6829 be restored if possible |X11|.
6830 When this option contains printf-style '%' items, they will be
6831 expanded according to the rules used for 'statusline'.
6832 Example: >
6833 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6834 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6835< The value of 'titlelen' is used to align items in the middle or right
6836 of the available space.
6837 Some people prefer to have the file name first: >
6838 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6839< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006840 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006841 separating space only when needed.
6842 NOTE: Use of special characters in 'titlestring' may cause the display
6843 to be garbled (e.g., when it contains a CR or NL character).
6844 {not available when compiled without the |+statusline| feature}
6845
6846 *'toolbar'* *'tb'*
6847'toolbar' 'tb' string (default "icons,tooltips")
6848 global
6849 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6850 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006851 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006852 possible values are:
6853 icons Toolbar buttons are shown with icons.
6854 text Toolbar buttons shown with text.
6855 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006856 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006857 tooltips Tooltips are active for toolbar buttons.
6858 Tooltips refer to the popup help text which appears after the mouse
6859 cursor is placed over a toolbar button for a brief moment.
6860
6861 If you want the toolbar to be shown with icons as well as text, do the
6862 following: >
6863 :set tb=icons,text
6864< Motif and Athena cannot display icons and text at the same time. They
6865 will show icons if both are requested.
6866
6867 If none of the strings specified in 'toolbar' are valid or if
6868 'toolbar' is empty, this option is ignored. If you want to disable
6869 the toolbar, you need to set the 'guioptions' option. For example: >
6870 :set guioptions-=T
6871< Also see |gui-toolbar|.
6872
6873 *'toolbariconsize'* *'tbis'*
6874'toolbariconsize' 'tbis' string (default "small")
6875 global
6876 {not in Vi}
6877 {only in the GTK+ 2 GUI}
6878 Controls the size of toolbar icons. The possible values are:
6879 tiny Use tiny toolbar icons.
6880 small Use small toolbar icons (default).
6881 medium Use medium-sized toolbar icons.
6882 large Use large toolbar icons.
6883 The exact dimensions in pixels of the various icon sizes depend on
6884 the current theme. Common dimensions are large=32x32, medium=24x24,
6885 small=20x20 and tiny=16x16.
6886
6887 If 'toolbariconsize' is empty, the global default size as determined
6888 by user preferences or the current theme is used.
6889
6890 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6891'ttybuiltin' 'tbi' boolean (default on)
6892 global
6893 {not in Vi}
6894 When on, the builtin termcaps are searched before the external ones.
6895 When off the builtin termcaps are searched after the external ones.
6896 When this option is changed, you should set the 'term' option next for
6897 the change to take effect, for example: >
6898 :set notbi term=$TERM
6899< See also |termcap|.
6900 Rationale: The default for this option is "on", because the builtin
6901 termcap entries are generally better (many systems contain faulty
6902 xterm entries...).
6903
6904 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6905'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6906 sun-cmd, screen, rxvt, dtterm or
6907 iris-ansi; also on when running Vim in
6908 a DOS console)
6909 global
6910 {not in Vi}
6911 Indicates a fast terminal connection. More characters will be sent to
6912 the screen for redrawing, instead of using insert/delete line
6913 commands. Improves smoothness of redrawing when there are multiple
6914 windows and the terminal does not support a scrolling region.
6915 Also enables the extra writing of characters at the end of each screen
6916 line for lines that wrap. This helps when using copy/paste with the
6917 mouse in an xterm and other terminals.
6918
6919 *'ttymouse'* *'ttym'*
6920'ttymouse' 'ttym' string (default depends on 'term')
6921 global
6922 {not in Vi}
6923 {only in Unix and VMS, doesn't work in the GUI; not
6924 available when compiled without |+mouse|}
6925 Name of the terminal type for which mouse codes are to be recognized.
6926 Currently these three strings are valid:
6927 *xterm-mouse*
6928 xterm xterm-like mouse handling. The mouse generates
6929 "<Esc>[Mscr", where "scr" is three bytes:
6930 "s" = button state
6931 "c" = column plus 33
6932 "r" = row plus 33
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006933 This only works up to 223 columns! See "dec" for a
6934 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006935 xterm2 Works like "xterm", but with the xterm reporting the
6936 mouse position while the mouse is dragged. This works
6937 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006938 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00006939 work. See below for how Vim detects this
6940 automatically.
6941 *netterm-mouse*
6942 netterm NetTerm mouse handling. The mouse generates
6943 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6944 for the row and column.
6945 *dec-mouse*
6946 dec DEC terminal mouse handling. The mouse generates a
6947 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006948 This is also available for an Xterm, if it was
6949 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006950 *jsbterm-mouse*
6951 jsbterm JSB term mouse handling.
6952 *pterm-mouse*
6953 pterm QNX pterm mouse handling.
6954
6955 The mouse handling must be enabled at compile time |+mouse_xterm|
6956 |+mouse_dec| |+mouse_netterm|.
6957 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6958 recognized, if enabled at compile time. DEC terminal mouse codes
6959 are recognized if enabled at compile time, and 'ttymouse' is not
6960 "xterm" (because the xterm and dec mouse codes conflict).
6961 This option is automatically set to "xterm", when the 'term' option is
6962 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6963 or "xterm2" already. The main use of this option is to set it to
6964 "xterm", when the terminal name doesn't start with "xterm", but it can
6965 handle xterm mouse codes.
6966 The "xterm2" value will be set if the xterm version is reported to be
6967 95 of higher. This only works when compiled with the |+termresponse|
6968 feature and if |t_RV| is set to the escape sequence to request the
6969 xterm version number. Otherwise "xterm2" must be set explicitly.
6970 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6971 t_RV to an empty string: >
6972 :set t_RV=
6973<
6974 *'ttyscroll'* *'tsl'*
6975'ttyscroll' 'tsl' number (default 999)
6976 global
6977 Maximum number of lines to scroll the screen. If there are more lines
6978 to scroll the window is redrawn. For terminals where scrolling is
6979 very slow and redrawing is not slow this can be set to a small number,
6980 e.g., 3, to speed up displaying.
6981
6982 *'ttytype'* *'tty'*
6983'ttytype' 'tty' string (default from $TERM)
6984 global
6985 Alias for 'term', see above.
6986
6987 *'undolevels'* *'ul'*
6988'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
6989 Win32 and OS/2)
6990 global
6991 {not in Vi}
6992 Maximum number of changes that can be undone. Since undo information
6993 is kept in memory, higher numbers will cause more memory to be used
6994 (nevertheless, a single change can use an unlimited amount of memory).
6995 Set to 0 for Vi compatibility: One level of undo and "u" undoes
6996 itself: >
6997 set ul=0
6998< But you can also get Vi compatibility by including the 'u' flag in
6999 'cpoptions', and still be able to use CTRL-R to repeat undo.
7000 Set to a negative number for no undo at all: >
7001 set ul=-1
7002< This helps when you run out of memory for a single change.
7003 Also see |undo-two-ways|.
7004
7005 *'updatecount'* *'uc'*
7006'updatecount' 'uc' number (default: 200)
7007 global
7008 {not in Vi}
7009 After typing this many characters the swap file will be written to
7010 disk. When zero, no swap file will be created at all (see chapter on
7011 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7012 Vim with the "-n" option, see |startup|. When editing in readonly
7013 mode this option will be initialized to 10000.
7014 The swapfile can be disabled per buffer with |'swapfile'|.
7015 When 'updatecount' is set from zero to non-zero, swap files are
7016 created for all buffers that have 'swapfile' set. When 'updatecount'
7017 is set to zero, existing swap files are not deleted.
7018 Also see |'swapsync'|.
7019 This option has no meaning in buffers where |'buftype'| is "nofile"
7020 or "nowrite".
7021
7022 *'updatetime'* *'ut'*
7023'updatetime' 'ut' number (default 4000)
7024 global
7025 {not in Vi}
7026 If this many milliseconds nothing is typed the swap file will be
7027 written to disk (see |crash-recovery|). Also used for the
7028 |CursorHold| autocommand event.
7029
7030 *'verbose'* *'vbs'*
7031'verbose' 'vbs' number (default 0)
7032 global
7033 {not in Vi, although some versions have a boolean
7034 verbose option}
7035 When bigger than zero, Vim will give messages about what it is doing.
7036 Currently, these messages are given:
7037 >= 1 When the viminfo file is read or written.
7038 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007039 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007040 >= 8 Files for which a group of autocommands is executed.
7041 >= 9 Every executed autocommand.
7042 >= 12 Every executed function.
7043 >= 13 When an exception is thrown, caught, finished, or discarded.
7044 >= 14 Anything pending in a ":finally" clause.
7045 >= 15 Every executed Ex command (truncated at 200 characters).
7046
7047 This option can also be set with the "-V" argument. See |-V|.
7048 This option is also set by the |:verbose| command.
7049
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007050 When the 'verbosefile' option is set then the verbose messages are not
7051 displayed.
7052
7053 *'verbosefile'* *'vfile'*
7054'verbosefile' 'vfile' string (default empty)
7055 global
7056 {not in Vi}
7057 When not empty all messages are written in a file with this name.
7058 When the file exists messages are appended.
7059 Writing to the file ends when Vim exits or when 'verbosefile' is made
7060 empty.
7061 Setting 'verbosefile' to a new value is like making it empty first.
7062 The difference with |:redir| is that verbose messages are not
7063 displayed when 'verbosefile' is set.
7064
Bram Moolenaar071d4272004-06-13 20:20:40 +00007065 *'viewdir'* *'vdir'*
7066'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7067 "$VIM/vimfiles/view",
7068 for Unix: "~/.vim/view",
7069 for Macintosh: "$VIM:vimfiles:view"
7070 for VMS: "sys$login:vimfiles/view"
7071 for RiscOS: "Choices:vimfiles/view")
7072 global
7073 {not in Vi}
7074 {not available when compiled without the +mksession
7075 feature}
7076 Name of the directory where to store files for |:mkview|.
7077 This option cannot be set from a |modeline| or in the |sandbox|, for
7078 security reasons.
7079
7080 *'viewoptions'* *'vop'*
7081'viewoptions' 'vop' string (default: "folds,options,cursor")
7082 global
7083 {not in Vi}
7084 {not available when compiled without the +mksession
7085 feature}
7086 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007087 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007088 word save and restore ~
7089 cursor cursor position in file and in window
7090 folds manually created folds, opened/closed folds and local
7091 fold options
7092 options options and mappings local to a window or buffer (not
7093 global values for local options)
7094 slash backslashes in file names replaced with forward
7095 slashes
7096 unix with Unix end-of-line format (single <NL>), even when
7097 on Windows or DOS
7098
7099 "slash" and "unix" are useful on Windows when sharing view files
7100 with Unix. The Unix version of Vim cannot source dos format scripts,
7101 but the Windows version of Vim can source unix format scripts.
7102
7103 *'viminfo'* *'vi'* *E526* *E527* *E528*
7104'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
7105 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
7106 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
7107 for others: '20,<50,s10,h)
7108 global
7109 {not in Vi}
7110 {not available when compiled without the |+viminfo|
7111 feature}
7112 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007113 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007114 separated list of parameters, each consisting of a single character
7115 identifying the particular parameter, followed by a number or string
7116 which specifies the value of that parameter. If a particular
7117 character is left out, then the default value is used for that
7118 parameter. The following is a list of the identifying characters and
7119 the effect of their value.
7120 CHAR VALUE ~
7121 ! When included, save and restore global variables that start
7122 with an uppercase letter, and don't contain a lowercase
7123 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007124 and "_K_L_M" are not. Only String and Number types are
7125 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007126 " Maximum number of lines saved for each register. Old name of
7127 the '<' item, with the disadvantage that you need to put a
7128 backslash before the ", otherwise it will be recognized as the
7129 start of a comment!
7130 % When included, save and restore the buffer list. If Vim is
7131 started with a file name argument, the buffer list is not
7132 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007133 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007134 without a file name and buffers for help files are not written
7135 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007136 When followed by a number, the number specifies the maximum
7137 number of buffers that are stored. Without a number all
7138 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007139 ' Maximum number of previously edited files for which the marks
7140 are remembered. This parameter must always be included when
7141 'viminfo' is non-empty.
7142 Including this item also means that the |jumplist| and the
7143 |changelist| are stored in the viminfo file.
7144 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007145 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007146 patterns are also saved. When not included, the value of
7147 'history' is used.
7148 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007149 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007150 < Maximum number of lines saved for each register. If zero then
7151 registers are not saved. When not included, all lines are
7152 saved. '"' is the old name for this item.
7153 Also see the 's' item below: limit specified in Kbyte.
7154 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007155 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007156 c When included, convert the text in the viminfo file from the
7157 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007158 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007159 f Whether file marks need to be stored. If zero, file marks ('0
7160 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007161 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007162 cursor position (when exiting or when doing ":wviminfo").
7163 h Disable the effect of 'hlsearch' when loading the viminfo
7164 file. When not included, it depends on whether ":nohlsearch"
7165 has been used since the last search command.
7166 n Name of the viminfo file. The name must immediately follow
7167 the 'n'. Must be the last one! If the "-i" argument was
7168 given when starting Vim, that file name overrides the one
7169 given here with 'viminfo'. Environment variables are expanded
7170 when opening the file, not when setting the option.
7171 r Removable media. The argument is a string (up to the next
7172 ','). This parameter can be given several times. Each
7173 specifies the start of a path for which no marks will be
7174 stored. This is to avoid removable media. For MS-DOS you
7175 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7176 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7177 ignored. Maximum length of each 'r' argument is 50
7178 characters.
7179 s Maximum size of an item in Kbyte. If zero then registers are
7180 not saved. Currently only applies to registers. The default
7181 "s10" will exclude registers with more than 10 Kbyte of text.
7182 Also see the '<' item above: line count limit.
7183
7184 Example: >
7185 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7186<
7187 '50 Marks will be remembered for the last 50 files you
7188 edited.
7189 <1000 Contents of registers (up to 1000 lines each) will be
7190 remembered.
7191 s100 Registers with more than 100 Kbyte text are skipped.
7192 :0 Command-line history will not be saved.
7193 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7194 no / Since '/' is not specified, the default will be used,
7195 that is, save all of the search history, and also the
7196 previous search and substitute patterns.
7197 no % The buffer list will not be saved nor read back.
7198 no h 'hlsearch' highlighting will be restored.
7199
7200 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7201 load the contents of the file, this is not done automatically.
7202
7203 This option cannot be set from a |modeline| or in the |sandbox|, for
7204 security reasons.
7205
7206 *'virtualedit'* *'ve'*
7207'virtualedit' 've' string (default "")
7208 global
7209 {not in Vi}
7210 {not available when compiled without the
7211 |+virtualedit| feature}
7212 A comma separated list of these words:
7213 block Allow virtual editing in Visual block mode.
7214 insert Allow virtual editing in Insert mode.
7215 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007216 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007217
Bram Moolenaar071d4272004-06-13 20:20:40 +00007218 Virtual editing means that the cursor can be positioned where there is
7219 no actual character. This can be halfway into a Tab or beyond the end
7220 of the line. Useful for selecting a rectangle in Visual mode and
7221 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007222 "onemore" is not the same, it will only allow moving the cursor just
7223 after the last character of the line. This makes some commands more
7224 consistent. Previously the cursor was always past the end of the line
7225 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007226 break some plugins or Vim scripts. For example because |l| can move
7227 the cursor after the last character. Use with care!
7228 Using the |$| command will move to the last character in the line, not
7229 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007230 It doesn't make sense to combine "all" with "onemore", but you will
7231 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007232
7233 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7234'visualbell' 'vb' boolean (default off)
7235 global
7236 {not in Vi}
7237 Use visual bell instead of beeping. The terminal code to display the
7238 visual bell is given with 't_vb'. When no beep or flash is wanted,
7239 use ":set vb t_vb=".
7240 Note: When the GUI starts, 't_vb' is reset to its default value. You
7241 might want to set it again in your |gvimrc|.
7242 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7243 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7244 where 40 is the time in msec.
7245 Does not work on the Amiga, you always get a screen flash.
7246 Also see 'errorbells'.
7247
7248 *'warn'* *'nowarn'*
7249'warn' boolean (default on)
7250 global
7251 Give a warning message when a shell command is used while the buffer
7252 has been changed.
7253
7254 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7255'weirdinvert' 'wiv' boolean (default off)
7256 global
7257 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007258 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007259 It is provided for backwards compatibility with version 4.x.
7260 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7261 vice versa. Has no effect when the GUI is running.
7262
7263 *'whichwrap'* *'ww'*
7264'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7265 global
7266 {not in Vi}
7267 Allow specified keys that move the cursor left/right to move to the
7268 previous/next line when the cursor is on the first/last character in
7269 the line. Concatenate characters to allow this for these keys:
7270 char key mode ~
7271 b <BS> Normal and Visual
7272 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007273 h "h" Normal and Visual (not recommended)
7274 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007275 < <Left> Normal and Visual
7276 > <Right> Normal and Visual
7277 ~ "~" Normal
7278 [ <Left> Insert and Replace
7279 ] <Right> Insert and Replace
7280 For example: >
7281 :set ww=<,>,[,]
7282< allows wrap only when cursor keys are used.
7283 When the movement keys are used in combination with a delete or change
7284 operator, the <EOL> also counts for a character. This makes "3h"
7285 different from "3dh" when the cursor crosses the end of a line. This
7286 is also true for "x" and "X", because they do the same as "dl" and
7287 "dh". If you use this, you may also want to use the mapping
7288 ":map <BS> X" to make backspace delete the character in front of the
7289 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007290 When 'l' is included and it is used after an operator at the end of a
7291 line then it will not move to the next line. This makes "dl", "cl",
7292 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007293 NOTE: This option is set to the Vi default value when 'compatible' is
7294 set and to the Vim default value when 'compatible' is reset.
7295
7296 *'wildchar'* *'wc'*
7297'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7298 global
7299 {not in Vi}
7300 Character you have to type to start wildcard expansion in the
7301 command-line, as specified with 'wildmode'.
7302 The character is not recognized when used inside a macro. See
7303 'wildcharm' for that.
7304 Although 'wc' is a number option, you can set it to a special key: >
7305 :set wc=<Esc>
7306< NOTE: This option is set to the Vi default value when 'compatible' is
7307 set and to the Vim default value when 'compatible' is reset.
7308
7309 *'wildcharm'* *'wcm'*
7310'wildcharm' 'wcm' number (default: none (0))
7311 global
7312 {not in Vi}
7313 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007314 recognized when used inside a macro. You can find "spare" command-line
7315 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007316 you'll never actually type 'wildcharm', just use it in mappings that
7317 automatically invoke completion mode, e.g.: >
7318 :set wcm=<C-Z>
7319 :cmap ss so $vim/sessions/*.vim<C-Z>
7320< Then after typing :ss you can use CTRL-P & CTRL-N.
7321
7322 *'wildignore'* *'wig'*
7323'wildignore' 'wig' string (default "")
7324 global
7325 {not in Vi}
7326 {not available when compiled without the |+wildignore|
7327 feature}
7328 A list of file patterns. A file that matches with one of these
7329 patterns is ignored when completing file or directory names.
7330 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7331 Also see 'suffixes'.
7332 Example: >
7333 :set wildignore=*.o,*.obj
7334< The use of |:set+=| and |:set-=| is preferred when adding or removing
7335 a pattern from the list. This avoids problems when a future version
7336 uses another default.
7337
7338 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7339'wildmenu' 'wmnu' boolean (default off)
7340 global
7341 {not in Vi}
7342 {not available if compiled without the |+wildmenu|
7343 feature}
7344 When 'wildmenu' is on, command-line completion operates in an enhanced
7345 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7346 the possible matches are shown just above the command line, with the
7347 first match highlighted (overwriting the status line, if there is
7348 one). Keys that show the previous/next match, such as <Tab> or
7349 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7350 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7351 specified. "longest" and "list" do not start "wildmenu" mode.
7352 If there are more matches than can fit in the line, a ">" is shown on
7353 the right and/or a "<" is shown on the left. The status line scrolls
7354 as needed.
7355 The "wildmenu" mode is abandoned when a key is hit that is not used
7356 for selecting a completion.
7357 While the "wildmenu" is active the following keys have special
7358 meanings:
7359
7360 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7361 <Down> - in filename/menu name completion: move into a
7362 subdirectory or submenu.
7363 <CR> - in menu completion, when the cursor is just after a
7364 dot: move into a submenu.
7365 <Up> - in filename/menu name completion: move up into
7366 parent directory or parent menu.
7367
7368 This makes the menus accessible from the console |console-menus|.
7369
7370 If you prefer the <Left> and <Right> keys to move the cursor instead
7371 of selecting a different match, use this: >
7372 :cnoremap <Left> <Space><BS><Left>
7373 :cnoremap <Right> <Space><BS><Right>
7374<
7375 The "WildMenu" highlighting is used for displaying the current match
7376 |hl-WildMenu|.
7377
7378 *'wildmode'* *'wim'*
7379'wildmode' 'wim' string (Vim default: "full")
7380 global
7381 {not in Vi}
7382 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007383 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00007384 part specifies what to do for each consecutive use of 'wildchar. The
7385 first part specifies the behavior for the first use of 'wildchar',
7386 The second part for the second use, etc.
7387 These are the possible values for each part:
7388 "" Complete only the first match.
7389 "full" Complete the next full match. After the last match,
7390 the original string is used and then the first match
7391 again.
7392 "longest" Complete till longest common string. If this doesn't
7393 result in a longer string, use the next part.
7394 "longest:full" Like "longest", but also start 'wildmenu' if it is
7395 enabled.
7396 "list" When more than one match, list all matches.
7397 "list:full" When more than one match, list all matches and
7398 complete first match.
7399 "list:longest" When more than one match, list all matches and
7400 complete till longest common string.
7401 When there is only a single match, it is fully completed in all cases.
7402
7403 Examples: >
7404 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007405< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007406 :set wildmode=longest,full
7407< Complete longest common string, then each full match >
7408 :set wildmode=list:full
7409< List all matches and complete each full match >
7410 :set wildmode=list,full
7411< List all matches without completing, then each full match >
7412 :set wildmode=longest,list
7413< Complete longest common string, then list alternatives.
7414
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007415 *'wildoptions'* *'wop'*
7416'wildoptions' 'wop' string (default "")
7417 global
7418 {not in Vi}
7419 {not available when compiled without the |+wildignore|
7420 feature}
7421 A list of words that change how command line completion is done.
7422 Currently only one word is allowed:
7423 tagfile When using CTRL-D to list matching tags, the kind of
7424 tag and the file of the tag is listed. Only one match
7425 is displayed per line. Often used tag kinds are:
7426 d #define
7427 f function
7428 Also see |cmdline-completion|.
7429
Bram Moolenaar071d4272004-06-13 20:20:40 +00007430 *'winaltkeys'* *'wak'*
7431'winaltkeys' 'wak' string (default "menu")
7432 global
7433 {not in Vi}
7434 {only used in Win32, Motif, GTK and Photon GUI}
7435 Some GUI versions allow the access to menu entries by using the ALT
7436 key in combination with a character that appears underlined in the
7437 menu. This conflicts with the use of the ALT key for mappings and
7438 entering special characters. This option tells what to do:
7439 no Don't use ALT keys for menus. ALT key combinations can be
7440 mapped, but there is no automatic handling. This can then be
7441 done with the |:simalt| command.
7442 yes ALT key handling is done by the windowing system. ALT key
7443 combinations cannot be mapped.
7444 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007445 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007446 keys can be mapped.
7447 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7448 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007449 This option is not used for <F10>; on Win32 and with GTK <F10> will
7450 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007451
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007452 *'window'* *'wi'*
7453'window' 'wi' number (default screen height - 1)
7454 global
7455 Window height. Do not confuse this with the height of the Vim window,
7456 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007457 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7458 value is smaller than 'lines' minus one. The screen will scroll
7459 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007460 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7461 in a much smarter way, taking care of wrapping lines.
7462 When resizing the Vim window, the value is smaller than 1 or more than
7463 or equal to 'lines' it will be set to 'lines' minus 1.
7464 {Vi also uses the option to specify the number of displayed lines}
7465
Bram Moolenaar071d4272004-06-13 20:20:40 +00007466 *'winheight'* *'wh'* *E591*
7467'winheight' 'wh' number (default 1)
7468 global
7469 {not in Vi}
7470 {not available when compiled without the +windows
7471 feature}
7472 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007473 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007474 current window is smaller, its size is increased, at the cost of the
7475 height of other windows. Set it to 999 to make the current window
7476 always fill the screen (although this has the drawback that ":all"
7477 will create only two windows). Set it to a small number for normal
7478 editing.
7479 Minimum value is 1.
7480 The height is not adjusted after one of the commands to change the
7481 height of the current window.
7482 'winheight' applies to the current window. Use 'winminheight' to set
7483 the minimal height for other windows.
7484
7485 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7486'winfixheight' 'wfh' boolean (default off)
7487 local to window
7488 {not in Vi}
7489 {not available when compiled without the +windows
7490 feature}
7491 Keep the window height when windows are opened or closed and
7492 'equalalways' is set. Set by default for the |preview-window| and
7493 |quickfix-window|.
7494 The height may be changed anyway when running out of room.
7495
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007496 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7497'winfixwidth' 'wfw' boolean (default off)
7498 local to window
7499 {not in Vi}
7500 {not available when compiled without the +windows
7501 feature}
7502 Keep the window width when windows are opened or closed and
7503 'equalalways' is set.
7504 The width may be changed anyway when running out of room.
7505
Bram Moolenaar071d4272004-06-13 20:20:40 +00007506 *'winminheight'* *'wmh'*
7507'winminheight' 'wmh' number (default 1)
7508 global
7509 {not in Vi}
7510 {not available when compiled without the +windows
7511 feature}
7512 The minimal height of a window, when it's not the current window.
7513 This is a hard minimum, windows will never become smaller.
7514 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7515 status bar) if necessary. They will return to at least one line when
7516 they become active (since the cursor has to have somewhere to go.)
7517 Use 'winheight' to set the minimal height of the current window.
7518 This option is only checked when making a window smaller. Don't use a
7519 large number, it will cause errors when opening more than a few
7520 windows. A value of 0 to 3 is reasonable.
7521
7522 *'winminwidth'* *'wmw'*
7523'winminwidth' 'wmw' number (default 1)
7524 global
7525 {not in Vi}
7526 {not available when compiled without the +vertsplit
7527 feature}
7528 The minimal width of a window, when it's not the current window.
7529 This is a hard minimum, windows will never become smaller.
7530 When set to zero, windows may be "squashed" to zero columns (i.e. just
7531 a vertical separator) if necessary. They will return to at least one
7532 line when they become active (since the cursor has to have somewhere
7533 to go.)
7534 Use 'winwidth' to set the minimal width of the current window.
7535 This option is only checked when making a window smaller. Don't use a
7536 large number, it will cause errors when opening more than a few
7537 windows. A value of 0 to 12 is reasonable.
7538
7539 *'winwidth'* *'wiw'* *E592*
7540'winwidth' 'wiw' number (default 20)
7541 global
7542 {not in Vi}
7543 {not available when compiled without the +vertsplit
7544 feature}
7545 Minimal number of columns for the current window. This is not a hard
7546 minimum, Vim will use fewer columns if there is not enough room. If
7547 the current window is smaller, its size is increased, at the cost of
7548 the width of other windows. Set it to 999 to make the current window
7549 always fill the screen. Set it to a small number for normal editing.
7550 The width is not adjusted after one of the commands to change the
7551 width of the current window.
7552 'winwidth' applies to the current window. Use 'winminwidth' to set
7553 the minimal width for other windows.
7554
7555 *'wrap'* *'nowrap'*
7556'wrap' boolean (default on)
7557 local to window
7558 {not in Vi}
7559 This option changes how text is displayed. It doesn't change the text
7560 in the buffer, see 'textwidth' for that.
7561 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007562 displaying continues on the next line. When off lines will not wrap
7563 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007564 moved to a part that is not shown, the screen will scroll
7565 horizontally.
7566 The line will be broken in the middle of a word if necessary. See
7567 'linebreak' to get the break at a word boundary.
7568 To make scrolling horizontally a bit more useful, try this: >
7569 :set sidescroll=5
7570 :set listchars+=precedes:<,extends:>
7571< See 'sidescroll', 'listchars' and |wrap-off|.
7572
7573 *'wrapmargin'* *'wm'*
7574'wrapmargin' 'wm' number (default 0)
7575 local to buffer
7576 Number of characters from the right window border where wrapping
7577 starts. When typing text beyond this limit, an <EOL> will be inserted
7578 and inserting continues on the next line.
7579 Options that add a margin, such as 'number' and 'foldcolumn', cause
7580 the text width to be further reduced. This is Vi compatible.
7581 When 'textwidth' is non-zero, this option is not used.
7582 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7583 and less usefully}
7584
7585 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7586'wrapscan' 'ws' boolean (default on) *E384* *E385*
7587 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007588 Searches wrap around the end of the file. Also applies to |]s| and
7589 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007590
7591 *'write'* *'nowrite'*
7592'write' boolean (default on)
7593 global
7594 {not in Vi}
7595 Allows writing files. When not set, writing a file is not allowed.
7596 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007597 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007598 argument. Filtering text is still possible, even though this requires
7599 writing a temporary file.
7600
7601 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7602'writeany' 'wa' boolean (default off)
7603 global
7604 Allows writing to any file with no need for "!" override.
7605
7606 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7607'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7608 otherwise)
7609 global
7610 {not in Vi}
7611 Make a backup before overwriting a file. The backup is removed after
7612 the file was successfully written, unless the 'backup' option is
7613 also on. Reset this option if your file system is almost full. See
7614 |backup-table| for another explanation.
7615 When the 'backupskip' pattern matches, a backup is not made anyway.
7616 NOTE: This option is set to the default value when 'compatible' is
7617 set.
7618
7619 *'writedelay'* *'wd'*
7620'writedelay' 'wd' number (default 0)
7621 global
7622 {not in Vi}
7623 The number of microseconds to wait for each character sent to the
7624 screen. When non-zero, characters are sent to the terminal one by
7625 one. For MS-DOS pcterm this does not work. For debugging purposes.
7626
7627 vim:tw=78:ts=8:ft=help:norl: