blob: f176566d357fb1d0d2c4b2ce5479a69b197a3792 [file] [log] [blame]
Bram Moolenaare2f98b92006-03-29 21:18:24 +00001*options.txt* For Vim version 7.0c. Last change: 2006 Mar 29
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.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002080 When Visual mode is active the highlighting isn't used to make it
2081 easier to spot where the selected area.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002082
2083
Bram Moolenaar071d4272004-06-13 20:20:40 +00002084 *'debug'*
2085'debug' string (default "")
2086 global
2087 {not in Vi}
2088 When set to "msg", error messages that would otherwise be omitted will
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002089 be given anyway. This is useful when debugging 'foldexpr',
2090 'formatexpr' or 'indentexpr'.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002091 When set to "beep", a message will be given when otherwise only a beep
2092 would be produced.
2093 The values can be combined, separated by a comma.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002094
2095 *'define'* *'def'*
2096'define' 'def' string (default "^\s*#\s*define")
2097 global or local to buffer |global-local|
2098 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002099 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002100 pattern, just like for the "/" command. This option is used for the
2101 commands like "[i" and "[d" |include-search|. The 'isident' option is
2102 used to recognize the defined name after the match:
2103 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2104 See |option-backslash| about inserting backslashes to include a space
2105 or backslash.
2106 The default value is for C programs. For C++ this value would be
2107 useful, to include const type declarations: >
2108 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2109< When using the ":set" command, you need to double the backslashes!
2110
2111 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2112'delcombine' 'deco' boolean (default off)
2113 global
2114 {not in Vi}
2115 {only available when compiled with the |+multi_byte|
2116 feature}
2117 If editing Unicode and this option is set, backspace and Normal mode
2118 "x" delete each combining character on its own. When it is off (the
2119 default) the character along with its combining characters are
2120 deleted.
2121 Note: When 'delcombine' is set "xx" may work different from "2x"!
2122
2123 This is useful for Arabic, Hebrew and many other languages where one
2124 may have combining characters overtop of base characters, and want
2125 to remove only the combining ones.
2126
2127 *'dictionary'* *'dict'*
2128'dictionary' 'dict' string (default "")
2129 global or local to buffer |global-local|
2130 {not in Vi}
2131 List of file names, separated by commas, that are used to lookup words
2132 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2133 contain a list of words. This can be one word per line, or several
2134 words per line, separated by non-keyword characters (white space is
2135 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002136 When this option is empty, or an entry "spell" is present, spell
2137 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002138 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002139 after a comma are ignored, otherwise spaces are included in the file
2140 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002141 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002142 Where to find a list of words?
2143 - On FreeBSD, there is the file "/usr/share/dict/words".
2144 - In the Simtel archive, look in the "msdos/linguist" directory.
2145 - In "miscfiles" of the GNU collection.
2146 The use of |:set+=| and |:set-=| is preferred when adding or removing
2147 directories from the list. This avoids problems when a future version
2148 uses another default.
2149 Backticks cannot be used in this option for security reasons.
2150
2151 *'diff'* *'nodiff'*
2152'diff' boolean (default off)
2153 local to window
2154 {not in Vi}
2155 {not available when compiled without the |+diff|
2156 feature}
2157 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002158 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002159
2160 *'dex'* *'diffexpr'*
2161'diffexpr' 'dex' string (default "")
2162 global
2163 {not in Vi}
2164 {not available when compiled without the |+diff|
2165 feature}
2166 Expression which is evaluated to obtain an ed-style diff file from two
2167 versions of a file. See |diff-diffexpr|.
2168 This option cannot be set from a |modeline| or in the |sandbox|, for
2169 security reasons.
2170
2171 *'dip'* *'diffopt'*
2172'diffopt' 'dip' string (default "filler")
2173 global
2174 {not in Vi}
2175 {not available when compiled without the |+diff|
2176 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002177 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002178 All are optional. Items must be separated by a comma.
2179
2180 filler Show filler lines, to keep the text
2181 synchronized with a window that has inserted
2182 lines at the same position. Mostly useful
2183 when windows are side-by-side and 'scrollbind'
2184 is set.
2185
2186 context:{n} Use a context of {n} lines between a change
2187 and a fold that contains unchanged lines.
2188 When omitted a context of six lines is used.
2189 See |fold-diff|.
2190
2191 icase Ignore changes in case of text. "a" and "A"
2192 are considered the same. Adds the "-i" flag
2193 to the "diff" command if 'diffexpr' is empty.
2194
2195 iwhite Ignore changes in amount of white space. Adds
2196 the "-b" flag to the "diff" command if
2197 'diffexpr' is empty. Check the documentation
2198 of the "diff" command for what this does
2199 exactly. It should ignore adding trailing
2200 white space, but not leading white space.
2201
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002202 horizontal Start diff mode with horizontal splits (unless
2203 explicitly specified otherwise).
2204
2205 vertical Start diff mode with vertical splits (unless
2206 explicitly specified otherwise).
2207
2208 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2209 starting diff mode. Without this 2 is used.
2210
Bram Moolenaar071d4272004-06-13 20:20:40 +00002211 Examples: >
2212
2213 :set diffopt=filler,context:4
2214 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002215 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002216<
2217 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2218'digraph' 'dg' boolean (default off)
2219 global
2220 {not in Vi}
2221 {not available when compiled without the |+digraphs|
2222 feature}
2223 Enable the entering of digraphs in Insert mode with {char1} <BS>
2224 {char2}. See |digraphs|.
2225 NOTE: This option is reset when 'compatible' is set.
2226
2227 *'directory'* *'dir'*
2228'directory' 'dir' string (default for Amiga: ".,t:",
2229 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2230 for Unix: ".,~/tmp,/var/tmp,/tmp")
2231 global
2232 List of directory names for the swap file, separated with commas.
2233 - The swap file will be created in the first directory where this is
2234 possible.
2235 - Empty means that no swap file will be used (recovery is
2236 impossible!).
2237 - A directory "." means to put the swap file in the same directory as
2238 the edited file. On Unix, a dot is prepended to the file name, so
2239 it doesn't show in a directory listing. On MS-Windows the "hidden"
2240 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002241 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002242 put the swap file relative to where the edited file is. The leading
2243 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002244 - For Unix and Win32, if a directory ends in two path separators "//"
2245 or "\\", the swap file name will be built from the complete path to
2246 the file with all path separators substituted to percent '%' signs.
2247 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002248 - Spaces after the comma are ignored, other spaces are considered part
2249 of the directory name. To have a space at the start of a directory
2250 name, precede it with a backslash.
2251 - To include a comma in a directory name precede it with a backslash.
2252 - A directory name may end in an ':' or '/'.
2253 - Environment variables are expanded |:set_env|.
2254 - Careful with '\' characters, type one before a space, type two to
2255 get one in the option (see |option-backslash|), for example: >
2256 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2257< - For backwards compatibility with Vim version 3.0 a '>' at the start
2258 of the option is removed.
2259 Using "." first in the list is recommended. This means that editing
2260 the same file twice will result in a warning. Using "/tmp" on Unix is
2261 discouraged: When the system crashes you lose the swap file.
2262 "/var/tmp" is often not cleared when rebooting, thus is a better
2263 choice than "/tmp". But it can contain a lot of files, your swap
2264 files get lost in the crowd. That is why a "tmp" directory in your
2265 home directory is tried first.
2266 The use of |:set+=| and |:set-=| is preferred when adding or removing
2267 directories from the list. This avoids problems when a future version
2268 uses another default.
2269 This option cannot be set from a |modeline| or in the |sandbox|, for
2270 security reasons.
2271 {Vi: directory to put temp file in, defaults to "/tmp"}
2272
2273 *'display'* *'dy'*
2274'display' 'dy' string (default "")
2275 global
2276 {not in Vi}
2277 Change the way text is displayed. This is comma separated list of
2278 flags:
2279 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002280 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002281 last line that doesn't fit is replaced with "@" lines.
2282 uhex Show unprintable characters hexadecimal as <xx>
2283 instead of using ^C and ~C.
2284
2285 *'eadirection'* *'ead'*
2286'eadirection' 'ead' string (default "both")
2287 global
2288 {not in Vi}
2289 {not available when compiled without the +vertsplit
2290 feature}
2291 Tells when the 'equalalways' option applies:
2292 ver vertically, width of windows is not affected
2293 hor horizontally, height of windows is not affected
2294 both width and height of windows is affected
2295
2296 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2297'edcompatible' 'ed' boolean (default off)
2298 global
2299 Makes the 'g' and 'c' flags of the ":substitute" command to be
2300 toggled each time the flag is given. See |complex-change|. See
2301 also 'gdefault' option.
2302 Switching this option on is discouraged!
2303
2304 *'encoding'* *'enc'* *E543*
2305'encoding' 'enc' string (default: "latin1" or value from $LANG)
2306 global
2307 {only available when compiled with the |+multi_byte|
2308 feature}
2309 {not in Vi}
2310 Sets the character encoding used inside Vim. It applies to text in
2311 the buffers, registers, Strings in expressions, text stored in the
2312 viminfo file, etc. It sets the kind of characters which Vim can work
2313 with. See |encoding-names| for the possible values.
2314
2315 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002316 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002317 It should normally be kept at its default value, or set when Vim
2318 starts up. See |multibyte|.
2319
2320 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2321 "utf-8". Although care has been taken to allow different values of
2322 'encoding', "utf-8" is the natural choice for the environment and
2323 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002324 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002325 versions, and to avoid changing the encoding of newly created files
2326 without your knowledge (in case 'fileencodings' is empty).
2327
2328 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002329 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002330 iconv() or as specified with 'charconvert'.
2331
2332 Normally 'encoding' will be equal to your current locale. This will
2333 be the default if Vim recognizes your environment settings. If
2334 'encoding' is not set to the current locale, 'termencoding' must be
2335 set to convert typed and displayed text. See |encoding-table|.
2336
2337 When you set this option, it fires the |EncodingChanged| autocommand
2338 event so that you can set up fonts if necessary.
2339
2340 When the option is set, the value is converted to lowercase. Thus
2341 you can set it with uppercase values too. Underscores are translated
2342 to '-' signs.
2343 When the encoding is recognized, it is changed to the standard name.
2344 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2345 "iso-8859-2" and "utf8" becomes "utf-8".
2346
2347 Note: "latin1" is also used when the encoding could not be detected.
2348 This only works when editing files in the same encoding! When the
2349 actual character set is not latin1, make sure 'fileencoding' and
2350 'fileencodings' are empty. When conversion is needed, switch to using
2351 utf-8.
2352
2353 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2354 You don't notice this while editing, but it does matter for the
2355 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2356 setting 'encoding' to one of these values instead of utf-8 only has
2357 effect for encoding used for files when 'fileencoding' is empty.
2358
Bram Moolenaar661b1822005-07-28 22:36:45 +00002359 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2360 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002361
2362 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2363'endofline' 'eol' boolean (default on)
2364 local to buffer
2365 {not in Vi}
2366 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002367 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002368 option is automatically set when starting to edit a new file, unless
2369 the file does not have an <EOL> for the last line in the file, in
2370 which case it is reset. Normally you don't have to set or reset this
2371 option. When 'binary' is off the value is not used when writing the
2372 file. When 'binary' is on it is used to remember the presence of a
2373 <EOL> for the last line in the file, so that when you write the file
2374 the situation from the original file can be kept. But you can change
2375 it if you want to.
2376
2377 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2378'equalalways' 'ea' boolean (default on)
2379 global
2380 {not in Vi}
2381 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002382 splitting or closing a window. This also happens the moment the
2383 option is switched on. When off, splitting a window will reduce the
2384 size of the current window and leave the other windows the same. When
2385 closing a window the extra lines are given to the window next to it
2386 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002387 When mixing vertically and horizontally split windows, a minimal size
2388 is computed and some windows may be larger if there is room. The
2389 'eadirection' option tells in which direction the size is affected.
2390 Changing the height of a window can be avoided by setting
2391 'winfixheight'.
2392
2393 *'equalprg'* *'ep'*
2394'equalprg' 'ep' string (default "")
2395 global or local to buffer |global-local|
2396 {not in Vi}
2397 External program to use for "=" command. When this option is empty
2398 the internal formatting functions are used ('lisp', 'cindent' or
2399 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002400 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002401 about including spaces and backslashes.
2402 This option cannot be set from a |modeline| or in the |sandbox|, for
2403 security reasons.
2404
2405 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2406'errorbells' 'eb' boolean (default off)
2407 global
2408 Ring the bell (beep or screen flash) for error messages. This only
2409 makes a difference for error messages, the bell will be used always
2410 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002411 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002412 screen flash or do nothing.
2413
2414 *'errorfile'* *'ef'*
2415'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2416 others: "errors.err")
2417 global
2418 {not in Vi}
2419 {not available when compiled without the |+quickfix|
2420 feature}
2421 Name of the errorfile for the QuickFix mode (see |:cf|).
2422 When the "-q" command-line argument is used, 'errorfile' is set to the
2423 following argument. See |-q|.
2424 NOT used for the ":make" command. See 'makeef' for that.
2425 Environment variables are expanded |:set_env|.
2426 See |option-backslash| about including spaces and backslashes.
2427 This option cannot be set from a |modeline| or in the |sandbox|, for
2428 security reasons.
2429
2430 *'errorformat'* *'efm'*
2431'errorformat' 'efm' string (default is very long)
2432 global or local to buffer |global-local|
2433 {not in Vi}
2434 {not available when compiled without the |+quickfix|
2435 feature}
2436 Scanf-like description of the format for the lines in the error file
2437 (see |errorformat|).
2438
2439 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2440'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2441 global
2442 {not in Vi}
2443 Function keys that start with an <Esc> are recognized in Insert
2444 mode. When this option is off, the cursor and function keys cannot be
2445 used in Insert mode if they start with an <Esc>. The advantage of
2446 this is that the single <Esc> is recognized immediately, instead of
2447 after one second. Instead of resetting this option, you might want to
2448 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2449 when 'esckeys' is off, you can still map anything, but the cursor keys
2450 won't work by default.
2451 NOTE: This option is set to the Vi default value when 'compatible' is
2452 set and to the Vim default value when 'compatible' is reset.
2453
2454 *'eventignore'* *'ei'*
2455'eventignore' 'ei' string (default "")
2456 global
2457 {not in Vi}
2458 {not available when compiled without the |+autocmd|
2459 feature}
2460 A list of autocommand event names, which are to be ignored.
2461 When set to "all", all autocommand events are ignored, autocommands
2462 will not be executed.
2463 Otherwise this is a comma separated list of event names. Example: >
2464 :set ei=WinEnter,WinLeave
2465<
2466 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2467'expandtab' 'et' boolean (default off)
2468 local to buffer
2469 {not in Vi}
2470 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002471 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002472 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2473 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2474 NOTE: This option is reset when 'compatible' is set.
2475
2476 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2477'exrc' 'ex' boolean (default off)
2478 global
2479 {not in Vi}
2480 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2481 directory. If you switch this option on you should also consider
2482 setting the 'secure' option (see |initialization|). Using a local
2483 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2484 also see |.vimrc| and |gui-init|.
2485 This option cannot be set from a |modeline| or in the |sandbox|, for
2486 security reasons.
2487
2488 *'fileencoding'* *'fenc'* *E213*
2489'fileencoding' 'fenc' string (default: "")
2490 local to buffer
2491 {only available when compiled with the |+multi_byte|
2492 feature}
2493 {not in Vi}
2494 Sets the character encoding for the file of this buffer.
2495 When 'fileencoding' is different from 'encoding', conversion will be
2496 done when reading and writing the file.
2497 When 'fileencoding' is empty, the same value as 'encoding' will be
2498 used (no conversion when reading or writing a file).
2499 WARNING: Conversion can cause loss of information! When
2500 'encoding' is "utf-8" conversion is most likely done in a way
2501 that the reverse conversion results in the same text. When
2502 'encoding' is not "utf-8" some characters may be lost!
2503 See 'encoding' for the possible values. Additionally, values may be
2504 specified that can be handled by the converter, see
2505 |mbyte-conversion|.
2506 When reading a file 'fileencoding' will be set from 'fileencodings'.
2507 To read a file in a certain encoding it won't work by setting
2508 'fileencoding', use the |++enc| argument.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002509 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002510 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2511 When the option is set, the value is converted to lowercase. Thus
2512 you can set it with uppercase values too. '_' characters are
2513 replaced with '-'. If a name is recognized from the list for
2514 'encoding', it is replaced by the standard name. For example
2515 "ISO8859-2" becomes "iso-8859-2".
2516 When this option is set, after starting to edit a file, the 'modified'
2517 option is set, because the file would be different when written.
2518 If you do this in a modeline, you might want to set 'nomodified' to
2519 avoid this.
2520 This option can not be changed when 'modifiable' is off.
2521
2522 *'fe'*
2523 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002524 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002525 old short name was 'fe', which is no longer used.
2526
2527 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002528'fileencodings' 'fencs' string (default: "ucs-bom",
2529 "ucs-bom,utf-8,default,latin1" when
2530 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002531 global
2532 {only available when compiled with the |+multi_byte|
2533 feature}
2534 {not in Vi}
2535 This is a list of character encodings considered when starting to edit
2536 an existing file. When a file is read, Vim tries to use the first
2537 mentioned character encoding. If an error is detected, the next one
2538 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002539 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002540 an empty string, which means the value of 'encoding' is used.
2541 WARNING: Conversion can cause loss of information! When
2542 'encoding' is "utf-8" (or one of the other Unicode variants)
2543 conversion is most likely done in a way that the reverse
2544 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002545 "utf-8" some non-ASCII characters may be lost! You can use
2546 the |++bad| argument to specify what is done with characters
2547 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002548 For an empty file or a file with only ASCII characters most encodings
2549 will work and the first entry of 'fileencodings' will be used (except
2550 "ucs-bom", which requires the BOM to be present). If you prefer
2551 another encoding use an BufReadPost autocommand event to test if your
2552 preferred encoding is to be used. Example: >
2553 au BufReadPost * if search('\S', 'w') == 0 |
2554 \ set fenc=iso-2022-jp | endif
2555< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2556 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002557 When the |++enc| argument is used then the value of 'fileencodings' is
2558 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002559 Note that 'fileencodings' is not used for a new file, the global value
2560 of 'fileencoding' is used instead. You can set it with: >
2561 :setglobal fenc=iso-8859-2
2562< This means that a non-existing file may get a different encoding than
2563 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002564 The special value "ucs-bom" can be used to check for a Unicode BOM
2565 (Byte Order Mark) at the start of the file. It must not be preceded
2566 by "utf-8" or another Unicode encoding for this to work properly.
2567 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2568 because Vim cannot detect an error, thus the encoding is always
2569 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002570 The special value "default" can be used for the encoding from the
2571 environment. This is the default value for 'encoding'. It is useful
2572 when 'encoding' is set to "utf-8" and your environment uses a
2573 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002574 When 'encoding' is "utf-8" and a file contains an illegal byte
2575 sequence it won't be recognized as UTF-8. You can use the |8g8|
2576 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002577 WRONG VALUES: WHAT'S WRONG:
2578 latin1,utf-8 "latin1" will always be used
2579 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2580 file
2581 cp1250,latin1 "cp1250" will always be used
2582 If 'fileencodings' is empty, 'fileencoding' is not modified.
2583 See 'fileencoding' for the possible values.
2584 Setting this option does not have an effect until the next time a file
2585 is read.
2586
2587 *'fileformat'* *'ff'*
2588'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2589 Unix default: "unix",
2590 Macintosh default: "mac")
2591 local to buffer
2592 {not in Vi}
2593 This gives the <EOL> of the current buffer, which is used for
2594 reading/writing the buffer from/to a file:
2595 dos <CR> <NL>
2596 unix <NL>
2597 mac <CR>
2598 When "dos" is used, CTRL-Z at the end of a file is ignored.
2599 See |file-formats| and |file-read|.
2600 For the character encoding of the file see 'fileencoding'.
2601 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2602 works like it was set to "unix'.
2603 This option is set automatically when starting to edit a file and
2604 'fileformats' is not empty and 'binary' is off.
2605 When this option is set, after starting to edit a file, the 'modified'
2606 option is set, because the file would be different when written.
2607 This option can not be changed when 'modifiable' is off.
2608 For backwards compatibility: When this option is set to "dos",
2609 'textmode' is set, otherwise 'textmode' is reset.
2610
2611 *'fileformats'* *'ffs'*
2612'fileformats' 'ffs' string (default:
2613 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2614 Vim Unix: "unix,dos",
2615 Vim Mac: "mac,unix,dos",
2616 Vi Cygwin: "unix,dos",
2617 Vi others: "")
2618 global
2619 {not in Vi}
2620 This gives the end-of-line (<EOL>) formats that will be tried when
2621 starting to edit a new buffer and when reading a file into an existing
2622 buffer:
2623 - When empty, the format defined with 'fileformat' will be used
2624 always. It is not set automatically.
2625 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002626 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002627 'fileformats' name will be used when a file is read into an existing
2628 buffer, no matter what 'fileformat' for that buffer is set to.
2629 - When more than one name is present, separated by commas, automatic
2630 <EOL> detection will be done when reading a file. When starting to
2631 edit a file, a check is done for the <EOL>:
2632 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2633 'fileformat' is set to "dos".
2634 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002635 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002636 preceding <CR>, "unix" is preferred over "dos".
2637 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2638 This means that "mac" is only chosen when "unix" is not present,
2639 or when no <NL> is found in the file, and when "dos" is not
2640 present, or no <CR><NL> is present in the file.
2641 Also if "unix" was first chosen, but the first <CR> is before
2642 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2643 the file, then 'fileformat' is set to "mac".
2644 4. If 'fileformat' is still not set, the first name from
2645 'fileformats' is used.
2646 When reading a file into an existing buffer, the same is done, but
2647 this happens like 'fileformat' has been set appropriately for that
2648 file only, the option is not changed.
2649 When 'binary' is set, the value of 'fileformats' is not used.
2650
2651 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2652 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2653 done:
2654 - When 'fileformats' is empty, there is no automatic detection. Dos
2655 format will be used.
2656 - When 'fileformats' is set to one or more names, automatic detection
2657 is done. This is based on the first <NL> in the file: If there is a
2658 <CR> in front of it, Dos format is used, otherwise Unix format is
2659 used.
2660 Also see |file-formats|.
2661 For backwards compatibility: When this option is set to an empty
2662 string or one format (no comma is included), 'textauto' is reset,
2663 otherwise 'textauto' is set.
2664 NOTE: This option is set to the Vi default value when 'compatible' is
2665 set and to the Vim default value when 'compatible' is reset.
2666
2667 *'filetype'* *'ft'*
2668'filetype' 'ft' string (default: "")
2669 local to buffer
2670 {not in Vi}
2671 {not available when compiled without the |+autocmd|
2672 feature}
2673 When this option is set, the FileType autocommand event is triggered.
2674 All autocommands that match with the value of this option will be
2675 executed. Thus the value of 'filetype' is used in place of the file
2676 name.
2677 Otherwise this option does not always reflect the current file type.
2678 This option is normally set when the file type is detected. To enable
2679 this use the ":filetype on" command. |:filetype|
2680 Setting this option to a different value is most useful in a modeline,
2681 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002682 Example, for in an IDL file:
2683 /* vim: set filetype=idl : */ ~
2684 |FileType| |filetypes|
2685 When a dot appears in the value then this separates two filetype
2686 names. Example:
2687 /* vim: set filetype=c.doxygen : */ ~
2688 This will use the "c" filetype first, then the "doxygen" filetype.
2689 This works both for filetype plugins and for syntax files. More than
2690 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002691 Do not confuse this option with 'osfiletype', which is for the file
2692 type that is actually stored with the file.
2693 This option is not copied to another buffer, independent of the 's' or
2694 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002695 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002696
2697 *'fillchars'* *'fcs'*
2698'fillchars' 'fcs' string (default "vert:|,fold:-")
2699 global
2700 {not in Vi}
2701 {not available when compiled without the |+windows|
2702 and |+folding| features}
2703 Characters to fill the statuslines and vertical separators.
2704 It is a comma separated list of items:
2705
2706 item default Used for ~
2707 stl:c ' ' or '^' statusline of the current window
2708 stlnc:c ' ' or '-' statusline of the non-current windows
2709 vert:c '|' vertical separators |:vsplit|
2710 fold:c '-' filling 'foldtext'
2711 diff:c '-' deleted lines of the 'diff' option
2712
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002713 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002714 "stlnc" the space will be used when there is highlighting, '^' or '-'
2715 otherwise.
2716
2717 Example: >
2718 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2719< This is similar to the default, except that these characters will also
2720 be used when there is highlighting.
2721
2722 The highlighting used for these items:
2723 item highlight group ~
2724 stl:c StatusLine |hl-StatusLine|
2725 stlnc:c StatusLineNC |hl-StatusLineNC|
2726 vert:c VertSplit |hl-VertSplit|
2727 fold:c Folded |hl-Folded|
2728 diff:c DiffDelete |hl-DiffDelete|
2729
2730 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2731'fkmap' 'fk' boolean (default off) *E198*
2732 global
2733 {not in Vi}
2734 {only available when compiled with the |+rightleft|
2735 feature}
2736 When on, the keyboard is mapped for the Farsi character set.
2737 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002738 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002739
2740 *'foldclose'* *'fcl'*
2741'foldclose' 'fcl' string (default "")
2742 global
2743 {not in Vi}
2744 {not available when compiled without the |+folding|
2745 feature}
2746 When set to "all", a fold is closed when the cursor isn't in it and
2747 its level is higher than 'foldlevel'. Useful if you want folds to
2748 automatically close when moving out of them.
2749
2750 *'foldcolumn'* *'fdc'*
2751'foldcolumn' 'fdc' number (default 0)
2752 local to window
2753 {not in Vi}
2754 {not available when compiled without the |+folding|
2755 feature}
2756 When non-zero, a column with the specified width is shown at the side
2757 of the window which indicates open and closed folds. The maximum
2758 value is 12.
2759 See |folding|.
2760
2761 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2762'foldenable' 'fen' boolean (default on)
2763 local to window
2764 {not in Vi}
2765 {not available when compiled without the |+folding|
2766 feature}
2767 When off, all folds are open. This option can be used to quickly
2768 switch between showing all text unfolded and viewing the text with
2769 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002770 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002771 'foldenable' is off.
2772 This option is set by commands that create a new fold or close a fold.
2773 See |folding|.
2774
2775 *'foldexpr'* *'fde'*
2776'foldexpr' 'fde' string (default: "0")
2777 local to window
2778 {not in Vi}
2779 {not available when compiled without the |+folding|
2780 or |+eval| feature}
2781 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002782 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002783
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002784 The expression may be evaluated in the |sandbox|, see
2785 |sandbox-option|.
2786
2787 It is not allowed to change text or jump to another window while
2788 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789
2790 *'foldignore'* *'fdi'*
2791'foldignore' 'fdi' string (default: "#")
2792 local to window
2793 {not in Vi}
2794 {not available when compiled without the |+folding|
2795 feature}
2796 Used only when 'foldmethod' is "indent". Lines starting with
2797 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002798 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002799 The default "#" works well for C programs. See |fold-indent|.
2800
2801 *'foldlevel'* *'fdl'*
2802'foldlevel' 'fdl' number (default: 0)
2803 local to window
2804 {not in Vi}
2805 {not available when compiled without the |+folding|
2806 feature}
2807 Sets the fold level: Folds with a higher level will be closed.
2808 Setting this option to zero will close all folds. Higher numbers will
2809 close fewer folds.
2810 This option is set by commands like |zm|, |zM| and |zR|.
2811 See |fold-foldlevel|.
2812
2813 *'foldlevelstart'* *'fdls'*
2814'foldlevelstart' 'fdls' number (default: -1)
2815 global
2816 {not in Vi}
2817 {not available when compiled without the |+folding|
2818 feature}
2819 Sets 'foldlevel' when starting to edit another buffer in a window.
2820 Useful to always start editing with all folds closed (value zero),
2821 some folds closed (one) or no folds closed (99).
2822 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002823 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002824 ignores this option and closes all folds.
2825 It is also done before BufReadPre autocommands, to allow an autocmd to
2826 overrule the 'foldlevel' value for specific files.
2827 When the value is negative, it is not used.
2828
2829 *'foldmarker'* *'fmr'* *E536*
2830'foldmarker' 'fmr' string (default: "{{{,}}}")
2831 local to window
2832 {not in Vi}
2833 {not available when compiled without the |+folding|
2834 feature}
2835 The start and end marker used when 'foldmethod' is "marker". There
2836 must be one comma, which separates the start and end marker. The
2837 marker is a literal string (a regular expression would be too slow).
2838 See |fold-marker|.
2839
2840 *'foldmethod'* *'fdm'*
2841'foldmethod' 'fdm' string (default: "manual")
2842 local to window
2843 {not in Vi}
2844 {not available when compiled without the |+folding|
2845 feature}
2846 The kind of folding used for the current window. Possible values:
2847 |fold-manual| manual Folds are created manually.
2848 |fold-indent| indent Lines with equal indent form a fold.
2849 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2850 |fold-marker| marker Markers are used to specify folds.
2851 |fold-syntax| syntax Syntax highlighting items specify folds.
2852 |fold-diff| diff Fold text that is not changed.
2853
2854 *'foldminlines'* *'fml'*
2855'foldminlines' 'fml' number (default: 1)
2856 local to window
2857 {not in Vi}
2858 {not available when compiled without the |+folding|
2859 feature}
2860 Sets the minimum number of screen lines for a fold to be displayed
2861 closed. Also for manually closed folds.
2862 Note that this only has an effect of what is displayed. After using
2863 "zc" to close a fold, which is displayed open because it's smaller
2864 than 'foldminlines', a following "zc" may close a containing fold.
2865
2866 *'foldnestmax'* *'fdn'*
2867'foldnestmax' 'fdn' number (default: 20)
2868 local to window
2869 {not in Vi}
2870 {not available when compiled without the |+folding|
2871 feature}
2872 Sets the maximum nesting of folds for the "indent" and "syntax"
2873 methods. This avoids that too many folds will be created. Using more
2874 than 20 doesn't work, because the internal limit is 20.
2875
2876 *'foldopen'* *'fdo'*
2877'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2878 search,tag,undo")
2879 global
2880 {not in Vi}
2881 {not available when compiled without the |+folding|
2882 feature}
2883 Specifies for which type of commands folds will be opened, if the
2884 command moves the cursor into a closed fold. It is a comma separated
2885 list of items.
2886 item commands ~
2887 all any
2888 block "(", "{", "[[", "[{", etc.
2889 hor horizontal movements: "l", "w", "fx", etc.
2890 insert any command in Insert mode
2891 jump far jumps: "G", "gg", etc.
2892 mark jumping to a mark: "'m", CTRL-O, etc.
2893 percent "%"
2894 quickfix ":cn", ":crew", ":make", etc.
2895 search search for a pattern: "/", "n", "*", "gd", etc.
2896 (not for a search pattern in a ":" command)
2897 tag jumping to a tag: ":ta", CTRL-T, etc.
2898 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002899 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002900 the |zv| command to the mapping to get the same effect.
2901 When a movement command is used for an operator (e.g., "dl" or "y%")
2902 this option is not used. This means the operator will include the
2903 whole closed fold.
2904 Note that vertical movements are not here, because it would make it
2905 very difficult to move onto a closed fold.
2906 In insert mode the folds containing the cursor will always be open
2907 when text is inserted.
2908 To close folds you can re-apply 'foldlevel' with the |zx| command or
2909 set the 'foldclose' option to "all".
2910
2911 *'foldtext'* *'fdt'*
2912'foldtext' 'fdt' string (default: "foldtext()")
2913 local to window
2914 {not in Vi}
2915 {not available when compiled without the |+folding|
2916 feature}
2917 An expression which is used to specify the text displayed for a closed
2918 fold. See |fold-foldtext|.
2919
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002920 The expression may be evaluated in the |sandbox|, see
2921 |sandbox-option|.
2922
2923 It is not allowed to change text or jump to another window while
2924 evaluating 'foldtext' |textlock|.
2925
Bram Moolenaar071d4272004-06-13 20:20:40 +00002926 *'formatoptions'* *'fo'*
2927'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2928 local to buffer
2929 {not in Vi}
2930 This is a sequence of letters which describes how automatic
2931 formatting is to be done. See |fo-table|. When the 'paste' option is
2932 on, no formatting is done (like 'formatoptions' is empty). Commas can
2933 be inserted for readability.
2934 To avoid problems with flags that are added in the future, use the
2935 "+=" and "-=" feature of ":set" |add-option-flags|.
2936 NOTE: This option is set to the Vi default value when 'compatible' is
2937 set and to the Vim default value when 'compatible' is reset.
2938
Bram Moolenaar86b68352004-12-27 21:59:20 +00002939 *'formatlistpat'* *'flp'*
2940'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
2941 local to buffer
2942 {not in Vi}
2943 A pattern that is used to recognize a list header. This is used for
2944 the "n" flag in 'formatoptions'.
2945 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00002946 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00002947 while still checking more characters. There must be a character
2948 following the pattern, when it matches the whole line it is handled
2949 like there is no match.
2950 The default recognizes a number, followed by an optional punctuation
2951 character and white space.
2952
Bram Moolenaar071d4272004-06-13 20:20:40 +00002953 *'formatprg'* *'fp'*
2954'formatprg' 'fp' string (default "")
2955 global
2956 {not in Vi}
2957 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002958 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00002959 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00002960 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002961 If the 'formatexpr' option is not empty it will be used instead.
2962 Otherwise, if 'formatprg' option is an empty string, the internal
2963 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00002964 Environment variables are expanded |:set_env|. See |option-backslash|
2965 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002966 The expression may be evaluated in the |sandbox|, see
2967 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002968
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002969 *'formatexpr'* *'fex'*
2970'formatexpr' 'fex' string (default "")
2971 local to buffer
2972 {not in Vi}
2973 {not available when compiled without the |+eval|
2974 feature}
2975 Expression which is evaluated to format a range of lines for the |gq|
2976 operator. The |v:lnum| variable holds the first line to be formatted,
2977 |v:count| the number of lines to be formatted.
2978 When this option is empty 'formatprg' is used.
2979 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00002980 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002981< This will invoke the mylang#Format() function in the
2982 autoload/mylang.vim file in 'runtimepath'. |autoload|
2983
2984 The expression is also evaluated when 'textwidth' is set and adding
2985 text beyond that limit. This happens under the same conditions as
2986 when internal formatting is used. Make sure the cursor is kept in the
2987 same spot relative to the text then! The |mode()| function will
2988 return "i" or "R" in this situation. When the function returns
2989 non-zero Vim will fall back to using the internal format mechanism.
2990
2991 The expression may be evaluated in the |sandbox|, see
2992 |sandbox-option|.
2993
2994 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002995'fsync' 'fs' boolean (default on)
2996 global
2997 {not in Vi}
2998 When on, the library function fsync() will be called after writing a
2999 file. This will flush a file to disk, ensuring that it is safely
3000 written even on filesystems which do metadata-only journaling. This
3001 will force the harddrive to spin up on Linux systems running in laptop
3002 mode, so it may be undesirable in some situations. Be warned that
3003 turning this off increases the chances of data loss after a crash. On
3004 systems without an fsync() implementation, this variable is always
3005 off.
3006 Also see 'swapsync' for controlling fsync() on swap files.
3007
Bram Moolenaar071d4272004-06-13 20:20:40 +00003008 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3009'gdefault' 'gd' boolean (default off)
3010 global
3011 {not in Vi}
3012 When on, the ":substitute" flag 'g' is default on. This means that
3013 all matches in a line are substituted instead of one. When a 'g' flag
3014 is given to a ":substitute" command, this will toggle the substitution
3015 of all or one match. See |complex-change|.
3016
3017 command 'gdefault' on 'gdefault' off ~
3018 :s/// subst. all subst. one
3019 :s///g subst. one subst. all
3020 :s///gg subst. all subst. one
3021
3022 NOTE: This option is reset when 'compatible' is set.
3023
3024 *'grepformat'* *'gfm'*
3025'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3026 global
3027 {not in Vi}
3028 Format to recognize for the ":grep" command output.
3029 This is a scanf-like string that uses the same format as the
3030 'errorformat' option: see |errorformat|.
3031
3032 *'grepprg'* *'gp'*
3033'grepprg' 'gp' string (default "grep -n ",
3034 Unix: "grep -n $* /dev/null",
3035 Win32: "findstr /n" or "grep -n",
3036 VMS: "SEARCH/NUMBERS ")
3037 global or local to buffer |global-local|
3038 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003039 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003040 and '#' characters, which are expanded like when used in a command-
3041 line. The placeholder "$*" is allowed to specify where the arguments
3042 will be included. Environment variables are expanded |:set_env|. See
3043 |option-backslash| about including spaces and backslashes.
3044 When your "grep" accepts the "-H" argument, use this to make ":grep"
3045 also work well with a single file: >
3046 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003047< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003048 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3049 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003050 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003051 apply equally to 'grepprg'.
3052 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3053 otherwise it's "grep -n".
3054 This option cannot be set from a |modeline| or in the |sandbox|, for
3055 security reasons.
3056
3057 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3058'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3059 ve:ver35-Cursor,
3060 o:hor50-Cursor,
3061 i-ci:ver25-Cursor/lCursor,
3062 r-cr:hor20-Cursor/lCursor,
3063 sm:block-Cursor
3064 -blinkwait175-blinkoff150-blinkon175",
3065 for MS-DOS and Win32 console:
3066 "n-v-c:block,o:hor50,i-ci:hor15,
3067 r-cr:hor30,sm:block")
3068 global
3069 {not in Vi}
3070 {only available when compiled with GUI enabled, and
3071 for MS-DOS and Win32 console}
3072 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003073 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003074 the height of the cursor can be changed. This can be done by
3075 specifying a block cursor, or a percentage for a vertical or
3076 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003077 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003078
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003079 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003080 mode-list and an argument-list:
3081 mode-list:argument-list,mode-list:argument-list,..
3082 The mode-list is a dash separated list of these modes:
3083 n Normal mode
3084 v Visual mode
3085 ve Visual mode with 'selection' "exclusive" (same as 'v',
3086 if not specified)
3087 o Operator-pending mode
3088 i Insert mode
3089 r Replace mode
3090 c Command-line Normal (append) mode
3091 ci Command-line Insert mode
3092 cr Command-line Replace mode
3093 sm showmatch in Insert mode
3094 a all modes
3095 The argument-list is a dash separated list of these arguments:
3096 hor{N} horizontal bar, {N} percent of the character height
3097 ver{N} vertical bar, {N} percent of the character width
3098 block block cursor, fills the whole character
3099 [only one of the above three should be present]
3100 blinkwait{N} *cursor-blinking*
3101 blinkon{N}
3102 blinkoff{N}
3103 blink times for cursor: blinkwait is the delay before
3104 the cursor starts blinking, blinkon is the time that
3105 the cursor is shown and blinkoff is the time that the
3106 cursor is not shown. The times are in msec. When one
3107 of the numbers is zero, there is no blinking. The
3108 default is: "blinkwait700-blinkon400-blinkoff250".
3109 These numbers are used for a missing entry. This
3110 means that blinking is enabled by default. To switch
3111 blinking off you can use "blinkon0". The cursor only
3112 blinks when Vim is waiting for input, not while
3113 executing a command.
3114 To make the cursor blink in an xterm, see
3115 |xterm-blink|.
3116 {group-name}
3117 a highlight group name, that sets the color and font
3118 for the cursor
3119 {group-name}/{group-name}
3120 Two highlight group names, the first is used when
3121 no language mappings are used, the other when they
3122 are. |language-mapping|
3123
3124 Examples of parts:
3125 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3126 block cursor with colors from the "nCursor"
3127 highlight group
3128 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3129 In Insert and Command-line Insert mode, use a
3130 30% vertical bar cursor with colors from the
3131 "iCursor" highlight group. Blink a bit
3132 faster.
3133
3134 The 'a' mode is different. It will set the given argument-list for
3135 all modes. It does not reset anything to defaults. This can be used
3136 to do a common setting for all modes. For example, to switch off
3137 blinking: "a:blinkon0"
3138
3139 Examples of cursor highlighting: >
3140 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3141 :highlight Cursor gui=NONE guifg=bg guibg=fg
3142<
3143 *'guifont'* *'gfn'*
3144 *E235* *E596* *E610* *E611*
3145'guifont' 'gfn' string (default "")
3146 global
3147 {not in Vi}
3148 {only available when compiled with GUI enabled}
3149 This is a list of fonts which will be used for the GUI version of Vim.
3150 In its simplest form the value is just one font name. When
3151 the font cannot be found you will get an error message. To try other
3152 font names a list can be specified, font names separated with commas.
3153 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003154
Bram Moolenaar05159a02005-02-26 23:04:13 +00003155 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3156 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003157
Bram Moolenaar071d4272004-06-13 20:20:40 +00003158 Spaces after a comma are ignored. To include a comma in a font name
3159 precede it with a backslash. Setting an option requires an extra
3160 backslash before a space and a backslash. See also
3161 |option-backslash|. For example: >
3162 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003163< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003165
3166 If none of the fonts can be loaded, Vim will keep the current setting.
3167 If an empty font list is given, Vim will try using other resource
3168 settings (for X, it will use the Vim.font resource), and finally it
3169 will try some builtin default which should always be there ("7x13" in
3170 the case of X). The font names given should be "normal" fonts. Vim
3171 will try to find the related bold and italic fonts.
3172
Bram Moolenaar05159a02005-02-26 23:04:13 +00003173 For Win32, GTK, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003174 :set guifont=*
3175< will bring up a font requester, where you can pick the font you want.
3176
3177 The font name depends on the GUI used. See |setting-guifont| for a
3178 way to set 'guifont' for various systems.
3179
Bram Moolenaar071d4272004-06-13 20:20:40 +00003180 For the GTK+ 2 GUI the font name looks like this: >
3181 :set guifont=Andale\ Mono\ 11
3182< That's all. XLFDs are no longer accepted.
Bram Moolenaar05159a02005-02-26 23:04:13 +00003183
3184 For Mac OSX you can use something like this: >
3185 :set guifont=Monaco:h10
3186< *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003187 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003188 width). An exception is GTK 2: all fonts are accepted, but
3189 mono-spaced fonts look best.
3190
Bram Moolenaar071d4272004-06-13 20:20:40 +00003191 To preview a font on X11, you might be able to use the "xfontsel"
3192 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003193
Bram Moolenaar071d4272004-06-13 20:20:40 +00003194 For the Win32 GUI *E244* *E245*
3195 - takes these options in the font name:
3196 hXX - height is XX (points, can be floating-point)
3197 wXX - width is XX (points, can be floating-point)
3198 b - bold
3199 i - italic
3200 u - underline
3201 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003202 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003203 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3204 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3205 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003206 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003207
3208 Use a ':' to separate the options.
3209 - A '_' can be used in the place of a space, so you don't need to use
3210 backslashes to escape the spaces.
3211 - Examples: >
3212 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3213 :set guifont=Andale_Mono:h7.5:w4.5
3214< See also |font-sizes|.
3215
3216 *'guifontset'* *'gfs'*
3217 *E250* *E252* *E234* *E597* *E598*
3218'guifontset' 'gfs' string (default "")
3219 global
3220 {not in Vi}
3221 {only available when compiled with GUI enabled and
3222 with the |+xfontset| feature}
3223 {not available in the GTK+ 2 GUI}
3224 When not empty, specifies two (or more) fonts to be used. The first
3225 one for normal English, the second one for your special language. See
3226 |xfontset|.
3227 Setting this option also means that all font names will be handled as
3228 a fontset name. Also the ones used for the "font" argument of the
3229 |:highlight| command.
3230 The fonts must match with the current locale. If fonts for the
3231 character sets that the current locale uses are not included, setting
3232 'guifontset' will fail.
3233 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3234 the comma-separated names are alternative names, one of which will be
3235 used. In 'guifontset' the whole string is one fontset name,
3236 including the commas. It is not possible to specify alternative
3237 fontset names.
3238 This example works on many X11 systems: >
3239 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3240<
3241 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3242'guifontwide' 'gfw' string (default "")
3243 global
3244 {not in Vi}
3245 {only available when compiled with GUI enabled}
3246 When not empty, specifies a comma-separated list of fonts to be used
3247 for double-width characters. The first font that can be loaded is
3248 used.
3249 Note: The size of these fonts must be exactly twice as wide as the one
3250 specified with 'guifont' and the same height.
3251
3252 All GUI versions but GTK+ 2:
3253
3254 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3255 'guifontset' is empty or invalid.
3256 When 'guifont' is set and a valid font is found in it and
3257 'guifontwide' is empty Vim will attempt to find a matching
3258 double-width font and set 'guifontwide' to it.
3259
3260 GTK+ 2 GUI only: *guifontwide_gtk2*
3261
3262 If set and valid, 'guifontwide' is always used for double width
3263 characters, even if 'encoding' is not set to "utf-8".
3264 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003265 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003266 font for characters not available in 'guifont'. Thus you do not need
3267 to set 'guifontwide' at all unless you want to override the choice
3268 made by Pango/Xft.
3269
3270 *'guiheadroom'* *'ghr'*
3271'guiheadroom' 'ghr' number (default 50)
3272 global
3273 {not in Vi} {only for GTK and X11 GUI}
3274 The number of pixels subtracted from the screen height when fitting
3275 the GUI window on the screen. Set this before the GUI is started,
3276 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003277 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003278 lines will be left for window decorations and other items on the
3279 screen. Set it to a negative value to allow windows taller than the
3280 screen.
3281
3282 *'guioptions'* *'go'*
3283'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003284 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003285 global
3286 {not in Vi}
3287 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003288 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003289 sequence of letters which describes what components and options of the
3290 GUI should be used.
3291 To avoid problems with flags that are added in the future, use the
3292 "+=" and "-=" feature of ":set" |add-option-flags|.
3293
3294 Valid letters are as follows:
3295 *guioptions_a*
3296 'a' Autoselect: If present, then whenever VISUAL mode is started,
3297 or the Visual area extended, Vim tries to become the owner of
3298 the windowing system's global selection. This means that the
3299 Visually highlighted text is available for pasting into other
3300 applications as well as into Vim itself. When the Visual mode
3301 ends, possibly due to an operation on the text, or when an
3302 application wants to paste the selection, the highlighted text
3303 is automatically yanked into the "* selection register.
3304 Thus the selection is still available for pasting into other
3305 applications after the VISUAL mode has ended.
3306 If not present, then Vim won't become the owner of the
3307 windowing system's global selection unless explicitly told to
3308 by a yank or delete operation for the "* register.
3309 The same applies to the modeless selection.
3310
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003311 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003312 applies to the modeless selection.
3313
3314 'guioptions' autoselect Visual autoselect modeless ~
3315 "" - -
3316 "a" yes yes
3317 "A" - yes
3318 "aA" yes yes
3319
3320 'c' Use console dialogs instead of popup dialogs for simple
3321 choices.
3322
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003323 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003324 'guitablabel' can be used to change the text in the labels.
3325 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00003326 The GUI tabs are only supported on some systens, currently
3327 only for GTK.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003328
Bram Moolenaar071d4272004-06-13 20:20:40 +00003329 'f' Foreground: Don't use fork() to detach the GUI from the shell
3330 where it was started. Use this for programs that wait for the
3331 editor to finish (e.g., an e-mail program). Alternatively you
3332 can use "gvim -f" or ":gui -f" to start the GUI in the
3333 foreground. |gui-fork|
3334 Note: Set this option in the vimrc file. The forking may have
3335 happened already when the gvimrc file is read.
3336
3337 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3338 corner of the window. It's black&white on non-GTK, because of
3339 limitations of X11. For a color icon, see |X11-icon|.
3340
3341 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003342 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003343 that this flag must be added in the .vimrc file, before
3344 switching on syntax or filetype recognition (when the .gvimrc
3345 file is sourced the system menu has already been loaded; the
3346 ":syntax on" and ":filetype on" commands load the menu too).
3347 'g' Grey menu items: Make menu items that are not active grey. If
3348 'g' is not included inactive menu items are not shown at all.
3349 Exception: Athena will always use grey menu items.
3350
3351 't' Include tearoff menu items. Currently only works for Win32,
3352 GTK+, and Motif 1.2 GUI.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003353 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
3354 and Athena GUIs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003355
3356 'r' Right-hand scrollbar is always present.
3357 'R' Right-hand scrollbar is present when there is a vertically
3358 split window.
3359 'l' Left-hand scrollbar is always present.
3360 'L' Left-hand scrollbar is present when there is a vertically
3361 split window.
3362 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3363 the longest visible line, or on the cursor line if the 'h'
3364 flag is included. |gui-horiz-scroll|
3365 'h' Limit horizontal scrollbar size to the length of the cursor
3366 line. Reduces computations. |gui-horiz-scroll|
3367
3368 And yes, you may even have scrollbars on the left AND the right if
3369 you really want to :-). See |gui-scrollbars| for more information.
3370
3371 'v' Use a vertical button layout for dialogs. When not included,
3372 a horizontal layout is preferred, but when it doesn't fit a
3373 vertical layout is used anyway.
3374 'p' Use Pointer callbacks for X11 GUI. This is required for some
3375 window managers. If the cursor is not blinking or hollow at
3376 the right moment, try adding this flag. This must be done
3377 before starting the GUI. Set it in your gvimrc. Adding or
3378 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003379 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003380
3381 *'guipty'* *'noguipty'*
3382'guipty' boolean (default on)
3383 global
3384 {not in Vi}
3385 {only available when compiled with GUI enabled}
3386 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3387 I/O to/from shell commands. See |gui-pty|.
3388
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003389 *'guitablabel'* *'gtl'*
3390'guitablabel' 'gtl' string (default empty)
3391 global
3392 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003393 {only available when compiled with GUI enabled and
3394 with the +windows feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003395 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003396 pages line. When empty Vim will use a default label. See
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003397 |setting-guitablabel| for more info.
3398
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003399 The format of this option is like that of 'statusline'.
3400
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003401 Only used when the GUI tab pages line is displayed. 'e' must be
3402 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3403 used.
3404
Bram Moolenaar071d4272004-06-13 20:20:40 +00003405 *'helpfile'* *'hf'*
3406'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3407 (others) "$VIMRUNTIME/doc/help.txt")
3408 global
3409 {not in Vi}
3410 Name of the main help file. All distributed help files should be
3411 placed together in one directory. Additionally, all "doc" directories
3412 in 'runtimepath' will be used.
3413 Environment variables are expanded |:set_env|. For example:
3414 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003415 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003416 spaces and backslashes.
3417 This option cannot be set from a |modeline| or in the |sandbox|, for
3418 security reasons.
3419
3420 *'helpheight'* *'hh'*
3421'helpheight' 'hh' number (default 20)
3422 global
3423 {not in Vi}
3424 {not available when compiled without the +windows
3425 feature}
3426 Minimal initial height of the help window when it is opened with the
3427 ":help" command. The initial height of the help window is half of the
3428 current window, or (when the 'ea' option is on) the same as other
3429 windows. When the height is less than 'helpheight', the height is
3430 set to 'helpheight'. Set to zero to disable.
3431
3432 *'helplang'* *'hlg'*
3433'helplang' 'hlg' string (default: messages language or empty)
3434 global
3435 {only available when compiled with the |+multi_lang|
3436 feature}
3437 {not in Vi}
3438 Comma separated list of languages. Vim will use the first language
3439 for which the desired help can be found. The English help will always
3440 be used as a last resort. You can add "en" to prefer English over
3441 another language, but that will only find tags that exist in that
3442 language and not in the English help.
3443 Example: >
3444 :set helplang=de,it
3445< This will first search German, then Italian and finally English help
3446 files.
3447 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3448 try to find the tag in the current language before using this option.
3449 See |help-translated|.
3450
3451 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3452'hidden' 'hid' boolean (default off)
3453 global
3454 {not in Vi}
3455 When off a buffer is unloaded when it is |abandon|ed. When on a
3456 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3457 displayed in another window, it does not become hidden, of course.
3458 The commands that move through the buffer list sometimes make a buffer
3459 hidden although the 'hidden' option is off: When the buffer is
3460 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003461 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003462 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003463 This option is set for one command with ":hide {command}" |:hide|.
3464 WARNING: It's easy to forget that you have changes in hidden buffers.
3465 Think twice when using ":q!" or ":qa!".
3466
3467 *'highlight'* *'hl'*
3468'highlight' 'hl' string (default (as a single string):
3469 "8:SpecialKey,@:NonText,d:Directory,
3470 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3471 M:ModeMsg,n:LineNr,r:Question,
3472 s:StatusLine,S:StatusLineNC,c:VertSplit
3473 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3474 f:Folded,F:FoldColumn,A:DiffAdd,
3475 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003476 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003477 R:SpellRare,L:SpellLocal,
3478 +:Pmenu,=:PmenuSel,
3479 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003480 global
3481 {not in Vi}
3482 This option can be used to set highlighting mode for various
3483 occasions. It is a comma separated list of character pairs. The
3484 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003485 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003486 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3487 |hl-NonText| @ '~' and '@' at the end of the window and
3488 characters from 'showbreak'
3489 |hl-Directory| d directories in CTRL-D listing and other special
3490 things in listings
3491 |hl-ErrorMsg| e error messages
3492 h (obsolete, ignored)
3493 |hl-IncSearch| i 'incsearch' highlighting
3494 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3495 |hl-MoreMsg| m |more-prompt|
3496 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3497 |hl-LineNr| n line number for ":number" and ":#" commands
3498 |hl-Question| r |hit-enter| prompt and yes/no questions
3499 |hl-StatusLine| s status line of current window |status-line|
3500 |hl-StatusLineNC| S status lines of not-current windows
3501 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3502 |hl-VertSplit| c column used to separate vertically split windows
3503 |hl-Visual| v Visual mode
3504 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3505 Selection" Only X11 Gui's |gui-x11| and
3506 |xterm-clipboard|.
3507 |hl-WarningMsg| w warning messages
3508 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3509 |hl-Folded| f line used for closed folds
3510 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003511 |hl-DiffAdd| A added line in diff mode
3512 |hl-DiffChange| C changed line in diff mode
3513 |hl-DiffDelete| D deleted line in diff mode
3514 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003516 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003517 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003518 |hl-SpellRare| R rare word |spell|
3519 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003520 |hl-Pmenu| + popup menu normal line
3521 |hl-PmenuSel| = popup menu normal line
3522 |hl-PmenuSbar| x popup menu scrollbar
3523 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003524
3525 The display modes are:
3526 r reverse (termcap entry "mr" and "me")
3527 i italic (termcap entry "ZH" and "ZR")
3528 b bold (termcap entry "md" and "me")
3529 s standout (termcap entry "so" and "se")
3530 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003531 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003532 n no highlighting
3533 - no highlighting
3534 : use a highlight group
3535 The default is used for occasions that are not included.
3536 If you want to change what the display modes do, see |dos-colors|
3537 for an example.
3538 When using the ':' display mode, this must be followed by the name of
3539 a highlight group. A highlight group can be used to define any type
3540 of highlighting, including using color. See |:highlight| on how to
3541 define one. The default uses a different group for each occasion.
3542 See |highlight-default| for the default highlight groups.
3543
3544 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3545'hlsearch' 'hls' boolean (default off)
3546 global
3547 {not in Vi}
3548 {not available when compiled without the
3549 |+extra_search| feature}
3550 When there is a previous search pattern, highlight all its matches.
3551 The type of highlighting used can be set with the 'l' occasion in the
3552 'highlight' option. This uses the "Search" highlight group by
3553 default. Note that only the matching text is highlighted, any offsets
3554 are not applied.
3555 See also: 'incsearch' and |:match|.
3556 When you get bored looking at the highlighted matches, you can turn it
3557 off with |:nohlsearch|. As soon as you use a search command, the
3558 highlighting comes back.
3559 When the search pattern can match an end-of-line, Vim will try to
3560 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003561 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003562 line below a closed fold. A match in a previous line which is not
3563 drawn may not continue in an newly drawn line.
3564 NOTE: This option is reset when 'compatible' is set.
3565
3566 *'history'* *'hi'*
3567'history' 'hi' number (Vim default: 20, Vi default: 0)
3568 global
3569 {not in Vi}
3570 A history of ":" commands, and a history of previous search patterns
3571 are remembered. This option decides how many entries may be stored in
3572 each of these histories (see |cmdline-editing|).
3573 NOTE: This option is set to the Vi default value when 'compatible' is
3574 set and to the Vim default value when 'compatible' is reset.
3575
3576 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3577'hkmap' 'hk' boolean (default off)
3578 global
3579 {not in Vi}
3580 {only available when compiled with the |+rightleft|
3581 feature}
3582 When on, the keyboard is mapped for the Hebrew character set.
3583 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3584 toggle this option. See |rileft.txt|.
3585 NOTE: This option is reset when 'compatible' is set.
3586
3587 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3588'hkmapp' 'hkp' boolean (default off)
3589 global
3590 {not in Vi}
3591 {only available when compiled with the |+rightleft|
3592 feature}
3593 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3594 This is useful if you have a non-Hebrew keyboard.
3595 See |rileft.txt|.
3596 NOTE: This option is reset when 'compatible' is set.
3597
3598 *'icon'* *'noicon'*
3599'icon' boolean (default off, on when title can be restored)
3600 global
3601 {not in Vi}
3602 {not available when compiled without the |+title|
3603 feature}
3604 When on, the icon text of the window will be set to the value of
3605 'iconstring' (if it is not empty), or to the name of the file
3606 currently being edited. Only the last part of the name is used.
3607 Overridden by the 'iconstring' option.
3608 Only works if the terminal supports setting window icons (currently
3609 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3610 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3611 builtin termcap).
3612 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003613 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003614 X11.
3615
3616 *'iconstring'*
3617'iconstring' string (default "")
3618 global
3619 {not in Vi}
3620 {not available when compiled without the |+title|
3621 feature}
3622 When this option is not empty, it will be used for the icon text of
3623 the window. This happens only when the 'icon' option is on.
3624 Only works if the terminal supports setting window icon text
3625 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3626 Does not work for MS Windows.
3627 When Vim was compiled with HAVE_X11 defined, the original icon will be
3628 restored if possible |X11|.
3629 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003630 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003631 'titlestring' for example settings.
3632 {not available when compiled without the |+statusline| feature}
3633
3634 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3635'ignorecase' 'ic' boolean (default off)
3636 global
3637 Ignore case in search patterns. Also used when searching in the tags
3638 file.
3639 Also see 'smartcase'.
3640 Can be overruled by using "\c" or "\C" in the pattern, see
3641 |/ignorecase|.
3642
3643 *'imactivatekey'* *'imak'*
3644'imactivatekey' 'imak' string (default "")
3645 global
3646 {not in Vi}
3647 {only available when compiled with |+xim| and
3648 |+GUI_GTK|}
3649 Specifies the key that your Input Method in X-Windows uses for
3650 activation. When this is specified correctly, vim can fully control
3651 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3652 You can't use this option to change the activation key, the option
3653 tells Vim what the key is.
3654 Format:
3655 [MODIFIER_FLAG-]KEY_STRING
3656
3657 These characters can be used for MODIFIER_FLAG (case is ignored):
3658 S Shift key
3659 L Lock key
3660 C Control key
3661 1 Mod1 key
3662 2 Mod2 key
3663 3 Mod3 key
3664 4 Mod4 key
3665 5 Mod5 key
3666 Combinations are allowed, for example "S-C-space" or "SC-space" are
3667 both shift+ctrl+space.
3668 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3669
3670 Example: >
3671 :set imactivatekey=S-space
3672< "S-space" means shift+space. This is the activation key for kinput2 +
3673 canna (Japanese), and ami (Korean).
3674
3675 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3676'imcmdline' 'imc' boolean (default off)
3677 global
3678 {not in Vi}
3679 {only available when compiled with the |+xim|
3680 |+multi_byte_ime| or |global-ime| feature}
3681 When set the Input Method is always on when starting to edit a command
3682 line, unless entering a search pattern (see 'imsearch' for that).
3683 Setting this option is useful when your input method allows entering
3684 English characters directly, e.g., when it's used to type accented
3685 characters with dead keys.
3686
3687 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3688'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3689 global
3690 {not in Vi}
3691 {only available when compiled with the |+xim|
3692 |+multi_byte_ime| or |global-ime| feature}
3693 When set the Input Method is never used. This is useful to disable
3694 the IM when it doesn't work properly.
3695 Currently this option is on by default for SGI/IRIX machines. This
3696 may change in later releases.
3697
3698 *'iminsert'* *'imi'*
3699'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3700 local to buffer
3701 {not in Vi}
3702 Specifies whether :lmap or an Input Method (IM) is to be used in
3703 Insert mode. Valid values:
3704 0 :lmap is off and IM is off
3705 1 :lmap is ON and IM is off
3706 2 :lmap is off and IM is ON
3707 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3708 or |global-ime|.
3709 To always reset the option to zero when leaving Insert mode with <Esc>
3710 this can be used: >
3711 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3712< This makes :lmap and IM turn off automatically when leaving Insert
3713 mode.
3714 Note that this option changes when using CTRL-^ in Insert mode
3715 |i_CTRL-^|.
3716 The value is set to 1 when setting 'keymap' to a valid keymap name.
3717 It is also used for the argument of commands like "r" and "f".
3718 The value 0 may not work correctly with Athena and Motif with some XIM
3719 methods. Use 'imdisable' to disable XIM then.
3720
3721 *'imsearch'* *'ims'*
3722'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3723 local to buffer
3724 {not in Vi}
3725 Specifies whether :lmap or an Input Method (IM) is to be used when
3726 entering a search pattern. Valid values:
3727 -1 the value of 'iminsert' is used, makes it look like
3728 'iminsert' is also used when typing a search pattern
3729 0 :lmap is off and IM is off
3730 1 :lmap is ON and IM is off
3731 2 :lmap is off and IM is ON
3732 Note that this option changes when using CTRL-^ in Command-line mode
3733 |c_CTRL-^|.
3734 The value is set to 1 when it is not -1 and setting the 'keymap'
3735 option to a valid keymap name.
3736 The value 0 may not work correctly with Athena and Motif with some XIM
3737 methods. Use 'imdisable' to disable XIM then.
3738
3739 *'include'* *'inc'*
3740'include' 'inc' string (default "^\s*#\s*include")
3741 global or local to buffer |global-local|
3742 {not in Vi}
3743 {not available when compiled without the
3744 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003745 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003746 pattern, just like for the "/" command (See |pattern|). The default
3747 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003748 "]I", "[d", etc.
3749 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003750 comes after the matched pattern. But if "\zs" appears in the pattern
3751 then the text matched from "\zs" to the end, or until "\ze" if it
3752 appears, is used as the file name. Use this to include characters
3753 that are not in 'isfname', such as a space. You can then use
3754 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003755 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003756
3757 *'includeexpr'* *'inex'*
3758'includeexpr' 'inex' string (default "")
3759 local to buffer
3760 {not in Vi}
3761 {not available when compiled without the
3762 |+find_in_path| or |+eval| feature}
3763 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003764 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003765 :set includeexpr=substitute(v:fname,'\\.','/','g')
3766< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003767
Bram Moolenaar071d4272004-06-13 20:20:40 +00003768 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003769 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003770 Also used for |<cfile>|.
3771
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003772 The expression may be evaluated in the |sandbox|, see
3773 |sandbox-option|.
3774
3775 It is not allowed to change text or jump to another window while
3776 evaluating 'includeexpr' |textlock|.
3777
Bram Moolenaar071d4272004-06-13 20:20:40 +00003778 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3779'incsearch' 'is' boolean (default off)
3780 global
3781 {not in Vi}
3782 {not available when compiled without the
3783 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003784 While typing a search command, show where the pattern, as it was typed
3785 so far, matches. The matched string is highlighted. If the pattern
3786 is invalid or not found, nothing is shown. The screen will be updated
3787 often, this is only useful on fast terminals.
3788 Note that the match will be shown, but the cursor will return to its
3789 original position when no match is found and when pressing <Esc>. You
3790 still need to finish the search command with <Enter> to move the
3791 cursor to the match.
3792 The highlighting can be set with the 'i' flag in 'highlight'.
3793 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00003794 CTRL-L can be used to add one character from after the current match
3795 to the command line.
3796 CTRL-R CTRL-W can be used to add the word at the end of the current
3797 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003798 NOTE: This option is reset when 'compatible' is set.
3799
3800 *'indentexpr'* *'inde'*
3801'indentexpr' 'inde' string (default "")
3802 local to buffer
3803 {not in Vi}
3804 {not available when compiled without the |+cindent|
3805 or |+eval| features}
3806 Expression which is evaluated to obtain the proper indent for a line.
3807 It is used when a new line is created, for the |=| operator and
3808 in Insert mode as specified with the 'indentkeys' option.
3809 When this option is not empty, it overrules the 'cindent' and
3810 'smartindent' indenting.
3811 When 'paste' is set this option is not used for indenting.
3812 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003813 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003814 when the expression is evaluated (but it may be moved around).
3815 The expression must return the number of spaces worth of indent. It
3816 can return "-1" to keep the current indent (this means 'autoindent' is
3817 used for the indent).
3818 Functions useful for computing the indent are |indent()|, |cindent()|
3819 and |lispindent()|.
3820 The evaluation of the expression must not have side effects! It must
3821 not change the text, jump to another window, etc. Afterwards the
3822 cursor position is always restored, thus the cursor may be moved.
3823 Normally this option would be set to call a function: >
3824 :set indentexpr=GetMyIndent()
3825< Error messages will be suppressed, unless the 'debug' option contains
3826 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003827 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003828 NOTE: This option is made empty when 'compatible' is set.
3829
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003830 The expression may be evaluated in the |sandbox|, see
3831 |sandbox-option|.
3832
3833 It is not allowed to change text or jump to another window while
3834 evaluating 'indentexpr' |textlock|.
3835
3836
Bram Moolenaar071d4272004-06-13 20:20:40 +00003837 *'indentkeys'* *'indk'*
3838'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3839 local to buffer
3840 {not in Vi}
3841 {not available when compiled without the |+cindent|
3842 feature}
3843 A list of keys that, when typed in Insert mode, cause reindenting of
3844 the current line. Only happens if 'indentexpr' isn't empty.
3845 The format is identical to 'cinkeys', see |indentkeys-format|.
3846 See |C-indenting| and |indent-expression|.
3847
3848 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3849'infercase' 'inf' boolean (default off)
3850 local to buffer
3851 {not in Vi}
3852 When doing keyword completion in insert mode |ins-completion|, and
3853 'ignorecase' is also on, the case of the match is adjusted. If the
3854 typed text contains a lowercase letter where the match has an upper
3855 case letter, the completed part is made lowercase. If the typed text
3856 has no lowercase letters and the match has a lowercase letter where
3857 the typed text has an uppercase letter, and there is a letter before
3858 it, the completed part is made uppercase.
3859
3860 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3861'insertmode' 'im' boolean (default off)
3862 global
3863 {not in Vi}
3864 Makes Vim work in a way that Insert mode is the default mode. Useful
3865 if you want to use Vim as a modeless editor. Used for |evim|.
3866 These Insert mode commands will be useful:
3867 - Use the cursor keys to move around.
3868 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3869 this is a mapping, it is executed as if 'insertmode' was off.
3870 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003871 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00003872 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
3873 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003874
3875 These items change when 'insertmode' is set:
3876 - when starting to edit of a file, Vim goes to Insert mode.
3877 - <Esc> in Insert mode is a no-op and beeps.
3878 - <Esc> in Normal mode makes Vim go to Insert mode.
3879 - CTRL-L in Insert mode is a command, it is not inserted.
3880 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3881 However, when <Esc> is used inside a mapping, it behaves like
3882 'insertmode' was not set. This was done to be able to use the same
3883 mappings with 'insertmode' set or not set.
3884 When executing commands with |:normal| 'insertmode' is not used.
3885
3886 NOTE: This option is reset when 'compatible' is set.
3887
3888 *'isfname'* *'isf'*
3889'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3890 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3891 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3892 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3893 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3894 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3895 global
3896 {not in Vi}
3897 The characters specified by this option are included in file names and
3898 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003899 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003900 Multi-byte characters 256 and above are always included, only the
3901 characters up to 255 are specified with this option.
3902 For UTF-8 the characters 0xa0 to 0xff are included as well.
3903
3904 Note that on systems using a backslash as path separator, Vim tries to
3905 do its best to make it work as you would expect. That is a bit
3906 tricky, since Vi originally used the backslash to escape special
3907 characters. Vim will not remove a backslash in front of a normal file
3908 name character on these systems, but it will on Unix and alikes. The
3909 '&' and '^' are not included by default, because these are special for
3910 cmd.exe.
3911
3912 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003913 Each part can be a single character number or a range. A range is two
3914 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003915 decimal number between 0 and 255 or the ASCII character itself (does
3916 not work for digits). Example:
3917 "_,-,128-140,#-43" (include '_' and '-' and the range
3918 128 to 140 and '#' to 43)
3919 If a part starts with '^', the following character number or range
3920 will be excluded from the option. The option is interpreted from left
3921 to right. Put the excluded character after the range where it is
3922 included. To include '^' itself use it as the last character of the
3923 option or the end of a range. Example:
3924 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3925 If the character is '@', all characters where isalpha() returns TRUE
3926 are included. Normally these are the characters a to z and A to Z,
3927 plus accented characters. To include '@' itself use "@-@". Examples:
3928 "@,^a-z" All alphabetic characters, excluding lower
3929 case letters.
3930 "a-z,A-Z,@-@" All letters plus the '@' character.
3931 A comma can be included by using it where a character number is
3932 expected. Example:
3933 "48-57,,,_" Digits, comma and underscore.
3934 A comma can be excluded by prepending a '^'. Example:
3935 " -~,^,,9" All characters from space to '~', excluding
3936 comma, plus <Tab>.
3937 See |option-backslash| about including spaces and backslashes.
3938
3939 *'isident'* *'isi'*
3940'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3941 "@,48-57,_,128-167,224-235"
3942 otherwise: "@,48-57,_,192-255")
3943 global
3944 {not in Vi}
3945 The characters given by this option are included in identifiers.
3946 Identifiers are used in recognizing environment variables and after a
3947 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00003948 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00003949 option.
3950 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003951 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003952 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3953
3954 *'iskeyword'* *'isk'*
3955'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3956 "@,48-57,_,128-167,224-235"
3957 otherwise: "@,48-57,_,192-255"
3958 Vi default: "@,48-57,_")
3959 local to buffer
3960 {not in Vi}
3961 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003962 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003963 'isfname' for a description of the format of this option. For C
3964 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3965 For a help file it is set to all non-blank printable characters except
3966 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3967 command).
3968 When the 'lisp' option is on the '-' character is always included.
3969 NOTE: This option is set to the Vi default value when 'compatible' is
3970 set and to the Vim default value when 'compatible' is reset.
3971
3972 *'isprint'* *'isp'*
3973'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3974 "@,~-255"; otherwise: "@,161-255")
3975 global
3976 {not in Vi}
3977 The characters given by this option are displayed directly on the
3978 screen. It is also used for "\p" in a |pattern|. The characters from
3979 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3980 even when they are not included in 'isprint' or excluded. See
3981 'isfname' for a description of the format of this option.
3982
3983 Non-printable characters are displayed with two characters:
3984 0 - 31 "^@" - "^_"
3985 32 - 126 always single characters
3986 127 "^?"
3987 128 - 159 "~@" - "~_"
3988 160 - 254 "| " - "|~"
3989 255 "~?"
3990 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3991 displayed as <xx>, with the hexadecimal value of the byte.
3992 When 'display' contains "uhex" all unprintable characters are
3993 displayed as <xx>.
3994 The NonText highlighting will be used for unprintable characters.
3995 |hl-NonText|
3996
3997 Multi-byte characters 256 and above are always included, only the
3998 characters up to 255 are specified with this option. When a character
3999 is printable but it is not available in the current font, a
4000 replacement character will be shown.
4001 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4002 There is no option to specify these characters.
4003
4004 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4005'joinspaces' 'js' boolean (default on)
4006 global
4007 {not in Vi}
4008 Insert two spaces after a '.', '?' and '!' with a join command.
4009 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4010 Otherwise only one space is inserted.
4011 NOTE: This option is set when 'compatible' is set.
4012
4013 *'key'*
4014'key' string (default "")
4015 local to buffer
4016 {not in Vi}
4017 The key that is used for encrypting and decrypting the current buffer.
4018 See |encryption|.
4019 Careful: Do not set the key value by hand, someone might see the typed
4020 key. Use the |:X| command. But you can make 'key' empty: >
4021 :set key=
4022< It is not possible to get the value of this option with ":set key" or
4023 "echo &key". This is to avoid showing it to someone who shouldn't
4024 know. It also means you cannot see it yourself once you have set it,
4025 be careful not to make a typing error!
4026
4027 *'keymap'* *'kmp'* *E544*
4028'keymap' 'kmp' string (default "")
4029 local to buffer
4030 {not in Vi}
4031 {only available when compiled with the |+keymap|
4032 feature}
4033 Name of a keyboard mapping. See |mbyte-keymap|.
4034 Setting this option to a valid keymap name has the side effect of
4035 setting 'iminsert' to one, so that the keymap becomes effective.
4036 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004037 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004038
4039 *'keymodel'* *'km'*
4040'keymodel' 'km' string (default "")
4041 global
4042 {not in Vi}
4043 List of comma separated words, which enable special things that keys
4044 can do. These values can be used:
4045 startsel Using a shifted special key starts selection (either
4046 Select mode or Visual mode, depending on "key" being
4047 present in 'selectmode').
4048 stopsel Using a not-shifted special key stops selection.
4049 Special keys in this context are the cursor keys, <End>, <Home>,
4050 <PageUp> and <PageDown>.
4051 The 'keymodel' option is set by the |:behave| command.
4052
4053 *'keywordprg'* *'kp'*
4054'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4055 OS/2: "view /", VMS: "help")
4056 global or local to buffer |global-local|
4057 {not in Vi}
4058 Program to use for the |K| command. Environment variables are
4059 expanded |:set_env|. ":help" may be used to access the Vim internal
4060 help. (Note that previously setting the global option to the empty
4061 value did this, which is now deprecated.)
4062 When "man" is used, Vim will automatically translate a count for the
4063 "K" command to a section number. Also for "man -s", in which case the
4064 "-s" is removed when there is no count.
4065 See |option-backslash| about including spaces and backslashes.
4066 Example: >
4067 :set keywordprg=man\ -s
4068< This option cannot be set from a |modeline| or in the |sandbox|, for
4069 security reasons.
4070
4071 *'langmap'* *'lmap'* *E357* *E358*
4072'langmap' 'lmap' string (default "")
4073 global
4074 {not in Vi}
4075 {only available when compiled with the |+langmap|
4076 feature}
4077 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004078 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004079 inserted directly. When in command mode the 'langmap' option takes
4080 care of translating these special characters to the original meaning
4081 of the key. This means you don't have to change the keyboard mode to
4082 be able to execute Normal mode commands.
4083 This is the opposite of the 'keymap' option, where characters are
4084 mapped in Insert mode.
4085 This only works for 8-bit characters. The value of 'langmap' may be
4086 specified with multi-byte characters (e.g., UTF-8), but only the lower
4087 8 bits of each character will be used.
4088
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004089 Example (for Greek, in UTF-8): *greek* >
4090 :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 +00004091< Example (exchanges meaning of z and y for commands): >
4092 :set langmap=zy,yz,ZY,YZ
4093<
4094 The 'langmap' option is a list of parts, separated with commas. Each
4095 part can be in one of two forms:
4096 1. A list of pairs. Each pair is a "from" character immediately
4097 followed by the "to" character. Examples: "aA", "aAbBcC".
4098 2. A list of "from" characters, a semi-colon and a list of "to"
4099 characters. Example: "abc;ABC"
4100 Example: "aA,fgh;FGH,cCdDeE"
4101 Special characters need to be preceded with a backslash. These are
4102 ";", ',' and backslash itself.
4103
4104 This will allow you to activate vim actions without having to switch
4105 back and forth between the languages. Your language characters will
4106 be understood as normal vim English characters (according to the
4107 langmap mappings) in the following cases:
4108 o Normal/Visual mode (commands, buffer/register names, user mappings)
4109 o Insert/Replace Mode: Register names after CTRL-R
4110 o Insert/Replace Mode: Mappings
4111 Characters entered in Command-line mode will NOT be affected by
4112 this option. Note that this option can be changed at any time
4113 allowing to switch between mappings for different languages/encodings.
4114 Use a mapping to avoid having to type it each time!
4115
4116 *'langmenu'* *'lm'*
4117'langmenu' 'lm' string (default "")
4118 global
4119 {not in Vi}
4120 {only available when compiled with the |+menu| and
4121 |+multi_lang| features}
4122 Language to use for menu translation. Tells which file is loaded
4123 from the "lang" directory in 'runtimepath': >
4124 "lang/menu_" . &langmenu . ".vim"
4125< (without the spaces). For example, to always use the Dutch menus, no
4126 matter what $LANG is set to: >
4127 :set langmenu=nl_NL.ISO_8859-1
4128< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004129 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004130 If your $LANG is set to a non-English language but you do want to use
4131 the English menus: >
4132 :set langmenu=none
4133< This option must be set before loading menus, switching on filetype
4134 detection or syntax highlighting. Once the menus are defined setting
4135 this option has no effect. But you could do this: >
4136 :source $VIMRUNTIME/delmenu.vim
4137 :set langmenu=de_DE.ISO_8859-1
4138 :source $VIMRUNTIME/menu.vim
4139< Warning: This deletes all menus that you defined yourself!
4140
4141 *'laststatus'* *'ls'*
4142'laststatus' 'ls' number (default 1)
4143 global
4144 {not in Vi}
4145 The value of this option influences when the last window will have a
4146 status line:
4147 0: never
4148 1: only if there are at least two windows
4149 2: always
4150 The screen looks nicer with a status line if you have several
4151 windows, but it takes another screen line. |status-line|
4152
4153 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4154'lazyredraw' 'lz' boolean (default off)
4155 global
4156 {not in Vi}
4157 When this option is set, the screen will not be redrawn while
4158 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004159 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004160 update use |:redraw|.
4161
4162 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4163'linebreak' 'lbr' boolean (default off)
4164 local to window
4165 {not in Vi}
4166 {not available when compiled without the |+linebreak|
4167 feature}
4168 If on Vim will wrap long lines at a character in 'breakat' rather
4169 than at the last character that fits on the screen. Unlike
4170 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4171 it only affects the way the file is displayed, not its contents. The
4172 value of 'showbreak' is used to put in front of wrapped lines.
4173 This option is not used when the 'wrap' option is off or 'list' is on.
4174 Note that <Tab> characters after an <EOL> are mostly not displayed
4175 with the right amount of white space.
4176
4177 *'lines'* *E593*
4178'lines' number (default 24 or terminal height)
4179 global
4180 Number of lines of the Vim window.
4181 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004182 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004183 When Vim is running in the GUI or in a resizable window, setting this
4184 option will cause the window size to be changed. When you only want
4185 to use the size for the GUI, put the command in your |gvimrc| file.
4186 Vim limits the number of lines to what fits on the screen. You can
4187 use this command to get the tallest window possible: >
4188 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004189< Minimum value is 2, maximum value is 1000.
4190 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004191 When you set this option and Vim is unable to change the physical
4192 number of lines of the display, the display may be messed up.
4193
4194 *'linespace'* *'lsp'*
4195'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4196 global
4197 {not in Vi}
4198 {only in the GUI}
4199 Number of pixel lines inserted between characters. Useful if the font
4200 uses the full character cell height, making lines touch each other.
4201 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004202 With some fonts there can be too much room between lines (to have
4203 space for ascents and descents). Then it makes sense to set
4204 'linespace' to a negative value. This may cause display problems
4205 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004206
4207 *'lisp'* *'nolisp'*
4208'lisp' boolean (default off)
4209 local to buffer
4210 {not available when compiled without the |+lispindent|
4211 feature}
4212 Lisp mode: When <Enter> is typed in insert mode set the indent for
4213 the next line to Lisp standards (well, sort of). Also happens with
4214 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4215 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4216 better. Also see 'lispwords'.
4217 The '-' character is included in keyword characters. Redefines the
4218 "=" operator to use this same indentation algorithm rather than
4219 calling an external program if 'equalprg' is empty.
4220 This option is not used when 'paste' is set.
4221 {Vi: Does it a little bit differently}
4222
4223 *'lispwords'* *'lw'*
4224'lispwords' 'lw' string (default is very long)
4225 global
4226 {not in Vi}
4227 {not available when compiled without the |+lispindent|
4228 feature}
4229 Comma separated list of words that influence the Lisp indenting.
4230 |'lisp'|
4231
4232 *'list'* *'nolist'*
4233'list' boolean (default off)
4234 local to window
4235 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
4236 see the difference between tabs and spaces and for trailing blanks.
4237 Note that this will also affect formatting (set with 'textwidth' or
4238 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
4239 changing the way tabs are displayed.
4240
4241 *'listchars'* *'lcs'*
4242'listchars' 'lcs' string (default "eol:$")
4243 global
4244 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004245 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004246 settings.
4247 eol:c Character to show at the end of each line. When
4248 omitted, there is no extra character at the end of the
4249 line.
4250 tab:xy Two characters to be used to show a Tab. The first
4251 char is used once. The second char is repeated to
4252 fill the space that the Tab normally occupies.
4253 "tab:>-" will show a Tab that takes four spaces as
4254 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004255 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004256 trailing spaces are blank.
4257 extends:c Character to show in the last column, when 'wrap' is
4258 off and the line continues beyond the right of the
4259 screen.
4260 precedes:c Character to show in the first column, when 'wrap'
4261 is off and there is text preceding the character
4262 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004263 nbsp:c Character to show for a non-breakable space (character
4264 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004265
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004266 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004267 be used when 'encoding' is "utf-8", otherwise only printable
4268 characters are allowed.
4269
4270 Examples: >
4271 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004272 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004273 :set lcs=extends:>,precedes:<
4274< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004275 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004276
4277 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4278'loadplugins' 'lpl' boolean (default on)
4279 global
4280 {not in Vi}
4281 When on the plugin scripts are loaded when starting up |load-plugins|.
4282 This option can be reset in your |vimrc| file to disable the loading
4283 of plugins.
4284 Note that using the "-u NONE" and "--noplugin" command line arguments
4285 reset this option. |-u| |--noplugin|
4286
4287 *'magic'* *'nomagic'*
4288'magic' boolean (default on)
4289 global
4290 Changes the special characters that can be used in search patterns.
4291 See |pattern|.
4292 NOTE: To avoid portability problems with using patterns, always keep
4293 this option at the default "on". Only switch it off when working with
4294 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004295 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004296
4297 *'makeef'* *'mef'*
4298'makeef' 'mef' string (default: "")
4299 global
4300 {not in Vi}
4301 {not available when compiled without the |+quickfix|
4302 feature}
4303 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4304 and the |:grep| command.
4305 When it is empty, an internally generated temp file will be used.
4306 When "##" is included, it is replaced by a number to make the name
4307 unique. This makes sure that the ":make" command doesn't overwrite an
4308 existing file.
4309 NOT used for the ":cf" command. See 'errorfile' for that.
4310 Environment variables are expanded |:set_env|.
4311 See |option-backslash| about including spaces and backslashes.
4312 This option cannot be set from a |modeline| or in the |sandbox|, for
4313 security reasons.
4314
4315 *'makeprg'* *'mp'*
4316'makeprg' 'mp' string (default "make", VMS: "MMS")
4317 global or local to buffer |global-local|
4318 {not in Vi}
4319 Program to use for the ":make" command. See |:make_makeprg|. This
4320 option may contain '%' and '#' characters, which are expanded like
4321 when used in a command-line. Environment variables are expanded
4322 |:set_env|. See |option-backslash| about including spaces and
4323 backslashes. Note that a '|' must be escaped twice: once for ":set"
4324 and once for the interpretation of a command. When you use a filter
4325 called "myfilter" do it like this: >
4326 :set makeprg=gmake\ \\\|\ myfilter
4327< The placeholder "$*" can be given (even multiple times) to specify
4328 where the arguments will be included, for example: >
4329 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4330< This option cannot be set from a |modeline| or in the |sandbox|, for
4331 security reasons.
4332
4333 *'matchpairs'* *'mps'*
4334'matchpairs' 'mps' string (default "(:),{:},[:]")
4335 local to buffer
4336 {not in Vi}
4337 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004338 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00004339 must be different. The characters must be separated by a colon. The
4340 pairs must be separated by a comma. Example for including '<' and '>'
4341 (HTML): >
4342 :set mps+=<:>
4343
4344< A more exotic example, to jump between the '=' and ';' in an
4345 assignment, useful for languages like C and Java: >
4346 :au FileType c,cpp,java set mps+==:;
4347
4348< For a more advanced way of using "%", see the matchit.vim plugin in
4349 the $VIMRUNTIME/macros directory. |add-local-help|
4350
4351 *'matchtime'* *'mat'*
4352'matchtime' 'mat' number (default 5)
4353 global
4354 {not in Vi}{in Nvi}
4355 Tenths of a second to show the matching paren, when 'showmatch' is
4356 set. Note that this is not in milliseconds, like other options that
4357 set a time. This is to be compatible with Nvi.
4358
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004359 *'maxcombine'* *'mco'*
4360'maxcombine' 'mco' number (default 2)
4361 global
4362 {not in Vi}
4363 {only available when compiled with the |+multi_byte|
4364 feature}
4365 The maximum number of combining characters supported for displaying.
4366 Only used when 'encoding' is "utf-8".
4367 The default is OK for most languages. Hebrew may require 4.
4368 Maximum value is 6.
4369 Even when this option is set to 2 you can still edit text with more
4370 combining characters, you just can't see them. Use |g8| or |ga|.
4371 See |mbyte-combining|.
4372
Bram Moolenaar071d4272004-06-13 20:20:40 +00004373 *'maxfuncdepth'* *'mfd'*
4374'maxfuncdepth' 'mfd' number (default 100)
4375 global
4376 {not in Vi}
4377 Maximum depth of function calls for user functions. This normally
4378 catches endless recursion. When using a recursive function with
4379 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4380 more memory, there is the danger of failing when memory is exhausted.
4381 See also |:function|.
4382
4383 *'maxmapdepth'* *'mmd'* *E223*
4384'maxmapdepth' 'mmd' number (default 1000)
4385 global
4386 {not in Vi}
4387 Maximum number of times a mapping is done without resulting in a
4388 character to be used. This normally catches endless mappings, like
4389 ":map x y" with ":map y x". It still does not catch ":map g wg",
4390 because the 'w' is used before the next mapping is done. See also
4391 |key-mapping|.
4392
4393 *'maxmem'* *'mm'*
4394'maxmem' 'mm' number (default between 256 to 5120 (system
4395 dependent) or half the amount of memory
4396 available)
4397 global
4398 {not in Vi}
4399 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4400 limit is reached allocating extra memory for a buffer will cause
4401 other memory to be freed. Maximum value 2000000. Use this to work
4402 without a limit. Also see 'maxmemtot'.
4403
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004404 *'maxmempattern'* *'mmp'*
4405'maxmempattern' 'mmp' number (default 1000)
4406 global
4407 {not in Vi}
4408 Maximum amount of memory (in Kbyte) to use for pattern matching.
4409 Maximum value 2000000. Use this to work without a limit.
4410 *E363*
4411 When Vim runs into the limit it gives an error message mostly behaves
4412 like CTRL-C was typed.
4413 Running into the limit often means that the pattern is very
4414 inefficient or too complex. This may already happen with the pattern
4415 "\(.\)*" on a very long line. ".*" works much better.
4416 Vim may run out of memory before hitting the 'maxmempattern' limit.
4417
Bram Moolenaar071d4272004-06-13 20:20:40 +00004418 *'maxmemtot'* *'mmt'*
4419'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4420 dependent) or half the amount of memory
4421 available)
4422 global
4423 {not in Vi}
4424 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004425 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004426 'maxmem'.
4427
4428 *'menuitems'* *'mis'*
4429'menuitems' 'mis' number (default 25)
4430 global
4431 {not in Vi}
4432 {not available when compiled without the |+menu|
4433 feature}
4434 Maximum number of items to use in a menu. Used for menus that are
4435 generated from a list of items, e.g., the Buffers menu. Changing this
4436 option has no direct effect, the menu must be refreshed first.
4437
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004438 *'mkspellmem'* *'msm'*
4439'mkspellmem' 'msm' string (default "460000,2000,500")
4440 global
4441 {not in Vi}
4442 {not available when compiled without the |+syntax|
4443 feature}
4444 Parameters for |:mkspell|. This tunes when to start compressing the
4445 word tree. Compression can be slow when there are many words, but
4446 it's needed to avoid running out of memory. The amount of memory used
4447 per word depends very much on how similar the words are, that's why
4448 this tuning is complicated.
4449
4450 There are three numbers, separated by commas:
4451 {start},{inc},{added}
4452
4453 For most languages the uncompressed word tree fits in memory. {start}
4454 gives the amount of memory in Kbyte that can be used before any
4455 compression is done. It should be a bit smaller than the amount of
4456 memory that is available to Vim.
4457
4458 When going over the {start} limit the {inc} number specifies the
4459 amount of memory in Kbyte that can be allocated before another
4460 compression is done. A low number means compression is done after
4461 less words are added, which is slow. A high number means more memory
4462 will be allocated.
4463
4464 After doing compression, {added} times 1024 words can be added before
4465 the {inc} limit is ignored and compression is done when any extra
4466 amount of memory is needed. A low number means there is a smaller
4467 chance of hitting the {inc} limit, less memory is used but it's
4468 slower.
4469
4470 The languages for which these numbers are important are Italian and
4471 Hungarian. The default works for when you have about 512 Mbyte. If
4472 you have 1 Gbyte you could use: >
4473 :set mkspellmem=900000,3000,800
4474< If you have less than 512 Mbyte |:mkspell| may fail for some
4475 languages, no matter what you set 'mkspellmem' to.
4476
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4478'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4479 local to buffer
4480 *'modelines'* *'mls'*
4481'modelines' 'mls' number (default 5)
4482 global
4483 {not in Vi}
4484 If 'modeline' is on 'modelines' gives the number of lines that is
4485 checked for set commands. If 'modeline' is off or 'modelines' is zero
4486 no lines are checked. See |modeline|.
4487 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4488 set and to the Vim default value when 'compatible' is reset.
4489
4490 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4491'modifiable' 'ma' boolean (default on)
4492 local to buffer
4493 {not in Vi} *E21*
4494 When off the buffer contents cannot be changed. The 'fileformat' and
4495 'fileencoding' options also can't be changed.
4496 Can be reset with the |-M| command line argument.
4497
4498 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4499'modified' 'mod' boolean (default off)
4500 local to buffer
4501 {not in Vi}
4502 When on, the buffer is considered to be modified. This option is set
4503 when:
4504 1. A change was made to the text since it was last written. Using the
4505 |undo| command to go back to the original text will reset the
4506 option. But undoing changes that were made before writing the
4507 buffer will set the option again, since the text is different from
4508 when it was written.
4509 2. 'fileformat' or 'fileencoding' is different from its original
4510 value. The original value is set when the buffer is read or
4511 written. A ":set nomodified" command also resets the original
4512 values to the current values and the 'modified' option will be
4513 reset.
4514 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4515 will be ignored.
4516
4517 *'more'* *'nomore'*
4518'more' boolean (Vim default: on, Vi default: off)
4519 global
4520 {not in Vi}
4521 When on, listings pause when the whole screen is filled. You will get
4522 the |more-prompt|. When this option is off there are no pauses, the
4523 listing continues until finished.
4524 NOTE: This option is set to the Vi default value when 'compatible' is
4525 set and to the Vim default value when 'compatible' is reset.
4526
4527 *'mouse'* *E538*
4528'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4529 global
4530 {not in Vi}
4531 Enable the use of the mouse. Only works for certain terminals
4532 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4533 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4534 The mouse can be enabled for different modes:
4535 n Normal mode
4536 v Visual mode
4537 i Insert mode
4538 c Command-line mode
4539 h all previous modes when editing a help file
4540 a all previous modes
4541 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004542 Normally you would enable the mouse in all four modes with: >
4543 :set mouse=a
4544< When the mouse is not enabled, the GUI will still use the mouse for
4545 modeless selection. This doesn't move the text cursor.
4546
4547 See |mouse-using|. Also see |'clipboard'|.
4548
4549 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004550 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004551 the mouse buttons can still be used by keeping the shift key pressed.
4552 Also see the 'clipboard' option.
4553
4554 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4555'mousefocus' 'mousef' boolean (default off)
4556 global
4557 {not in Vi}
4558 {only works in the GUI}
4559 The window that the mouse pointer is on is automatically activated.
4560 When changing the window layout or window focus in another way, the
4561 mouse pointer is moved to the window with keyboard focus. Off is the
4562 default because it makes using the pull down menus a little goofy, as
4563 a pointer transit may activate a window unintentionally.
4564
4565 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4566'mousehide' 'mh' boolean (default on)
4567 global
4568 {not in Vi}
4569 {only works in the GUI}
4570 When on, the mouse pointer is hidden when characters are typed.
4571 The mouse pointer is restored when the mouse is moved.
4572
4573 *'mousemodel'* *'mousem'*
4574'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4575 global
4576 {not in Vi}
4577 Sets the model to use for the mouse. The name mostly specifies what
4578 the right mouse button is used for:
4579 extend Right mouse button extends a selection. This works
4580 like in an xterm.
4581 popup Right mouse button pops up a menu. The shifted left
4582 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004583 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004584 popup_setpos Like "popup", but the cursor will be moved to the
4585 position where the mouse was clicked, and thus the
4586 selected operation will act upon the clicked object.
4587 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004588 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004589 course, that right clicking outside a selection will
4590 end Visual mode.
4591 Overview of what button does what for each model:
4592 mouse extend popup(_setpos) ~
4593 left click place cursor place cursor
4594 left drag start selection start selection
4595 shift-left search word extend selection
4596 right click extend selection popup menu (place cursor)
4597 right drag extend selection -
4598 middle click paste paste
4599
4600 In the "popup" model the right mouse button produces a pop-up menu.
4601 You need to define this first, see |popup-menu|.
4602
4603 Note that you can further refine the meaning of buttons with mappings.
4604 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4605 selection (because that's handled in the GUI code directly).
4606
4607 The 'mousemodel' option is set by the |:behave| command.
4608
4609 *'mouseshape'* *'mouses'* *E547*
4610'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004611 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004612 global
4613 {not in Vi}
4614 {only available when compiled with the |+mouseshape|
4615 feature}
4616 This option tells Vim what the mouse pointer should look like in
4617 different modes. The option is a comma separated list of parts, much
4618 like used for 'guicursor'. Each part consist of a mode/location-list
4619 and an argument-list:
4620 mode-list:shape,mode-list:shape,..
4621 The mode-list is a dash separated list of these modes/locations:
4622 In a normal window: ~
4623 n Normal mode
4624 v Visual mode
4625 ve Visual mode with 'selection' "exclusive" (same as 'v',
4626 if not specified)
4627 o Operator-pending mode
4628 i Insert mode
4629 r Replace mode
4630
4631 Others: ~
4632 c appending to the command-line
4633 ci inserting in the command-line
4634 cr replacing in the command-line
4635 m at the 'Hit ENTER' or 'More' prompts
4636 ml idem, but cursor in the last line
4637 e any mode, pointer below last window
4638 s any mode, pointer on a status line
4639 sd any mode, while dragging a status line
4640 vs any mode, pointer on a vertical separator line
4641 vd any mode, while dragging a vertical separator line
4642 a everywhere
4643
4644 The shape is one of the following:
4645 avail name looks like ~
4646 w x arrow Normal mouse pointer
4647 w x blank no pointer at all (use with care!)
4648 w x beam I-beam
4649 w x updown up-down sizing arrows
4650 w x leftright left-right sizing arrows
4651 w x busy The system's usual busy pointer
4652 w x no The system's usual 'no input' pointer
4653 x udsizing indicates up-down resizing
4654 x lrsizing indicates left-right resizing
4655 x crosshair like a big thin +
4656 x hand1 black hand
4657 x hand2 white hand
4658 x pencil what you write with
4659 x question big ?
4660 x rightup-arrow arrow pointing right-up
4661 w x up-arrow arrow pointing up
4662 x <number> any X11 pointer number (see X11/cursorfont.h)
4663
4664 The "avail" column contains a 'w' if the shape is available for Win32,
4665 x for X11.
4666 Any modes not specified or shapes not available use the normal mouse
4667 pointer.
4668
4669 Example: >
4670 :set mouseshape=s:udsizing,m:no
4671< will make the mouse turn to a sizing arrow over the status lines and
4672 indicate no input when the hit-enter prompt is displayed (since
4673 clicking the mouse has no effect in this state.)
4674
4675 *'mousetime'* *'mouset'*
4676'mousetime' 'mouset' number (default 500)
4677 global
4678 {not in Vi}
4679 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4680 time in msec between two mouse clicks for the second click to be
4681 recognized as a multi click.
4682
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004683 *'mzquantum'* *'mzq'*
4684'mzquantum' 'mzq' number (default 100)
4685 global
4686 {not in Vi}
4687 {not available when compiled without the |+mzscheme|
4688 feature}
4689 The number of milliseconds between polls for MzScheme threads.
4690 Negative or zero value means no thread scheduling.
4691
Bram Moolenaar071d4272004-06-13 20:20:40 +00004692 *'nrformats'* *'nf'*
4693'nrformats' 'nf' string (default "octal,hex")
4694 local to buffer
4695 {not in Vi}
4696 This defines what bases Vim will consider for numbers when using the
4697 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4698 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004699 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004700 incremented or decremented. This is useful for a list with a
4701 letter index a), b), etc.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004702 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004703 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004704 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004705 considered to be hexadecimal. Example: Using CTRL-X on
4706 "0x100" results in "0x0ff".
4707 Numbers which simply begin with a digit in the range 1-9 are always
4708 considered decimal. This also happens for numbers that are not
4709 recognized as octal or hex.
4710
4711 *'number'* *'nu'* *'nonumber'* *'nonu'*
4712'number' 'nu' boolean (default off)
4713 local to window
4714 Print the line number in front of each line. When the 'n' option is
4715 excluded from 'cpoptions' a wrapped line will not use the column of
4716 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004717 The 'numberwidth' option can be used to set the room used for the line
4718 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004719 When a long, wrapped line doesn't start with the first character, '-'
4720 characters are put before the number.
4721 See |hl-LineNr| for the highlighting used for the number.
4722
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004723 *'numberwidth'* *'nuw'*
4724'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4725 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004726 {not in Vi}
4727 {only available when compiled with the |+linebreak|
4728 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004729 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00004730 when the 'number' option is set or printing lines with a line number.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004731 Since one space is always between the number and the text, there is
4732 one less character for the number itself.
4733 The value is the minimum width. A bigger width is used when needed to
4734 fit the highest line number in the buffer. Thus with the Vim default
4735 of 4 there is room for a line number up to 999. When the buffer has
4736 1000 lines five columns will be used.
4737 The minimum value is 1, the maximum value is 10.
4738 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4739
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004740 *'omnifunc'* *'ofu'*
4741'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00004742 local to buffer
4743 {not in Vi}
4744 {not available when compiled without the +eval
4745 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00004746 This option specifies a function to be used for Insert mode omni
4747 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00004748 See |complete-functions| for an explanation of how the function is
4749 invoked and what it should return.
Bram Moolenaare344bea2005-09-01 20:46:49 +00004750
4751
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00004752 *'operatorfunc'* *'opfunc'*
4753'operatorfunc' 'opfunc' string (default: empty)
4754 global
4755 {not in Vi}
4756 This option specifies a function to be called by the |g@| operator.
4757 See |:map-operator| for more info and an example.
4758
4759 This option cannot be set from a |modeline| or in the |sandbox|, for
4760 security reasons.
4761
4762
Bram Moolenaar071d4272004-06-13 20:20:40 +00004763 *'osfiletype'* *'oft'* *E366*
4764'osfiletype' 'oft' string (RISC-OS default: "Text",
4765 others default: "")
4766 local to buffer
4767 {not in Vi}
4768 {only available when compiled with the |+osfiletype|
4769 feature}
4770 Some operating systems store extra information about files besides
4771 name, datestamp and permissions. This option contains the extra
4772 information, the nature of which will vary between systems.
4773 The value of this option is usually set when the file is loaded, and
4774 use to set the file type when file is written.
4775 It can affect the pattern matching of the automatic commands.
4776 |autocmd-osfiletypes|
4777
4778 *'paragraphs'* *'para'*
4779'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4780 global
4781 Specifies the nroff macros that separate paragraphs. These are pairs
4782 of two letters (see |object-motions|).
4783
4784 *'paste'* *'nopaste'*
4785'paste' boolean (default off)
4786 global
4787 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004788 Put Vim in Paste mode. This is useful if you want to cut or copy
4789 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004790 unexpected effects.
4791 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004792 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004793 knows about pasting and will mostly do the right thing without 'paste'
4794 being set. The same is true for a terminal where Vim handles the
4795 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004796 This option is reset when starting the GUI. Thus if you set it in
4797 your .vimrc it will work in a terminal, but not in the GUI. Setting
4798 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4799 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004800 When the 'paste' option is switched on (also when it was already on):
4801 - mapping in Insert mode and Command-line mode is disabled
4802 - abbreviations are disabled
4803 - 'textwidth' is set to 0
4804 - 'wrapmargin' is set to 0
4805 - 'autoindent' is reset
4806 - 'smartindent' is reset
4807 - 'softtabstop' is set to 0
4808 - 'revins' is reset
4809 - 'ruler' is reset
4810 - 'showmatch' is reset
4811 - 'formatoptions' is used like it is empty
4812 These options keep their value, but their effect is disabled:
4813 - 'lisp'
4814 - 'indentexpr'
4815 - 'cindent'
4816 NOTE: When you start editing another file while the 'paste' option is
4817 on, settings from the modelines or autocommands may change the
4818 settings again, causing trouble when pasting text. You might want to
4819 set the 'paste' option again.
4820 When the 'paste' option is reset the mentioned options are restored to
4821 the value before the moment 'paste' was switched from off to on.
4822 Resetting 'paste' before ever setting it does not have any effect.
4823 Since mapping doesn't work while 'paste' is active, you need to use
4824 the 'pastetoggle' option to toggle the 'paste' option with some key.
4825
4826 *'pastetoggle'* *'pt'*
4827'pastetoggle' 'pt' string (default "")
4828 global
4829 {not in Vi}
4830 When non-empty, specifies the key sequence that toggles the 'paste'
4831 option. This is like specifying a mapping: >
4832 :map {keys} :set invpaste<CR>
4833< Where {keys} is the value of 'pastetoggle'.
4834 The difference is that it will work even when 'paste' is set.
4835 'pastetoggle' works in Insert mode and Normal mode, but not in
4836 Command-line mode.
4837 Mappings are checked first, thus overrule 'pastetoggle'. However,
4838 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4839 this: >
4840 :map <F10> :set paste<CR>
4841 :map <F11> :set nopaste<CR>
4842 :imap <F10> <C-O>:set paste<CR>
4843 :imap <F11> <nop>
4844 :set pastetoggle=<F11>
4845< This will make <F10> start paste mode and <F11> stop paste mode.
4846 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4847 mode everything is inserted literally, except the 'pastetoggle' key
4848 sequence.
4849
4850 *'pex'* *'patchexpr'*
4851'patchexpr' 'pex' string (default "")
4852 global
4853 {not in Vi}
4854 {not available when compiled without the |+diff|
4855 feature}
4856 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004857 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004858
4859 *'patchmode'* *'pm'* *E206*
4860'patchmode' 'pm' string (default "")
4861 global
4862 {not in Vi}
4863 When non-empty the oldest version of a file is kept. This can be used
4864 to keep the original version of a file if you are changing files in a
4865 source distribution. Only the first time that a file is written a
4866 copy of the original file will be kept. The name of the copy is the
4867 name of the original file with the string in the 'patchmode' option
4868 appended. This option should start with a dot. Use a string like
4869 ".org". 'backupdir' must not be empty for this to work (Detail: The
4870 backup file is renamed to the patchmode file after the new file has
4871 been successfully written, that's why it must be possible to write a
4872 backup file). If there was no file to be backed up, an empty file is
4873 created.
4874 When the 'backupskip' pattern matches, a patchmode file is not made.
4875 Using 'patchmode' for compressed files appends the extension at the
4876 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4877 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004878 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004879
4880 *'path'* *'pa'* *E343* *E345* *E347*
4881'path' 'pa' string (default on Unix: ".,/usr/include,,"
4882 on OS/2: ".,/emx/include,,"
4883 other systems: ".,,")
4884 global or local to buffer |global-local|
4885 {not in Vi}
4886 This is a list of directories which will be searched when using the
4887 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4888 being searched for has a relative path (not starting with '/'). The
4889 directories in the 'path' option may be relative or absolute.
4890 - Use commas to separate directory names: >
4891 :set path=.,/usr/local/include,/usr/include
4892< - Spaces can also be used to separate directory names (for backwards
4893 compatibility with version 3.0). To have a space in a directory
4894 name, precede it with an extra backslash, and escape the space: >
4895 :set path=.,/dir/with\\\ space
4896< - To include a comma in a directory name precede it with an extra
4897 backslash: >
4898 :set path=.,/dir/with\\,comma
4899< - To search relative to the directory of the current file, use: >
4900 :set path=.
4901< - To search in the current directory use an empty string between two
4902 commas: >
4903 :set path=,,
4904< - A directory name may end in a ':' or '/'.
4905 - Environment variables are expanded |:set_env|.
4906 - When using |netrw.vim| URLs can be used. For example, adding
4907 "http://www.vim.org" will make ":find index.html" work.
4908 - Search upwards and downwards in a directory tree:
4909 1) "*" matches a sequence of characters, e.g.: >
4910 :set path=/usr/include/*
4911< means all subdirectories in /usr/include (but not /usr/include
4912 itself). >
4913 :set path=/usr/*c
4914< matches /usr/doc and /usr/src.
4915 2) "**" matches a subtree, up to 100 directories deep. Example: >
4916 :set path=/home/user_x/src/**
4917< means search in the whole subtree under "/home/usr_x/src".
4918 3) If the path ends with a ';', this path is the startpoint
4919 for upward search.
4920 See |file-searching| for more info and exact syntax.
4921 {not available when compiled without the |+path_extra| feature}
4922 - Careful with '\' characters, type two to get one in the option: >
4923 :set path=.,c:\\include
4924< Or just use '/' instead: >
4925 :set path=.,c:/include
4926< Don't forget "." or files won't even be found in the same directory as
4927 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004928 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004929 it is something like 256 or 1024 characters.
4930 You can check if all the include files are found, using the value of
4931 'path', see |:checkpath|.
4932 The use of |:set+=| and |:set-=| is preferred when adding or removing
4933 directories from the list. This avoids problems when a future version
4934 uses another default. To remove the current directory use: >
4935 :set path-=
4936< To add the current directory use: >
4937 :set path+=
4938< To use an environment variable, you probably need to replace the
4939 separator. Here is an example to append $INCL, in which directory
4940 names are separated with a semi-colon: >
4941 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4942< Replace the ';' with a ':' or whatever separator is used. Note that
4943 this doesn't work when $INCL contains a comma or white space.
4944
4945 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4946'preserveindent' 'pi' boolean (default off)
4947 local to buffer
4948 {not in Vi}
4949 When changing the indent of the current line, preserve as much of the
4950 indent structure as possible. Normally the indent is replaced by a
4951 series of tabs followed by spaces as required (unless |'expandtab'| is
4952 enabled, in which case only spaces are used). Enabling this option
4953 means the indent will preserve as many existing characters as possible
4954 for indenting, and only add additional tabs or spaces as required.
4955 NOTE: When using ">>" multiple times the resulting indent is a mix of
4956 tabs and spaces. You might not like this.
4957 NOTE: 'preserveindent' is reset when 'compatible' is set.
4958 Also see 'copyindent'.
4959 Use |:retab| to clean up white space.
4960
4961 *'previewheight'* *'pvh'*
4962'previewheight' 'pvh' number (default 12)
4963 global
4964 {not in Vi}
4965 {not available when compiled without the |+windows| or
4966 |+quickfix| feature}
4967 Default height for a preview window. Used for |:ptag| and associated
4968 commands. Used for |CTRL-W_}| when no count is given.
4969
4970 *'previewwindow'* *'nopreviewwindow'*
4971 *'pvw'* *'nopvw'* *E590*
4972'previewwindow' 'pvw' boolean (default off)
4973 local to window
4974 {not in Vi}
4975 {not available when compiled without the |+windows| or
4976 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004977 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004978 set. It's normally not set directly, but by using one of the commands
4979 |:ptag|, |:pedit|, etc.
4980
4981 *'printdevice'* *'pdev'*
4982'printdevice' 'pdev' string (default empty)
4983 global
4984 {not in Vi}
4985 {only available when compiled with the |+printer|
4986 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004987 The name of the printer to be used for |:hardcopy|.
4988 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004989 This option cannot be set from a |modeline| or in the |sandbox|, for
4990 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004991
Bram Moolenaar8299df92004-07-10 09:47:34 +00004992 *'printencoding'* *'penc'*
4993'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004994 global
4995 {not in Vi}
4996 {only available when compiled with the |+printer|
4997 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004998 Sets the character encoding used when printing.
4999 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005000
5001 *'printexpr'* *'pexpr'*
5002'printexpr' 'pexpr' String (default: see below)
5003 global
5004 {not in Vi}
5005 {only available when compiled with the |+printer|
5006 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005007 Expression used to print the PostScript produced with |:hardcopy|.
5008 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005009
Bram Moolenaar8299df92004-07-10 09:47:34 +00005010 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005011'printfont' 'pfn' string (default "courier")
5012 global
5013 {not in Vi}
5014 {only available when compiled with the |+printer|
5015 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005016 The name of the font that will be used for |:hardcopy|.
5017 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005018
5019 *'printheader'* *'pheader'*
5020'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5021 global
5022 {not in Vi}
5023 {only available when compiled with the |+printer|
5024 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005025 The format of the header produced in |:hardcopy| output.
5026 See |pheader-option|.
5027
5028 *'printmbcharset'* *'pmbcs'*
5029'printmbcharset' 'pmbcs' string (default "")
5030 global
5031 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005032 {only available when compiled with the |+printer|,
5033 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005034 The CJK character set to be used for CJK output from |:hardcopy|.
5035 See |pmbcs-option|.
5036
5037 *'printmbfont'* *'pmbfn'*
5038'printmbfont' 'pmbfn' string (default "")
5039 global
5040 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005041 {only available when compiled with the |+printer|,
5042 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005043 List of font names to be used for CJK output from |:hardcopy|.
5044 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005045
5046 *'printoptions'* *'popt'*
5047'printoptions' 'popt' string (default "")
5048 global
5049 {not in Vi}
5050 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005051 List of items that control the format of the output of |:hardcopy|.
5052 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005053
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005054 *'prompt'* *'noprompt'*
5055'prompt' boolean (default on)
5056 global
5057 When on a ":" prompt is used in Ex mode.
5058
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005059 *'pumheight'* *'ph'*
5060'pumheight' 'ph' number (default 0)
5061 global
5062 {not available when compiled without the
5063 |+insert_expand| feature}
5064 {not in Vi}
5065 Determines the maximum number of items to show in the popup menu.
5066 When zero as much space as available is used.
5067 |ins-completion-menu|.
5068
5069
Bram Moolenaar677ee682005-01-27 14:41:15 +00005070 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005071'quoteescape' 'qe' string (default "\")
5072 local to buffer
5073 {not in Vi}
5074 The characters that are used to escape quotes in a string. Used for
5075 objects like a', a" and a` |a'|.
5076 When one of the characters in this option is found inside a string,
5077 the following character will be skipped. The default value makes the
5078 text "foo\"bar\\" considered to be one string.
5079
Bram Moolenaar071d4272004-06-13 20:20:40 +00005080 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5081'readonly' 'ro' boolean (default off)
5082 local to buffer
5083 If on, writes fail unless you use a '!'. Protects you from
5084 accidentally overwriting a file. Default on when Vim is started
5085 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005086 When using ":w!" the 'readonly' option is reset for the current
5087 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005088 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005089 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005090
5091 *'remap'* *'noremap'*
5092'remap' boolean (default on)
5093 global
5094 Allows for mappings to work recursively. If you do not want this for
5095 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005096 NOTE: To avoid portability problems with Vim scripts, always keep
5097 this option at the default "on". Only switch it off when working with
5098 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005099
5100 *'report'*
5101'report' number (default 2)
5102 global
5103 Threshold for reporting number of lines changed. When the number of
5104 changed lines is more than 'report' a message will be given for most
5105 ":" commands. If you want it always, set 'report' to 0.
5106 For the ":substitute" command the number of substitutions is used
5107 instead of the number of lines.
5108
5109 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5110'restorescreen' 'rs' boolean (default on)
5111 global
5112 {not in Vi} {only in Windows 95/NT console version}
5113 When set, the screen contents is restored when exiting Vim. This also
5114 happens when executing external commands.
5115
5116 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5117 options in your .vimrc. To disable restoring:
5118 set t_ti= t_te=
5119 To enable restoring (for an xterm):
5120 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5121 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5122
5123 *'revins'* *'ri'* *'norevins'* *'nori'*
5124'revins' 'ri' boolean (default off)
5125 global
5126 {not in Vi}
5127 {only available when compiled with the |+rightleft|
5128 feature}
5129 Inserting characters in Insert mode will work backwards. See "typing
5130 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5131 command in Insert mode, when 'allowrevins' is set.
5132 NOTE: This option is reset when 'compatible' or 'paste' is set.
5133
5134 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5135'rightleft' 'rl' boolean (default off)
5136 local to window
5137 {not in Vi}
5138 {only available when compiled with the |+rightleft|
5139 feature}
5140 When on, display orientation becomes right-to-left, i.e., characters
5141 that are stored in the file appear from the right to the left.
5142 Using this option, it is possible to edit files for languages that
5143 are written from the right to the left such as Hebrew and Arabic.
5144 This option is per window, so it is possible to edit mixed files
5145 simultaneously, or to view the same file in both ways (this is
5146 useful whenever you have a mixed text file with both right-to-left
5147 and left-to-right strings so that both sets are displayed properly
5148 in different windows). Also see |rileft.txt|.
5149
5150 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
5151'rightleftcmd' 'rlc' string (default "search")
5152 local to window
5153 {not in Vi}
5154 {only available when compiled with the |+rightleft|
5155 feature}
5156 Each word in this option enables the command line editing to work in
5157 right-to-left mode for a group of commands:
5158
5159 search "/" and "?" commands
5160
5161 This is useful for languages such as Hebrew, Arabic and Farsi.
5162 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5163
5164 *'ruler'* *'ru'* *'noruler'* *'noru'*
5165'ruler' 'ru' boolean (default off)
5166 global
5167 {not in Vi}
5168 {not available when compiled without the
5169 |+cmdline_info| feature}
5170 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005171 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005172 text in the file is shown on the far right:
5173 Top first line is visible
5174 Bot last line is visible
5175 All first and last line are visible
5176 45% relative position in the file
5177 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005178 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005179 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005180 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005181 this option takes precedence over 'ruler' and 'rulerformat'
5182 If the number of characters displayed is different from the number of
5183 bytes in the text (e.g., for a TAB or a multi-byte character), both
5184 the text column (byte number) and the screen column are shown,
5185 separated with a dash.
5186 For an empty line "0-1" is shown.
5187 For an empty buffer the line number will also be zero: "0,0-1".
5188 This option is reset when the 'paste' option is set.
5189 If you don't want to see the ruler all the time but want to know where
5190 you are, use "g CTRL-G" |g_CTRL-G|.
5191 NOTE: This option is reset when 'compatible' is set.
5192
5193 *'rulerformat'* *'ruf'*
5194'rulerformat' 'ruf' string (default empty)
5195 global
5196 {not in Vi}
5197 {not available when compiled without the |+statusline|
5198 feature}
5199 When this option is not empty, it determines the content of the ruler
5200 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005201 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005202 The default ruler width is 17 characters. To make the ruler 15
5203 characters wide, put "%15(" at the start and "%)" at the end.
5204 Example: >
5205 :set rulerformat=%15(%c%V\ %p%%%)
5206<
5207 *'runtimepath'* *'rtp'* *vimfiles*
5208'runtimepath' 'rtp' string (default:
5209 Unix: "$HOME/.vim,
5210 $VIM/vimfiles,
5211 $VIMRUNTIME,
5212 $VIM/vimfiles/after,
5213 $HOME/.vim/after"
5214 Amiga: "home:vimfiles,
5215 $VIM/vimfiles,
5216 $VIMRUNTIME,
5217 $VIM/vimfiles/after,
5218 home:vimfiles/after"
5219 PC, OS/2: "$HOME/vimfiles,
5220 $VIM/vimfiles,
5221 $VIMRUNTIME,
5222 $VIM/vimfiles/after,
5223 $HOME/vimfiles/after"
5224 Macintosh: "$VIM:vimfiles,
5225 $VIMRUNTIME,
5226 $VIM:vimfiles:after"
5227 RISC-OS: "Choices:vimfiles,
5228 $VIMRUNTIME,
5229 Choices:vimfiles/after"
5230 VMS: "sys$login:vimfiles,
5231 $VIM/vimfiles,
5232 $VIMRUNTIME,
5233 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005234 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005235 global
5236 {not in Vi}
5237 This is a list of directories which will be searched for runtime
5238 files:
5239 filetype.vim filetypes by file name |new-filetype|
5240 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005241 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005242 colors/ color scheme files |:colorscheme|
5243 compiler/ compiler files |:compiler|
5244 doc/ documentation |write-local-help|
5245 ftplugin/ filetype plugins |write-filetype-plugin|
5246 indent/ indent scripts |indent-expression|
5247 keymap/ key mapping files |mbyte-keymap|
5248 lang/ menu translations |:menutrans|
5249 menu.vim GUI menus |menu.vim|
5250 plugin/ plugin scripts |write-plugin|
5251 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005252 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005253 syntax/ syntax files |mysyntaxfile|
5254 tutor/ files for vimtutor |tutor|
5255
5256 And any other file searched for with the |:runtime| command.
5257
5258 The defaults for most systems are setup to search five locations:
5259 1. In your home directory, for your personal preferences.
5260 2. In a system-wide Vim directory, for preferences from the system
5261 administrator.
5262 3. In $VIMRUNTIME, for files distributed with Vim.
5263 *after-directory*
5264 4. In the "after" directory in the system-wide Vim directory. This is
5265 for the system administrator to overrule or add to the distributed
5266 defaults (rarely needed)
5267 5. In the "after" directory in your home directory. This is for
5268 personal preferences to overrule or add to the distributed defaults
5269 or system-wide settings (rarely needed).
5270
5271 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5272 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005273 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005274 wildcards.
5275 See |:runtime|.
5276 Example: >
5277 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5278< This will use the directory "~/vimruntime" first (containing your
5279 personal Vim runtime files), then "/mygroup/vim" (shared between a
5280 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5281 files).
5282 You probably should always include $VIMRUNTIME somewhere, to use the
5283 distributed runtime files. You can put a directory before $VIMRUNTIME
5284 to find files which replace a distributed runtime files. You can put
5285 a directory after $VIMRUNTIME to find files which add to distributed
5286 runtime files.
5287 This option cannot be set from a |modeline| or in the |sandbox|, for
5288 security reasons.
5289
5290 *'scroll'* *'scr'*
5291'scroll' 'scr' number (default: half the window height)
5292 local to window
5293 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5294 set to half the number of lines in the window when the window size
5295 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005296 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005297 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5298 the number of screen lines instead of file lines, makes a difference
5299 when lines wrap}
5300
5301 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5302'scrollbind' 'scb' boolean (default off)
5303 local to window
5304 {not in Vi}
5305 {not available when compiled without the |+scrollbind|
5306 feature}
5307 See also |scroll-binding|. When this option is set, the current
5308 window scrolls as other scrollbind windows (windows that also have
5309 this option set) scroll. This option is useful for viewing the
5310 differences between two versions of a file, see 'diff'.
5311 See |'scrollopt'| for options that determine how this option should be
5312 interpreted.
5313 This option is mostly reset when splitting a window to edit another
5314 file. This means that ":split | edit file" results in two windows
5315 with scroll-binding, but ":split file" does not.
5316
5317 *'scrolljump'* *'sj'*
5318'scrolljump' 'sj' number (default 1)
5319 global
5320 {not in Vi}
5321 Minimal number of lines to scroll when the cursor gets off the
5322 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5323 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005324 When set to a negative number from -1 to -100 this is used as the
5325 percentage of the window height. Thus -50 scrolls half the window
5326 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005327 NOTE: This option is set to 1 when 'compatible' is set.
5328
5329 *'scrolloff'* *'so'*
5330'scrolloff' 'so' number (default 0)
5331 global
5332 {not in Vi}
5333 Minimal number of screen lines to keep above and below the cursor.
5334 This will make some context visible around where you are working. If
5335 you set it to a very large value (999) the cursor line will always be
5336 in the middle of the window (except at the start or end of the file or
5337 when long lines wrap).
5338 For scrolling horizontally see 'sidescrolloff'.
5339 NOTE: This option is set to 0 when 'compatible' is set.
5340
5341 *'scrollopt'* *'sbo'*
5342'scrollopt' 'sbo' string (default "ver,jump")
5343 global
5344 {not available when compiled without the |+scrollbind|
5345 feature}
5346 {not in Vi}
5347 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005348 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5349 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005350 The following words are available:
5351 ver Bind vertical scrolling for 'scrollbind' windows
5352 hor Bind horizontal scrolling for 'scrollbind' windows
5353 jump Applies to the offset between two windows for vertical
5354 scrolling. This offset is the difference in the first
5355 displayed line of the bound windows. When moving
5356 around in a window, another 'scrollbind' window may
5357 reach a position before the start or after the end of
5358 the buffer. The offset is not changed though, when
5359 moving back the 'scrollbind' window will try to scroll
5360 to the desired position when possible.
5361 When now making that window the current one, two
5362 things can be done with the relative offset:
5363 1. When "jump" is not included, the relative offset is
5364 adjusted for the scroll position in the new current
5365 window. When going back to the other window, the
5366 the new relative offset will be used.
5367 2. When "jump" is included, the other windows are
5368 scrolled to keep the same relative offset. When
5369 going back to the other window, it still uses the
5370 same relative offset.
5371 Also see |scroll-binding|.
5372
5373 *'sections'* *'sect'*
5374'sections' 'sect' string (default "SHNHH HUnhsh")
5375 global
5376 Specifies the nroff macros that separate sections. These are pairs of
5377 two letters (See |object-motions|). The default makes a section start
5378 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5379
5380 *'secure'* *'nosecure'* *E523*
5381'secure' boolean (default off)
5382 global
5383 {not in Vi}
5384 When on, ":autocmd", shell and write commands are not allowed in
5385 ".vimrc" and ".exrc" in the current directory and map commands are
5386 displayed. Switch it off only if you know that you will not run into
5387 problems, or when the 'exrc' option is off. On Unix this option is
5388 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005389 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005390 'secure' at the end of your ~/.vimrc then.
5391 This option cannot be set from a |modeline| or in the |sandbox|, for
5392 security reasons.
5393
5394 *'selection'* *'sel'*
5395'selection' 'sel' string (default "inclusive")
5396 global
5397 {not in Vi}
5398 This option defines the behavior of the selection. It is only used
5399 in Visual and Select mode.
5400 Possible values:
5401 value past line inclusive ~
5402 old no yes
5403 inclusive yes yes
5404 exclusive yes no
5405 "past line" means that the cursor is allowed to be positioned one
5406 character past the line.
5407 "inclusive" means that the last character of the selection is included
5408 in an operation. For example, when "x" is used to delete the
5409 selection.
5410 Note that when "exclusive" is used and selecting from the end
5411 backwards, you cannot include the last character of a line, when
5412 starting in Normal mode and 'virtualedit' empty.
5413
5414 The 'selection' option is set by the |:behave| command.
5415
5416 *'selectmode'* *'slm'*
5417'selectmode' 'slm' string (default "")
5418 global
5419 {not in Vi}
5420 This is a comma separated list of words, which specifies when to start
5421 Select mode instead of Visual mode, when a selection is started.
5422 Possible values:
5423 mouse when using the mouse
5424 key when using shifted special keys
5425 cmd when using "v", "V" or CTRL-V
5426 See |Select-mode|.
5427 The 'selectmode' option is set by the |:behave| command.
5428
5429 *'sessionoptions'* *'ssop'*
5430'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
5431 help,options,winsize")
5432 global
5433 {not in Vi}
5434 {not available when compiled without the +mksession
5435 feature}
5436 Changes the effect of the |:mksession| command. It is a comma
5437 separated list of words. Each word enables saving and restoring
5438 something:
5439 word save and restore ~
5440 blank empty windows
5441 buffers hidden and unloaded buffers, not just those in windows
5442 curdir the current directory
5443 folds manually created folds, opened/closed folds and local
5444 fold options
5445 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005446 and contain at least one lowercase letter. Only
5447 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005448 help the help window
5449 localoptions options and mappings local to a window or buffer (not
5450 global values for local options)
5451 options all options and mappings (also global values for local
5452 options)
5453 resize size of the Vim window: 'lines' and 'columns'
5454 sesdir the directory in which the session file is located
5455 will become the current directory (useful with
5456 projects accessed over a network from different
5457 systems)
5458 slash backslashes in file names replaced with forward
5459 slashes
5460 unix with Unix end-of-line format (single <NL>), even when
5461 on Windows or DOS
5462 winpos position of the whole Vim window
5463 winsize window sizes
5464
5465 Don't include both "curdir" and "sesdir".
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00005466 There is no option to include tab pages yet, only the current tab page
5467 is stored in the session. |tab-page|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005468 When "curdir" nor "sesdir" is included, file names are stored with
5469 absolute paths.
5470 "slash" and "unix" are useful on Windows when sharing session files
5471 with Unix. The Unix version of Vim cannot source dos format scripts,
5472 but the Windows version of Vim can source unix format scripts.
5473
5474 *'shell'* *'sh'* *E91*
5475'shell' 'sh' string (default $SHELL or "sh",
5476 MS-DOS and Win32: "command.com" or
5477 "cmd.exe", OS/2: "cmd")
5478 global
5479 Name of the shell to use for ! and :! commands. When changing the
5480 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5481 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005482 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005483 See |option-backslash| about including spaces and backslashes.
5484 Environment variables are expanded |:set_env|.
5485 If the name of the shell contains a space, you might need to enclose
5486 it in quotes. Example: >
5487 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5488< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005489 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005490 "-f" is not inside the quotes, because it is not part of the command
5491 name. And Vim automagically recognizes the backslashes that are path
5492 separators.
5493 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5494 variable to change the way external commands are executed. See the
5495 libc.inf file of DJGPP.
5496 Under MS-Windows, when the executable ends in ".com" it must be
5497 included. Thus setting the shell to "command.com" or "4dos.com"
5498 works, but "command" and "4dos" do not work for all commands (e.g.,
5499 filtering).
5500 For unknown reasons, when using "4dos.com" the current directory is
5501 changed to "C:\". To avoid this set 'shell' like this: >
5502 :set shell=command.com\ /c\ 4dos
5503< This option cannot be set from a |modeline| or in the |sandbox|, for
5504 security reasons.
5505
5506 *'shellcmdflag'* *'shcf'*
5507'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5508 does not contain "sh" somewhere: "/c")
5509 global
5510 {not in Vi}
5511 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5512 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5513 systems, the default is set according to the value of 'shell', to
5514 reduce the need to set this option by the user. It's not used for
5515 OS/2 (EMX figures this out itself). See |option-backslash| about
5516 including spaces and backslashes. See |dos-shell|.
5517 This option cannot be set from a |modeline| or in the |sandbox|, for
5518 security reasons.
5519
5520 *'shellpipe'* *'sp'*
5521'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5522 global
5523 {not in Vi}
5524 {not available when compiled without the |+quickfix|
5525 feature}
5526 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005527 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005528 including spaces and backslashes.
5529 The name of the temporary file can be represented by "%s" if necessary
5530 (the file name is appended automatically if no %s appears in the value
5531 of this option).
5532 For the Amiga and MS-DOS the default is ">". The output is directly
5533 saved in a file and not echoed to the screen.
5534 For Unix the default it "| tee". The stdout of the compiler is saved
5535 in a file and echoed to the screen. If the 'shell' option is "csh" or
5536 "tcsh" after initializations, the default becomes "|& tee". If the
5537 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5538 "2>&1| tee". This means that stderr is also included.
5539 The initialization of this option is done after reading the ".vimrc"
5540 and the other initializations, so that when the 'shell' option is set
5541 there, the 'shellpipe' option changes automatically, unless it was
5542 explicitly set before.
5543 When 'shellpipe' is set to an empty string, no redirection of the
5544 ":make" output will be done. This is useful if you use a 'makeprg'
5545 that writes to 'makeef' by itself. If you want no piping, but do
5546 want to include the 'makeef', set 'shellpipe' to a single space.
5547 Don't forget to precede the space with a backslash: ":set sp=\ ".
5548 In the future pipes may be used for filtering and this option will
5549 become obsolete (at least for Unix).
5550 This option cannot be set from a |modeline| or in the |sandbox|, for
5551 security reasons.
5552
5553 *'shellquote'* *'shq'*
5554'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5555 contains "sh" somewhere: "\"")
5556 global
5557 {not in Vi}
5558 Quoting character(s), put around the command passed to the shell, for
5559 the "!" and ":!" commands. The redirection is kept outside of the
5560 quoting. See 'shellxquote' to include the redirection. It's
5561 probably not useful to set both options.
5562 This is an empty string by default. Only known to be useful for
5563 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5564 or bash, where it should be "\"". The default is adjusted according
5565 the value of 'shell', to reduce the need to set this option by the
5566 user. See |dos-shell|.
5567 This option cannot be set from a |modeline| or in the |sandbox|, for
5568 security reasons.
5569
5570 *'shellredir'* *'srr'*
5571'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5572 global
5573 {not in Vi}
5574 String to be used to put the output of a filter command in a temporary
5575 file. See also |:!|. See |option-backslash| about including spaces
5576 and backslashes.
5577 The name of the temporary file can be represented by "%s" if necessary
5578 (the file name is appended automatically if no %s appears in the value
5579 of this option).
5580 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5581 or "zsh" during initializations, the default becomes ">&". If the
5582 'shell' option is "sh", "ksh" or "bash" the default becomes
5583 ">%s 2>&1". This means that stderr is also included.
5584 For Win32, the Unix checks are done and additionally "cmd" is checked
5585 for, which makes the default ">%s 2>&1". Also, the same names with
5586 ".exe" appended are checked for.
5587 The initialization of this option is done after reading the ".vimrc"
5588 and the other initializations, so that when the 'shell' option is set
5589 there, the 'shellredir' option changes automatically unless it was
5590 explicitly set before.
5591 In the future pipes may be used for filtering and this option will
5592 become obsolete (at least for Unix).
5593 This option cannot be set from a |modeline| or in the |sandbox|, for
5594 security reasons.
5595
5596 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5597'shellslash' 'ssl' boolean (default off)
5598 global
5599 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5600 When set, a forward slash is used when expanding file names. This is
5601 useful when a Unix-like shell is used instead of command.com or
5602 cmd.exe. Backward slashes can still be typed, but they are changed to
5603 forward slashes by Vim.
5604 Note that setting or resetting this option has no effect for some
5605 existing file names, thus this option needs to be set before opening
5606 any file for best results. This might change in the future.
5607 'shellslash' only works when a backslash can be used as a path
5608 separator. To test if this is so use: >
5609 if exists('+shellslash')
5610<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005611 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5612'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5613 global
5614 {not in Vi}
5615 When on, use temp files for shell commands. When off use a pipe.
5616 When using a pipe is not possible temp files are used anyway.
5617 Currently a pipe is only supported on Unix. You can check it with: >
5618 :if has("filterpipe")
5619< The advantage of using a pipe is that nobody can read the temp file
5620 and the 'shell' command does not need to support redirection.
5621 The advantage of using a temp file is that the file type and encoding
5622 can be detected.
5623 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5624 |FilterWritePost| autocommands event are not triggered when
5625 'shelltemp' is off.
5626
Bram Moolenaar071d4272004-06-13 20:20:40 +00005627 *'shelltype'* *'st'*
5628'shelltype' 'st' number (default 0)
5629 global
5630 {not in Vi} {only for the Amiga}
5631 On the Amiga this option influences the way how the commands work
5632 which use a shell.
5633 0 and 1: always use the shell
5634 2 and 3: use the shell only to filter lines
5635 4 and 5: use shell only for ':sh' command
5636 When not using the shell, the command is executed directly.
5637
5638 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5639 1 and 3: use "shell cmd" to start external commands
5640
5641 *'shellxquote'* *'sxq'*
5642'shellxquote' 'sxq' string (default: "";
5643 for Win32, when 'shell' contains "sh"
5644 somewhere: "\""
5645 for Unix, when using system(): "\"")
5646 global
5647 {not in Vi}
5648 Quoting character(s), put around the command passed to the shell, for
5649 the "!" and ":!" commands. Includes the redirection. See
5650 'shellquote' to exclude the redirection. It's probably not useful
5651 to set both options.
5652 This is an empty string by default. Known to be useful for
5653 third-party shells when using the Win32 version, such as the MKS Korn
5654 Shell or bash, where it should be "\"". The default is adjusted
5655 according the value of 'shell', to reduce the need to set this option
5656 by the user. See |dos-shell|.
5657 This option cannot be set from a |modeline| or in the |sandbox|, for
5658 security reasons.
5659
5660 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5661'shiftround' 'sr' boolean (default off)
5662 global
5663 {not in Vi}
5664 Round indent to multiple of 'shiftwidth'. Applies to > and <
5665 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5666 a multiple of 'shiftwidth' (this is Vi compatible).
5667 NOTE: This option is reset when 'compatible' is set.
5668
5669 *'shiftwidth'* *'sw'*
5670'shiftwidth' 'sw' number (default 8)
5671 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005672 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005673 |'cindent'|, |>>|, |<<|, etc.
5674
5675 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005676'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5677 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005678 global
5679 {not in Vi}
5680 This option helps to avoid all the |hit-enter| prompts caused by file
5681 messages, for example with CTRL-G, and to avoid some other messages.
5682 It is a list of flags:
5683 flag meaning when present ~
5684 f use "(3 of 5)" instead of "(file 3 of 5)"
5685 i use "[noeol]" instead of "[Incomplete last line]"
5686 l use "999L, 888C" instead of "999 lines, 888 characters"
5687 m use "[+]" instead of "[Modified]"
5688 n use "[New]" instead of "[New File]"
5689 r use "[RO]" instead of "[readonly]"
5690 w use "[w]" instead of "written" for file write message
5691 and "[a]" instead of "appended" for ':w >> file' command
5692 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5693 "[unix format]" and "[mac]" instead of "[mac format]".
5694 a all of the above abbreviations
5695
5696 o overwrite message for writing a file with subsequent message
5697 for reading a file (useful for ":wn" or when 'autowrite' on)
5698 O message for reading a file overwrites any previous message.
5699 Also for quickfix message (e.g., ":cn").
5700 s don't give "search hit BOTTOM, continuing at TOP" or "search
5701 hit TOP, continuing at BOTTOM" messages
5702 t truncate file message at the start if it is too long to fit
5703 on the command-line, "<" will appear in the left most column.
5704 Ignored in Ex mode.
5705 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005706 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005707 Ignored in Ex mode.
5708 W don't give "written" or "[w]" when writing a file
5709 A don't give the "ATTENTION" message when an existing swap file
5710 is found.
5711 I don't give the intro message when starting Vim |:intro|.
5712
5713 This gives you the opportunity to avoid that a change between buffers
5714 requires you to hit <Enter>, but still gives as useful a message as
5715 possible for the space available. To get the whole message that you
5716 would have got with 'shm' empty, use ":file!"
5717 Useful values:
5718 shm= No abbreviation of message.
5719 shm=a Abbreviation, but no loss of information.
5720 shm=at Abbreviation, and truncate message when necessary.
5721
5722 NOTE: This option is set to the Vi default value when 'compatible' is
5723 set and to the Vim default value when 'compatible' is reset.
5724
5725 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5726'shortname' 'sn' boolean (default off)
5727 local to buffer
5728 {not in Vi, not in MS-DOS versions}
5729 Filenames are assumed to be 8 characters plus one extension of 3
5730 characters. Multiple dots in file names are not allowed. When this
5731 option is on, dots in file names are replaced with underscores when
5732 adding an extension (".~" or ".swp"). This option is not available
5733 for MS-DOS, because then it would always be on. This option is useful
5734 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5735 or crossdos. When running the Win32 GUI version under Win32s, this
5736 option is always on by default.
5737
5738 *'showbreak'* *'sbr'* *E595*
5739'showbreak' 'sbr' string (default "")
5740 global
5741 {not in Vi}
5742 {not available when compiled without the |+linebreak|
5743 feature}
5744 String to put at the start of lines that have been wrapped. Useful
5745 values are "> " or "+++ ".
5746 Only printable single-cell characters are allowed, excluding <Tab> and
5747 comma (in a future version the comma might be used to separate the
5748 part that is shown at the end and at the start of a line).
5749 The characters are highlighted according to the '@' flag in
5750 'highlight'.
5751 Note that tabs after the showbreak will be displayed differently.
5752 If you want the 'showbreak' to appear in between line numbers, add the
5753 "n" flag to 'cpoptions'.
5754
5755 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5756'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5757 off)
5758 global
5759 {not in Vi}
5760 {not available when compiled without the
5761 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005762 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005763 terminal is slow.
5764 In Visual mode the size of the selected area is shown:
5765 - When selecting characters within a line, the number of characters.
5766 - When selecting more than one line, the number of lines.
5767 - When selecting a block, the size in screen characters: linesxcolumns.
5768 NOTE: This option is set to the Vi default value when 'compatible' is
5769 set and to the Vim default value when 'compatible' is reset.
5770
5771 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5772'showfulltag' 'sft' boolean (default off)
5773 global
5774 {not in Vi}
5775 When completing a word in insert mode (see |ins-completion|) from the
5776 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005777 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005778 matched a C function, you can see a template for what arguments are
5779 required (coding style permitting).
5780
5781 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5782'showmatch' 'sm' boolean (default off)
5783 global
5784 When a bracket is inserted, briefly jump to the matching one. The
5785 jump is only done if the match can be seen on the screen. The time to
5786 show the match can be set with 'matchtime'.
5787 A Beep is given if there is no match (no matter if the match can be
5788 seen or not). This option is reset when the 'paste' option is set.
5789 When the 'm' flag is not included in 'cpoptions', typing a character
5790 will immediately move the cursor back to where it belongs.
5791 See the "sm" field in 'guicursor' for setting the cursor shape and
5792 blinking when showing the match.
5793 The 'matchpairs' option can be used to specify the characters to show
5794 matches for. 'rightleft' and 'revins' are used to look for opposite
5795 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005796 Also see the matchparen plugin for highlighting the match when moving
5797 around |pi_paren.txt|.
5798 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005799
5800 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5801'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5802 global
5803 If in Insert, Replace or Visual mode put a message on the last line.
5804 Use the 'M' flag in 'highlight' to set the type of highlighting for
5805 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005806 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005807 doesn't mean XIM is really active, especially when 'imactivatekey' is
5808 not set.
5809 NOTE: This option is set to the Vi default value when 'compatible' is
5810 set and to the Vim default value when 'compatible' is reset.
5811
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00005812 *'showtabline'* *'stal'*
5813'showtabline' 'stal' number (default 1)
5814 global
5815 {not in Vi}
5816 {not available when compiled without the +windows
5817 feature}
5818 The value of this option specifies when the line with tab page labels
5819 will be displayed:
5820 0: never
5821 1: only if there are at least two tab pages
5822 2: always
5823 This is both for the GUI and non-GUI implementation of the tab pages
5824 line.
5825 See |tab-page| for more information about tab pages.
5826
Bram Moolenaar071d4272004-06-13 20:20:40 +00005827 *'sidescroll'* *'ss'*
5828'sidescroll' 'ss' number (default 0)
5829 global
5830 {not in Vi}
5831 The minimal number of columns to scroll horizontally. Used only when
5832 the 'wrap' option is off and the cursor is moved off of the screen.
5833 When it is zero the cursor will be put in the middle of the screen.
5834 When using a slow terminal set it to a large number or 0. When using
5835 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5836 commands.
5837
5838 *'sidescrolloff'* *'siso'*
5839'sidescrolloff' 'siso' number (default 0)
5840 global
5841 {not in Vi}
5842 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005843 right of the cursor if 'nowrap' is set. Setting this option to a
5844 value greater than 0 while having |'sidescroll'| also at a non-zero
5845 value makes some context visible in the line you are scrolling in
5846 horizontally (except at beginning of the line). Setting this option
5847 to a large value (like 999) has the effect of keeping the cursor
5848 horizontally centered in the window, as long as one does not come too
5849 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005850 NOTE: This option is set to 0 when 'compatible' is set.
5851
5852 Example: Try this together with 'sidescroll' and 'listchars' as
5853 in the following example to never allow the cursor to move
5854 onto the "extends" character:
5855
5856 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5857 :set sidescrolloff=1
5858
5859
5860 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5861'smartcase' 'scs' boolean (default off)
5862 global
5863 {not in Vi}
5864 Override the 'ignorecase' option if the search pattern contains upper
5865 case characters. Only used when the search pattern is typed and
5866 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005867 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005868 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5869 recalling the search pattern from history and hitting <Enter>.
5870 NOTE: This option is reset when 'compatible' is set.
5871
5872 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5873'smartindent' 'si' boolean (default off)
5874 local to buffer
5875 {not in Vi}
5876 {not available when compiled without the
5877 |+smartindent| feature}
5878 Do smart autoindenting when starting a new line. Works for C-like
5879 programs, but can also be used for other languages. 'cindent' does
5880 something like this, works better in most cases, but is more strict,
5881 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5882 'indentexpr' is a more advanced alternative.
5883 Normally 'autoindent' should also be on when using 'smartindent'.
5884 An indent is automatically inserted:
5885 - After a line ending in '{'.
5886 - After a line starting with a keyword from 'cinwords'.
5887 - Before a line starting with '}' (only with the "O" command).
5888 When typing '}' as the first character in a new line, that line is
5889 given the same indent as the matching '{'.
5890 When typing '#' as the first character in a new line, the indent for
5891 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005892 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005893 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5894 When using the ">>" command, lines starting with '#' are not shifted
5895 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005896 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005897 is set smart indenting is disabled.
5898
5899 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5900'smarttab' 'sta' boolean (default off)
5901 global
5902 {not in Vi}
5903 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00005904 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
5905 <BS> will delete a 'shiftwidth' worth of space at the start of the
5906 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005907 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00005908 'softtabstop'. 'shiftwidth' is only used for shifting text left or
5909 right |shift-left-right|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005910 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5911 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005912 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005913 NOTE: This option is reset when 'compatible' is set.
5914
5915 *'softtabstop'* *'sts'*
5916'softtabstop' 'sts' number (default 0)
5917 local to buffer
5918 {not in Vi}
5919 Number of spaces that a <Tab> counts for while performing editing
5920 operations, like inserting a <Tab> or using <BS>. It "feels" like
5921 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5922 used. This is useful to keep the 'ts' setting at its standard value
5923 of 8, while being able to edit like it is set to 'sts'. However,
5924 commands like "x" still work on the actual characters.
5925 When 'sts' is zero, this feature is off.
5926 'softtabstop' is set to 0 when the 'paste' option is set.
5927 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5928 spaces is minimized by using <Tab>s.
5929 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5930 set.
5931 NOTE: This option is set to 0 when 'compatible' is set.
5932
Bram Moolenaar217ad922005-03-20 22:37:15 +00005933 *'spell'* *'nospell'*
5934'spell' boolean (default off)
5935 local to window
5936 {not in Vi}
5937 {not available when compiled without the |+syntax|
5938 feature}
5939 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005940 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005941
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005942 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005943'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005944 local to buffer
5945 {not in Vi}
5946 {not available when compiled without the |+syntax|
5947 feature}
5948 Pattern to locate the end of a sentence. The following word will be
5949 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005950 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005951 When this check is not wanted make this option empty.
5952 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005953 Be careful with special characters, see |option-backslash| about
5954 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005955 To set this option automatically depending on the language, see
5956 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005957
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005958 *'spellfile'* *'spf'*
5959'spellfile' 'spf' string (default empty)
5960 local to buffer
5961 {not in Vi}
5962 {not available when compiled without the |+syntax|
5963 feature}
5964 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00005965 commands. It must end in ".{encoding}.add". You need to include the
5966 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005967 *E765*
5968 It may also be a comma separated list of names. A count before the
5969 |zg| and |zw| commands can be used to access each. This allows using
5970 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005971 When a word is added while this option is empty Vim will set it for
5972 you: Using the first "spell" directory in 'runtimepath' that is
Bram Moolenaar3b506942005-06-23 22:36:45 +00005973 writable and the first language name that appears in 'spelllang',
5974 ignoring the region.
5975 The resulting ".spl" file will be used for spell checking, it does not
5976 have to appear in 'spelllang'.
5977 Normally one file is used for all regions, but you can add the region
5978 name if you want to. However, it will then only be used when
5979 'spellfile' is set to it, for entries in 'spelllang' only files
5980 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00005981 This option cannot be set from a |modeline| or in the |sandbox|, for
5982 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005983
Bram Moolenaar217ad922005-03-20 22:37:15 +00005984 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005985'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00005986 local to buffer
5987 {not in Vi}
5988 {not available when compiled without the |+syntax|
5989 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00005990 A comma separated list of word list names. When the 'spell' option is
5991 on spellchecking will be done for these languages. Example: >
5992 set spelllang=en_us,nl,medical
5993< This means US English, Dutch and medical words are recognized. Words
5994 that are not recognized will be highlighted.
5995 The word list name must not include a comma or dot. Using a dash is
5996 recommended to separate the two letter language name from a
5997 specification. Thus "en-rare" is used for rare English words.
5998 A region name must come last and have the form "_xx", where "xx" is
5999 the two-letter, lower case region name. You can use more than one
6000 region by listing them: "en_us,en_ca" supports both US and Canadian
6001 English, but not words specific for Australia, New Zealand or Great
6002 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006003 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006004 As a special case the name of a .spl file can be given as-is. The
6005 first "_xx" in the name is removed and used as the region name
6006 (_xx is an underscore, two letters and followed by a non-letter).
6007 This is mainly for testing purposes. You must make sure the correct
6008 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006009 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006010 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6011 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006012 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006013
Bram Moolenaar98692072006-02-04 00:57:42 +00006014 If the |spellfile.vim| plugin is active and you use a language name
6015 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6016 will ask you if you want to download the file.
6017
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006018 After this option has been set successfully, Vim will source the files
6019 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006020 up to the first comma, dot or underscore.
6021 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006022
6023
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006024 *'spellsuggest'* *'sps'*
6025'spellsuggest' 'sps' string (default "best")
6026 global
6027 {not in Vi}
6028 {not available when compiled without the |+syntax|
6029 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006030 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006031 the |spellsuggest()| function. This is a comma-separated list of
6032 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006033
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006034 best Internal method that works best for English. Finds
6035 changes like "fast" and uses a bit of sound-a-like
6036 scoring to improve the ordering.
6037
6038 double Internal method that uses two methods and mixes the
6039 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006040 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006041 word. That only works when the language specifies
6042 sound folding. Can be slow and doesn't always give
6043 better results.
6044
6045 fast Internal method that only checks for simple changes:
6046 character inserts/deletes/swaps. Works well for
6047 simple typing mistakes.
6048
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006049 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006050 Not used for |spellsuggest()|. The number of
6051 suggestions is never more than the value of 'lines'
6052 minus two.
6053
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006054 file:{filename} Read file {filename}, which must have two columns,
6055 separated by a slash. The first column contains the
6056 bad word, the second column the suggested good word.
6057 Example:
6058 theribal/terrible ~
6059 Use this for common mistakes that do not appear at the
6060 top of the suggestion list with the internal methods.
6061 Lines without a slash are ignored, use this for
6062 comments.
6063 The file is used for all languages.
6064
6065 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6066 trouble with spaces. |v:val| holds the badly spelled
6067 word. The expression must evaluate to a List of
6068 Lists, each with a suggestion and a score.
6069 Example:
6070 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006071 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006072 internal methods use. A lower score is better.
6073 This may invoke |spellsuggest()| if you temporarily
6074 set 'spellsuggest' to exclude the "expr:" part.
6075 Errors are silently ignored, unless you set the
6076 'verbose' option to a non-zero value.
6077
6078 Only one of "best", "double" or "fast" may be used. The others may
6079 appear several times in any order. Example: >
6080 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6081<
6082 This option cannot be set from a |modeline| or in the |sandbox|, for
6083 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006084
6085
Bram Moolenaar071d4272004-06-13 20:20:40 +00006086 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6087'splitbelow' 'sb' boolean (default off)
6088 global
6089 {not in Vi}
6090 {not available when compiled without the +windows
6091 feature}
6092 When on, splitting a window will put the new window below the current
6093 one. |:split|
6094
6095 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6096'splitright' 'spr' boolean (default off)
6097 global
6098 {not in Vi}
6099 {not available when compiled without the +vertsplit
6100 feature}
6101 When on, splitting a window will put the new window right of the
6102 current one. |:vsplit|
6103
6104 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6105'startofline' 'sol' boolean (default on)
6106 global
6107 {not in Vi}
6108 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006109 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006110 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006111 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006112 with a linewise operator, with "%" with a count and to buffer changing
6113 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6114 only has a line number, e.g., ":25" or ":+".
6115 In case of buffer changing commands the cursor is placed at the column
6116 where it was the last time the buffer was edited.
6117 NOTE: This option is set when 'compatible' is set.
6118
6119 *'statusline'* *'stl'* *E540* *E541* *E542*
6120'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006121 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006122 {not in Vi}
6123 {not available when compiled without the |+statusline|
6124 feature}
6125 When nonempty, this option determines the content of the status line.
6126 Also see |status-line|.
6127
6128 The option consists of printf style '%' items interspersed with
6129 normal text. Each status line item is of the form:
6130 %-0{minwid}.{maxwid}{item}
6131 All fields except the {item} is optional. A single percent sign can
6132 be given as "%%". Up to 80 items can be specified.
6133
Bram Moolenaar238a5642006-02-21 22:12:05 +00006134 When the option starts with "%!" then it is used as an expression,
6135 evaluated and the result is used as the option value. Example: >
6136 :set statusline=%!MyStatusLine()
6137< The result can contain %{} items that will be evaluated too.
6138
6139 When there is error while evaluating the option then it will be made
6140 empty to avoid further errors. Otherwise screen updating would loop.
6141
Bram Moolenaar071d4272004-06-13 20:20:40 +00006142 Note that the only effect of 'ruler' when this option is set (and
6143 'laststatus' is 2) is controlling the output of |CTRL-G|.
6144
6145 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006146 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006147 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006148 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006149 minwid Minimum width of the item, padding as set by '-' & '0'.
6150 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006151 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006152 on the left for text items. Numeric items will be
6153 shifted down to maxwid-2 digits followed by '>'number
6154 where number is the amount of missing digits, much like
6155 an exponential notation.
6156 item A one letter code as described below.
6157
6158 Following is a description of the possible statusline items. The
6159 second character in "item" is the type:
6160 N for number
6161 S for string
6162 F for flags as described below
6163 - not applicable
6164
6165 item meaning ~
6166 f S Path to the file in the buffer, relative to current directory.
6167 F S Full path to the file in the buffer.
6168 t S File name (tail) of file in the buffer.
6169 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
6170 M F Modified flag, text is ",+" or ",-".
6171 r F Readonly flag, text is " [RO]".
6172 R F Readonly flag, text is ",RO".
6173 h F Help buffer flag, text is " [help]".
6174 H F Help buffer flag, text is ",HLP".
6175 w F Preview window flag, text is " [Preview]".
6176 W F Preview window flag, text is ",PRV".
6177 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
6178 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6179 {not available when compiled without |+autocmd| feature}
6180 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6181 being used: "<keymap>"
6182 n N Buffer number.
6183 b N Value of byte under cursor.
6184 B N As above, in hexadecimal.
6185 o N Byte number in file of byte under cursor, first byte is 1.
6186 Mnemonic: Offset from start of file (with one added)
6187 {not available when compiled without |+byte_offset| feature}
6188 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006189 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006190 l N Line number.
6191 L N Number of lines in buffer.
6192 c N Column number.
6193 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006194 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006195 p N Percentage through file in lines as in |CTRL-G|.
6196 P S Percentage through file of displayed window. This is like the
6197 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006198 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006199 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006200 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006201 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006202 ( - Start of item group. Can be used for setting the width and
6203 alignment of a section. Must be followed by %) somewhere.
6204 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006205 T N For 'tabline': start of tab page N label. Use %T after the last
6206 label. This information is used for mouse clicks.
6207 X N For 'tabline': start of close tab N label. Use %X after the
6208 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6209 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006210 < - Where to truncate line if too long. Default is at the start.
6211 No width fields allowed.
6212 = - Separation point between left and right aligned items.
6213 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006214 # - Set highlight group. The name must follow and then a # again.
6215 Thus use %#HLname# for highlight group HLname. The same
6216 highlighting is used, also for the statusline of non-current
6217 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006218 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006219 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006220 The difference between User{N} and StatusLine will be applied
6221 to StatusLineNC for the statusline of non-current windows.
6222 The number N must be between 1 and 9. See |hl-User1..9|
6223
6224 Display of flags are controlled by the following heuristic:
6225 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006226 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00006227 with a space it is assumed that it wants to separate itself from
6228 anything but other flags. That is: A leading comma is removed if the
6229 preceding character stems from plaintext. A leading space is removed
Bram Moolenaar582fd852005-03-28 20:58:01 +00006230 if the preceding character stems from another active flag. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006231 make a nice display when flags are used like in the examples below.
6232
Bram Moolenaar582fd852005-03-28 20:58:01 +00006233 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006234 not set) and a minwid is not set for the group, the whole group will
6235 become empty. This will make a group like the following disappear
6236 completely from the statusline when none of the flags are set. >
6237 :set statusline=...%(\ [%M%R%H]%)...
6238<
6239 Beware that an expression is evaluated each and every time the status
6240 line is displayed. The current buffer and current window will be set
6241 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006242 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006243 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006244 real current buffer.
6245
6246 The 'statusline' option may be evaluated in the |sandbox|, see
6247 |sandbox-option|.
6248
6249 It is not allowed to change text or jump to another window while
6250 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006251
6252 If the statusline is not updated when you want it (e.g., after setting
6253 a variable that's used in an expression), you can force an update by
6254 setting an option without changing its value. Example: >
6255 :let &ro = &ro
6256
6257< A result of all digits is regarded a number for display purposes.
6258 Otherwise the result is taken as flag text and applied to the rules
6259 described above.
6260
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006261 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006262 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6263 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6264
6265 Examples:
6266 Emulate standard status line with 'ruler' set >
6267 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6268< Similar, but add ASCII value of char under the cursor (like "ga") >
6269 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6270< Display byte count and byte value, modified flag in red. >
6271 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6272 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6273< Display a ,GZ flag if a compressed file is loaded >
6274 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6275< In the |:autocmd|'s: >
6276 :let b:gzflag = 1
6277< And: >
6278 :unlet b:gzflag
6279< And define this function: >
6280 :function VarExists(var, val)
6281 : if exists(a:var) | return a:val | else | return '' | endif
6282 :endfunction
6283<
6284 *'suffixes'* *'su'*
6285'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6286 global
6287 {not in Vi}
6288 Files with these suffixes get a lower priority when multiple files
6289 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006290 suffixes. Spaces after the comma are ignored. A dot is also seen as
6291 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006292 separator, precede it with a backslash (see |option-backslash| about
6293 including spaces and backslashes).
6294 See 'wildignore' for completely ignoring files.
6295 The use of |:set+=| and |:set-=| is preferred when adding or removing
6296 suffixes from the list. This avoids problems when a future version
6297 uses another default.
6298
6299 *'suffixesadd'* *'sua'*
6300'suffixesadd' 'sua' string (default "")
6301 local to buffer
6302 {not in Vi}
6303 {not available when compiled without the
6304 |+file_in_path| feature}
6305 Comma separated list of suffixes, which are used when searching for a
6306 file for the "gf", "[I", etc. commands. Example: >
6307 :set suffixesadd=.java
6308<
6309 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6310'swapfile' 'swf' boolean (default on)
6311 local to buffer
6312 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006313 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006314 swapfile is not wanted for a specific buffer. For example, with
6315 confidential information that even root must not be able to access.
6316 Careful: All text will be in memory:
6317 - Don't use this for big files.
6318 - Recovery will be impossible!
6319 A swapfile will only be present when |'updatecount'| is non-zero and
6320 'swapfile' is set.
6321 When 'swapfile' is reset, the swap file for the current buffer is
6322 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6323 non-zero, a swap file is immediately created.
6324 Also see |swap-file| and |'swapsync'|.
6325
6326 This option is used together with 'bufhidden' and 'buftype' to
6327 specify special kinds of buffers. See |special-buffers|.
6328
6329 *'swapsync'* *'sws'*
6330'swapsync' 'sws' string (default "fsync")
6331 global
6332 {not in Vi}
6333 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006334 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006335 When this option is empty parts of the swap file may be in memory and
6336 not written to disk. When the system crashes you may lose more work.
6337 On Unix the system does a sync now and then without Vim asking for it,
6338 so the disadvantage of setting this option off is small. On some
6339 systems the swap file will not be written at all. For a unix system
6340 setting it to "sync" will use the sync() call instead of the default
6341 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006342 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006343
6344 *'switchbuf'* *'swb'*
6345'switchbuf' 'swb' string (default "")
6346 global
6347 {not in Vi}
6348 This option controls the behavior when switching between buffers.
6349 Possible values (comma separated list):
6350 useopen If included, jump to the first open window that
6351 contains the specified buffer (if there is one).
6352 Otherwise: Do not examine other windows.
6353 This setting is checked with |quickfix| commands, when
6354 jumping to errors (":cc", ":cn", "cp", etc.). It is
6355 also used in all buffer related split commands, for
6356 example ":sbuffer", ":sbnext", or ":sbrewind".
6357 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006358 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006359 Supported in |quickfix| commands that display errors.
6360
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006361 *'synmaxcol'* *'smc'*
6362'synmaxcol' 'smc' number (default 3000)
6363 local to buffer
6364 {not in Vi}
6365 {not available when compiled without the |+syntax|
6366 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006367 Maximum column in which to search for syntax items. In long lines the
6368 text after this column is not highlighted and following lines may not
6369 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006370 This helps to avoid very slow redrawing for an XML file that is one
6371 long line.
6372 Set to zero to remove the limit.
6373
Bram Moolenaar071d4272004-06-13 20:20:40 +00006374 *'syntax'* *'syn'*
6375'syntax' 'syn' string (default empty)
6376 local to buffer
6377 {not in Vi}
6378 {not available when compiled without the |+syntax|
6379 feature}
6380 When this option is set, the syntax with this name is loaded, unless
6381 syntax highlighting has been switched off with ":syntax off".
6382 Otherwise this option does not always reflect the current syntax (the
6383 b:current_syntax variable does).
6384 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006385 not automatically recognized. Example, in an IDL file:
6386 /* vim: set syntax=idl : */ ~
6387 When a dot appears in the value then this separates two filetype
6388 names. Example:
6389 /* vim: set syntax=c.doxygen : */ ~
6390 This will use the "c" syntax first, then the "doxygen" syntax.
6391 Note that the second one must be prepared to be loaded as an addition,
6392 otherwise it will be skipped. More than one dot may appear.
6393 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006394 :set syntax=OFF
6395< To switch syntax highlighting on according to the current value of the
6396 'filetype' option: >
6397 :set syntax=ON
6398< What actually happens when setting the 'syntax' option is that the
6399 Syntax autocommand event is triggered with the value as argument.
6400 This option is not copied to another buffer, independent of the 's' or
6401 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006402 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006403
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006404 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006405'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006406 global
6407 {not in Vi}
6408 {not available when compiled without the +windows
6409 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006410 When nonempty, this option determines the content of the tab pages
6411 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006412 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006413
6414 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006415 option and only when there is no GUI tab line. When 'e' is in
6416 'guioptions' and the GUI supports a tab line 'guitablabel' is used
6417 instead.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006418
6419 The value is evaluated like with 'statusline'. You can use
6420 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006421 the text to be displayed. Use "%1T" for the first label, "%2T" for
6422 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006423
6424 Keep in mind that only one of the tab pages is the current one, others
6425 are invisible and you can't jump to their windows.
6426
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006427
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006428 *'tabpagemax'* *'tpm'*
6429'tabpagemax' 'tpm' number (default 10)
6430 global
6431 {not in Vi}
6432 {not available when compiled without the +windows
6433 feature}
6434 Maximum number of tab pages to be opened by the |-p| command line
6435 argument or the ":tab all" command. |tabpage|
6436
6437
6438 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006439'tabstop' 'ts' number (default 8)
6440 local to buffer
6441 Number of spaces that a <Tab> in the file counts for. Also see
6442 |:retab| command, and 'softtabstop' option.
6443
6444 Note: Setting 'tabstop' to any other value than 8 can make your file
6445 appear wrong in many places (e.g., when printing it).
6446
6447 There are four main ways to use tabs in Vim:
6448 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6449 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
6450 will use a mix of tabs and spaces, but typing Tab and BS will
6451 behave like a tab appears every 4 (or 3) characters.
6452 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6453 'expandtab'. This way you will always insert spaces. The
6454 formatting will never be messed up when 'tabstop' is changed.
6455 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006456 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006457 works when using Vim to edit the file.
6458 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6459 'noexpandtab'. This should then work (for initial indents only)
6460 for any tabstop setting that people use. It might be nice to have
6461 tabs after the first non-blank inserted as spaces if you do this
6462 though. Otherwise aligned comments will be wrong when 'tabstop' is
6463 changed.
6464
6465 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6466'tagbsearch' 'tbs' boolean (default on)
6467 global
6468 {not in Vi}
6469 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006470 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006471 searching makes searching for a tag a LOT faster, but a linear search
6472 will find more tags if the tags file wasn't properly sorted.
6473 Vim normally assumes that your tags files are sorted, or indicate that
6474 they are not sorted. Only when this is not the case does the
6475 'tagbsearch' option need to be switched off.
6476
6477 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006478 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006479 certain files, or retry all files with a linear search. When
6480 'tagbsearch' is off, only a linear search is done.
6481
6482 Linear searching is done anyway, for one file, when Vim finds a line
6483 at the start of the file indicating that it's not sorted: >
6484 !_TAG_FILE_SORTED 0 /some command/
6485< [The whitespace before and after the '0' must be a single <Tab>]
6486
6487 When a binary search was done and no match was found in any of the
6488 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6489 instead of a normal tag name, a retry is done with a linear search.
6490 Tags in unsorted tags files, and matches with different case will only
6491 be found in the retry.
6492
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006493 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006494 linear search can be avoided for the 'ignorecase' case. Use a value
6495 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6496 case-fold sorted with the -f switch to "sort" in most unices, as in
6497 the command: "sort -f -o tags tags". For "Exuberant ctags" version
6498 5.3 or higher the -f or --fold-case-sort switch can be used for this
6499 as well. Note that case must be folded to uppercase for this to work.
6500
6501 When 'tagbsearch' is off, tags searching is slower when a full match
6502 exists, but faster when no full match exists. Tags in unsorted tags
6503 files may only be found with 'tagbsearch' off.
6504 When the tags file is not sorted, or sorted in a wrong way (not on
6505 ASCII byte value), 'tagbsearch' should be off, or the line given above
6506 must be included in the tags file.
6507 This option doesn't affect commands that find all matching tags (e.g.,
6508 command-line completion and ":help").
6509 {Vi: always uses binary search in some versions}
6510
6511 *'taglength'* *'tl'*
6512'taglength' 'tl' number (default 0)
6513 global
6514 If non-zero, tags are significant up to this number of characters.
6515
6516 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6517'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6518 global
6519 {not in Vi}
6520 If on and using a tag file in another directory, file names in that
6521 tag file are relative to the directory where the tag file is.
6522 NOTE: This option is set to the Vi default value when 'compatible' is
6523 set and to the Vim default value when 'compatible' is reset.
6524
6525 *'tags'* *'tag'* *E433*
6526'tags' 'tag' string (default "./tags,tags", when compiled with
6527 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6528 global or local to buffer |global-local|
6529 Filenames for the tag command, separated by spaces or commas. To
6530 include a space or comma in a file name, precede it with a backslash
6531 (see |option-backslash| about including spaces and backslashes).
6532 When a file name starts with "./", the '.' is replaced with the path
6533 of the current file. But only when the 'd' flag is not included in
6534 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6535 |tags-option|.
6536 "*", "**" and other wildcards can be used to search for tags files in
6537 a directory tree. See |file-searching|. {not available when compiled
6538 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006539 The |tagfiles()| function can be used to get a list of the file names
6540 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006541 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6542 files are also supported. They are automatically recognized. The
6543 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6544 differences are ignored (MS-Windows). |emacs-tags|
6545 The use of |:set+=| and |:set-=| is preferred when adding or removing
6546 file names from the list. This avoids problems when a future version
6547 uses another default.
6548 {Vi: default is "tags /usr/lib/tags"}
6549
6550 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6551'tagstack' 'tgst' boolean (default on)
6552 global
6553 {not in all versions of Vi}
6554 When on, the |tagstack| is used normally. When off, a ":tag" or
6555 ":tselect" command with an argument will not push the tag onto the
6556 tagstack. A following ":tag" without an argument, a ":pop" command or
6557 any other command that uses the tagstack will use the unmodified
6558 tagstack, but does change the pointer to the active entry.
6559 Resetting this option is useful when using a ":tag" command in a
6560 mapping which should not change the tagstack.
6561
6562 *'term'* *E529* *E530* *E531*
6563'term' string (default is $TERM, if that fails:
6564 in the GUI: "builtin_gui"
6565 on Amiga: "amiga"
6566 on BeOS: "beos-ansi"
6567 on Mac: "mac-ansi"
6568 on MiNT: "vt52"
6569 on MS-DOS: "pcterm"
6570 on OS/2: "os2ansi"
6571 on Unix: "ansi"
6572 on VMS: "ansi"
6573 on Win 32: "win32")
6574 global
6575 Name of the terminal. Used for choosing the terminal control
6576 characters. Environment variables are expanded |:set_env|.
6577 For example: >
6578 :set term=$TERM
6579< See |termcap|.
6580
6581 *'termbidi'* *'tbidi'*
6582 *'notermbidi'* *'notbidi'*
6583'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6584 global
6585 {not in Vi}
6586 {only available when compiled with the |+arabic|
6587 feature}
6588 The terminal is in charge of Bi-directionality of text (as specified
6589 by Unicode). The terminal is also expected to do the required shaping
6590 that some languages (such as Arabic) require.
6591 Setting this option implies that 'rightleft' will not be set when
6592 'arabic' is set and the value of 'arabicshape' will be ignored.
6593 Note that setting 'termbidi' has the immediate effect that
6594 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6595 This option is reset when the GUI is started.
6596 For further details see |arabic.txt|.
6597
6598 *'termencoding'* *'tenc'*
6599'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6600 Macintosh GUI: "macroman")
6601 global
6602 {only available when compiled with the |+multi_byte|
6603 feature}
6604 {not in Vi}
6605 Encoding used for the terminal. This specifies what character
6606 encoding the keyboard produces and the display will understand. For
6607 the GUI it only applies to the keyboard ('encoding' is used for the
6608 display).
6609 In the Win32 console version the default value is the console codepage
6610 when it differs from the ANSI codepage.
6611 *E617*
6612 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6613 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6614 Any attempts to set a different value will be rejected, and an error
6615 message is shown.
6616 For the Win32 GUI 'termencoding' is not used for typed characters,
6617 because the Win32 system always passes Unicode characters.
6618 When empty, the same encoding is used as for the 'encoding' option.
6619 This is the normal value.
6620 Not all combinations for 'termencoding' and 'encoding' are valid. See
6621 |encoding-table|.
6622 The value for this option must be supported by internal conversions or
6623 iconv(). When this is not possible no conversion will be done and you
6624 will probably experience problems with non-ASCII characters.
6625 Example: You are working with the locale set to euc-jp (Japanese) and
6626 want to edit a UTF-8 file: >
6627 :let &termencoding = &encoding
6628 :set encoding=utf-8
6629< You need to do this when your system has no locale support for UTF-8.
6630
6631 *'terse'* *'noterse'*
6632'terse' boolean (default off)
6633 global
6634 When set: Add 's' flag to 'shortmess' option (this makes the message
6635 for a search that hits the start or end of the file not being
6636 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6637 shortens a lot of messages}
6638
6639 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6640'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6641 global
6642 {not in Vi}
6643 This option is obsolete. Use 'fileformats'.
6644 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6645 set to the default value for the current system. When 'textauto' is
6646 reset, 'fileformats' is made empty.
6647 NOTE: This option is set to the Vi default value when 'compatible' is
6648 set and to the Vim default value when 'compatible' is reset.
6649
6650 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6651'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6652 others: default off)
6653 local to buffer
6654 {not in Vi}
6655 This option is obsolete. Use 'fileformat'.
6656 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6657 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6658 "unix".
6659
6660 *'textwidth'* *'tw'*
6661'textwidth' 'tw' number (default 0)
6662 local to buffer
6663 {not in Vi}
6664 Maximum width of text that is being inserted. A longer line will be
6665 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006666 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6667 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006668 'formatoptions' and |ins-textwidth|.
6669 NOTE: This option is set to 0 when 'compatible' is set.
6670
6671 *'thesaurus'* *'tsr'*
6672'thesaurus' 'tsr' string (default "")
6673 global or local to buffer |global-local|
6674 {not in Vi}
6675 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006676 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006677 the file should contain words with similar meaning, separated by
6678 non-keyword characters (white space is preferred). Maximum line
6679 length is 510 bytes.
6680 To obtain a file to be used here, check out the wordlist FAQ at
6681 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006682 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006683 after a comma are ignored, otherwise spaces are included in the file
6684 name. See |option-backslash| about using backslashes.
6685 The use of |:set+=| and |:set-=| is preferred when adding or removing
6686 directories from the list. This avoids problems when a future version
6687 uses another default.
6688 Backticks cannot be used in this option for security reasons.
6689
6690 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6691'tildeop' 'top' boolean (default off)
6692 global
6693 {not in Vi}
6694 When on: The tilde command "~" behaves like an operator.
6695 NOTE: This option is reset when 'compatible' is set.
6696
6697 *'timeout'* *'to'* *'notimeout'* *'noto'*
6698'timeout' 'to' boolean (default on)
6699 global
6700 *'ttimeout'* *'nottimeout'*
6701'ttimeout' boolean (default off)
6702 global
6703 {not in Vi}
6704 These two options together determine the behavior when part of a
6705 mapped key sequence or keyboard code has been received:
6706
6707 'timeout' 'ttimeout' action ~
6708 off off do not time out
6709 on on or off time out on :mappings and key codes
6710 off on time out on key codes
6711
6712 If both options are off, Vim will wait until either the complete
6713 mapping or key sequence has been received, or it is clear that there
6714 is no mapping or key sequence for the received characters. For
6715 example: if you have mapped "vl" and Vim has received 'v', the next
6716 character is needed to see if the 'v' is followed by an 'l'.
6717 When one of the options is on, Vim will wait for about 1 second for
6718 the next character to arrive. After that the already received
6719 characters are interpreted as single characters. The waiting time can
6720 be changed with the 'timeoutlen' option.
6721 On slow terminals or very busy systems timing out may cause
6722 malfunctioning cursor keys. If both options are off, Vim waits
6723 forever after an entered <Esc> if there are key codes that start
6724 with <Esc>. You will have to type <Esc> twice. If you do not have
6725 problems with key codes, but would like to have :mapped key
6726 sequences not timing out in 1 second, set the 'ttimeout' option and
6727 reset the 'timeout' option.
6728
6729 NOTE: 'ttimeout' is reset when 'compatible' is set.
6730
6731 *'timeoutlen'* *'tm'*
6732'timeoutlen' 'tm' number (default 1000)
6733 global
6734 {not in all versions of Vi}
6735 *'ttimeoutlen'* *'ttm'*
6736'ttimeoutlen' 'ttm' number (default -1)
6737 global
6738 {not in Vi}
6739 The time in milliseconds that is waited for a key code or mapped key
6740 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6741 when part of a command has been typed.
6742 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6743 different timeout value for key codes is desired set 'ttimeoutlen' to
6744 a non-negative number.
6745
6746 ttimeoutlen mapping delay key code delay ~
6747 < 0 'timeoutlen' 'timeoutlen'
6748 >= 0 'timeoutlen' 'ttimeoutlen'
6749
6750 The timeout only happens when the 'timeout' and 'ttimeout' options
6751 tell so. A useful setting would be >
6752 :set timeout timeoutlen=3000 ttimeoutlen=100
6753< (time out on mapping after three seconds, time out on key codes after
6754 a tenth of a second).
6755
6756 *'title'* *'notitle'*
6757'title' boolean (default off, on when title can be restored)
6758 global
6759 {not in Vi}
6760 {not available when compiled without the |+title|
6761 feature}
6762 When on, the title of the window will be set to the value of
6763 'titlestring' (if it is not empty), or to:
6764 filename [+=-] (path) - VIM
6765 Where:
6766 filename the name of the file being edited
6767 - indicates the file cannot be modified, 'ma' off
6768 + indicates the file was modified
6769 = indicates the file is read-only
6770 =+ indicates the file is read-only and modified
6771 (path) is the path of the file being edited
6772 - VIM the server name |v:servername| or "VIM"
6773 Only works if the terminal supports setting window titles
6774 (currently Amiga console, Win32 console, all GUI versions and
6775 terminals with a non- empty 't_ts' option - these are Unix xterm and
6776 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6777 *X11*
6778 When Vim was compiled with HAVE_X11 defined, the original title will
6779 be restored if possible. The output of ":version" will include "+X11"
6780 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6781 works for the icon name |'icon'|.
6782 But: When Vim was started with the |-X| argument, restoring the title
6783 will not work (except in the GUI).
6784 If the title cannot be restored, it is set to the value of 'titleold'.
6785 You might want to restore the title outside of Vim then.
6786 When using an xterm from a remote machine you can use this command:
6787 rsh machine_name xterm -display $DISPLAY &
6788 then the WINDOWID environment variable should be inherited and the
6789 title of the window should change back to what it should be after
6790 exiting Vim.
6791
6792 *'titlelen'*
6793'titlelen' number (default 85)
6794 global
6795 {not in Vi}
6796 {not available when compiled without the |+title|
6797 feature}
6798 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006799 title. When the title is longer, only the end of the path name is
6800 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006801 Using a percentage makes this adapt to the width of the window. But
6802 it won't work perfectly, because the actual number of characters
6803 available also depends on the font used and other things in the title
6804 bar. When 'titlelen' is zero the full path is used. Otherwise,
6805 values from 1 to 30000 percent can be used.
6806 'titlelen' is also used for the 'titlestring' option.
6807
6808 *'titleold'*
6809'titleold' string (default "Thanks for flying Vim")
6810 global
6811 {not in Vi}
6812 {only available when compiled with the |+title|
6813 feature}
6814 This option will be used for the window title when exiting Vim if the
6815 original title cannot be restored. Only happens if 'title' is on or
6816 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006817 This option cannot be set from a |modeline| or in the |sandbox|, for
6818 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006819 *'titlestring'*
6820'titlestring' string (default "")
6821 global
6822 {not in Vi}
6823 {not available when compiled without the |+title|
6824 feature}
6825 When this option is not empty, it will be used for the title of the
6826 window. This happens only when the 'title' option is on.
6827 Only works if the terminal supports setting window titles (currently
6828 Amiga console, Win32 console, all GUI versions and terminals with a
6829 non-empty 't_ts' option).
6830 When Vim was compiled with HAVE_X11 defined, the original title will
6831 be restored if possible |X11|.
6832 When this option contains printf-style '%' items, they will be
6833 expanded according to the rules used for 'statusline'.
6834 Example: >
6835 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6836 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6837< The value of 'titlelen' is used to align items in the middle or right
6838 of the available space.
6839 Some people prefer to have the file name first: >
6840 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6841< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006842 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006843 separating space only when needed.
6844 NOTE: Use of special characters in 'titlestring' may cause the display
6845 to be garbled (e.g., when it contains a CR or NL character).
6846 {not available when compiled without the |+statusline| feature}
6847
6848 *'toolbar'* *'tb'*
6849'toolbar' 'tb' string (default "icons,tooltips")
6850 global
6851 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6852 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006853 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006854 possible values are:
6855 icons Toolbar buttons are shown with icons.
6856 text Toolbar buttons shown with text.
6857 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006858 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006859 tooltips Tooltips are active for toolbar buttons.
6860 Tooltips refer to the popup help text which appears after the mouse
6861 cursor is placed over a toolbar button for a brief moment.
6862
6863 If you want the toolbar to be shown with icons as well as text, do the
6864 following: >
6865 :set tb=icons,text
6866< Motif and Athena cannot display icons and text at the same time. They
6867 will show icons if both are requested.
6868
6869 If none of the strings specified in 'toolbar' are valid or if
6870 'toolbar' is empty, this option is ignored. If you want to disable
6871 the toolbar, you need to set the 'guioptions' option. For example: >
6872 :set guioptions-=T
6873< Also see |gui-toolbar|.
6874
6875 *'toolbariconsize'* *'tbis'*
6876'toolbariconsize' 'tbis' string (default "small")
6877 global
6878 {not in Vi}
6879 {only in the GTK+ 2 GUI}
6880 Controls the size of toolbar icons. The possible values are:
6881 tiny Use tiny toolbar icons.
6882 small Use small toolbar icons (default).
6883 medium Use medium-sized toolbar icons.
6884 large Use large toolbar icons.
6885 The exact dimensions in pixels of the various icon sizes depend on
6886 the current theme. Common dimensions are large=32x32, medium=24x24,
6887 small=20x20 and tiny=16x16.
6888
6889 If 'toolbariconsize' is empty, the global default size as determined
6890 by user preferences or the current theme is used.
6891
6892 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6893'ttybuiltin' 'tbi' boolean (default on)
6894 global
6895 {not in Vi}
6896 When on, the builtin termcaps are searched before the external ones.
6897 When off the builtin termcaps are searched after the external ones.
6898 When this option is changed, you should set the 'term' option next for
6899 the change to take effect, for example: >
6900 :set notbi term=$TERM
6901< See also |termcap|.
6902 Rationale: The default for this option is "on", because the builtin
6903 termcap entries are generally better (many systems contain faulty
6904 xterm entries...).
6905
6906 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6907'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6908 sun-cmd, screen, rxvt, dtterm or
6909 iris-ansi; also on when running Vim in
6910 a DOS console)
6911 global
6912 {not in Vi}
6913 Indicates a fast terminal connection. More characters will be sent to
6914 the screen for redrawing, instead of using insert/delete line
6915 commands. Improves smoothness of redrawing when there are multiple
6916 windows and the terminal does not support a scrolling region.
6917 Also enables the extra writing of characters at the end of each screen
6918 line for lines that wrap. This helps when using copy/paste with the
6919 mouse in an xterm and other terminals.
6920
6921 *'ttymouse'* *'ttym'*
6922'ttymouse' 'ttym' string (default depends on 'term')
6923 global
6924 {not in Vi}
6925 {only in Unix and VMS, doesn't work in the GUI; not
6926 available when compiled without |+mouse|}
6927 Name of the terminal type for which mouse codes are to be recognized.
6928 Currently these three strings are valid:
6929 *xterm-mouse*
6930 xterm xterm-like mouse handling. The mouse generates
6931 "<Esc>[Mscr", where "scr" is three bytes:
6932 "s" = button state
6933 "c" = column plus 33
6934 "r" = row plus 33
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006935 This only works up to 223 columns! See "dec" for a
6936 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006937 xterm2 Works like "xterm", but with the xterm reporting the
6938 mouse position while the mouse is dragged. This works
6939 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006940 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00006941 work. See below for how Vim detects this
6942 automatically.
6943 *netterm-mouse*
6944 netterm NetTerm mouse handling. The mouse generates
6945 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6946 for the row and column.
6947 *dec-mouse*
6948 dec DEC terminal mouse handling. The mouse generates a
6949 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006950 This is also available for an Xterm, if it was
6951 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006952 *jsbterm-mouse*
6953 jsbterm JSB term mouse handling.
6954 *pterm-mouse*
6955 pterm QNX pterm mouse handling.
6956
6957 The mouse handling must be enabled at compile time |+mouse_xterm|
6958 |+mouse_dec| |+mouse_netterm|.
6959 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6960 recognized, if enabled at compile time. DEC terminal mouse codes
6961 are recognized if enabled at compile time, and 'ttymouse' is not
6962 "xterm" (because the xterm and dec mouse codes conflict).
6963 This option is automatically set to "xterm", when the 'term' option is
6964 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6965 or "xterm2" already. The main use of this option is to set it to
6966 "xterm", when the terminal name doesn't start with "xterm", but it can
6967 handle xterm mouse codes.
6968 The "xterm2" value will be set if the xterm version is reported to be
6969 95 of higher. This only works when compiled with the |+termresponse|
6970 feature and if |t_RV| is set to the escape sequence to request the
6971 xterm version number. Otherwise "xterm2" must be set explicitly.
6972 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6973 t_RV to an empty string: >
6974 :set t_RV=
6975<
6976 *'ttyscroll'* *'tsl'*
6977'ttyscroll' 'tsl' number (default 999)
6978 global
6979 Maximum number of lines to scroll the screen. If there are more lines
6980 to scroll the window is redrawn. For terminals where scrolling is
6981 very slow and redrawing is not slow this can be set to a small number,
6982 e.g., 3, to speed up displaying.
6983
6984 *'ttytype'* *'tty'*
6985'ttytype' 'tty' string (default from $TERM)
6986 global
6987 Alias for 'term', see above.
6988
6989 *'undolevels'* *'ul'*
6990'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
6991 Win32 and OS/2)
6992 global
6993 {not in Vi}
6994 Maximum number of changes that can be undone. Since undo information
6995 is kept in memory, higher numbers will cause more memory to be used
6996 (nevertheless, a single change can use an unlimited amount of memory).
6997 Set to 0 for Vi compatibility: One level of undo and "u" undoes
6998 itself: >
6999 set ul=0
7000< But you can also get Vi compatibility by including the 'u' flag in
7001 'cpoptions', and still be able to use CTRL-R to repeat undo.
7002 Set to a negative number for no undo at all: >
7003 set ul=-1
7004< This helps when you run out of memory for a single change.
7005 Also see |undo-two-ways|.
7006
7007 *'updatecount'* *'uc'*
7008'updatecount' 'uc' number (default: 200)
7009 global
7010 {not in Vi}
7011 After typing this many characters the swap file will be written to
7012 disk. When zero, no swap file will be created at all (see chapter on
7013 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7014 Vim with the "-n" option, see |startup|. When editing in readonly
7015 mode this option will be initialized to 10000.
7016 The swapfile can be disabled per buffer with |'swapfile'|.
7017 When 'updatecount' is set from zero to non-zero, swap files are
7018 created for all buffers that have 'swapfile' set. When 'updatecount'
7019 is set to zero, existing swap files are not deleted.
7020 Also see |'swapsync'|.
7021 This option has no meaning in buffers where |'buftype'| is "nofile"
7022 or "nowrite".
7023
7024 *'updatetime'* *'ut'*
7025'updatetime' 'ut' number (default 4000)
7026 global
7027 {not in Vi}
7028 If this many milliseconds nothing is typed the swap file will be
7029 written to disk (see |crash-recovery|). Also used for the
7030 |CursorHold| autocommand event.
7031
7032 *'verbose'* *'vbs'*
7033'verbose' 'vbs' number (default 0)
7034 global
7035 {not in Vi, although some versions have a boolean
7036 verbose option}
7037 When bigger than zero, Vim will give messages about what it is doing.
7038 Currently, these messages are given:
7039 >= 1 When the viminfo file is read or written.
7040 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007041 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007042 >= 8 Files for which a group of autocommands is executed.
7043 >= 9 Every executed autocommand.
7044 >= 12 Every executed function.
7045 >= 13 When an exception is thrown, caught, finished, or discarded.
7046 >= 14 Anything pending in a ":finally" clause.
7047 >= 15 Every executed Ex command (truncated at 200 characters).
7048
7049 This option can also be set with the "-V" argument. See |-V|.
7050 This option is also set by the |:verbose| command.
7051
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007052 When the 'verbosefile' option is set then the verbose messages are not
7053 displayed.
7054
7055 *'verbosefile'* *'vfile'*
7056'verbosefile' 'vfile' string (default empty)
7057 global
7058 {not in Vi}
7059 When not empty all messages are written in a file with this name.
7060 When the file exists messages are appended.
7061 Writing to the file ends when Vim exits or when 'verbosefile' is made
7062 empty.
7063 Setting 'verbosefile' to a new value is like making it empty first.
7064 The difference with |:redir| is that verbose messages are not
7065 displayed when 'verbosefile' is set.
7066
Bram Moolenaar071d4272004-06-13 20:20:40 +00007067 *'viewdir'* *'vdir'*
7068'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7069 "$VIM/vimfiles/view",
7070 for Unix: "~/.vim/view",
7071 for Macintosh: "$VIM:vimfiles:view"
7072 for VMS: "sys$login:vimfiles/view"
7073 for RiscOS: "Choices:vimfiles/view")
7074 global
7075 {not in Vi}
7076 {not available when compiled without the +mksession
7077 feature}
7078 Name of the directory where to store files for |:mkview|.
7079 This option cannot be set from a |modeline| or in the |sandbox|, for
7080 security reasons.
7081
7082 *'viewoptions'* *'vop'*
7083'viewoptions' 'vop' string (default: "folds,options,cursor")
7084 global
7085 {not in Vi}
7086 {not available when compiled without the +mksession
7087 feature}
7088 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007089 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007090 word save and restore ~
7091 cursor cursor position in file and in window
7092 folds manually created folds, opened/closed folds and local
7093 fold options
7094 options options and mappings local to a window or buffer (not
7095 global values for local options)
7096 slash backslashes in file names replaced with forward
7097 slashes
7098 unix with Unix end-of-line format (single <NL>), even when
7099 on Windows or DOS
7100
7101 "slash" and "unix" are useful on Windows when sharing view files
7102 with Unix. The Unix version of Vim cannot source dos format scripts,
7103 but the Windows version of Vim can source unix format scripts.
7104
7105 *'viminfo'* *'vi'* *E526* *E527* *E528*
7106'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
7107 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
7108 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
7109 for others: '20,<50,s10,h)
7110 global
7111 {not in Vi}
7112 {not available when compiled without the |+viminfo|
7113 feature}
7114 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007115 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007116 separated list of parameters, each consisting of a single character
7117 identifying the particular parameter, followed by a number or string
7118 which specifies the value of that parameter. If a particular
7119 character is left out, then the default value is used for that
7120 parameter. The following is a list of the identifying characters and
7121 the effect of their value.
7122 CHAR VALUE ~
7123 ! When included, save and restore global variables that start
7124 with an uppercase letter, and don't contain a lowercase
7125 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007126 and "_K_L_M" are not. Only String and Number types are
7127 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007128 " Maximum number of lines saved for each register. Old name of
7129 the '<' item, with the disadvantage that you need to put a
7130 backslash before the ", otherwise it will be recognized as the
7131 start of a comment!
7132 % When included, save and restore the buffer list. If Vim is
7133 started with a file name argument, the buffer list is not
7134 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007135 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007136 without a file name and buffers for help files are not written
7137 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007138 When followed by a number, the number specifies the maximum
7139 number of buffers that are stored. Without a number all
7140 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007141 ' Maximum number of previously edited files for which the marks
7142 are remembered. This parameter must always be included when
7143 'viminfo' is non-empty.
7144 Including this item also means that the |jumplist| and the
7145 |changelist| are stored in the viminfo file.
7146 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007147 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007148 patterns are also saved. When not included, the value of
7149 'history' is used.
7150 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007151 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007152 < Maximum number of lines saved for each register. If zero then
7153 registers are not saved. When not included, all lines are
7154 saved. '"' is the old name for this item.
7155 Also see the 's' item below: limit specified in Kbyte.
7156 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007157 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007158 c When included, convert the text in the viminfo file from the
7159 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007160 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007161 f Whether file marks need to be stored. If zero, file marks ('0
7162 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007163 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007164 cursor position (when exiting or when doing ":wviminfo").
7165 h Disable the effect of 'hlsearch' when loading the viminfo
7166 file. When not included, it depends on whether ":nohlsearch"
7167 has been used since the last search command.
7168 n Name of the viminfo file. The name must immediately follow
7169 the 'n'. Must be the last one! If the "-i" argument was
7170 given when starting Vim, that file name overrides the one
7171 given here with 'viminfo'. Environment variables are expanded
7172 when opening the file, not when setting the option.
7173 r Removable media. The argument is a string (up to the next
7174 ','). This parameter can be given several times. Each
7175 specifies the start of a path for which no marks will be
7176 stored. This is to avoid removable media. For MS-DOS you
7177 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7178 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7179 ignored. Maximum length of each 'r' argument is 50
7180 characters.
7181 s Maximum size of an item in Kbyte. If zero then registers are
7182 not saved. Currently only applies to registers. The default
7183 "s10" will exclude registers with more than 10 Kbyte of text.
7184 Also see the '<' item above: line count limit.
7185
7186 Example: >
7187 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7188<
7189 '50 Marks will be remembered for the last 50 files you
7190 edited.
7191 <1000 Contents of registers (up to 1000 lines each) will be
7192 remembered.
7193 s100 Registers with more than 100 Kbyte text are skipped.
7194 :0 Command-line history will not be saved.
7195 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7196 no / Since '/' is not specified, the default will be used,
7197 that is, save all of the search history, and also the
7198 previous search and substitute patterns.
7199 no % The buffer list will not be saved nor read back.
7200 no h 'hlsearch' highlighting will be restored.
7201
7202 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7203 load the contents of the file, this is not done automatically.
7204
7205 This option cannot be set from a |modeline| or in the |sandbox|, for
7206 security reasons.
7207
7208 *'virtualedit'* *'ve'*
7209'virtualedit' 've' string (default "")
7210 global
7211 {not in Vi}
7212 {not available when compiled without the
7213 |+virtualedit| feature}
7214 A comma separated list of these words:
7215 block Allow virtual editing in Visual block mode.
7216 insert Allow virtual editing in Insert mode.
7217 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007218 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007219
Bram Moolenaar071d4272004-06-13 20:20:40 +00007220 Virtual editing means that the cursor can be positioned where there is
7221 no actual character. This can be halfway into a Tab or beyond the end
7222 of the line. Useful for selecting a rectangle in Visual mode and
7223 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007224 "onemore" is not the same, it will only allow moving the cursor just
7225 after the last character of the line. This makes some commands more
7226 consistent. Previously the cursor was always past the end of the line
7227 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007228 break some plugins or Vim scripts. For example because |l| can move
7229 the cursor after the last character. Use with care!
7230 Using the |$| command will move to the last character in the line, not
7231 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007232 It doesn't make sense to combine "all" with "onemore", but you will
7233 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007234
7235 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7236'visualbell' 'vb' boolean (default off)
7237 global
7238 {not in Vi}
7239 Use visual bell instead of beeping. The terminal code to display the
7240 visual bell is given with 't_vb'. When no beep or flash is wanted,
7241 use ":set vb t_vb=".
7242 Note: When the GUI starts, 't_vb' is reset to its default value. You
7243 might want to set it again in your |gvimrc|.
7244 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7245 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7246 where 40 is the time in msec.
7247 Does not work on the Amiga, you always get a screen flash.
7248 Also see 'errorbells'.
7249
7250 *'warn'* *'nowarn'*
7251'warn' boolean (default on)
7252 global
7253 Give a warning message when a shell command is used while the buffer
7254 has been changed.
7255
7256 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7257'weirdinvert' 'wiv' boolean (default off)
7258 global
7259 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007260 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007261 It is provided for backwards compatibility with version 4.x.
7262 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7263 vice versa. Has no effect when the GUI is running.
7264
7265 *'whichwrap'* *'ww'*
7266'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7267 global
7268 {not in Vi}
7269 Allow specified keys that move the cursor left/right to move to the
7270 previous/next line when the cursor is on the first/last character in
7271 the line. Concatenate characters to allow this for these keys:
7272 char key mode ~
7273 b <BS> Normal and Visual
7274 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007275 h "h" Normal and Visual (not recommended)
7276 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007277 < <Left> Normal and Visual
7278 > <Right> Normal and Visual
7279 ~ "~" Normal
7280 [ <Left> Insert and Replace
7281 ] <Right> Insert and Replace
7282 For example: >
7283 :set ww=<,>,[,]
7284< allows wrap only when cursor keys are used.
7285 When the movement keys are used in combination with a delete or change
7286 operator, the <EOL> also counts for a character. This makes "3h"
7287 different from "3dh" when the cursor crosses the end of a line. This
7288 is also true for "x" and "X", because they do the same as "dl" and
7289 "dh". If you use this, you may also want to use the mapping
7290 ":map <BS> X" to make backspace delete the character in front of the
7291 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007292 When 'l' is included and it is used after an operator at the end of a
7293 line then it will not move to the next line. This makes "dl", "cl",
7294 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007295 NOTE: This option is set to the Vi default value when 'compatible' is
7296 set and to the Vim default value when 'compatible' is reset.
7297
7298 *'wildchar'* *'wc'*
7299'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7300 global
7301 {not in Vi}
7302 Character you have to type to start wildcard expansion in the
7303 command-line, as specified with 'wildmode'.
7304 The character is not recognized when used inside a macro. See
7305 'wildcharm' for that.
7306 Although 'wc' is a number option, you can set it to a special key: >
7307 :set wc=<Esc>
7308< NOTE: This option is set to the Vi default value when 'compatible' is
7309 set and to the Vim default value when 'compatible' is reset.
7310
7311 *'wildcharm'* *'wcm'*
7312'wildcharm' 'wcm' number (default: none (0))
7313 global
7314 {not in Vi}
7315 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007316 recognized when used inside a macro. You can find "spare" command-line
7317 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007318 you'll never actually type 'wildcharm', just use it in mappings that
7319 automatically invoke completion mode, e.g.: >
7320 :set wcm=<C-Z>
7321 :cmap ss so $vim/sessions/*.vim<C-Z>
7322< Then after typing :ss you can use CTRL-P & CTRL-N.
7323
7324 *'wildignore'* *'wig'*
7325'wildignore' 'wig' string (default "")
7326 global
7327 {not in Vi}
7328 {not available when compiled without the |+wildignore|
7329 feature}
7330 A list of file patterns. A file that matches with one of these
7331 patterns is ignored when completing file or directory names.
7332 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7333 Also see 'suffixes'.
7334 Example: >
7335 :set wildignore=*.o,*.obj
7336< The use of |:set+=| and |:set-=| is preferred when adding or removing
7337 a pattern from the list. This avoids problems when a future version
7338 uses another default.
7339
7340 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7341'wildmenu' 'wmnu' boolean (default off)
7342 global
7343 {not in Vi}
7344 {not available if compiled without the |+wildmenu|
7345 feature}
7346 When 'wildmenu' is on, command-line completion operates in an enhanced
7347 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7348 the possible matches are shown just above the command line, with the
7349 first match highlighted (overwriting the status line, if there is
7350 one). Keys that show the previous/next match, such as <Tab> or
7351 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7352 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7353 specified. "longest" and "list" do not start "wildmenu" mode.
7354 If there are more matches than can fit in the line, a ">" is shown on
7355 the right and/or a "<" is shown on the left. The status line scrolls
7356 as needed.
7357 The "wildmenu" mode is abandoned when a key is hit that is not used
7358 for selecting a completion.
7359 While the "wildmenu" is active the following keys have special
7360 meanings:
7361
7362 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7363 <Down> - in filename/menu name completion: move into a
7364 subdirectory or submenu.
7365 <CR> - in menu completion, when the cursor is just after a
7366 dot: move into a submenu.
7367 <Up> - in filename/menu name completion: move up into
7368 parent directory or parent menu.
7369
7370 This makes the menus accessible from the console |console-menus|.
7371
7372 If you prefer the <Left> and <Right> keys to move the cursor instead
7373 of selecting a different match, use this: >
7374 :cnoremap <Left> <Space><BS><Left>
7375 :cnoremap <Right> <Space><BS><Right>
7376<
7377 The "WildMenu" highlighting is used for displaying the current match
7378 |hl-WildMenu|.
7379
7380 *'wildmode'* *'wim'*
7381'wildmode' 'wim' string (Vim default: "full")
7382 global
7383 {not in Vi}
7384 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007385 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00007386 part specifies what to do for each consecutive use of 'wildchar. The
7387 first part specifies the behavior for the first use of 'wildchar',
7388 The second part for the second use, etc.
7389 These are the possible values for each part:
7390 "" Complete only the first match.
7391 "full" Complete the next full match. After the last match,
7392 the original string is used and then the first match
7393 again.
7394 "longest" Complete till longest common string. If this doesn't
7395 result in a longer string, use the next part.
7396 "longest:full" Like "longest", but also start 'wildmenu' if it is
7397 enabled.
7398 "list" When more than one match, list all matches.
7399 "list:full" When more than one match, list all matches and
7400 complete first match.
7401 "list:longest" When more than one match, list all matches and
7402 complete till longest common string.
7403 When there is only a single match, it is fully completed in all cases.
7404
7405 Examples: >
7406 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007407< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007408 :set wildmode=longest,full
7409< Complete longest common string, then each full match >
7410 :set wildmode=list:full
7411< List all matches and complete each full match >
7412 :set wildmode=list,full
7413< List all matches without completing, then each full match >
7414 :set wildmode=longest,list
7415< Complete longest common string, then list alternatives.
7416
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007417 *'wildoptions'* *'wop'*
7418'wildoptions' 'wop' string (default "")
7419 global
7420 {not in Vi}
7421 {not available when compiled without the |+wildignore|
7422 feature}
7423 A list of words that change how command line completion is done.
7424 Currently only one word is allowed:
7425 tagfile When using CTRL-D to list matching tags, the kind of
7426 tag and the file of the tag is listed. Only one match
7427 is displayed per line. Often used tag kinds are:
7428 d #define
7429 f function
7430 Also see |cmdline-completion|.
7431
Bram Moolenaar071d4272004-06-13 20:20:40 +00007432 *'winaltkeys'* *'wak'*
7433'winaltkeys' 'wak' string (default "menu")
7434 global
7435 {not in Vi}
7436 {only used in Win32, Motif, GTK and Photon GUI}
7437 Some GUI versions allow the access to menu entries by using the ALT
7438 key in combination with a character that appears underlined in the
7439 menu. This conflicts with the use of the ALT key for mappings and
7440 entering special characters. This option tells what to do:
7441 no Don't use ALT keys for menus. ALT key combinations can be
7442 mapped, but there is no automatic handling. This can then be
7443 done with the |:simalt| command.
7444 yes ALT key handling is done by the windowing system. ALT key
7445 combinations cannot be mapped.
7446 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007447 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007448 keys can be mapped.
7449 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7450 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007451 This option is not used for <F10>; on Win32 and with GTK <F10> will
7452 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007453
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007454 *'window'* *'wi'*
7455'window' 'wi' number (default screen height - 1)
7456 global
7457 Window height. Do not confuse this with the height of the Vim window,
7458 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007459 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7460 value is smaller than 'lines' minus one. The screen will scroll
7461 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007462 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7463 in a much smarter way, taking care of wrapping lines.
7464 When resizing the Vim window, the value is smaller than 1 or more than
7465 or equal to 'lines' it will be set to 'lines' minus 1.
7466 {Vi also uses the option to specify the number of displayed lines}
7467
Bram Moolenaar071d4272004-06-13 20:20:40 +00007468 *'winheight'* *'wh'* *E591*
7469'winheight' 'wh' number (default 1)
7470 global
7471 {not in Vi}
7472 {not available when compiled without the +windows
7473 feature}
7474 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007475 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007476 current window is smaller, its size is increased, at the cost of the
7477 height of other windows. Set it to 999 to make the current window
7478 always fill the screen (although this has the drawback that ":all"
7479 will create only two windows). Set it to a small number for normal
7480 editing.
7481 Minimum value is 1.
7482 The height is not adjusted after one of the commands to change the
7483 height of the current window.
7484 'winheight' applies to the current window. Use 'winminheight' to set
7485 the minimal height for other windows.
7486
7487 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7488'winfixheight' 'wfh' boolean (default off)
7489 local to window
7490 {not in Vi}
7491 {not available when compiled without the +windows
7492 feature}
7493 Keep the window height when windows are opened or closed and
7494 'equalalways' is set. Set by default for the |preview-window| and
7495 |quickfix-window|.
7496 The height may be changed anyway when running out of room.
7497
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007498 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7499'winfixwidth' 'wfw' boolean (default off)
7500 local to window
7501 {not in Vi}
7502 {not available when compiled without the +windows
7503 feature}
7504 Keep the window width when windows are opened or closed and
7505 'equalalways' is set.
7506 The width may be changed anyway when running out of room.
7507
Bram Moolenaar071d4272004-06-13 20:20:40 +00007508 *'winminheight'* *'wmh'*
7509'winminheight' 'wmh' number (default 1)
7510 global
7511 {not in Vi}
7512 {not available when compiled without the +windows
7513 feature}
7514 The minimal height of a window, when it's not the current window.
7515 This is a hard minimum, windows will never become smaller.
7516 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7517 status bar) if necessary. They will return to at least one line when
7518 they become active (since the cursor has to have somewhere to go.)
7519 Use 'winheight' to set the minimal height of the current window.
7520 This option is only checked when making a window smaller. Don't use a
7521 large number, it will cause errors when opening more than a few
7522 windows. A value of 0 to 3 is reasonable.
7523
7524 *'winminwidth'* *'wmw'*
7525'winminwidth' 'wmw' number (default 1)
7526 global
7527 {not in Vi}
7528 {not available when compiled without the +vertsplit
7529 feature}
7530 The minimal width of a window, when it's not the current window.
7531 This is a hard minimum, windows will never become smaller.
7532 When set to zero, windows may be "squashed" to zero columns (i.e. just
7533 a vertical separator) if necessary. They will return to at least one
7534 line when they become active (since the cursor has to have somewhere
7535 to go.)
7536 Use 'winwidth' to set the minimal width of the current window.
7537 This option is only checked when making a window smaller. Don't use a
7538 large number, it will cause errors when opening more than a few
7539 windows. A value of 0 to 12 is reasonable.
7540
7541 *'winwidth'* *'wiw'* *E592*
7542'winwidth' 'wiw' number (default 20)
7543 global
7544 {not in Vi}
7545 {not available when compiled without the +vertsplit
7546 feature}
7547 Minimal number of columns for the current window. This is not a hard
7548 minimum, Vim will use fewer columns if there is not enough room. If
7549 the current window is smaller, its size is increased, at the cost of
7550 the width of other windows. Set it to 999 to make the current window
7551 always fill the screen. Set it to a small number for normal editing.
7552 The width is not adjusted after one of the commands to change the
7553 width of the current window.
7554 'winwidth' applies to the current window. Use 'winminwidth' to set
7555 the minimal width for other windows.
7556
7557 *'wrap'* *'nowrap'*
7558'wrap' boolean (default on)
7559 local to window
7560 {not in Vi}
7561 This option changes how text is displayed. It doesn't change the text
7562 in the buffer, see 'textwidth' for that.
7563 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007564 displaying continues on the next line. When off lines will not wrap
7565 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007566 moved to a part that is not shown, the screen will scroll
7567 horizontally.
7568 The line will be broken in the middle of a word if necessary. See
7569 'linebreak' to get the break at a word boundary.
7570 To make scrolling horizontally a bit more useful, try this: >
7571 :set sidescroll=5
7572 :set listchars+=precedes:<,extends:>
7573< See 'sidescroll', 'listchars' and |wrap-off|.
7574
7575 *'wrapmargin'* *'wm'*
7576'wrapmargin' 'wm' number (default 0)
7577 local to buffer
7578 Number of characters from the right window border where wrapping
7579 starts. When typing text beyond this limit, an <EOL> will be inserted
7580 and inserting continues on the next line.
7581 Options that add a margin, such as 'number' and 'foldcolumn', cause
7582 the text width to be further reduced. This is Vi compatible.
7583 When 'textwidth' is non-zero, this option is not used.
7584 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7585 and less usefully}
7586
7587 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7588'wrapscan' 'ws' boolean (default on) *E384* *E385*
7589 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007590 Searches wrap around the end of the file. Also applies to |]s| and
7591 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007592
7593 *'write'* *'nowrite'*
7594'write' boolean (default on)
7595 global
7596 {not in Vi}
7597 Allows writing files. When not set, writing a file is not allowed.
7598 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007599 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007600 argument. Filtering text is still possible, even though this requires
7601 writing a temporary file.
7602
7603 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7604'writeany' 'wa' boolean (default off)
7605 global
7606 Allows writing to any file with no need for "!" override.
7607
7608 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7609'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7610 otherwise)
7611 global
7612 {not in Vi}
7613 Make a backup before overwriting a file. The backup is removed after
7614 the file was successfully written, unless the 'backup' option is
7615 also on. Reset this option if your file system is almost full. See
7616 |backup-table| for another explanation.
7617 When the 'backupskip' pattern matches, a backup is not made anyway.
7618 NOTE: This option is set to the default value when 'compatible' is
7619 set.
7620
7621 *'writedelay'* *'wd'*
7622'writedelay' 'wd' number (default 0)
7623 global
7624 {not in Vi}
7625 The number of microseconds to wait for each character sent to the
7626 screen. When non-zero, characters are sent to the terminal one by
7627 one. For MS-DOS pcterm this does not work. For debugging purposes.
7628
7629 vim:tw=78:ts=8:ft=help:norl: