blob: b04bb5562b42e892475964a0da814194142cf454 [file] [log] [blame]
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001*options.txt* For Vim version 7.0c. Last change: 2006 Apr 05
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.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000687 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000688
689 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
690'arabic' 'arab' boolean (default off)
691 local to window
692 {not in Vi}
693 {only available when compiled with the |+arabic|
694 feature}
695 This option can be set to start editing Arabic text.
696 Setting this option will:
697 - Set the 'rightleft' option, unless 'termbidi' is set.
698 - Set the 'arabicshape' option, unless 'termbidi' is set.
699 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
700 between typing English and Arabic key mapping.
701 - Set the 'delcombine' option
702 Note that 'encoding' must be "utf-8" for working with Arabic text.
703
704 Resetting this option will:
705 - Reset the 'rightleft' option.
706 - Disable the use of 'keymap' (without changing its value).
707 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
708 option.
709 Also see |arabic.txt|.
710
711 *'arabicshape'* *'arshape'*
712 *'noarabicshape'* *'noarshape'*
713'arabicshape' 'arshape' boolean (default on)
714 global
715 {not in Vi}
716 {only available when compiled with the |+arabic|
717 feature}
718 When on and 'termbidi' is off, the required visual character
719 corrections that need to take place for displaying the Arabic language
720 take affect. Shaping, in essence, gets enabled; the term is a broad
721 one which encompasses:
722 a) the changing/morphing of characters based on their location
723 within a word (initial, medial, final and stand-alone).
724 b) the enabling of the ability to compose characters
725 c) the enabling of the required combining of some characters
726 When disabled the character display reverts back to each character's
727 true stand-alone form.
728 Arabic is a complex language which requires other settings, for
729 further details see |arabic.txt|.
730
731 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
732'autoindent' 'ai' boolean (default off)
733 local to buffer
734 Copy indent from current line when starting a new line (typing <CR>
735 in Insert mode or when using the "o" or "O" command). If you do not
736 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000737 <Esc> or <CR>, the indent is deleted again. Moving the cursor to
738 another line has the same effect, unless the 'I' flag is included in
739 'cpoptions'.
740 When autoindent is on, formatting (with the "gq" command or when you
741 reach 'textwidth' in Insert mode) uses the indentation of the first
742 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000743 When 'smartindent' or 'cindent' is on the indent is changed in
744 a different way.
745 The 'autoindent' option is reset when the 'paste' option is set.
746 {small difference from Vi: After the indent is deleted when typing
747 <Esc> or <CR>, the cursor position when moving up or down is after the
748 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
749
750 *'autoread'* *'ar'* *'noautoread'* *'noar'*
751'autoread' 'ar' boolean (default off)
752 global or local to buffer |global-local|
753 {not in Vi}
754 When a file has been detected to have been changed outside of Vim and
755 it has not been changed inside of Vim, automatically read it again.
756 When the file has been deleted this is not done. |timestamp|
757 If this option has a local value, use this command to switch back to
758 using the global value: >
759 :set autoread<
760<
761 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
762'autowrite' 'aw' boolean (default off)
763 global
764 Write the contents of the file, if it has been modified, on each
765 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
766 :make, CTRL-] and CTRL-^ command; and when a CTRL-O, CTRL-I,
767 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
768 Note that for some commands the 'autowrite' option is not used, see
769 'autowriteall' for that.
770
771 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
772'autowriteall' 'awa' boolean (default off)
773 global
774 {not in Vi}
775 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
776 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
777 Setting this option also implies that Vim behaves like 'autowrite' has
778 been set.
779
780 *'background'* *'bg'*
781'background' 'bg' string (default "dark" or "light")
782 global
783 {not in Vi}
784 When set to "dark", Vim will try to use colors that look good on a
785 dark background. When set to "light", Vim will try to use colors that
786 look good on a light background. Any other value is illegal.
787 Vim tries to set the default value according to the terminal used.
788 This will not always be correct.
789 Setting this option does not change the background color, it tells Vim
790 what the background color looks like. For changing the background
791 color, see |:hi-normal|.
792
793 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000794 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000795 change.
796 When a color scheme is loaded (the "colors_name" variable is set)
797 setting 'background' will cause the color scheme to be reloaded. If
798 the color scheme adjusts to the value of 'background' this will work.
799 However, if the color scheme sets 'background' itself the effect may
800 be undone. First delete the "colors_name" variable when needed.
801
802 When setting 'background' to the default value with: >
803 :set background&
804< Vim will guess the value. In the GUI this should work correctly,
805 in other cases Vim might not be able to guess the right value.
806
807 When starting the GUI, the default value for 'background' will be
808 "light". When the value is not set in the .gvimrc, and Vim detects
809 that the background is actually quite dark, 'background' is set to
810 "dark". But this happens only AFTER the .gvimrc file has been read
811 (because the window needs to be opened to find the actual background
812 color). To get around this, force the GUI window to be opened by
813 putting a ":gui" command in the .gvimrc file, before where the value
814 of 'background' is used (e.g., before ":syntax on").
815 Normally this option would be set in the .vimrc file. Possibly
816 depending on the terminal name. Example: >
817 :if &term == "pcterm"
818 : set background=dark
819 :endif
820< When this option is set, the default settings for the highlight groups
821 will change. To use other settings, place ":highlight" commands AFTER
822 the setting of the 'background' option.
823 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
824 to select the colors for syntax highlighting. After changing this
825 option, you must load syntax.vim again to see the result. This can be
826 done with ":syntax on".
827
828 *'backspace'* *'bs'*
829'backspace' 'bs' string (default "")
830 global
831 {not in Vi}
832 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
833 mode. This is a list of items, separated by commas. Each item allows
834 a way to backspace over something:
835 value effect ~
836 indent allow backspacing over autoindent
837 eol allow backspacing over line breaks (join lines)
838 start allow backspacing over the start of insert; CTRL-W and CTRL-U
839 stop once at the start of insert.
840
841 When the value is empty, Vi compatible backspacing is used.
842
843 For backwards compatibility with version 5.4 and earlier:
844 value effect ~
845 0 same as ":set backspace=" (Vi compatible)
846 1 same as ":set backspace=indent,eol"
847 2 same as ":set backspace=indent,eol,start"
848
849 See |:fixdel| if your <BS> or <Del> key does not do what you want.
850 NOTE: This option is set to "" when 'compatible' is set.
851
852 *'backup'* *'bk'* *'nobackup'* *'nobk'*
853'backup' 'bk' boolean (default off)
854 global
855 {not in Vi}
856 Make a backup before overwriting a file. Leave it around after the
857 file has been successfully written. If you do not want to keep the
858 backup file, but you do want a backup while the file is being
859 written, reset this option and set the 'writebackup' option (this is
860 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000861 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000862 |backup-table| for more explanations.
863 When the 'backupskip' pattern matches, a backup is not made anyway.
864 When 'patchmode' is set, the backup may be renamed to become the
865 oldest version of a file.
866 NOTE: This option is reset when 'compatible' is set.
867
868 *'backupcopy'* *'bkc'*
869'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
870 global
871 {not in Vi}
872 When writing a file and a backup is made, this option tells how it's
873 done. This is a comma separated list of words.
874
875 The main values are:
876 "yes" make a copy of the file and overwrite the original one
877 "no" rename the file and write a new one
878 "auto" one of the previous, what works best
879
880 Extra values that can be combined with the ones above are:
881 "breaksymlink" always break symlinks when writing
882 "breakhardlink" always break hardlinks when writing
883
884 Making a copy and overwriting the original file:
885 - Takes extra time to copy the file.
886 + When the file has special attributes, is a (hard/symbolic) link or
887 has a resource fork, all this is preserved.
888 - When the file is a link the backup will have the name of the link,
889 not of the real file.
890
891 Renaming the file and writing a new one:
892 + It's fast.
893 - Sometimes not all attributes of the file can be copied to the new
894 file.
895 - When the file is a link the new file will not be a link.
896
897 The "auto" value is the middle way: When Vim sees that renaming file
898 is possible without side effects (the attributes can be passed on and
899 and the file is not a link) that is used. When problems are expected,
900 a copy will be made.
901
902 The "breaksymlink" and "breakhardlink" values can be used in
903 combination with any of "yes", "no" and "auto". When included, they
904 force Vim to always break either symbolic or hard links by doing
905 exactly what the "no" option does, renaming the original file to
906 become the backup and writing a new file in its place. This can be
907 useful for example in source trees where all the files are symbolic or
908 hard links and any changes should stay in the local source tree, not
909 be propagated back to the original source.
910 *crontab*
911 One situation where "no" and "auto" will cause problems: A program
912 that opens a file, invokes Vim to edit that file, and then tests if
913 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000914 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000915 example.
916
917 When a copy is made, the original file is truncated and then filled
918 with the new text. This means that protection bits, owner and
919 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000920 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000921 group of the backup is set to the group of the original file. If this
922 fails, the protection bits for the group are made the same as for
923 others.
924
925 When the file is renamed this is the other way around: The backup has
926 the same attributes of the original file, and the newly written file
927 is owned by the current user. When the file was a (hard/symbolic)
928 link, the new file will not! That's why the "auto" value doesn't
929 rename when the file is a link. The owner and group of the newly
930 written file will be set to the same ones as the original file, but
931 the system may refuse to do this. In that case the "auto" value will
932 again not rename the file.
933
934 *'backupdir'* *'bdir'*
935'backupdir' 'bdir' string (default for Amiga: ".,t:",
936 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
937 for Unix: ".,~/tmp,~/")
938 global
939 {not in Vi}
940 List of directories for the backup file, separated with commas.
941 - The backup file will be created in the first directory in the list
942 where this is possible.
943 - Empty means that no backup file will be created ('patchmode' is
944 impossible!). Writing may fail because of this.
945 - A directory "." means to put the backup file in the same directory
946 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000947 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000948 put the backup file relative to where the edited file is. The
949 leading "." is replaced with the path name of the edited file.
950 ("." inside a directory name has no special meaning).
951 - Spaces after the comma are ignored, other spaces are considered part
952 of the directory name. To have a space at the start of a directory
953 name, precede it with a backslash.
954 - To include a comma in a directory name precede it with a backslash.
955 - A directory name may end in an '/'.
956 - Environment variables are expanded |:set_env|.
957 - Careful with '\' characters, type one before a space, type two to
958 get one in the option (see |option-backslash|), for example: >
959 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
960< - For backwards compatibility with Vim version 3.0 a '>' at the start
961 of the option is removed.
962 See also 'backup' and 'writebackup' options.
963 If you want to hide your backup files on Unix, consider this value: >
964 :set backupdir=./.backup,~/.backup,.,/tmp
965< You must create a ".backup" directory in each directory and in your
966 home directory for this to work properly.
967 The use of |:set+=| and |:set-=| is preferred when adding or removing
968 directories from the list. This avoids problems when a future version
969 uses another default.
970 This option cannot be set from a |modeline| or in the |sandbox|, for
971 security reasons.
972
973 *'backupext'* *'bex'* *E589*
974'backupext' 'bex' string (default "~", for VMS: "_")
975 global
976 {not in Vi}
977 String which is appended to a file name to make the name of the
978 backup file. The default is quite unusual, because this avoids
979 accidentally overwriting existing files with a backup file. You might
980 prefer using ".bak", but make sure that you don't have files with
981 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000982 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000983
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +0000984 If you like to keep a lot of backups, you could use a BufWritePre
985 autocommand to change 'backupext' just before writing the file to
986 include a timestamp. >
987 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
988< Use 'backupdir' to put the backup in a different directory.
989
Bram Moolenaar071d4272004-06-13 20:20:40 +0000990 *'backupskip'* *'bsk'*
991'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
992 global
993 {not in Vi}
994 {not available when compiled without the |+wildignore|
995 feature}
996 A list of file patterns. When one of the patterns matches with the
997 name of the file which is written, no backup file is created. Both
998 the specified file name and the full path name of the file are used.
999 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1000 Watch out for special characters, see |option-backslash|.
1001 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001002 default value. "/tmp/*" is only used for Unix.
Bram Moolenaara5792f52005-11-23 21:25:05 +00001003 Note that the default also makes sure that "crontab -e" works (when a
1004 backup would be made by renaming the original file crontab won't see
1005 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001006
1007 *'balloondelay'* *'bdlay'*
1008'balloondelay' 'bdlay' number (default: 600)
1009 global
1010 {not in Vi}
1011 {only available when compiled with the |+balloon_eval|
1012 feature}
1013 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1014
1015 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1016'ballooneval' 'beval' boolean (default off)
1017 global
1018 {not in Vi}
1019 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001020 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001021 Switch on the |balloon-eval| functionality.
1022
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001023 *'balloonexpr'* *'bexpr'*
1024'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001025 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001026 {not in Vi}
1027 {only available when compiled with the |+balloon_eval|
1028 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001029 Expression for text to show in evaluation balloon. It is only used
1030 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001031
1032 v:beval_bufnr number of the buffer in which balloon is going to show
1033 v:beval_winnr number of the window
1034 v:beval_lnum line number
1035 v:beval_col column number (byte index)
1036 v:beval_text word under or after the mouse pointer
1037
1038 The evaluation of the expression must not have side effects!
1039 Example: >
1040 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001041 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001042 \', column ' . v:beval_col .
1043 \ ' of file ' . bufname(v:beval_bufnr) .
1044 \ ' on word "' . v:beval_text . '"'
1045 endfunction
1046 set bexpr=MyBalloonExpr()
1047 set ballooneval
1048<
1049 NOTE: The balloon is displayed only if the cursor is on a text
1050 character. If the result of evaluating 'balloonexpr' is not empty,
1051 Vim does not try to send a message to an external debugger (Netbeans
1052 or Sun Workshop).
1053
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001054 The expression may be evaluated in the |sandbox|, see
1055 |sandbox-option|.
1056
1057 It is not allowed to change text or jump to another window while
1058 evaluating 'balloonexpr' |textlock|.
1059
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001060 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001061 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001062< When they are supported "\n" characters will start a new line. If the
1063 expression evaluates to a |List| this is equal to using each List item
1064 as a string and putting "\n" in between them.
1065
Bram Moolenaar071d4272004-06-13 20:20:40 +00001066 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1067'binary' 'bin' boolean (default off)
1068 local to buffer
1069 {not in Vi}
1070 This option should be set before editing a binary file. You can also
1071 use the |-b| Vim argument. When this option is switched on a few
1072 options will be changed (also when it already was on):
1073 'textwidth' will be set to 0
1074 'wrapmargin' will be set to 0
1075 'modeline' will be off
1076 'expandtab' will be off
1077 Also, 'fileformat' and 'fileformats' options will not be used, the
1078 file is read and written like 'fileformat' was "unix" (a single <NL>
1079 separates lines).
1080 The 'fileencoding' and 'fileencodings' options will not be used, the
1081 file is read without conversion.
1082 NOTE: When you start editing a(nother) file while the 'bin' option is
1083 on, settings from autocommands may change the settings again (e.g.,
1084 'textwidth'), causing trouble when editing. You might want to set
1085 'bin' again when the file has been loaded.
1086 The previous values of these options are remembered and restored when
1087 'bin' is switched from on to off. Each buffer has its own set of
1088 saved option values.
1089 To edit a file with 'binary' set you can use the |++bin| argument.
1090 This avoids you have to do ":set bin", which would have effect for all
1091 files you edit.
1092 When writing a file the <EOL> for the last line is only written if
1093 there was one in the original file (normally Vim appends an <EOL> to
1094 the last line if there is none; this would make the file longer). See
1095 the 'endofline' option.
1096
1097 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1098'bioskey' 'biosk' boolean (default on)
1099 global
1100 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001101 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001102 better to detect CTRL-C, but only works for the console. When using a
1103 terminal over a serial port reset this option.
1104 Also see |'conskey'|.
1105
1106 *'bomb'* *'nobomb'*
1107'bomb' boolean (default off)
1108 local to buffer
1109 {not in Vi}
1110 {only available when compiled with the |+multi_byte|
1111 feature}
1112 When writing a file and the following conditions are met, a BOM (Byte
1113 Order Mark) is prepended to the file:
1114 - this option is on
1115 - the 'binary' option is off
1116 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1117 endian variants.
1118 Some applications use the BOM to recognize the encoding of the file.
1119 Often used for UCS-2 files on MS-Windows. For other applications it
1120 causes trouble, for example: "cat file1 file2" makes the BOM of file2
1121 appear halfway the resulting file.
1122 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1123 check for the presence of the BOM is done and 'bomb' set accordingly.
1124 Unless 'binary' is set, it is removed from the first line, so that you
1125 don't see it when editing. When you don't change the options, the BOM
1126 will be restored when writing the file.
1127
1128 *'breakat'* *'brk'*
1129'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1130 global
1131 {not in Vi}
1132 {not available when compiled without the |+linebreak|
1133 feature}
1134 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001135 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1136 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001137
1138 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001139'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001140 global
1141 {not in Vi} {only for Motif and Win32 GUI}
1142 Which directory to use for the file browser:
1143 last Use same directory as with last file browser.
1144 buffer Use the directory of the related buffer.
1145 current Use the current directory.
1146 {path} Use the specified directory
1147
1148 *'bufhidden'* *'bh'*
1149'bufhidden' 'bh' string (default: "")
1150 local to buffer
1151 {not in Vi}
1152 {not available when compiled without the |+quickfix|
1153 feature}
1154 This option specifies what happens when a buffer is no longer
1155 displayed in a window:
1156 <empty> follow the global 'hidden' option
1157 hide hide the buffer (don't unload it), also when 'hidden'
1158 is not set
1159 unload unload the buffer, also when 'hidden' is set or using
1160 |:hide|
1161 delete delete the buffer from the buffer list, also when
1162 'hidden' is set or using |:hide|, like using
1163 |:bdelete|
1164 wipe wipe out the buffer from the buffer list, also when
1165 'hidden' is set or using |:hide|, like using
1166 |:bwipeout|
1167
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001168 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1169 are lost without a warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001170 This option is used together with 'buftype' and 'swapfile' to specify
1171 special kinds of buffers. See |special-buffers|.
1172
1173 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1174'buflisted' 'bl' boolean (default: on)
1175 local to buffer
1176 {not in Vi}
1177 When this option is set, the buffer shows up in the buffer list. If
1178 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1179 This option is reset by Vim for buffers that are only used to remember
1180 a file name or marks. Vim sets it when starting to edit a buffer.
1181 But not when moving to a buffer with ":buffer".
1182
1183 *'buftype'* *'bt'* *E382*
1184'buftype' 'bt' string (default: "")
1185 local to buffer
1186 {not in Vi}
1187 {not available when compiled without the |+quickfix|
1188 feature}
1189 The value of this option specifies the type of a buffer:
1190 <empty> normal buffer
1191 nofile buffer which is not related to a file and will not be
1192 written
1193 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001194 acwrite buffer which will always be written with BufWriteCmd
1195 autocommands. {not available when compiled without the
1196 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001197 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001198 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001199 help help buffer (you are not supposed to set this
1200 manually)
1201
1202 This option is used together with 'bufhidden' and 'swapfile' to
1203 specify special kinds of buffers. See |special-buffers|.
1204
1205 Be careful with changing this option, it can have many side effects!
1206
Bram Moolenaar280f1262006-01-30 00:14:18 +00001207 A "quickfix" buffer is only used for the error list and the location
1208 list. This value is set by the |:cwindow| and |:lwindow| commands and
1209 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001210
1211 "nofile" and "nowrite" buffers are similar:
1212 both: The buffer is not to be written to disk, ":w" doesn't
1213 work (":w filename" does work though).
1214 both: The buffer is never considered to be |'modified'|.
1215 There is no warning when the changes will be lost, for
1216 example when you quit Vim.
1217 both: A swap file is only created when using too much memory
1218 (when 'swapfile' has been reset there is never a swap
1219 file).
1220 nofile only: The buffer name is fixed, it is not handled like a
1221 file name. It is not modified in response to a |:cd|
1222 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001223 *E676*
1224 "acwrite" implies that the buffer name is not related to a file, like
1225 "nofile", but it will be written. Thus, in contrast to "nofile" and
1226 "nowrite", ":w" does work and a modified buffer can't be abandoned
1227 without saving. For writing there must be matching |BufWriteCmd|,
1228 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001229
1230 *'casemap'* *'cmp'*
1231'casemap' 'cmp' string (default: "internal,keepascii")
1232 global
1233 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001234 {only available when compiled with the |+multi_byte|
1235 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001236 Specifies details about changing the case of letters. It may contain
1237 these words, separated by a comma:
1238 internal Use internal case mapping functions, the current
1239 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001240 matters when 'encoding' is a Unicode encoding,
1241 "latin1" or "iso-8859-15". When "internal" is
1242 omitted, the towupper() and towlower() system library
1243 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001244 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1245 case mapping, the current locale is not effective.
1246 This probably only matters for Turkish.
1247
1248 *'cdpath'* *'cd'* *E344* *E346*
1249'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1250 global
1251 {not in Vi}
1252 {not available when compiled without the
1253 |+file_in_path| feature}
1254 This is a list of directories which will be searched when using the
1255 |:cd| and |:lcd| commands, provided that the directory being searched
1256 for has a relative path (not starting with "/", "./" or "../").
1257 The 'cdpath' option's value has the same form and semantics as
1258 |'path'|. Also see |file-searching|.
1259 The default value is taken from $CDPATH, with a "," prepended to look
1260 in the current directory first.
1261 If the default value taken from $CDPATH is not what you want, include
1262 a modified version of the following command in your vimrc file to
1263 override it: >
1264 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1265< This option cannot be set from a |modeline| or in the |sandbox|, for
1266 security reasons.
1267 (parts of 'cdpath' can be passed to the shell to expand file names).
1268
1269 *'cedit'*
1270'cedit' string (Vi default: "", Vim default: CTRL-F)
1271 global
1272 {not in Vi}
1273 {not available when compiled without the |+vertsplit|
1274 feature}
1275 The key used in Command-line Mode to open the command-line window.
1276 The default is CTRL-F when 'compatible' is off.
1277 Only non-printable keys are allowed.
1278 The key can be specified as a single character, but it is difficult to
1279 type. The preferred way is to use the <> notation. Examples: >
1280 :set cedit=<C-Y>
1281 :set cedit=<Esc>
1282< |Nvi| also has this option, but it only uses the first character.
1283 See |cmdwin|.
1284
1285 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1286'charconvert' 'ccv' string (default "")
1287 global
1288 {only available when compiled with the |+multi_byte|
1289 feature and the |+eval| feature}
1290 {not in Vi}
1291 An expression that is used for character encoding conversion. It is
1292 evaluated when a file that is to be read or has been written has a
1293 different encoding from what is desired.
1294 'charconvert' is not used when the internal iconv() function is
1295 supported and is able to do the conversion. Using iconv() is
1296 preferred, because it is much faster.
1297 'charconvert' is not used when reading stdin |--|, because there is no
1298 file to convert from. You will have to save the text in a file first.
1299 The expression must return zero or an empty string for success,
1300 non-zero for failure.
1301 The possible encoding names encountered are in 'encoding'.
1302 Additionally, names given in 'fileencodings' and 'fileencoding' are
1303 used.
1304 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1305 is done internally by Vim, 'charconvert' is not used for this.
1306 'charconvert' is also used to convert the viminfo file, if the 'c'
1307 flag is present in 'viminfo'. Also used for Unicode conversion.
1308 Example: >
1309 set charconvert=CharConvert()
1310 fun CharConvert()
1311 system("recode "
1312 \ . v:charconvert_from . ".." . v:charconvert_to
1313 \ . " <" . v:fname_in . " >" v:fname_out)
1314 return v:shell_error
1315 endfun
1316< The related Vim variables are:
1317 v:charconvert_from name of the current encoding
1318 v:charconvert_to name of the desired encoding
1319 v:fname_in name of the input file
1320 v:fname_out name of the output file
1321 Note that v:fname_in and v:fname_out will never be the same.
1322 Note that v:charconvert_from and v:charconvert_to may be different
1323 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1324 Encryption is not done by Vim when using 'charconvert'. If you want
1325 to encrypt the file after conversion, 'charconvert' should take care
1326 of this.
1327 This option cannot be set from a |modeline| or in the |sandbox|, for
1328 security reasons.
1329
1330 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1331'cindent' 'cin' boolean (default off)
1332 local to buffer
1333 {not in Vi}
1334 {not available when compiled without the |+cindent|
1335 feature}
1336 Enables automatic C program indenting See 'cinkeys' to set the keys
1337 that trigger reindenting in insert mode and 'cinoptions' to set your
1338 preferred indent style.
1339 If 'indentexpr' is not empty, it overrules 'cindent'.
1340 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1341 the "=" operator indents using this algorithm rather than calling an
1342 external program.
1343 See |C-indenting|.
1344 When you don't like the way 'cindent' works, try the 'smartindent'
1345 option or 'indentexpr'.
1346 This option is not used when 'paste' is set.
1347 NOTE: This option is reset when 'compatible' is set.
1348
1349 *'cinkeys'* *'cink'*
1350'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1351 local to buffer
1352 {not in Vi}
1353 {not available when compiled without the |+cindent|
1354 feature}
1355 A list of keys that, when typed in Insert mode, cause reindenting of
1356 the current line. Only used if 'cindent' is on and 'indentexpr' is
1357 empty.
1358 For the format of this option see |cinkeys-format|.
1359 See |C-indenting|.
1360
1361 *'cinoptions'* *'cino'*
1362'cinoptions' 'cino' string (default "")
1363 local to buffer
1364 {not in Vi}
1365 {not available when compiled without the |+cindent|
1366 feature}
1367 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1368 program. See |cinoptions-values| for the values of this option, and
1369 |C-indenting| for info on C indenting in general.
1370
1371
1372 *'cinwords'* *'cinw'*
1373'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1374 local to buffer
1375 {not in Vi}
1376 {not available when compiled without both the
1377 |+cindent| and the |+smartindent| features}
1378 These keywords start an extra indent in the next line when
1379 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1380 an appropriate place (inside {}).
1381 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1382 matter, include the keyword both the uppercase and lowercase:
1383 "if,If,IF".
1384
1385 *'clipboard'* *'cb'*
1386'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1387 for X-windows, "" otherwise)
1388 global
1389 {not in Vi}
1390 {only in GUI versions or when the |+xterm_clipboard|
1391 feature is included}
1392 This option is a list of comma separated names.
1393 These names are recognized:
1394
1395 unnamed When included, Vim will use the clipboard register '*'
1396 for all yank, delete, change and put operations which
1397 would normally go to the unnamed register. When a
1398 register is explicitly specified, it will always be
1399 used regardless of whether "unnamed" is in 'clipboard'
1400 or not. The clipboard register can always be
1401 explicitly accessed using the "* notation. Also see
1402 |gui-clipboard|.
1403
1404 autoselect Works like the 'a' flag in 'guioptions': If present,
1405 then whenever Visual mode is started, or the Visual
1406 area extended, Vim tries to become the owner of the
1407 windowing system's global selection or put the
1408 selected text on the clipboard used by the selection
1409 register "*. See |guioptions_a| and |quotestar| for
1410 details. When the GUI is active, the 'a' flag in
1411 'guioptions' is used, when the GUI is not active, this
1412 "autoselect" flag is used.
1413 Also applies to the modeless selection.
1414
1415 autoselectml Like "autoselect", but for the modeless selection
1416 only. Compare to the 'A' flag in 'guioptions'.
1417
1418 exclude:{pattern}
1419 Defines a pattern that is matched against the name of
1420 the terminal 'term'. If there is a match, no
1421 connection will be made to the X server. This is
1422 useful in this situation:
1423 - Running Vim in a console.
1424 - $DISPLAY is set to start applications on another
1425 display.
1426 - You do not want to connect to the X server in the
1427 console, but do want this in a terminal emulator.
1428 To never connect to the X server use: >
1429 exclude:.*
1430< This has the same effect as using the |-X| argument.
1431 Note that when there is no connection to the X server
1432 the window title won't be restored and the clipboard
1433 cannot be accessed.
1434 The value of 'magic' is ignored, {pattern} is
1435 interpreted as if 'magic' was on.
1436 The rest of the option value will be used for
1437 {pattern}, this must be the last entry.
1438
1439 *'cmdheight'* *'ch'*
1440'cmdheight' 'ch' number (default 1)
1441 global
1442 {not in Vi}
1443 Number of screen lines to use for the command-line. Helps avoiding
1444 |hit-enter| prompts.
1445
1446 *'cmdwinheight'* *'cwh'*
1447'cmdwinheight' 'cwh' number (default 7)
1448 global
1449 {not in Vi}
1450 {not available when compiled without the |+vertsplit|
1451 feature}
1452 Number of screen lines to use for the command-line window. |cmdwin|
1453
1454 *'columns'* *'co'* *E594*
1455'columns' 'co' number (default 80 or terminal width)
1456 global
1457 {not in Vi}
1458 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001459 initialization and does not have to be set by hand. Also see
1460 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001461 When Vim is running in the GUI or in a resizable window, setting this
1462 option will cause the window size to be changed. When you only want
1463 to use the size for the GUI, put the command in your |gvimrc| file.
1464 When you set this option and Vim is unable to change the physical
1465 number of columns of the display, the display may be messed up.
Bram Moolenaarf4d11452005-12-02 00:46:37 +00001466 Mimimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001467
1468 *'comments'* *'com'* *E524* *E525*
1469'comments' 'com' string (default
1470 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1471 local to buffer
1472 {not in Vi}
1473 {not available when compiled without the |+comments|
1474 feature}
1475 A comma separated list of strings that can start a comment line. See
1476 |format-comments|. See |option-backslash| about using backslashes to
1477 insert a space.
1478
1479 *'commentstring'* *'cms'* *E537*
1480'commentstring' 'cms' string (default "/*%s*/")
1481 local to buffer
1482 {not in Vi}
1483 {not available when compiled without the |+folding|
1484 feature}
1485 A template for a comment. The "%s" in the value is replaced with the
1486 comment text. Currently only used to add markers for folding, see
1487 |fold-marker|.
1488
1489 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001490'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1491 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001492 global
1493 {not in Vi}
1494 This option has the effect of making Vim either more Vi-compatible, or
1495 make Vim behave in a more useful way.
1496 This is a special kind of option, because when it's set or reset,
1497 other options are also changed as a side effect. CAREFUL: Setting or
1498 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001499 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001500 set this option in your vimrc file, you should probably put it at the
1501 very start.
1502 By default this option is on and the Vi defaults are used for the
1503 options. This default was chosen for those people who want to use Vim
1504 just like Vi, and don't even (want to) know about the 'compatible'
1505 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001506 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001507 this option is switched off, and all options that have not been
1508 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001509 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001510 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
1511 happen for the system-wide vimrc or gvimrc file). Also see
1512 |compatible-default| and |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001513 You can also set this option with the "-C" argument, and reset it with
1514 "-N". See |-C| and |-N|.
1515 Switching this option off makes the Vim defaults be used for options
1516 that have a different Vi and Vim default value. See the options
1517 marked with a '+' below. Other options are not modified.
1518 At the moment this option is set, several other options will be set
1519 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001520 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001521 editing.
1522 See also 'cpoptions'.
1523
1524 option + set value effect ~
1525
1526 'allowrevins' off no CTRL-_ command
1527 'backupcopy' Unix: "yes" backup file is a copy
1528 others: "auto" copy or rename backup file
1529 'backspace' "" normal backspace
1530 'backup' off no backup file
1531 'cindent' off no C code indentation
1532 'cedit' + "" no key to open the |cmdwin|
1533 'cpoptions' + (all flags) Vi-compatible flags
1534 'cscopetag' off don't use cscope for ":tag"
1535 'cscopetagorder' 0 see |cscopetagorder|
1536 'cscopeverbose' off see |cscopeverbose|
1537 'digraph' off no digraphs
1538 'esckeys' + off no <Esc>-keys in Insert mode
1539 'expandtab' off tabs not expanded to spaces
1540 'fileformats' + "" no automatic file format detection,
1541 "dos,unix" except for DOS, Windows and OS/2
1542 'formatoptions' + "vt" Vi compatible formatting
1543 'gdefault' off no default 'g' flag for ":s"
1544 'history' + 0 no commandline history
1545 'hkmap' off no Hebrew keyboard mapping
1546 'hkmapp' off no phonetic Hebrew keyboard mapping
1547 'hlsearch' off no highlighting of search matches
1548 'incsearch' off no incremental searching
1549 'indentexpr' "" no indenting by expression
1550 'insertmode' off do not start in Insert mode
1551 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1552 characters and '_'
1553 'joinspaces' on insert 2 spaces after period
1554 'modeline' + off no modelines
1555 'more' + off no pauses in listings
1556 'revins' off no reverse insert
1557 'ruler' off no ruler
1558 'scrolljump' 1 no jump scroll
1559 'scrolloff' 0 no scroll offset
1560 'shiftround' off indent not rounded to shiftwidth
1561 'shortmess' + "" no shortening of messages
1562 'showcmd' + off command characters not shown
1563 'showmode' + off current mode not shown
1564 'smartcase' off no automatic ignore case switch
1565 'smartindent' off no smart indentation
1566 'smarttab' off no smart tab size
1567 'softtabstop' 0 tabs are always 'tabstop' positions
1568 'startofline' on goto startofline with some commands
1569 'tagrelative' + off tag file names are not relative
1570 'textauto' + off no automatic textmode detection
1571 'textwidth' 0 no automatic line wrap
1572 'tildeop' off tilde is not an operator
1573 'ttimeout' off no terminal timeout
1574 'whichwrap' + "" left-right movements don't wrap
1575 'wildchar' + CTRL-E only when the current value is <Tab>
1576 use CTRL-E for cmdline completion
1577 'writebackup' on or off depends on +writebackup feature
1578
1579 *'complete'* *'cpt'* *E535*
1580'complete' 'cpt' string (default: ".,w,b,u,t,i")
1581 local to buffer
1582 {not in Vi}
1583 This option specifies how keyword completion |ins-completion| works
1584 when CTRL-P or CTRL-N are used. It is also used for whole-line
1585 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1586 and the places to scan. It is a comma separated list of flags:
1587 . scan the current buffer ('wrapscan' is ignored)
1588 w scan buffers from other windows
1589 b scan other loaded buffers that are in the buffer list
1590 u scan the unloaded buffers that are in the buffer list
1591 U scan the buffers that are not in the buffer list
1592 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001593 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001594 k{dict} scan the file {dict}. Several "k" flags can be given,
1595 patterns are valid too. For example: >
1596 :set cpt=k/usr/dict/*,k~/spanish
1597< s scan the files given with the 'thesaurus' option
1598 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1599 are valid too.
1600 i scan current and included files
1601 d scan current and included files for defined name or macro
1602 |i_CTRL-X_CTRL-D|
1603 ] tag completion
1604 t same as "]"
1605
1606 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1607 not executed, this may lead to unexpected completions from some files
1608 (gzipped files for example). Unloaded buffers are not scanned for
1609 whole-line completion.
1610
1611 The default is ".,w,b,u,t,i", which means to scan:
1612 1. the current buffer
1613 2. buffers in other windows
1614 3. other loaded buffers
1615 4. unloaded buffers
1616 5. tags
1617 6. included files
1618
1619 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001620 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1621 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001622
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001623 *'completefunc'* *'cfu'*
1624'completefunc' 'cfu' string (default: empty)
1625 local to buffer
1626 {not in Vi}
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001627 {not available when compiled without the +eval
1628 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001629 This option specifies a function to be used for Insert mode completion
1630 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001631 See |complete-functions| for an explanation of how the function is
1632 invoked and what it should return.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001633
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001634
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001635 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001636'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001637 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001638 {not available when compiled without the
1639 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001640 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001641 A comma separated list of options for Insert mode completion
1642 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001643
1644 menu Use a popup menu to show the possible completions. The
1645 menu is only shown when there is more than one match and
1646 sufficient colors are available. |ins-completion-menu|
1647
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001648 menuone Use the popup menu also when there is only one match.
1649 Useful when there is additional information about the
1650 match, e.g., what file it comes from.
1651
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001652 longest Only insert the longest common text of the matches. Use
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001653 CTRL-L to add more characters. Whether case is ignored
Bram Moolenaard1f56e62006-02-22 21:25:37 +00001654 depends on the kind of completion. For buffer text the
1655 'ignorecase' option is used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001656
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001657 preview Show extra information about the currently selected
1658 completion in the preview window.
1659
Bram Moolenaar071d4272004-06-13 20:20:40 +00001660 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1661'confirm' 'cf' boolean (default off)
1662 global
1663 {not in Vi}
1664 When 'confirm' is on, certain operations that would normally
1665 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1666 instead raise a |dialog| asking if you wish to save the current
1667 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1668 If 'confirm' is off you can still activate confirmation for one
1669 command only (this is most useful in mappings) with the |:confirm|
1670 command.
1671 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1672
1673 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1674'conskey' 'consk' boolean (default off)
1675 global
1676 {not in Vi} {only for MS-DOS}
1677 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001678 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001679 three methods of console input are available:
1680 'conskey' 'bioskey' action ~
1681 on on or off direct console input
1682 off on BIOS
1683 off off STDIN
1684
1685 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1686'copyindent' 'ci' boolean (default off)
1687 local to buffer
1688 {not in Vi}
1689 Copy the structure of the existing lines indent when autoindenting a
1690 new line. Normally the new indent is reconstructed by a series of
1691 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1692 in which case only spaces are used). Enabling this option makes the
1693 new line copy whatever characters were used for indenting on the
1694 existing line. If the new indent is greater than on the existing
1695 line, the remaining space is filled in the normal manner.
1696 NOTE: 'copyindent' is reset when 'compatible' is set.
1697 Also see 'preserveindent'.
1698
1699 *'cpoptions'* *'cpo'*
1700'cpoptions' 'cpo' string (Vim default: "aABceFs",
1701 Vi default: all flags)
1702 global
1703 {not in Vi}
1704 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001705 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001706 not being vi-compatible is mostly or sometimes preferred.
1707 'cpoptions' stands for "compatible-options".
1708 Commas can be added for readability.
1709 To avoid problems with flags that are added in the future, use the
1710 "+=" and "-=" feature of ":set" |add-option-flags|.
1711 NOTE: This option is set to the Vi default value when 'compatible' is
1712 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001713 NOTE: This option is set to the POSIX default value at startup when
1714 the Vi default value would be used and the $VIM_POSIX environment
1715 variable exists |posix|. This means tries to behave like the POSIX
1716 specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001717
1718 contains behavior ~
1719 *cpo-a*
1720 a When included, a ":read" command with a file name
1721 argument will set the alternate file name for the
1722 current window.
1723 *cpo-A*
1724 A When included, a ":write" command with a file name
1725 argument will set the alternate file name for the
1726 current window.
1727 *cpo-b*
1728 b "\|" in a ":map" command is recognized as the end of
1729 the map command. The '\' is included in the mapping,
1730 the text after the '|' is interpreted as the next
1731 command. Use a CTRL-V instead of a backslash to
1732 include the '|' in the mapping. Applies to all
1733 mapping, abbreviation, menu and autocmd commands.
1734 See also |map_bar|.
1735 *cpo-B*
1736 B A backslash has no special meaning in mappings,
1737 abbreviations and the "to" part of the menu commands.
1738 Remove this flag to be able to use a backslash like a
1739 CTRL-V. For example, the command ":map X \<Esc>"
1740 results in X being mapped to:
1741 'B' included: "\^[" (^[ is a real <Esc>)
1742 'B' excluded: "<Esc>" (5 characters)
1743 ('<' excluded in both cases)
1744 *cpo-c*
1745 c Searching continues at the end of any match at the
1746 cursor position, but not further than the start of the
1747 next line. When not present searching continues
1748 one character from the cursor position. With 'c'
1749 "abababababab" only gets three matches when repeating
1750 "/abab", without 'c' there are five matches.
1751 *cpo-C*
1752 C Do not concatenate sourced lines that start with a
1753 backslash. See |line-continuation|.
1754 *cpo-d*
1755 d Using "./" in the 'tags' option doesn't mean to use
1756 the tags file relative to the current file, but the
1757 tags file in the current directory.
1758 *cpo-D*
1759 D Can't use CTRL-K to enter a digraph after Normal mode
1760 commands with a character argument, like |r|, |f| and
1761 |t|.
1762 *cpo-e*
1763 e When executing a register with ":@r", always add a
1764 <CR> to the last line, also when the register is not
1765 linewise. If this flag is not present, the register
1766 is not linewise and the last line does not end in a
1767 <CR>, then the last line is put on the command-line
1768 and can be edited before hitting <CR>.
1769 *cpo-E*
1770 E It is an error when using "y", "d", "c", "g~", "gu" or
1771 "gU" on an Empty region. The operators only work when
1772 at least one character is to be operate on. Example:
1773 This makes "y0" fail in the first column.
1774 *cpo-f*
1775 f When included, a ":read" command with a file name
1776 argument will set the file name for the current buffer,
1777 if the current buffer doesn't have a file name yet.
1778 *cpo-F*
1779 F When included, a ":write" command with a file name
1780 argument will set the file name for the current
1781 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001782 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001783 *cpo-g*
1784 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001785 *cpo-H*
1786 H When using "I" on a line with only blanks, insert
1787 before the last blank. Without this flag insert after
1788 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001789 *cpo-i*
1790 i When included, interrupting the reading of a file will
1791 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001792 *cpo-I*
1793 I When moving the cursor up or down just after inserting
1794 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001795 *cpo-j*
1796 j When joining lines, only add two spaces after a '.',
1797 not after '!' or '?'. Also see 'joinspaces'.
1798 *cpo-J*
1799 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001800 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001801 white space.
1802 *cpo-k*
1803 k Disable the recognition of raw key codes in
1804 mappings, abbreviations, and the "to" part of menu
1805 commands. For example, if <Key> sends ^[OA (where ^[
1806 is <Esc>), the command ":map X ^[OA" results in X
1807 being mapped to:
1808 'k' included: "^[OA" (3 characters)
1809 'k' excluded: "<Key>" (one key code)
1810 Also see the '<' flag below.
1811 *cpo-K*
1812 K Don't wait for a key code to complete when it is
1813 halfway a mapping. This breaks mapping <F1><F1> when
1814 only part of the second <F1> has been read. It
1815 enables cancelling the mapping by typing <F1><Esc>.
1816 *cpo-l*
1817 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001818 literally, only "\]", "\^", "\-" and "\\" are special.
1819 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001820 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1821 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001822 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001823 *cpo-L*
1824 L When the 'list' option is set, 'wrapmargin',
1825 'textwidth', 'softtabstop' and Virtual Replace mode
1826 (see |gR|) count a <Tab> as two characters, instead of
1827 the normal behavior of a <Tab>.
1828 *cpo-m*
1829 m When included, a showmatch will always wait half a
1830 second. When not included, a showmatch will wait half
1831 a second or until a character is typed. |'showmatch'|
1832 *cpo-M*
1833 M When excluded, "%" matching will take backslashes into
1834 account. Thus in "( \( )" and "\( ( \)" the outer
1835 parenthesis match. When included "%" ignores
1836 backslashes, which is Vi compatible.
1837 *cpo-n*
1838 n When included, the column used for 'number' will also
1839 be used for text of wrapped lines.
1840 *cpo-o*
1841 o Line offset to search command is not remembered for
1842 next search.
1843 *cpo-O*
1844 O Don't complain if a file is being overwritten, even
1845 when it didn't exist when editing it. This is a
1846 protection against a file unexpectedly created by
1847 someone else. Vi didn't complain about this.
1848 *cpo-p*
1849 p Vi compatible Lisp indenting. When not present, a
1850 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001851 *cpo-P*
1852 P When included, a ":write" command that appends to a
1853 file will set the file name for the current buffer, if
1854 the current buffer doesn't have a file name yet and
1855 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001856 *cpo-q*
1857 q When joining multiple lines leave the cursor at the
1858 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001859 *cpo-r*
1860 r Redo ("." command) uses "/" to repeat a search
1861 command, instead of the actually used search string.
1862 *cpo-R*
1863 R Remove marks from filtered lines. Without this flag
1864 marks are kept like |:keepmarks| was used.
1865 *cpo-s*
1866 s Set buffer options when entering the buffer for the
1867 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001868 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001869 set when the buffer is created.
1870 *cpo-S*
1871 S Set buffer options always when entering a buffer
1872 (except 'readonly', 'fileformat', 'filetype' and
1873 'syntax'). This is the (most) Vi compatible setting.
1874 The options are set to the values in the current
1875 buffer. When you change an option and go to another
1876 buffer, the value is copied. Effectively makes the
1877 buffer options global to all buffers.
1878
1879 's' 'S' copy buffer options
1880 no no when buffer created
1881 yes no when buffer first entered (default)
1882 X yes each time when buffer entered (vi comp.)
1883 *cpo-t*
1884 t Search pattern for the tag command is remembered for
1885 "n" command. Otherwise Vim only puts the pattern in
1886 the history for search pattern, but doesn't change the
1887 last used search pattern.
1888 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001889 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001890 *cpo-v*
1891 v Backspaced characters remain visible on the screen in
1892 Insert mode. Without this flag the characters are
1893 erased from the screen right away. With this flag the
1894 screen newly typed text overwrites backspaced
1895 characters.
1896 *cpo-w*
1897 w When using "cw" on a blank character, only change one
1898 character and not all blanks until the start of the
1899 next word.
1900 *cpo-W*
1901 W Don't overwrite a readonly file. When omitted, ":w!"
1902 overwrites a readonly file, if possible.
1903 *cpo-x*
1904 x <Esc> on the command-line executes the command-line.
1905 The default in Vim is to abandon the command-line,
1906 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001907 *cpo-X*
1908 X When using a count with "R" the replaced text is
1909 deleted only once. Also when repeating "R" with "."
1910 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001911 *cpo-y*
1912 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001913 *cpo-Z*
1914 Z When using "w!" while the 'readonly' option is set,
1915 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001916 *cpo-!*
1917 ! When redoing a filter command, use the last used
1918 external command, whatever it was. Otherwise the last
1919 used -filter- command is used.
1920 *cpo-$*
1921 $ When making a change to one line, don't redisplay the
1922 line, but put a '$' at the end of the changed text.
1923 The changed text will be overwritten when you type the
1924 new text. The line is redisplayed if you type any
1925 command that moves the cursor from the insertion
1926 point.
1927 *cpo-%*
1928 % Vi-compatible matching is done for the "%" command.
1929 Does not recognize "#if", "#endif", etc.
1930 Does not recognize "/*" and "*/".
1931 Parens inside single and double quotes are also
1932 counted, causing a string that contains a paren to
1933 disturb the matching. For example, in a line like
1934 "if (strcmp("foo(", s))" the first paren does not
1935 match the last one. When this flag is not included,
1936 parens inside single and double quotes are treated
1937 specially. When matching a paren outside of quotes,
1938 everything inside quotes is ignored. When matching a
1939 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001940 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001941 This flag is also used for other features, such as
1942 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001943 *cpo--*
1944 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001945 it would go above the first line or below the last
1946 line. Without it the cursor moves to the first or
1947 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001948 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001949 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001950 *cpo-+*
1951 + When included, a ":write file" command will reset the
1952 'modified' flag of the buffer, even though the buffer
1953 itself may still be different from its file.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001954 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001955 * Use ":*" in the same way as ":@". When not included,
1956 ":*" is an alias for ":'<,'>", select the Visual area.
1957 *cpo-<*
1958 < Disable the recognition of special key codes in |<>|
1959 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001960 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001961 ":map X <Tab>" results in X being mapped to:
1962 '<' included: "<Tab>" (5 characters)
1963 '<' excluded: "^I" (^I is a real <Tab>)
1964 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001965 *cpo->*
1966 > When appending to a register, put a line break before
1967 the appended text.
1968
1969 POSIX flags. These are not included in the Vi default value, except
1970 when $VIM_POSIX was set on startup. |posix|
1971
1972 contains behavior ~
1973 *cpo-#*
1974 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001975 *cpo-&*
1976 & When ":preserve" was used keep the swap file when
1977 exiting normally while this buffer is still loaded.
1978 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001979 *cpo-\*
1980 \ Backslash in a [] range in a search pattern is taken
1981 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00001982 '\' included: "/[ \-]" finds <Space>, '\' and '-'
1983 '\' excluded: "/[ \-]" finds <Space> and '-'
1984 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001985 *cpo-/*
1986 / When "%" is used as the replacement string in a |:s|
1987 command, use the previous replacement string. |:s%|
1988 *cpo-{*
1989 { The |{| and |}| commands also stop at a "{" character
1990 at the start of a line.
1991 *cpo-.*
1992 . The ":chdir" and ":cd" commands fail if the current
1993 buffer is modified, unless ! is used. Vim doesn't
1994 need this, since it remembers the full path of an
1995 opened file.
1996 *cpo-bar*
1997 | The value of the $LINES and $COLUMNS environment
1998 variables overrule the terminal size values obtained
1999 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002000
Bram Moolenaar071d4272004-06-13 20:20:40 +00002001
2002 *'cscopepathcomp'* *'cspc'*
2003'cscopepathcomp' 'cspc' number (default 0)
2004 global
2005 {not available when compiled without the |+cscope|
2006 feature}
2007 {not in Vi}
2008 Determines how many components of the path to show in a list of tags.
2009 See |cscopepathcomp|.
2010
2011 *'cscopeprg'* *'csprg'*
2012'cscopeprg' 'csprg' string (default "cscope")
2013 global
2014 {not available when compiled without the |+cscope|
2015 feature}
2016 {not in Vi}
2017 Specifies the command to execute cscope. See |cscopeprg|.
2018 This option cannot be set from a |modeline| or in the |sandbox|, for
2019 security reasons.
2020
2021 *'cscopequickfix'* *'csqf'*
2022'cscopequickfix' 'csqf' string (default "")
2023 global
2024 {not available when compiled without the |+cscope|
2025 or |+quickfix| features}
2026 {not in Vi}
2027 Specifies whether to use quickfix window to show cscope results.
2028 See |cscopequickfix|.
2029
2030 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2031'cscopetag' 'cst' boolean (default off)
2032 global
2033 {not available when compiled without the |+cscope|
2034 feature}
2035 {not in Vi}
2036 Use cscope for tag commands. See |cscope-options|.
2037 NOTE: This option is reset when 'compatible' is set.
2038
2039 *'cscopetagorder'* *'csto'*
2040'cscopetagorder' 'csto' number (default 0)
2041 global
2042 {not available when compiled without the |+cscope|
2043 feature}
2044 {not in Vi}
2045 Determines the order in which ":cstag" performs a search. See
2046 |cscopetagorder|.
2047 NOTE: This option is set to 0 when 'compatible' is set.
2048
2049 *'cscopeverbose'* *'csverb'*
2050 *'nocscopeverbose'* *'nocsverb'*
2051'cscopeverbose' 'csverb' boolean (default off)
2052 global
2053 {not available when compiled without the |+cscope|
2054 feature}
2055 {not in Vi}
2056 Give messages when adding a cscope database. See |cscopeverbose|.
2057 NOTE: This option is reset when 'compatible' is set.
2058
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002059
2060 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2061'cursorcolumn' 'cuc' boolean (default off)
2062 local to window
2063 {not in Vi}
2064 {not available when compiled without the |+syntax|
2065 feature}
2066 Highlight the screen column of the cursor with CursorColumn
2067 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2068 slower.
2069
2070 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2071'cursorline' 'cul' boolean (default off)
2072 local to window
2073 {not in Vi}
2074 {not available when compiled without the |+syntax|
2075 feature}
2076 Highlight the screen line of the cursor with CursorLine
2077 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2078 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002079 When Visual mode is active the highlighting isn't used to make it
2080 easier to spot where the selected area.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002081
2082
Bram Moolenaar071d4272004-06-13 20:20:40 +00002083 *'debug'*
2084'debug' string (default "")
2085 global
2086 {not in Vi}
2087 When set to "msg", error messages that would otherwise be omitted will
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002088 be given anyway. This is useful when debugging 'foldexpr',
2089 'formatexpr' or 'indentexpr'.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002090 When set to "beep", a message will be given when otherwise only a beep
2091 would be produced.
2092 The values can be combined, separated by a comma.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002093
2094 *'define'* *'def'*
2095'define' 'def' string (default "^\s*#\s*define")
2096 global or local to buffer |global-local|
2097 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002098 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002099 pattern, just like for the "/" command. This option is used for the
2100 commands like "[i" and "[d" |include-search|. The 'isident' option is
2101 used to recognize the defined name after the match:
2102 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2103 See |option-backslash| about inserting backslashes to include a space
2104 or backslash.
2105 The default value is for C programs. For C++ this value would be
2106 useful, to include const type declarations: >
2107 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2108< When using the ":set" command, you need to double the backslashes!
2109
2110 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2111'delcombine' 'deco' boolean (default off)
2112 global
2113 {not in Vi}
2114 {only available when compiled with the |+multi_byte|
2115 feature}
2116 If editing Unicode and this option is set, backspace and Normal mode
2117 "x" delete each combining character on its own. When it is off (the
2118 default) the character along with its combining characters are
2119 deleted.
2120 Note: When 'delcombine' is set "xx" may work different from "2x"!
2121
2122 This is useful for Arabic, Hebrew and many other languages where one
2123 may have combining characters overtop of base characters, and want
2124 to remove only the combining ones.
2125
2126 *'dictionary'* *'dict'*
2127'dictionary' 'dict' string (default "")
2128 global or local to buffer |global-local|
2129 {not in Vi}
2130 List of file names, separated by commas, that are used to lookup words
2131 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2132 contain a list of words. This can be one word per line, or several
2133 words per line, separated by non-keyword characters (white space is
2134 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002135 When this option is empty, or an entry "spell" is present, spell
2136 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002137 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002138 after a comma are ignored, otherwise spaces are included in the file
2139 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002140 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002141 Where to find a list of words?
2142 - On FreeBSD, there is the file "/usr/share/dict/words".
2143 - In the Simtel archive, look in the "msdos/linguist" directory.
2144 - In "miscfiles" of the GNU collection.
2145 The use of |:set+=| and |:set-=| is preferred when adding or removing
2146 directories from the list. This avoids problems when a future version
2147 uses another default.
2148 Backticks cannot be used in this option for security reasons.
2149
2150 *'diff'* *'nodiff'*
2151'diff' boolean (default off)
2152 local to window
2153 {not in Vi}
2154 {not available when compiled without the |+diff|
2155 feature}
2156 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002157 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002158
2159 *'dex'* *'diffexpr'*
2160'diffexpr' 'dex' string (default "")
2161 global
2162 {not in Vi}
2163 {not available when compiled without the |+diff|
2164 feature}
2165 Expression which is evaluated to obtain an ed-style diff file from two
2166 versions of a file. See |diff-diffexpr|.
2167 This option cannot be set from a |modeline| or in the |sandbox|, for
2168 security reasons.
2169
2170 *'dip'* *'diffopt'*
2171'diffopt' 'dip' string (default "filler")
2172 global
2173 {not in Vi}
2174 {not available when compiled without the |+diff|
2175 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002176 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002177 All are optional. Items must be separated by a comma.
2178
2179 filler Show filler lines, to keep the text
2180 synchronized with a window that has inserted
2181 lines at the same position. Mostly useful
2182 when windows are side-by-side and 'scrollbind'
2183 is set.
2184
2185 context:{n} Use a context of {n} lines between a change
2186 and a fold that contains unchanged lines.
2187 When omitted a context of six lines is used.
2188 See |fold-diff|.
2189
2190 icase Ignore changes in case of text. "a" and "A"
2191 are considered the same. Adds the "-i" flag
2192 to the "diff" command if 'diffexpr' is empty.
2193
2194 iwhite Ignore changes in amount of white space. Adds
2195 the "-b" flag to the "diff" command if
2196 'diffexpr' is empty. Check the documentation
2197 of the "diff" command for what this does
2198 exactly. It should ignore adding trailing
2199 white space, but not leading white space.
2200
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002201 horizontal Start diff mode with horizontal splits (unless
2202 explicitly specified otherwise).
2203
2204 vertical Start diff mode with vertical splits (unless
2205 explicitly specified otherwise).
2206
2207 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2208 starting diff mode. Without this 2 is used.
2209
Bram Moolenaar071d4272004-06-13 20:20:40 +00002210 Examples: >
2211
2212 :set diffopt=filler,context:4
2213 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002214 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002215<
2216 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2217'digraph' 'dg' boolean (default off)
2218 global
2219 {not in Vi}
2220 {not available when compiled without the |+digraphs|
2221 feature}
2222 Enable the entering of digraphs in Insert mode with {char1} <BS>
2223 {char2}. See |digraphs|.
2224 NOTE: This option is reset when 'compatible' is set.
2225
2226 *'directory'* *'dir'*
2227'directory' 'dir' string (default for Amiga: ".,t:",
2228 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2229 for Unix: ".,~/tmp,/var/tmp,/tmp")
2230 global
2231 List of directory names for the swap file, separated with commas.
2232 - The swap file will be created in the first directory where this is
2233 possible.
2234 - Empty means that no swap file will be used (recovery is
2235 impossible!).
2236 - A directory "." means to put the swap file in the same directory as
2237 the edited file. On Unix, a dot is prepended to the file name, so
2238 it doesn't show in a directory listing. On MS-Windows the "hidden"
2239 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002240 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002241 put the swap file relative to where the edited file is. The leading
2242 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002243 - For Unix and Win32, if a directory ends in two path separators "//"
2244 or "\\", the swap file name will be built from the complete path to
2245 the file with all path separators substituted to percent '%' signs.
2246 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002247 - Spaces after the comma are ignored, other spaces are considered part
2248 of the directory name. To have a space at the start of a directory
2249 name, precede it with a backslash.
2250 - To include a comma in a directory name precede it with a backslash.
2251 - A directory name may end in an ':' or '/'.
2252 - Environment variables are expanded |:set_env|.
2253 - Careful with '\' characters, type one before a space, type two to
2254 get one in the option (see |option-backslash|), for example: >
2255 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2256< - For backwards compatibility with Vim version 3.0 a '>' at the start
2257 of the option is removed.
2258 Using "." first in the list is recommended. This means that editing
2259 the same file twice will result in a warning. Using "/tmp" on Unix is
2260 discouraged: When the system crashes you lose the swap file.
2261 "/var/tmp" is often not cleared when rebooting, thus is a better
2262 choice than "/tmp". But it can contain a lot of files, your swap
2263 files get lost in the crowd. That is why a "tmp" directory in your
2264 home directory is tried first.
2265 The use of |:set+=| and |:set-=| is preferred when adding or removing
2266 directories from the list. This avoids problems when a future version
2267 uses another default.
2268 This option cannot be set from a |modeline| or in the |sandbox|, for
2269 security reasons.
2270 {Vi: directory to put temp file in, defaults to "/tmp"}
2271
2272 *'display'* *'dy'*
2273'display' 'dy' string (default "")
2274 global
2275 {not in Vi}
2276 Change the way text is displayed. This is comma separated list of
2277 flags:
2278 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002279 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002280 last line that doesn't fit is replaced with "@" lines.
2281 uhex Show unprintable characters hexadecimal as <xx>
2282 instead of using ^C and ~C.
2283
2284 *'eadirection'* *'ead'*
2285'eadirection' 'ead' string (default "both")
2286 global
2287 {not in Vi}
2288 {not available when compiled without the +vertsplit
2289 feature}
2290 Tells when the 'equalalways' option applies:
2291 ver vertically, width of windows is not affected
2292 hor horizontally, height of windows is not affected
2293 both width and height of windows is affected
2294
2295 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2296'edcompatible' 'ed' boolean (default off)
2297 global
2298 Makes the 'g' and 'c' flags of the ":substitute" command to be
2299 toggled each time the flag is given. See |complex-change|. See
2300 also 'gdefault' option.
2301 Switching this option on is discouraged!
2302
2303 *'encoding'* *'enc'* *E543*
2304'encoding' 'enc' string (default: "latin1" or value from $LANG)
2305 global
2306 {only available when compiled with the |+multi_byte|
2307 feature}
2308 {not in Vi}
2309 Sets the character encoding used inside Vim. It applies to text in
2310 the buffers, registers, Strings in expressions, text stored in the
2311 viminfo file, etc. It sets the kind of characters which Vim can work
2312 with. See |encoding-names| for the possible values.
2313
2314 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002315 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002316 It should normally be kept at its default value, or set when Vim
2317 starts up. See |multibyte|.
2318
2319 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2320 "utf-8". Although care has been taken to allow different values of
2321 'encoding', "utf-8" is the natural choice for the environment and
2322 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002323 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002324 versions, and to avoid changing the encoding of newly created files
2325 without your knowledge (in case 'fileencodings' is empty).
2326
2327 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002328 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002329 iconv() or as specified with 'charconvert'.
2330
2331 Normally 'encoding' will be equal to your current locale. This will
2332 be the default if Vim recognizes your environment settings. If
2333 'encoding' is not set to the current locale, 'termencoding' must be
2334 set to convert typed and displayed text. See |encoding-table|.
2335
2336 When you set this option, it fires the |EncodingChanged| autocommand
2337 event so that you can set up fonts if necessary.
2338
2339 When the option is set, the value is converted to lowercase. Thus
2340 you can set it with uppercase values too. Underscores are translated
2341 to '-' signs.
2342 When the encoding is recognized, it is changed to the standard name.
2343 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2344 "iso-8859-2" and "utf8" becomes "utf-8".
2345
2346 Note: "latin1" is also used when the encoding could not be detected.
2347 This only works when editing files in the same encoding! When the
2348 actual character set is not latin1, make sure 'fileencoding' and
2349 'fileencodings' are empty. When conversion is needed, switch to using
2350 utf-8.
2351
2352 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2353 You don't notice this while editing, but it does matter for the
2354 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2355 setting 'encoding' to one of these values instead of utf-8 only has
2356 effect for encoding used for files when 'fileencoding' is empty.
2357
Bram Moolenaar661b1822005-07-28 22:36:45 +00002358 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2359 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002360
2361 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2362'endofline' 'eol' boolean (default on)
2363 local to buffer
2364 {not in Vi}
2365 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002366 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002367 option is automatically set when starting to edit a new file, unless
2368 the file does not have an <EOL> for the last line in the file, in
2369 which case it is reset. Normally you don't have to set or reset this
2370 option. When 'binary' is off the value is not used when writing the
2371 file. When 'binary' is on it is used to remember the presence of a
2372 <EOL> for the last line in the file, so that when you write the file
2373 the situation from the original file can be kept. But you can change
2374 it if you want to.
2375
2376 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2377'equalalways' 'ea' boolean (default on)
2378 global
2379 {not in Vi}
2380 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002381 splitting or closing a window. This also happens the moment the
2382 option is switched on. When off, splitting a window will reduce the
2383 size of the current window and leave the other windows the same. When
2384 closing a window the extra lines are given to the window next to it
2385 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002386 When mixing vertically and horizontally split windows, a minimal size
2387 is computed and some windows may be larger if there is room. The
2388 'eadirection' option tells in which direction the size is affected.
2389 Changing the height of a window can be avoided by setting
2390 'winfixheight'.
2391
2392 *'equalprg'* *'ep'*
2393'equalprg' 'ep' string (default "")
2394 global or local to buffer |global-local|
2395 {not in Vi}
2396 External program to use for "=" command. When this option is empty
2397 the internal formatting functions are used ('lisp', 'cindent' or
2398 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002399 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002400 about including spaces and backslashes.
2401 This option cannot be set from a |modeline| or in the |sandbox|, for
2402 security reasons.
2403
2404 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2405'errorbells' 'eb' boolean (default off)
2406 global
2407 Ring the bell (beep or screen flash) for error messages. This only
2408 makes a difference for error messages, the bell will be used always
2409 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002410 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002411 screen flash or do nothing.
2412
2413 *'errorfile'* *'ef'*
2414'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2415 others: "errors.err")
2416 global
2417 {not in Vi}
2418 {not available when compiled without the |+quickfix|
2419 feature}
2420 Name of the errorfile for the QuickFix mode (see |:cf|).
2421 When the "-q" command-line argument is used, 'errorfile' is set to the
2422 following argument. See |-q|.
2423 NOT used for the ":make" command. See 'makeef' for that.
2424 Environment variables are expanded |:set_env|.
2425 See |option-backslash| about including spaces and backslashes.
2426 This option cannot be set from a |modeline| or in the |sandbox|, for
2427 security reasons.
2428
2429 *'errorformat'* *'efm'*
2430'errorformat' 'efm' string (default is very long)
2431 global or local to buffer |global-local|
2432 {not in Vi}
2433 {not available when compiled without the |+quickfix|
2434 feature}
2435 Scanf-like description of the format for the lines in the error file
2436 (see |errorformat|).
2437
2438 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2439'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2440 global
2441 {not in Vi}
2442 Function keys that start with an <Esc> are recognized in Insert
2443 mode. When this option is off, the cursor and function keys cannot be
2444 used in Insert mode if they start with an <Esc>. The advantage of
2445 this is that the single <Esc> is recognized immediately, instead of
2446 after one second. Instead of resetting this option, you might want to
2447 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2448 when 'esckeys' is off, you can still map anything, but the cursor keys
2449 won't work by default.
2450 NOTE: This option is set to the Vi default value when 'compatible' is
2451 set and to the Vim default value when 'compatible' is reset.
2452
2453 *'eventignore'* *'ei'*
2454'eventignore' 'ei' string (default "")
2455 global
2456 {not in Vi}
2457 {not available when compiled without the |+autocmd|
2458 feature}
2459 A list of autocommand event names, which are to be ignored.
2460 When set to "all", all autocommand events are ignored, autocommands
2461 will not be executed.
2462 Otherwise this is a comma separated list of event names. Example: >
2463 :set ei=WinEnter,WinLeave
2464<
2465 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2466'expandtab' 'et' boolean (default off)
2467 local to buffer
2468 {not in Vi}
2469 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002470 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002471 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2472 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2473 NOTE: This option is reset when 'compatible' is set.
2474
2475 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2476'exrc' 'ex' boolean (default off)
2477 global
2478 {not in Vi}
2479 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2480 directory. If you switch this option on you should also consider
2481 setting the 'secure' option (see |initialization|). Using a local
2482 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2483 also see |.vimrc| and |gui-init|.
2484 This option cannot be set from a |modeline| or in the |sandbox|, for
2485 security reasons.
2486
2487 *'fileencoding'* *'fenc'* *E213*
2488'fileencoding' 'fenc' string (default: "")
2489 local to buffer
2490 {only available when compiled with the |+multi_byte|
2491 feature}
2492 {not in Vi}
2493 Sets the character encoding for the file of this buffer.
2494 When 'fileencoding' is different from 'encoding', conversion will be
2495 done when reading and writing the file.
2496 When 'fileencoding' is empty, the same value as 'encoding' will be
2497 used (no conversion when reading or writing a file).
2498 WARNING: Conversion can cause loss of information! When
2499 'encoding' is "utf-8" conversion is most likely done in a way
2500 that the reverse conversion results in the same text. When
2501 'encoding' is not "utf-8" some characters may be lost!
2502 See 'encoding' for the possible values. Additionally, values may be
2503 specified that can be handled by the converter, see
2504 |mbyte-conversion|.
2505 When reading a file 'fileencoding' will be set from 'fileencodings'.
2506 To read a file in a certain encoding it won't work by setting
2507 'fileencoding', use the |++enc| argument.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002508 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002509 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2510 When the option is set, the value is converted to lowercase. Thus
2511 you can set it with uppercase values too. '_' characters are
2512 replaced with '-'. If a name is recognized from the list for
2513 'encoding', it is replaced by the standard name. For example
2514 "ISO8859-2" becomes "iso-8859-2".
2515 When this option is set, after starting to edit a file, the 'modified'
2516 option is set, because the file would be different when written.
2517 If you do this in a modeline, you might want to set 'nomodified' to
2518 avoid this.
2519 This option can not be changed when 'modifiable' is off.
2520
2521 *'fe'*
2522 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002523 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002524 old short name was 'fe', which is no longer used.
2525
2526 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002527'fileencodings' 'fencs' string (default: "ucs-bom",
2528 "ucs-bom,utf-8,default,latin1" when
2529 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002530 global
2531 {only available when compiled with the |+multi_byte|
2532 feature}
2533 {not in Vi}
2534 This is a list of character encodings considered when starting to edit
2535 an existing file. When a file is read, Vim tries to use the first
2536 mentioned character encoding. If an error is detected, the next one
2537 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002538 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002539 an empty string, which means the value of 'encoding' is used.
2540 WARNING: Conversion can cause loss of information! When
2541 'encoding' is "utf-8" (or one of the other Unicode variants)
2542 conversion is most likely done in a way that the reverse
2543 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002544 "utf-8" some non-ASCII characters may be lost! You can use
2545 the |++bad| argument to specify what is done with characters
2546 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002547 For an empty file or a file with only ASCII characters most encodings
2548 will work and the first entry of 'fileencodings' will be used (except
2549 "ucs-bom", which requires the BOM to be present). If you prefer
2550 another encoding use an BufReadPost autocommand event to test if your
2551 preferred encoding is to be used. Example: >
2552 au BufReadPost * if search('\S', 'w') == 0 |
2553 \ set fenc=iso-2022-jp | endif
2554< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2555 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002556 When the |++enc| argument is used then the value of 'fileencodings' is
2557 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002558 Note that 'fileencodings' is not used for a new file, the global value
2559 of 'fileencoding' is used instead. You can set it with: >
2560 :setglobal fenc=iso-8859-2
2561< This means that a non-existing file may get a different encoding than
2562 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002563 The special value "ucs-bom" can be used to check for a Unicode BOM
2564 (Byte Order Mark) at the start of the file. It must not be preceded
2565 by "utf-8" or another Unicode encoding for this to work properly.
2566 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2567 because Vim cannot detect an error, thus the encoding is always
2568 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002569 The special value "default" can be used for the encoding from the
2570 environment. This is the default value for 'encoding'. It is useful
2571 when 'encoding' is set to "utf-8" and your environment uses a
2572 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002573 When 'encoding' is "utf-8" and a file contains an illegal byte
2574 sequence it won't be recognized as UTF-8. You can use the |8g8|
2575 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002576 WRONG VALUES: WHAT'S WRONG:
2577 latin1,utf-8 "latin1" will always be used
2578 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2579 file
2580 cp1250,latin1 "cp1250" will always be used
2581 If 'fileencodings' is empty, 'fileencoding' is not modified.
2582 See 'fileencoding' for the possible values.
2583 Setting this option does not have an effect until the next time a file
2584 is read.
2585
2586 *'fileformat'* *'ff'*
2587'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2588 Unix default: "unix",
2589 Macintosh default: "mac")
2590 local to buffer
2591 {not in Vi}
2592 This gives the <EOL> of the current buffer, which is used for
2593 reading/writing the buffer from/to a file:
2594 dos <CR> <NL>
2595 unix <NL>
2596 mac <CR>
2597 When "dos" is used, CTRL-Z at the end of a file is ignored.
2598 See |file-formats| and |file-read|.
2599 For the character encoding of the file see 'fileencoding'.
2600 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2601 works like it was set to "unix'.
2602 This option is set automatically when starting to edit a file and
2603 'fileformats' is not empty and 'binary' is off.
2604 When this option is set, after starting to edit a file, the 'modified'
2605 option is set, because the file would be different when written.
2606 This option can not be changed when 'modifiable' is off.
2607 For backwards compatibility: When this option is set to "dos",
2608 'textmode' is set, otherwise 'textmode' is reset.
2609
2610 *'fileformats'* *'ffs'*
2611'fileformats' 'ffs' string (default:
2612 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2613 Vim Unix: "unix,dos",
2614 Vim Mac: "mac,unix,dos",
2615 Vi Cygwin: "unix,dos",
2616 Vi others: "")
2617 global
2618 {not in Vi}
2619 This gives the end-of-line (<EOL>) formats that will be tried when
2620 starting to edit a new buffer and when reading a file into an existing
2621 buffer:
2622 - When empty, the format defined with 'fileformat' will be used
2623 always. It is not set automatically.
2624 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002625 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002626 'fileformats' name will be used when a file is read into an existing
2627 buffer, no matter what 'fileformat' for that buffer is set to.
2628 - When more than one name is present, separated by commas, automatic
2629 <EOL> detection will be done when reading a file. When starting to
2630 edit a file, a check is done for the <EOL>:
2631 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2632 'fileformat' is set to "dos".
2633 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002634 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002635 preceding <CR>, "unix" is preferred over "dos".
2636 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2637 This means that "mac" is only chosen when "unix" is not present,
2638 or when no <NL> is found in the file, and when "dos" is not
2639 present, or no <CR><NL> is present in the file.
2640 Also if "unix" was first chosen, but the first <CR> is before
2641 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2642 the file, then 'fileformat' is set to "mac".
2643 4. If 'fileformat' is still not set, the first name from
2644 'fileformats' is used.
2645 When reading a file into an existing buffer, the same is done, but
2646 this happens like 'fileformat' has been set appropriately for that
2647 file only, the option is not changed.
2648 When 'binary' is set, the value of 'fileformats' is not used.
2649
2650 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2651 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2652 done:
2653 - When 'fileformats' is empty, there is no automatic detection. Dos
2654 format will be used.
2655 - When 'fileformats' is set to one or more names, automatic detection
2656 is done. This is based on the first <NL> in the file: If there is a
2657 <CR> in front of it, Dos format is used, otherwise Unix format is
2658 used.
2659 Also see |file-formats|.
2660 For backwards compatibility: When this option is set to an empty
2661 string or one format (no comma is included), 'textauto' is reset,
2662 otherwise 'textauto' is set.
2663 NOTE: This option is set to the Vi default value when 'compatible' is
2664 set and to the Vim default value when 'compatible' is reset.
2665
2666 *'filetype'* *'ft'*
2667'filetype' 'ft' string (default: "")
2668 local to buffer
2669 {not in Vi}
2670 {not available when compiled without the |+autocmd|
2671 feature}
2672 When this option is set, the FileType autocommand event is triggered.
2673 All autocommands that match with the value of this option will be
2674 executed. Thus the value of 'filetype' is used in place of the file
2675 name.
2676 Otherwise this option does not always reflect the current file type.
2677 This option is normally set when the file type is detected. To enable
2678 this use the ":filetype on" command. |:filetype|
2679 Setting this option to a different value is most useful in a modeline,
2680 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002681 Example, for in an IDL file:
2682 /* vim: set filetype=idl : */ ~
2683 |FileType| |filetypes|
2684 When a dot appears in the value then this separates two filetype
2685 names. Example:
2686 /* vim: set filetype=c.doxygen : */ ~
2687 This will use the "c" filetype first, then the "doxygen" filetype.
2688 This works both for filetype plugins and for syntax files. More than
2689 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002690 Do not confuse this option with 'osfiletype', which is for the file
2691 type that is actually stored with the file.
2692 This option is not copied to another buffer, independent of the 's' or
2693 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002694 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002695
2696 *'fillchars'* *'fcs'*
2697'fillchars' 'fcs' string (default "vert:|,fold:-")
2698 global
2699 {not in Vi}
2700 {not available when compiled without the |+windows|
2701 and |+folding| features}
2702 Characters to fill the statuslines and vertical separators.
2703 It is a comma separated list of items:
2704
2705 item default Used for ~
2706 stl:c ' ' or '^' statusline of the current window
2707 stlnc:c ' ' or '-' statusline of the non-current windows
2708 vert:c '|' vertical separators |:vsplit|
2709 fold:c '-' filling 'foldtext'
2710 diff:c '-' deleted lines of the 'diff' option
2711
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002712 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002713 "stlnc" the space will be used when there is highlighting, '^' or '-'
2714 otherwise.
2715
2716 Example: >
2717 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2718< This is similar to the default, except that these characters will also
2719 be used when there is highlighting.
2720
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002721 for "stl" and "stlnc" only single-byte values are supported.
2722
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723 The highlighting used for these items:
2724 item highlight group ~
2725 stl:c StatusLine |hl-StatusLine|
2726 stlnc:c StatusLineNC |hl-StatusLineNC|
2727 vert:c VertSplit |hl-VertSplit|
2728 fold:c Folded |hl-Folded|
2729 diff:c DiffDelete |hl-DiffDelete|
2730
2731 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2732'fkmap' 'fk' boolean (default off) *E198*
2733 global
2734 {not in Vi}
2735 {only available when compiled with the |+rightleft|
2736 feature}
2737 When on, the keyboard is mapped for the Farsi character set.
2738 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002739 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002740
2741 *'foldclose'* *'fcl'*
2742'foldclose' 'fcl' string (default "")
2743 global
2744 {not in Vi}
2745 {not available when compiled without the |+folding|
2746 feature}
2747 When set to "all", a fold is closed when the cursor isn't in it and
2748 its level is higher than 'foldlevel'. Useful if you want folds to
2749 automatically close when moving out of them.
2750
2751 *'foldcolumn'* *'fdc'*
2752'foldcolumn' 'fdc' number (default 0)
2753 local to window
2754 {not in Vi}
2755 {not available when compiled without the |+folding|
2756 feature}
2757 When non-zero, a column with the specified width is shown at the side
2758 of the window which indicates open and closed folds. The maximum
2759 value is 12.
2760 See |folding|.
2761
2762 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2763'foldenable' 'fen' boolean (default on)
2764 local to window
2765 {not in Vi}
2766 {not available when compiled without the |+folding|
2767 feature}
2768 When off, all folds are open. This option can be used to quickly
2769 switch between showing all text unfolded and viewing the text with
2770 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002771 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002772 'foldenable' is off.
2773 This option is set by commands that create a new fold or close a fold.
2774 See |folding|.
2775
2776 *'foldexpr'* *'fde'*
2777'foldexpr' 'fde' string (default: "0")
2778 local to window
2779 {not in Vi}
2780 {not available when compiled without the |+folding|
2781 or |+eval| feature}
2782 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002783 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002784
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002785 The expression may be evaluated in the |sandbox|, see
2786 |sandbox-option|.
2787
2788 It is not allowed to change text or jump to another window while
2789 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002790
2791 *'foldignore'* *'fdi'*
2792'foldignore' 'fdi' string (default: "#")
2793 local to window
2794 {not in Vi}
2795 {not available when compiled without the |+folding|
2796 feature}
2797 Used only when 'foldmethod' is "indent". Lines starting with
2798 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002799 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002800 The default "#" works well for C programs. See |fold-indent|.
2801
2802 *'foldlevel'* *'fdl'*
2803'foldlevel' 'fdl' number (default: 0)
2804 local to window
2805 {not in Vi}
2806 {not available when compiled without the |+folding|
2807 feature}
2808 Sets the fold level: Folds with a higher level will be closed.
2809 Setting this option to zero will close all folds. Higher numbers will
2810 close fewer folds.
2811 This option is set by commands like |zm|, |zM| and |zR|.
2812 See |fold-foldlevel|.
2813
2814 *'foldlevelstart'* *'fdls'*
2815'foldlevelstart' 'fdls' number (default: -1)
2816 global
2817 {not in Vi}
2818 {not available when compiled without the |+folding|
2819 feature}
2820 Sets 'foldlevel' when starting to edit another buffer in a window.
2821 Useful to always start editing with all folds closed (value zero),
2822 some folds closed (one) or no folds closed (99).
2823 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002824 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002825 ignores this option and closes all folds.
2826 It is also done before BufReadPre autocommands, to allow an autocmd to
2827 overrule the 'foldlevel' value for specific files.
2828 When the value is negative, it is not used.
2829
2830 *'foldmarker'* *'fmr'* *E536*
2831'foldmarker' 'fmr' string (default: "{{{,}}}")
2832 local to window
2833 {not in Vi}
2834 {not available when compiled without the |+folding|
2835 feature}
2836 The start and end marker used when 'foldmethod' is "marker". There
2837 must be one comma, which separates the start and end marker. The
2838 marker is a literal string (a regular expression would be too slow).
2839 See |fold-marker|.
2840
2841 *'foldmethod'* *'fdm'*
2842'foldmethod' 'fdm' string (default: "manual")
2843 local to window
2844 {not in Vi}
2845 {not available when compiled without the |+folding|
2846 feature}
2847 The kind of folding used for the current window. Possible values:
2848 |fold-manual| manual Folds are created manually.
2849 |fold-indent| indent Lines with equal indent form a fold.
2850 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2851 |fold-marker| marker Markers are used to specify folds.
2852 |fold-syntax| syntax Syntax highlighting items specify folds.
2853 |fold-diff| diff Fold text that is not changed.
2854
2855 *'foldminlines'* *'fml'*
2856'foldminlines' 'fml' number (default: 1)
2857 local to window
2858 {not in Vi}
2859 {not available when compiled without the |+folding|
2860 feature}
2861 Sets the minimum number of screen lines for a fold to be displayed
2862 closed. Also for manually closed folds.
2863 Note that this only has an effect of what is displayed. After using
2864 "zc" to close a fold, which is displayed open because it's smaller
2865 than 'foldminlines', a following "zc" may close a containing fold.
2866
2867 *'foldnestmax'* *'fdn'*
2868'foldnestmax' 'fdn' number (default: 20)
2869 local to window
2870 {not in Vi}
2871 {not available when compiled without the |+folding|
2872 feature}
2873 Sets the maximum nesting of folds for the "indent" and "syntax"
2874 methods. This avoids that too many folds will be created. Using more
2875 than 20 doesn't work, because the internal limit is 20.
2876
2877 *'foldopen'* *'fdo'*
2878'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2879 search,tag,undo")
2880 global
2881 {not in Vi}
2882 {not available when compiled without the |+folding|
2883 feature}
2884 Specifies for which type of commands folds will be opened, if the
2885 command moves the cursor into a closed fold. It is a comma separated
2886 list of items.
2887 item commands ~
2888 all any
2889 block "(", "{", "[[", "[{", etc.
2890 hor horizontal movements: "l", "w", "fx", etc.
2891 insert any command in Insert mode
2892 jump far jumps: "G", "gg", etc.
2893 mark jumping to a mark: "'m", CTRL-O, etc.
2894 percent "%"
2895 quickfix ":cn", ":crew", ":make", etc.
2896 search search for a pattern: "/", "n", "*", "gd", etc.
2897 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002898 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002899 tag jumping to a tag: ":ta", CTRL-T, etc.
2900 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002901 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002902 the |zv| command to the mapping to get the same effect.
2903 When a movement command is used for an operator (e.g., "dl" or "y%")
2904 this option is not used. This means the operator will include the
2905 whole closed fold.
2906 Note that vertical movements are not here, because it would make it
2907 very difficult to move onto a closed fold.
2908 In insert mode the folds containing the cursor will always be open
2909 when text is inserted.
2910 To close folds you can re-apply 'foldlevel' with the |zx| command or
2911 set the 'foldclose' option to "all".
2912
2913 *'foldtext'* *'fdt'*
2914'foldtext' 'fdt' string (default: "foldtext()")
2915 local to window
2916 {not in Vi}
2917 {not available when compiled without the |+folding|
2918 feature}
2919 An expression which is used to specify the text displayed for a closed
2920 fold. See |fold-foldtext|.
2921
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002922 The expression may be evaluated in the |sandbox|, see
2923 |sandbox-option|.
2924
2925 It is not allowed to change text or jump to another window while
2926 evaluating 'foldtext' |textlock|.
2927
Bram Moolenaar071d4272004-06-13 20:20:40 +00002928 *'formatoptions'* *'fo'*
2929'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2930 local to buffer
2931 {not in Vi}
2932 This is a sequence of letters which describes how automatic
2933 formatting is to be done. See |fo-table|. When the 'paste' option is
2934 on, no formatting is done (like 'formatoptions' is empty). Commas can
2935 be inserted for readability.
2936 To avoid problems with flags that are added in the future, use the
2937 "+=" and "-=" feature of ":set" |add-option-flags|.
2938 NOTE: This option is set to the Vi default value when 'compatible' is
2939 set and to the Vim default value when 'compatible' is reset.
2940
Bram Moolenaar86b68352004-12-27 21:59:20 +00002941 *'formatlistpat'* *'flp'*
2942'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
2943 local to buffer
2944 {not in Vi}
2945 A pattern that is used to recognize a list header. This is used for
2946 the "n" flag in 'formatoptions'.
2947 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00002948 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00002949 while still checking more characters. There must be a character
2950 following the pattern, when it matches the whole line it is handled
2951 like there is no match.
2952 The default recognizes a number, followed by an optional punctuation
2953 character and white space.
2954
Bram Moolenaar071d4272004-06-13 20:20:40 +00002955 *'formatprg'* *'fp'*
2956'formatprg' 'fp' string (default "")
2957 global
2958 {not in Vi}
2959 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002960 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00002961 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00002962 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002963 If the 'formatexpr' option is not empty it will be used instead.
2964 Otherwise, if 'formatprg' option is an empty string, the internal
2965 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00002966 Environment variables are expanded |:set_env|. See |option-backslash|
2967 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002968 The expression may be evaluated in the |sandbox|, see
2969 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002970
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002971 *'formatexpr'* *'fex'*
2972'formatexpr' 'fex' string (default "")
2973 local to buffer
2974 {not in Vi}
2975 {not available when compiled without the |+eval|
2976 feature}
2977 Expression which is evaluated to format a range of lines for the |gq|
2978 operator. The |v:lnum| variable holds the first line to be formatted,
2979 |v:count| the number of lines to be formatted.
2980 When this option is empty 'formatprg' is used.
2981 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00002982 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002983< This will invoke the mylang#Format() function in the
2984 autoload/mylang.vim file in 'runtimepath'. |autoload|
2985
2986 The expression is also evaluated when 'textwidth' is set and adding
2987 text beyond that limit. This happens under the same conditions as
2988 when internal formatting is used. Make sure the cursor is kept in the
2989 same spot relative to the text then! The |mode()| function will
2990 return "i" or "R" in this situation. When the function returns
2991 non-zero Vim will fall back to using the internal format mechanism.
2992
2993 The expression may be evaluated in the |sandbox|, see
2994 |sandbox-option|.
2995
2996 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002997'fsync' 'fs' boolean (default on)
2998 global
2999 {not in Vi}
3000 When on, the library function fsync() will be called after writing a
3001 file. This will flush a file to disk, ensuring that it is safely
3002 written even on filesystems which do metadata-only journaling. This
3003 will force the harddrive to spin up on Linux systems running in laptop
3004 mode, so it may be undesirable in some situations. Be warned that
3005 turning this off increases the chances of data loss after a crash. On
3006 systems without an fsync() implementation, this variable is always
3007 off.
3008 Also see 'swapsync' for controlling fsync() on swap files.
3009
Bram Moolenaar071d4272004-06-13 20:20:40 +00003010 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3011'gdefault' 'gd' boolean (default off)
3012 global
3013 {not in Vi}
3014 When on, the ":substitute" flag 'g' is default on. This means that
3015 all matches in a line are substituted instead of one. When a 'g' flag
3016 is given to a ":substitute" command, this will toggle the substitution
3017 of all or one match. See |complex-change|.
3018
3019 command 'gdefault' on 'gdefault' off ~
3020 :s/// subst. all subst. one
3021 :s///g subst. one subst. all
3022 :s///gg subst. all subst. one
3023
3024 NOTE: This option is reset when 'compatible' is set.
3025
3026 *'grepformat'* *'gfm'*
3027'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3028 global
3029 {not in Vi}
3030 Format to recognize for the ":grep" command output.
3031 This is a scanf-like string that uses the same format as the
3032 'errorformat' option: see |errorformat|.
3033
3034 *'grepprg'* *'gp'*
3035'grepprg' 'gp' string (default "grep -n ",
3036 Unix: "grep -n $* /dev/null",
3037 Win32: "findstr /n" or "grep -n",
3038 VMS: "SEARCH/NUMBERS ")
3039 global or local to buffer |global-local|
3040 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003041 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003042 and '#' characters, which are expanded like when used in a command-
3043 line. The placeholder "$*" is allowed to specify where the arguments
3044 will be included. Environment variables are expanded |:set_env|. See
3045 |option-backslash| about including spaces and backslashes.
3046 When your "grep" accepts the "-H" argument, use this to make ":grep"
3047 also work well with a single file: >
3048 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003049< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003050 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3051 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003052 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003053 apply equally to 'grepprg'.
3054 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3055 otherwise it's "grep -n".
3056 This option cannot be set from a |modeline| or in the |sandbox|, for
3057 security reasons.
3058
3059 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3060'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3061 ve:ver35-Cursor,
3062 o:hor50-Cursor,
3063 i-ci:ver25-Cursor/lCursor,
3064 r-cr:hor20-Cursor/lCursor,
3065 sm:block-Cursor
3066 -blinkwait175-blinkoff150-blinkon175",
3067 for MS-DOS and Win32 console:
3068 "n-v-c:block,o:hor50,i-ci:hor15,
3069 r-cr:hor30,sm:block")
3070 global
3071 {not in Vi}
3072 {only available when compiled with GUI enabled, and
3073 for MS-DOS and Win32 console}
3074 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003075 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003076 the height of the cursor can be changed. This can be done by
3077 specifying a block cursor, or a percentage for a vertical or
3078 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003079 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003080
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003081 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003082 mode-list and an argument-list:
3083 mode-list:argument-list,mode-list:argument-list,..
3084 The mode-list is a dash separated list of these modes:
3085 n Normal mode
3086 v Visual mode
3087 ve Visual mode with 'selection' "exclusive" (same as 'v',
3088 if not specified)
3089 o Operator-pending mode
3090 i Insert mode
3091 r Replace mode
3092 c Command-line Normal (append) mode
3093 ci Command-line Insert mode
3094 cr Command-line Replace mode
3095 sm showmatch in Insert mode
3096 a all modes
3097 The argument-list is a dash separated list of these arguments:
3098 hor{N} horizontal bar, {N} percent of the character height
3099 ver{N} vertical bar, {N} percent of the character width
3100 block block cursor, fills the whole character
3101 [only one of the above three should be present]
3102 blinkwait{N} *cursor-blinking*
3103 blinkon{N}
3104 blinkoff{N}
3105 blink times for cursor: blinkwait is the delay before
3106 the cursor starts blinking, blinkon is the time that
3107 the cursor is shown and blinkoff is the time that the
3108 cursor is not shown. The times are in msec. When one
3109 of the numbers is zero, there is no blinking. The
3110 default is: "blinkwait700-blinkon400-blinkoff250".
3111 These numbers are used for a missing entry. This
3112 means that blinking is enabled by default. To switch
3113 blinking off you can use "blinkon0". The cursor only
3114 blinks when Vim is waiting for input, not while
3115 executing a command.
3116 To make the cursor blink in an xterm, see
3117 |xterm-blink|.
3118 {group-name}
3119 a highlight group name, that sets the color and font
3120 for the cursor
3121 {group-name}/{group-name}
3122 Two highlight group names, the first is used when
3123 no language mappings are used, the other when they
3124 are. |language-mapping|
3125
3126 Examples of parts:
3127 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3128 block cursor with colors from the "nCursor"
3129 highlight group
3130 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3131 In Insert and Command-line Insert mode, use a
3132 30% vertical bar cursor with colors from the
3133 "iCursor" highlight group. Blink a bit
3134 faster.
3135
3136 The 'a' mode is different. It will set the given argument-list for
3137 all modes. It does not reset anything to defaults. This can be used
3138 to do a common setting for all modes. For example, to switch off
3139 blinking: "a:blinkon0"
3140
3141 Examples of cursor highlighting: >
3142 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3143 :highlight Cursor gui=NONE guifg=bg guibg=fg
3144<
3145 *'guifont'* *'gfn'*
3146 *E235* *E596* *E610* *E611*
3147'guifont' 'gfn' string (default "")
3148 global
3149 {not in Vi}
3150 {only available when compiled with GUI enabled}
3151 This is a list of fonts which will be used for the GUI version of Vim.
3152 In its simplest form the value is just one font name. When
3153 the font cannot be found you will get an error message. To try other
3154 font names a list can be specified, font names separated with commas.
3155 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003156
Bram Moolenaar05159a02005-02-26 23:04:13 +00003157 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3158 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003159
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160 Spaces after a comma are ignored. To include a comma in a font name
3161 precede it with a backslash. Setting an option requires an extra
3162 backslash before a space and a backslash. See also
3163 |option-backslash|. For example: >
3164 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003165< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003166 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003167
3168 If none of the fonts can be loaded, Vim will keep the current setting.
3169 If an empty font list is given, Vim will try using other resource
3170 settings (for X, it will use the Vim.font resource), and finally it
3171 will try some builtin default which should always be there ("7x13" in
3172 the case of X). The font names given should be "normal" fonts. Vim
3173 will try to find the related bold and italic fonts.
3174
Bram Moolenaar05159a02005-02-26 23:04:13 +00003175 For Win32, GTK, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003176 :set guifont=*
3177< will bring up a font requester, where you can pick the font you want.
3178
3179 The font name depends on the GUI used. See |setting-guifont| for a
3180 way to set 'guifont' for various systems.
3181
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182 For the GTK+ 2 GUI the font name looks like this: >
3183 :set guifont=Andale\ Mono\ 11
3184< That's all. XLFDs are no longer accepted.
Bram Moolenaar05159a02005-02-26 23:04:13 +00003185
3186 For Mac OSX you can use something like this: >
3187 :set guifont=Monaco:h10
3188< *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003189 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003190 width). An exception is GTK 2: all fonts are accepted, but
3191 mono-spaced fonts look best.
3192
Bram Moolenaar071d4272004-06-13 20:20:40 +00003193 To preview a font on X11, you might be able to use the "xfontsel"
3194 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003195
Bram Moolenaar071d4272004-06-13 20:20:40 +00003196 For the Win32 GUI *E244* *E245*
3197 - takes these options in the font name:
3198 hXX - height is XX (points, can be floating-point)
3199 wXX - width is XX (points, can be floating-point)
3200 b - bold
3201 i - italic
3202 u - underline
3203 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003204 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003205 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3206 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3207 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003208 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003209
3210 Use a ':' to separate the options.
3211 - A '_' can be used in the place of a space, so you don't need to use
3212 backslashes to escape the spaces.
3213 - Examples: >
3214 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3215 :set guifont=Andale_Mono:h7.5:w4.5
3216< See also |font-sizes|.
3217
3218 *'guifontset'* *'gfs'*
3219 *E250* *E252* *E234* *E597* *E598*
3220'guifontset' 'gfs' string (default "")
3221 global
3222 {not in Vi}
3223 {only available when compiled with GUI enabled and
3224 with the |+xfontset| feature}
3225 {not available in the GTK+ 2 GUI}
3226 When not empty, specifies two (or more) fonts to be used. The first
3227 one for normal English, the second one for your special language. See
3228 |xfontset|.
3229 Setting this option also means that all font names will be handled as
3230 a fontset name. Also the ones used for the "font" argument of the
3231 |:highlight| command.
3232 The fonts must match with the current locale. If fonts for the
3233 character sets that the current locale uses are not included, setting
3234 'guifontset' will fail.
3235 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3236 the comma-separated names are alternative names, one of which will be
3237 used. In 'guifontset' the whole string is one fontset name,
3238 including the commas. It is not possible to specify alternative
3239 fontset names.
3240 This example works on many X11 systems: >
3241 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3242<
3243 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3244'guifontwide' 'gfw' string (default "")
3245 global
3246 {not in Vi}
3247 {only available when compiled with GUI enabled}
3248 When not empty, specifies a comma-separated list of fonts to be used
3249 for double-width characters. The first font that can be loaded is
3250 used.
3251 Note: The size of these fonts must be exactly twice as wide as the one
3252 specified with 'guifont' and the same height.
3253
3254 All GUI versions but GTK+ 2:
3255
3256 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3257 'guifontset' is empty or invalid.
3258 When 'guifont' is set and a valid font is found in it and
3259 'guifontwide' is empty Vim will attempt to find a matching
3260 double-width font and set 'guifontwide' to it.
3261
3262 GTK+ 2 GUI only: *guifontwide_gtk2*
3263
3264 If set and valid, 'guifontwide' is always used for double width
3265 characters, even if 'encoding' is not set to "utf-8".
3266 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003267 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003268 font for characters not available in 'guifont'. Thus you do not need
3269 to set 'guifontwide' at all unless you want to override the choice
3270 made by Pango/Xft.
3271
3272 *'guiheadroom'* *'ghr'*
3273'guiheadroom' 'ghr' number (default 50)
3274 global
3275 {not in Vi} {only for GTK and X11 GUI}
3276 The number of pixels subtracted from the screen height when fitting
3277 the GUI window on the screen. Set this before the GUI is started,
3278 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003279 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003280 lines will be left for window decorations and other items on the
3281 screen. Set it to a negative value to allow windows taller than the
3282 screen.
3283
3284 *'guioptions'* *'go'*
3285'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003286 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003287 global
3288 {not in Vi}
3289 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003290 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291 sequence of letters which describes what components and options of the
3292 GUI should be used.
3293 To avoid problems with flags that are added in the future, use the
3294 "+=" and "-=" feature of ":set" |add-option-flags|.
3295
3296 Valid letters are as follows:
3297 *guioptions_a*
3298 'a' Autoselect: If present, then whenever VISUAL mode is started,
3299 or the Visual area extended, Vim tries to become the owner of
3300 the windowing system's global selection. This means that the
3301 Visually highlighted text is available for pasting into other
3302 applications as well as into Vim itself. When the Visual mode
3303 ends, possibly due to an operation on the text, or when an
3304 application wants to paste the selection, the highlighted text
3305 is automatically yanked into the "* selection register.
3306 Thus the selection is still available for pasting into other
3307 applications after the VISUAL mode has ended.
3308 If not present, then Vim won't become the owner of the
3309 windowing system's global selection unless explicitly told to
3310 by a yank or delete operation for the "* register.
3311 The same applies to the modeless selection.
3312
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003313 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003314 applies to the modeless selection.
3315
3316 'guioptions' autoselect Visual autoselect modeless ~
3317 "" - -
3318 "a" yes yes
3319 "A" - yes
3320 "aA" yes yes
3321
3322 'c' Use console dialogs instead of popup dialogs for simple
3323 choices.
3324
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003325 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003326 'guitablabel' can be used to change the text in the labels.
3327 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00003328 The GUI tabs are only supported on some systens, currently
3329 only for GTK.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003330
Bram Moolenaar071d4272004-06-13 20:20:40 +00003331 'f' Foreground: Don't use fork() to detach the GUI from the shell
3332 where it was started. Use this for programs that wait for the
3333 editor to finish (e.g., an e-mail program). Alternatively you
3334 can use "gvim -f" or ":gui -f" to start the GUI in the
3335 foreground. |gui-fork|
3336 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003337 happened already when the |gvimrc| file is read.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003338
3339 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3340 corner of the window. It's black&white on non-GTK, because of
3341 limitations of X11. For a color icon, see |X11-icon|.
3342
3343 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003344 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003345 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003346 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003347 file is sourced the system menu has already been loaded; the
3348 ":syntax on" and ":filetype on" commands load the menu too).
3349 'g' Grey menu items: Make menu items that are not active grey. If
3350 'g' is not included inactive menu items are not shown at all.
3351 Exception: Athena will always use grey menu items.
3352
3353 't' Include tearoff menu items. Currently only works for Win32,
3354 GTK+, and Motif 1.2 GUI.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003355 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
3356 and Athena GUIs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003357
3358 'r' Right-hand scrollbar is always present.
3359 'R' Right-hand scrollbar is present when there is a vertically
3360 split window.
3361 'l' Left-hand scrollbar is always present.
3362 'L' Left-hand scrollbar is present when there is a vertically
3363 split window.
3364 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3365 the longest visible line, or on the cursor line if the 'h'
3366 flag is included. |gui-horiz-scroll|
3367 'h' Limit horizontal scrollbar size to the length of the cursor
3368 line. Reduces computations. |gui-horiz-scroll|
3369
3370 And yes, you may even have scrollbars on the left AND the right if
3371 you really want to :-). See |gui-scrollbars| for more information.
3372
3373 'v' Use a vertical button layout for dialogs. When not included,
3374 a horizontal layout is preferred, but when it doesn't fit a
3375 vertical layout is used anyway.
3376 'p' Use Pointer callbacks for X11 GUI. This is required for some
3377 window managers. If the cursor is not blinking or hollow at
3378 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003379 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003380 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003381 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003382
3383 *'guipty'* *'noguipty'*
3384'guipty' boolean (default on)
3385 global
3386 {not in Vi}
3387 {only available when compiled with GUI enabled}
3388 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3389 I/O to/from shell commands. See |gui-pty|.
3390
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003391 *'guitablabel'* *'gtl'*
3392'guitablabel' 'gtl' string (default empty)
3393 global
3394 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003395 {only available when compiled with GUI enabled and
3396 with the +windows feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003397 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003398 pages line. When empty Vim will use a default label. See
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003399 |setting-guitablabel| for more info.
3400
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003401 The format of this option is like that of 'statusline'.
3402
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003403 Only used when the GUI tab pages line is displayed. 'e' must be
3404 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3405 used.
3406
Bram Moolenaar071d4272004-06-13 20:20:40 +00003407 *'helpfile'* *'hf'*
3408'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3409 (others) "$VIMRUNTIME/doc/help.txt")
3410 global
3411 {not in Vi}
3412 Name of the main help file. All distributed help files should be
3413 placed together in one directory. Additionally, all "doc" directories
3414 in 'runtimepath' will be used.
3415 Environment variables are expanded |:set_env|. For example:
3416 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003417 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003418 spaces and backslashes.
3419 This option cannot be set from a |modeline| or in the |sandbox|, for
3420 security reasons.
3421
3422 *'helpheight'* *'hh'*
3423'helpheight' 'hh' number (default 20)
3424 global
3425 {not in Vi}
3426 {not available when compiled without the +windows
3427 feature}
3428 Minimal initial height of the help window when it is opened with the
3429 ":help" command. The initial height of the help window is half of the
3430 current window, or (when the 'ea' option is on) the same as other
3431 windows. When the height is less than 'helpheight', the height is
3432 set to 'helpheight'. Set to zero to disable.
3433
3434 *'helplang'* *'hlg'*
3435'helplang' 'hlg' string (default: messages language or empty)
3436 global
3437 {only available when compiled with the |+multi_lang|
3438 feature}
3439 {not in Vi}
3440 Comma separated list of languages. Vim will use the first language
3441 for which the desired help can be found. The English help will always
3442 be used as a last resort. You can add "en" to prefer English over
3443 another language, but that will only find tags that exist in that
3444 language and not in the English help.
3445 Example: >
3446 :set helplang=de,it
3447< This will first search German, then Italian and finally English help
3448 files.
3449 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3450 try to find the tag in the current language before using this option.
3451 See |help-translated|.
3452
3453 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3454'hidden' 'hid' boolean (default off)
3455 global
3456 {not in Vi}
3457 When off a buffer is unloaded when it is |abandon|ed. When on a
3458 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3459 displayed in another window, it does not become hidden, of course.
3460 The commands that move through the buffer list sometimes make a buffer
3461 hidden although the 'hidden' option is off: When the buffer is
3462 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003463 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003464 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003465 This option is set for one command with ":hide {command}" |:hide|.
3466 WARNING: It's easy to forget that you have changes in hidden buffers.
3467 Think twice when using ":q!" or ":qa!".
3468
3469 *'highlight'* *'hl'*
3470'highlight' 'hl' string (default (as a single string):
3471 "8:SpecialKey,@:NonText,d:Directory,
3472 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3473 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003474 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003475 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3476 f:Folded,F:FoldColumn,A:DiffAdd,
3477 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003478 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003479 R:SpellRare,L:SpellLocal,
3480 +:Pmenu,=:PmenuSel,
3481 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003482 global
3483 {not in Vi}
3484 This option can be used to set highlighting mode for various
3485 occasions. It is a comma separated list of character pairs. The
3486 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003487 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003488 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3489 |hl-NonText| @ '~' and '@' at the end of the window and
3490 characters from 'showbreak'
3491 |hl-Directory| d directories in CTRL-D listing and other special
3492 things in listings
3493 |hl-ErrorMsg| e error messages
3494 h (obsolete, ignored)
3495 |hl-IncSearch| i 'incsearch' highlighting
3496 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3497 |hl-MoreMsg| m |more-prompt|
3498 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3499 |hl-LineNr| n line number for ":number" and ":#" commands
3500 |hl-Question| r |hit-enter| prompt and yes/no questions
3501 |hl-StatusLine| s status line of current window |status-line|
3502 |hl-StatusLineNC| S status lines of not-current windows
3503 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3504 |hl-VertSplit| c column used to separate vertically split windows
3505 |hl-Visual| v Visual mode
3506 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3507 Selection" Only X11 Gui's |gui-x11| and
3508 |xterm-clipboard|.
3509 |hl-WarningMsg| w warning messages
3510 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3511 |hl-Folded| f line used for closed folds
3512 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003513 |hl-DiffAdd| A added line in diff mode
3514 |hl-DiffChange| C changed line in diff mode
3515 |hl-DiffDelete| D deleted line in diff mode
3516 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003517 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003518 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003519 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003520 |hl-SpellRare| R rare word |spell|
3521 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003522 |hl-Pmenu| + popup menu normal line
3523 |hl-PmenuSel| = popup menu normal line
3524 |hl-PmenuSbar| x popup menu scrollbar
3525 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003526
3527 The display modes are:
3528 r reverse (termcap entry "mr" and "me")
3529 i italic (termcap entry "ZH" and "ZR")
3530 b bold (termcap entry "md" and "me")
3531 s standout (termcap entry "so" and "se")
3532 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003533 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003534 n no highlighting
3535 - no highlighting
3536 : use a highlight group
3537 The default is used for occasions that are not included.
3538 If you want to change what the display modes do, see |dos-colors|
3539 for an example.
3540 When using the ':' display mode, this must be followed by the name of
3541 a highlight group. A highlight group can be used to define any type
3542 of highlighting, including using color. See |:highlight| on how to
3543 define one. The default uses a different group for each occasion.
3544 See |highlight-default| for the default highlight groups.
3545
3546 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3547'hlsearch' 'hls' boolean (default off)
3548 global
3549 {not in Vi}
3550 {not available when compiled without the
3551 |+extra_search| feature}
3552 When there is a previous search pattern, highlight all its matches.
3553 The type of highlighting used can be set with the 'l' occasion in the
3554 'highlight' option. This uses the "Search" highlight group by
3555 default. Note that only the matching text is highlighted, any offsets
3556 are not applied.
3557 See also: 'incsearch' and |:match|.
3558 When you get bored looking at the highlighted matches, you can turn it
3559 off with |:nohlsearch|. As soon as you use a search command, the
3560 highlighting comes back.
3561 When the search pattern can match an end-of-line, Vim will try to
3562 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003563 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003564 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003565 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003566 NOTE: This option is reset when 'compatible' is set.
3567
3568 *'history'* *'hi'*
3569'history' 'hi' number (Vim default: 20, Vi default: 0)
3570 global
3571 {not in Vi}
3572 A history of ":" commands, and a history of previous search patterns
3573 are remembered. This option decides how many entries may be stored in
3574 each of these histories (see |cmdline-editing|).
3575 NOTE: This option is set to the Vi default value when 'compatible' is
3576 set and to the Vim default value when 'compatible' is reset.
3577
3578 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3579'hkmap' 'hk' boolean (default off)
3580 global
3581 {not in Vi}
3582 {only available when compiled with the |+rightleft|
3583 feature}
3584 When on, the keyboard is mapped for the Hebrew character set.
3585 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3586 toggle this option. See |rileft.txt|.
3587 NOTE: This option is reset when 'compatible' is set.
3588
3589 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3590'hkmapp' 'hkp' boolean (default off)
3591 global
3592 {not in Vi}
3593 {only available when compiled with the |+rightleft|
3594 feature}
3595 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3596 This is useful if you have a non-Hebrew keyboard.
3597 See |rileft.txt|.
3598 NOTE: This option is reset when 'compatible' is set.
3599
3600 *'icon'* *'noicon'*
3601'icon' boolean (default off, on when title can be restored)
3602 global
3603 {not in Vi}
3604 {not available when compiled without the |+title|
3605 feature}
3606 When on, the icon text of the window will be set to the value of
3607 'iconstring' (if it is not empty), or to the name of the file
3608 currently being edited. Only the last part of the name is used.
3609 Overridden by the 'iconstring' option.
3610 Only works if the terminal supports setting window icons (currently
3611 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3612 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3613 builtin termcap).
3614 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003615 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003616 X11.
3617
3618 *'iconstring'*
3619'iconstring' string (default "")
3620 global
3621 {not in Vi}
3622 {not available when compiled without the |+title|
3623 feature}
3624 When this option is not empty, it will be used for the icon text of
3625 the window. This happens only when the 'icon' option is on.
3626 Only works if the terminal supports setting window icon text
3627 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3628 Does not work for MS Windows.
3629 When Vim was compiled with HAVE_X11 defined, the original icon will be
3630 restored if possible |X11|.
3631 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003632 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003633 'titlestring' for example settings.
3634 {not available when compiled without the |+statusline| feature}
3635
3636 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3637'ignorecase' 'ic' boolean (default off)
3638 global
3639 Ignore case in search patterns. Also used when searching in the tags
3640 file.
3641 Also see 'smartcase'.
3642 Can be overruled by using "\c" or "\C" in the pattern, see
3643 |/ignorecase|.
3644
3645 *'imactivatekey'* *'imak'*
3646'imactivatekey' 'imak' string (default "")
3647 global
3648 {not in Vi}
3649 {only available when compiled with |+xim| and
3650 |+GUI_GTK|}
3651 Specifies the key that your Input Method in X-Windows uses for
3652 activation. When this is specified correctly, vim can fully control
3653 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3654 You can't use this option to change the activation key, the option
3655 tells Vim what the key is.
3656 Format:
3657 [MODIFIER_FLAG-]KEY_STRING
3658
3659 These characters can be used for MODIFIER_FLAG (case is ignored):
3660 S Shift key
3661 L Lock key
3662 C Control key
3663 1 Mod1 key
3664 2 Mod2 key
3665 3 Mod3 key
3666 4 Mod4 key
3667 5 Mod5 key
3668 Combinations are allowed, for example "S-C-space" or "SC-space" are
3669 both shift+ctrl+space.
3670 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3671
3672 Example: >
3673 :set imactivatekey=S-space
3674< "S-space" means shift+space. This is the activation key for kinput2 +
3675 canna (Japanese), and ami (Korean).
3676
3677 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3678'imcmdline' 'imc' boolean (default off)
3679 global
3680 {not in Vi}
3681 {only available when compiled with the |+xim|
3682 |+multi_byte_ime| or |global-ime| feature}
3683 When set the Input Method is always on when starting to edit a command
3684 line, unless entering a search pattern (see 'imsearch' for that).
3685 Setting this option is useful when your input method allows entering
3686 English characters directly, e.g., when it's used to type accented
3687 characters with dead keys.
3688
3689 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3690'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3691 global
3692 {not in Vi}
3693 {only available when compiled with the |+xim|
3694 |+multi_byte_ime| or |global-ime| feature}
3695 When set the Input Method is never used. This is useful to disable
3696 the IM when it doesn't work properly.
3697 Currently this option is on by default for SGI/IRIX machines. This
3698 may change in later releases.
3699
3700 *'iminsert'* *'imi'*
3701'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3702 local to buffer
3703 {not in Vi}
3704 Specifies whether :lmap or an Input Method (IM) is to be used in
3705 Insert mode. Valid values:
3706 0 :lmap is off and IM is off
3707 1 :lmap is ON and IM is off
3708 2 :lmap is off and IM is ON
3709 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3710 or |global-ime|.
3711 To always reset the option to zero when leaving Insert mode with <Esc>
3712 this can be used: >
3713 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3714< This makes :lmap and IM turn off automatically when leaving Insert
3715 mode.
3716 Note that this option changes when using CTRL-^ in Insert mode
3717 |i_CTRL-^|.
3718 The value is set to 1 when setting 'keymap' to a valid keymap name.
3719 It is also used for the argument of commands like "r" and "f".
3720 The value 0 may not work correctly with Athena and Motif with some XIM
3721 methods. Use 'imdisable' to disable XIM then.
3722
3723 *'imsearch'* *'ims'*
3724'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3725 local to buffer
3726 {not in Vi}
3727 Specifies whether :lmap or an Input Method (IM) is to be used when
3728 entering a search pattern. Valid values:
3729 -1 the value of 'iminsert' is used, makes it look like
3730 'iminsert' is also used when typing a search pattern
3731 0 :lmap is off and IM is off
3732 1 :lmap is ON and IM is off
3733 2 :lmap is off and IM is ON
3734 Note that this option changes when using CTRL-^ in Command-line mode
3735 |c_CTRL-^|.
3736 The value is set to 1 when it is not -1 and setting the 'keymap'
3737 option to a valid keymap name.
3738 The value 0 may not work correctly with Athena and Motif with some XIM
3739 methods. Use 'imdisable' to disable XIM then.
3740
3741 *'include'* *'inc'*
3742'include' 'inc' string (default "^\s*#\s*include")
3743 global or local to buffer |global-local|
3744 {not in Vi}
3745 {not available when compiled without the
3746 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003747 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003748 pattern, just like for the "/" command (See |pattern|). The default
3749 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003750 "]I", "[d", etc.
3751 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003752 comes after the matched pattern. But if "\zs" appears in the pattern
3753 then the text matched from "\zs" to the end, or until "\ze" if it
3754 appears, is used as the file name. Use this to include characters
3755 that are not in 'isfname', such as a space. You can then use
3756 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003757 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003758
3759 *'includeexpr'* *'inex'*
3760'includeexpr' 'inex' string (default "")
3761 local to buffer
3762 {not in Vi}
3763 {not available when compiled without the
3764 |+find_in_path| or |+eval| feature}
3765 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003766 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003767 :set includeexpr=substitute(v:fname,'\\.','/','g')
3768< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003769
Bram Moolenaar071d4272004-06-13 20:20:40 +00003770 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003771 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003772 Also used for |<cfile>|.
3773
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003774 The expression may be evaluated in the |sandbox|, see
3775 |sandbox-option|.
3776
3777 It is not allowed to change text or jump to another window while
3778 evaluating 'includeexpr' |textlock|.
3779
Bram Moolenaar071d4272004-06-13 20:20:40 +00003780 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3781'incsearch' 'is' boolean (default off)
3782 global
3783 {not in Vi}
3784 {not available when compiled without the
3785 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003786 While typing a search command, show where the pattern, as it was typed
3787 so far, matches. The matched string is highlighted. If the pattern
3788 is invalid or not found, nothing is shown. The screen will be updated
3789 often, this is only useful on fast terminals.
3790 Note that the match will be shown, but the cursor will return to its
3791 original position when no match is found and when pressing <Esc>. You
3792 still need to finish the search command with <Enter> to move the
3793 cursor to the match.
3794 The highlighting can be set with the 'i' flag in 'highlight'.
3795 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00003796 CTRL-L can be used to add one character from after the current match
3797 to the command line.
3798 CTRL-R CTRL-W can be used to add the word at the end of the current
3799 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003800 NOTE: This option is reset when 'compatible' is set.
3801
3802 *'indentexpr'* *'inde'*
3803'indentexpr' 'inde' string (default "")
3804 local to buffer
3805 {not in Vi}
3806 {not available when compiled without the |+cindent|
3807 or |+eval| features}
3808 Expression which is evaluated to obtain the proper indent for a line.
3809 It is used when a new line is created, for the |=| operator and
3810 in Insert mode as specified with the 'indentkeys' option.
3811 When this option is not empty, it overrules the 'cindent' and
3812 'smartindent' indenting.
3813 When 'paste' is set this option is not used for indenting.
3814 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003815 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816 when the expression is evaluated (but it may be moved around).
3817 The expression must return the number of spaces worth of indent. It
3818 can return "-1" to keep the current indent (this means 'autoindent' is
3819 used for the indent).
3820 Functions useful for computing the indent are |indent()|, |cindent()|
3821 and |lispindent()|.
3822 The evaluation of the expression must not have side effects! It must
3823 not change the text, jump to another window, etc. Afterwards the
3824 cursor position is always restored, thus the cursor may be moved.
3825 Normally this option would be set to call a function: >
3826 :set indentexpr=GetMyIndent()
3827< Error messages will be suppressed, unless the 'debug' option contains
3828 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003829 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830 NOTE: This option is made empty when 'compatible' is set.
3831
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003832 The expression may be evaluated in the |sandbox|, see
3833 |sandbox-option|.
3834
3835 It is not allowed to change text or jump to another window while
3836 evaluating 'indentexpr' |textlock|.
3837
3838
Bram Moolenaar071d4272004-06-13 20:20:40 +00003839 *'indentkeys'* *'indk'*
3840'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3841 local to buffer
3842 {not in Vi}
3843 {not available when compiled without the |+cindent|
3844 feature}
3845 A list of keys that, when typed in Insert mode, cause reindenting of
3846 the current line. Only happens if 'indentexpr' isn't empty.
3847 The format is identical to 'cinkeys', see |indentkeys-format|.
3848 See |C-indenting| and |indent-expression|.
3849
3850 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3851'infercase' 'inf' boolean (default off)
3852 local to buffer
3853 {not in Vi}
3854 When doing keyword completion in insert mode |ins-completion|, and
3855 'ignorecase' is also on, the case of the match is adjusted. If the
3856 typed text contains a lowercase letter where the match has an upper
3857 case letter, the completed part is made lowercase. If the typed text
3858 has no lowercase letters and the match has a lowercase letter where
3859 the typed text has an uppercase letter, and there is a letter before
3860 it, the completed part is made uppercase.
3861
3862 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3863'insertmode' 'im' boolean (default off)
3864 global
3865 {not in Vi}
3866 Makes Vim work in a way that Insert mode is the default mode. Useful
3867 if you want to use Vim as a modeless editor. Used for |evim|.
3868 These Insert mode commands will be useful:
3869 - Use the cursor keys to move around.
3870 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3871 this is a mapping, it is executed as if 'insertmode' was off.
3872 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003873 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00003874 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
3875 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003876
3877 These items change when 'insertmode' is set:
3878 - when starting to edit of a file, Vim goes to Insert mode.
3879 - <Esc> in Insert mode is a no-op and beeps.
3880 - <Esc> in Normal mode makes Vim go to Insert mode.
3881 - CTRL-L in Insert mode is a command, it is not inserted.
3882 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3883 However, when <Esc> is used inside a mapping, it behaves like
3884 'insertmode' was not set. This was done to be able to use the same
3885 mappings with 'insertmode' set or not set.
3886 When executing commands with |:normal| 'insertmode' is not used.
3887
3888 NOTE: This option is reset when 'compatible' is set.
3889
3890 *'isfname'* *'isf'*
3891'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3892 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3893 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3894 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3895 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3896 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3897 global
3898 {not in Vi}
3899 The characters specified by this option are included in file names and
3900 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003901 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003902 Multi-byte characters 256 and above are always included, only the
3903 characters up to 255 are specified with this option.
3904 For UTF-8 the characters 0xa0 to 0xff are included as well.
3905
3906 Note that on systems using a backslash as path separator, Vim tries to
3907 do its best to make it work as you would expect. That is a bit
3908 tricky, since Vi originally used the backslash to escape special
3909 characters. Vim will not remove a backslash in front of a normal file
3910 name character on these systems, but it will on Unix and alikes. The
3911 '&' and '^' are not included by default, because these are special for
3912 cmd.exe.
3913
3914 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003915 Each part can be a single character number or a range. A range is two
3916 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003917 decimal number between 0 and 255 or the ASCII character itself (does
3918 not work for digits). Example:
3919 "_,-,128-140,#-43" (include '_' and '-' and the range
3920 128 to 140 and '#' to 43)
3921 If a part starts with '^', the following character number or range
3922 will be excluded from the option. The option is interpreted from left
3923 to right. Put the excluded character after the range where it is
3924 included. To include '^' itself use it as the last character of the
3925 option or the end of a range. Example:
3926 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3927 If the character is '@', all characters where isalpha() returns TRUE
3928 are included. Normally these are the characters a to z and A to Z,
3929 plus accented characters. To include '@' itself use "@-@". Examples:
3930 "@,^a-z" All alphabetic characters, excluding lower
3931 case letters.
3932 "a-z,A-Z,@-@" All letters plus the '@' character.
3933 A comma can be included by using it where a character number is
3934 expected. Example:
3935 "48-57,,,_" Digits, comma and underscore.
3936 A comma can be excluded by prepending a '^'. Example:
3937 " -~,^,,9" All characters from space to '~', excluding
3938 comma, plus <Tab>.
3939 See |option-backslash| about including spaces and backslashes.
3940
3941 *'isident'* *'isi'*
3942'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3943 "@,48-57,_,128-167,224-235"
3944 otherwise: "@,48-57,_,192-255")
3945 global
3946 {not in Vi}
3947 The characters given by this option are included in identifiers.
3948 Identifiers are used in recognizing environment variables and after a
3949 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00003950 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00003951 option.
3952 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003953 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003954 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3955
3956 *'iskeyword'* *'isk'*
3957'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3958 "@,48-57,_,128-167,224-235"
3959 otherwise: "@,48-57,_,192-255"
3960 Vi default: "@,48-57,_")
3961 local to buffer
3962 {not in Vi}
3963 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003964 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003965 'isfname' for a description of the format of this option. For C
3966 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3967 For a help file it is set to all non-blank printable characters except
3968 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3969 command).
3970 When the 'lisp' option is on the '-' character is always included.
3971 NOTE: This option is set to the Vi default value when 'compatible' is
3972 set and to the Vim default value when 'compatible' is reset.
3973
3974 *'isprint'* *'isp'*
3975'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3976 "@,~-255"; otherwise: "@,161-255")
3977 global
3978 {not in Vi}
3979 The characters given by this option are displayed directly on the
3980 screen. It is also used for "\p" in a |pattern|. The characters from
3981 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3982 even when they are not included in 'isprint' or excluded. See
3983 'isfname' for a description of the format of this option.
3984
3985 Non-printable characters are displayed with two characters:
3986 0 - 31 "^@" - "^_"
3987 32 - 126 always single characters
3988 127 "^?"
3989 128 - 159 "~@" - "~_"
3990 160 - 254 "| " - "|~"
3991 255 "~?"
3992 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3993 displayed as <xx>, with the hexadecimal value of the byte.
3994 When 'display' contains "uhex" all unprintable characters are
3995 displayed as <xx>.
3996 The NonText highlighting will be used for unprintable characters.
3997 |hl-NonText|
3998
3999 Multi-byte characters 256 and above are always included, only the
4000 characters up to 255 are specified with this option. When a character
4001 is printable but it is not available in the current font, a
4002 replacement character will be shown.
4003 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4004 There is no option to specify these characters.
4005
4006 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4007'joinspaces' 'js' boolean (default on)
4008 global
4009 {not in Vi}
4010 Insert two spaces after a '.', '?' and '!' with a join command.
4011 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4012 Otherwise only one space is inserted.
4013 NOTE: This option is set when 'compatible' is set.
4014
4015 *'key'*
4016'key' string (default "")
4017 local to buffer
4018 {not in Vi}
4019 The key that is used for encrypting and decrypting the current buffer.
4020 See |encryption|.
4021 Careful: Do not set the key value by hand, someone might see the typed
4022 key. Use the |:X| command. But you can make 'key' empty: >
4023 :set key=
4024< It is not possible to get the value of this option with ":set key" or
4025 "echo &key". This is to avoid showing it to someone who shouldn't
4026 know. It also means you cannot see it yourself once you have set it,
4027 be careful not to make a typing error!
4028
4029 *'keymap'* *'kmp'* *E544*
4030'keymap' 'kmp' string (default "")
4031 local to buffer
4032 {not in Vi}
4033 {only available when compiled with the |+keymap|
4034 feature}
4035 Name of a keyboard mapping. See |mbyte-keymap|.
4036 Setting this option to a valid keymap name has the side effect of
4037 setting 'iminsert' to one, so that the keymap becomes effective.
4038 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004039 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004040
4041 *'keymodel'* *'km'*
4042'keymodel' 'km' string (default "")
4043 global
4044 {not in Vi}
4045 List of comma separated words, which enable special things that keys
4046 can do. These values can be used:
4047 startsel Using a shifted special key starts selection (either
4048 Select mode or Visual mode, depending on "key" being
4049 present in 'selectmode').
4050 stopsel Using a not-shifted special key stops selection.
4051 Special keys in this context are the cursor keys, <End>, <Home>,
4052 <PageUp> and <PageDown>.
4053 The 'keymodel' option is set by the |:behave| command.
4054
4055 *'keywordprg'* *'kp'*
4056'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4057 OS/2: "view /", VMS: "help")
4058 global or local to buffer |global-local|
4059 {not in Vi}
4060 Program to use for the |K| command. Environment variables are
4061 expanded |:set_env|. ":help" may be used to access the Vim internal
4062 help. (Note that previously setting the global option to the empty
4063 value did this, which is now deprecated.)
4064 When "man" is used, Vim will automatically translate a count for the
4065 "K" command to a section number. Also for "man -s", in which case the
4066 "-s" is removed when there is no count.
4067 See |option-backslash| about including spaces and backslashes.
4068 Example: >
4069 :set keywordprg=man\ -s
4070< This option cannot be set from a |modeline| or in the |sandbox|, for
4071 security reasons.
4072
4073 *'langmap'* *'lmap'* *E357* *E358*
4074'langmap' 'lmap' string (default "")
4075 global
4076 {not in Vi}
4077 {only available when compiled with the |+langmap|
4078 feature}
4079 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004080 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004081 inserted directly. When in command mode the 'langmap' option takes
4082 care of translating these special characters to the original meaning
4083 of the key. This means you don't have to change the keyboard mode to
4084 be able to execute Normal mode commands.
4085 This is the opposite of the 'keymap' option, where characters are
4086 mapped in Insert mode.
4087 This only works for 8-bit characters. The value of 'langmap' may be
4088 specified with multi-byte characters (e.g., UTF-8), but only the lower
4089 8 bits of each character will be used.
4090
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004091 Example (for Greek, in UTF-8): *greek* >
4092 :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 +00004093< Example (exchanges meaning of z and y for commands): >
4094 :set langmap=zy,yz,ZY,YZ
4095<
4096 The 'langmap' option is a list of parts, separated with commas. Each
4097 part can be in one of two forms:
4098 1. A list of pairs. Each pair is a "from" character immediately
4099 followed by the "to" character. Examples: "aA", "aAbBcC".
4100 2. A list of "from" characters, a semi-colon and a list of "to"
4101 characters. Example: "abc;ABC"
4102 Example: "aA,fgh;FGH,cCdDeE"
4103 Special characters need to be preceded with a backslash. These are
4104 ";", ',' and backslash itself.
4105
4106 This will allow you to activate vim actions without having to switch
4107 back and forth between the languages. Your language characters will
4108 be understood as normal vim English characters (according to the
4109 langmap mappings) in the following cases:
4110 o Normal/Visual mode (commands, buffer/register names, user mappings)
4111 o Insert/Replace Mode: Register names after CTRL-R
4112 o Insert/Replace Mode: Mappings
4113 Characters entered in Command-line mode will NOT be affected by
4114 this option. Note that this option can be changed at any time
4115 allowing to switch between mappings for different languages/encodings.
4116 Use a mapping to avoid having to type it each time!
4117
4118 *'langmenu'* *'lm'*
4119'langmenu' 'lm' string (default "")
4120 global
4121 {not in Vi}
4122 {only available when compiled with the |+menu| and
4123 |+multi_lang| features}
4124 Language to use for menu translation. Tells which file is loaded
4125 from the "lang" directory in 'runtimepath': >
4126 "lang/menu_" . &langmenu . ".vim"
4127< (without the spaces). For example, to always use the Dutch menus, no
4128 matter what $LANG is set to: >
4129 :set langmenu=nl_NL.ISO_8859-1
4130< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004131 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004132 If your $LANG is set to a non-English language but you do want to use
4133 the English menus: >
4134 :set langmenu=none
4135< This option must be set before loading menus, switching on filetype
4136 detection or syntax highlighting. Once the menus are defined setting
4137 this option has no effect. But you could do this: >
4138 :source $VIMRUNTIME/delmenu.vim
4139 :set langmenu=de_DE.ISO_8859-1
4140 :source $VIMRUNTIME/menu.vim
4141< Warning: This deletes all menus that you defined yourself!
4142
4143 *'laststatus'* *'ls'*
4144'laststatus' 'ls' number (default 1)
4145 global
4146 {not in Vi}
4147 The value of this option influences when the last window will have a
4148 status line:
4149 0: never
4150 1: only if there are at least two windows
4151 2: always
4152 The screen looks nicer with a status line if you have several
4153 windows, but it takes another screen line. |status-line|
4154
4155 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4156'lazyredraw' 'lz' boolean (default off)
4157 global
4158 {not in Vi}
4159 When this option is set, the screen will not be redrawn while
4160 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004161 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004162 update use |:redraw|.
4163
4164 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4165'linebreak' 'lbr' boolean (default off)
4166 local to window
4167 {not in Vi}
4168 {not available when compiled without the |+linebreak|
4169 feature}
4170 If on Vim will wrap long lines at a character in 'breakat' rather
4171 than at the last character that fits on the screen. Unlike
4172 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4173 it only affects the way the file is displayed, not its contents. The
4174 value of 'showbreak' is used to put in front of wrapped lines.
4175 This option is not used when the 'wrap' option is off or 'list' is on.
4176 Note that <Tab> characters after an <EOL> are mostly not displayed
4177 with the right amount of white space.
4178
4179 *'lines'* *E593*
4180'lines' number (default 24 or terminal height)
4181 global
4182 Number of lines of the Vim window.
4183 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004184 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004185 When Vim is running in the GUI or in a resizable window, setting this
4186 option will cause the window size to be changed. When you only want
4187 to use the size for the GUI, put the command in your |gvimrc| file.
4188 Vim limits the number of lines to what fits on the screen. You can
4189 use this command to get the tallest window possible: >
4190 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004191< Minimum value is 2, maximum value is 1000.
4192 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004193 When you set this option and Vim is unable to change the physical
4194 number of lines of the display, the display may be messed up.
4195
4196 *'linespace'* *'lsp'*
4197'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4198 global
4199 {not in Vi}
4200 {only in the GUI}
4201 Number of pixel lines inserted between characters. Useful if the font
4202 uses the full character cell height, making lines touch each other.
4203 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004204 With some fonts there can be too much room between lines (to have
4205 space for ascents and descents). Then it makes sense to set
4206 'linespace' to a negative value. This may cause display problems
4207 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004208
4209 *'lisp'* *'nolisp'*
4210'lisp' boolean (default off)
4211 local to buffer
4212 {not available when compiled without the |+lispindent|
4213 feature}
4214 Lisp mode: When <Enter> is typed in insert mode set the indent for
4215 the next line to Lisp standards (well, sort of). Also happens with
4216 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4217 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4218 better. Also see 'lispwords'.
4219 The '-' character is included in keyword characters. Redefines the
4220 "=" operator to use this same indentation algorithm rather than
4221 calling an external program if 'equalprg' is empty.
4222 This option is not used when 'paste' is set.
4223 {Vi: Does it a little bit differently}
4224
4225 *'lispwords'* *'lw'*
4226'lispwords' 'lw' string (default is very long)
4227 global
4228 {not in Vi}
4229 {not available when compiled without the |+lispindent|
4230 feature}
4231 Comma separated list of words that influence the Lisp indenting.
4232 |'lisp'|
4233
4234 *'list'* *'nolist'*
4235'list' boolean (default off)
4236 local to window
4237 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
4238 see the difference between tabs and spaces and for trailing blanks.
4239 Note that this will also affect formatting (set with 'textwidth' or
4240 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
4241 changing the way tabs are displayed.
4242
4243 *'listchars'* *'lcs'*
4244'listchars' 'lcs' string (default "eol:$")
4245 global
4246 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004247 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004248 settings.
4249 eol:c Character to show at the end of each line. When
4250 omitted, there is no extra character at the end of the
4251 line.
4252 tab:xy Two characters to be used to show a Tab. The first
4253 char is used once. The second char is repeated to
4254 fill the space that the Tab normally occupies.
4255 "tab:>-" will show a Tab that takes four spaces as
4256 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004257 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004258 trailing spaces are blank.
4259 extends:c Character to show in the last column, when 'wrap' is
4260 off and the line continues beyond the right of the
4261 screen.
4262 precedes:c Character to show in the first column, when 'wrap'
4263 is off and there is text preceding the character
4264 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004265 nbsp:c Character to show for a non-breakable space (character
4266 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004267
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004268 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004269 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004270 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004271
4272 Examples: >
4273 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004274 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004275 :set lcs=extends:>,precedes:<
4276< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004277 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004278
4279 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4280'loadplugins' 'lpl' boolean (default on)
4281 global
4282 {not in Vi}
4283 When on the plugin scripts are loaded when starting up |load-plugins|.
4284 This option can be reset in your |vimrc| file to disable the loading
4285 of plugins.
4286 Note that using the "-u NONE" and "--noplugin" command line arguments
4287 reset this option. |-u| |--noplugin|
4288
4289 *'magic'* *'nomagic'*
4290'magic' boolean (default on)
4291 global
4292 Changes the special characters that can be used in search patterns.
4293 See |pattern|.
4294 NOTE: To avoid portability problems with using patterns, always keep
4295 this option at the default "on". Only switch it off when working with
4296 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004297 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004298
4299 *'makeef'* *'mef'*
4300'makeef' 'mef' string (default: "")
4301 global
4302 {not in Vi}
4303 {not available when compiled without the |+quickfix|
4304 feature}
4305 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4306 and the |:grep| command.
4307 When it is empty, an internally generated temp file will be used.
4308 When "##" is included, it is replaced by a number to make the name
4309 unique. This makes sure that the ":make" command doesn't overwrite an
4310 existing file.
4311 NOT used for the ":cf" command. See 'errorfile' for that.
4312 Environment variables are expanded |:set_env|.
4313 See |option-backslash| about including spaces and backslashes.
4314 This option cannot be set from a |modeline| or in the |sandbox|, for
4315 security reasons.
4316
4317 *'makeprg'* *'mp'*
4318'makeprg' 'mp' string (default "make", VMS: "MMS")
4319 global or local to buffer |global-local|
4320 {not in Vi}
4321 Program to use for the ":make" command. See |:make_makeprg|. This
4322 option may contain '%' and '#' characters, which are expanded like
4323 when used in a command-line. Environment variables are expanded
4324 |:set_env|. See |option-backslash| about including spaces and
4325 backslashes. Note that a '|' must be escaped twice: once for ":set"
4326 and once for the interpretation of a command. When you use a filter
4327 called "myfilter" do it like this: >
4328 :set makeprg=gmake\ \\\|\ myfilter
4329< The placeholder "$*" can be given (even multiple times) to specify
4330 where the arguments will be included, for example: >
4331 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4332< This option cannot be set from a |modeline| or in the |sandbox|, for
4333 security reasons.
4334
4335 *'matchpairs'* *'mps'*
4336'matchpairs' 'mps' string (default "(:),{:},[:]")
4337 local to buffer
4338 {not in Vi}
4339 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004340 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00004341 must be different. The characters must be separated by a colon. The
4342 pairs must be separated by a comma. Example for including '<' and '>'
4343 (HTML): >
4344 :set mps+=<:>
4345
4346< A more exotic example, to jump between the '=' and ';' in an
4347 assignment, useful for languages like C and Java: >
4348 :au FileType c,cpp,java set mps+==:;
4349
4350< For a more advanced way of using "%", see the matchit.vim plugin in
4351 the $VIMRUNTIME/macros directory. |add-local-help|
4352
4353 *'matchtime'* *'mat'*
4354'matchtime' 'mat' number (default 5)
4355 global
4356 {not in Vi}{in Nvi}
4357 Tenths of a second to show the matching paren, when 'showmatch' is
4358 set. Note that this is not in milliseconds, like other options that
4359 set a time. This is to be compatible with Nvi.
4360
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004361 *'maxcombine'* *'mco'*
4362'maxcombine' 'mco' number (default 2)
4363 global
4364 {not in Vi}
4365 {only available when compiled with the |+multi_byte|
4366 feature}
4367 The maximum number of combining characters supported for displaying.
4368 Only used when 'encoding' is "utf-8".
4369 The default is OK for most languages. Hebrew may require 4.
4370 Maximum value is 6.
4371 Even when this option is set to 2 you can still edit text with more
4372 combining characters, you just can't see them. Use |g8| or |ga|.
4373 See |mbyte-combining|.
4374
Bram Moolenaar071d4272004-06-13 20:20:40 +00004375 *'maxfuncdepth'* *'mfd'*
4376'maxfuncdepth' 'mfd' number (default 100)
4377 global
4378 {not in Vi}
4379 Maximum depth of function calls for user functions. This normally
4380 catches endless recursion. When using a recursive function with
4381 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4382 more memory, there is the danger of failing when memory is exhausted.
4383 See also |:function|.
4384
4385 *'maxmapdepth'* *'mmd'* *E223*
4386'maxmapdepth' 'mmd' number (default 1000)
4387 global
4388 {not in Vi}
4389 Maximum number of times a mapping is done without resulting in a
4390 character to be used. This normally catches endless mappings, like
4391 ":map x y" with ":map y x". It still does not catch ":map g wg",
4392 because the 'w' is used before the next mapping is done. See also
4393 |key-mapping|.
4394
4395 *'maxmem'* *'mm'*
4396'maxmem' 'mm' number (default between 256 to 5120 (system
4397 dependent) or half the amount of memory
4398 available)
4399 global
4400 {not in Vi}
4401 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4402 limit is reached allocating extra memory for a buffer will cause
4403 other memory to be freed. Maximum value 2000000. Use this to work
4404 without a limit. Also see 'maxmemtot'.
4405
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004406 *'maxmempattern'* *'mmp'*
4407'maxmempattern' 'mmp' number (default 1000)
4408 global
4409 {not in Vi}
4410 Maximum amount of memory (in Kbyte) to use for pattern matching.
4411 Maximum value 2000000. Use this to work without a limit.
4412 *E363*
4413 When Vim runs into the limit it gives an error message mostly behaves
4414 like CTRL-C was typed.
4415 Running into the limit often means that the pattern is very
4416 inefficient or too complex. This may already happen with the pattern
4417 "\(.\)*" on a very long line. ".*" works much better.
4418 Vim may run out of memory before hitting the 'maxmempattern' limit.
4419
Bram Moolenaar071d4272004-06-13 20:20:40 +00004420 *'maxmemtot'* *'mmt'*
4421'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4422 dependent) or half the amount of memory
4423 available)
4424 global
4425 {not in Vi}
4426 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004427 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004428 'maxmem'.
4429
4430 *'menuitems'* *'mis'*
4431'menuitems' 'mis' number (default 25)
4432 global
4433 {not in Vi}
4434 {not available when compiled without the |+menu|
4435 feature}
4436 Maximum number of items to use in a menu. Used for menus that are
4437 generated from a list of items, e.g., the Buffers menu. Changing this
4438 option has no direct effect, the menu must be refreshed first.
4439
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004440 *'mkspellmem'* *'msm'*
4441'mkspellmem' 'msm' string (default "460000,2000,500")
4442 global
4443 {not in Vi}
4444 {not available when compiled without the |+syntax|
4445 feature}
4446 Parameters for |:mkspell|. This tunes when to start compressing the
4447 word tree. Compression can be slow when there are many words, but
4448 it's needed to avoid running out of memory. The amount of memory used
4449 per word depends very much on how similar the words are, that's why
4450 this tuning is complicated.
4451
4452 There are three numbers, separated by commas:
4453 {start},{inc},{added}
4454
4455 For most languages the uncompressed word tree fits in memory. {start}
4456 gives the amount of memory in Kbyte that can be used before any
4457 compression is done. It should be a bit smaller than the amount of
4458 memory that is available to Vim.
4459
4460 When going over the {start} limit the {inc} number specifies the
4461 amount of memory in Kbyte that can be allocated before another
4462 compression is done. A low number means compression is done after
4463 less words are added, which is slow. A high number means more memory
4464 will be allocated.
4465
4466 After doing compression, {added} times 1024 words can be added before
4467 the {inc} limit is ignored and compression is done when any extra
4468 amount of memory is needed. A low number means there is a smaller
4469 chance of hitting the {inc} limit, less memory is used but it's
4470 slower.
4471
4472 The languages for which these numbers are important are Italian and
4473 Hungarian. The default works for when you have about 512 Mbyte. If
4474 you have 1 Gbyte you could use: >
4475 :set mkspellmem=900000,3000,800
4476< If you have less than 512 Mbyte |:mkspell| may fail for some
4477 languages, no matter what you set 'mkspellmem' to.
4478
Bram Moolenaar071d4272004-06-13 20:20:40 +00004479 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4480'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4481 local to buffer
4482 *'modelines'* *'mls'*
4483'modelines' 'mls' number (default 5)
4484 global
4485 {not in Vi}
4486 If 'modeline' is on 'modelines' gives the number of lines that is
4487 checked for set commands. If 'modeline' is off or 'modelines' is zero
4488 no lines are checked. See |modeline|.
4489 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4490 set and to the Vim default value when 'compatible' is reset.
4491
4492 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4493'modifiable' 'ma' boolean (default on)
4494 local to buffer
4495 {not in Vi} *E21*
4496 When off the buffer contents cannot be changed. The 'fileformat' and
4497 'fileencoding' options also can't be changed.
4498 Can be reset with the |-M| command line argument.
4499
4500 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4501'modified' 'mod' boolean (default off)
4502 local to buffer
4503 {not in Vi}
4504 When on, the buffer is considered to be modified. This option is set
4505 when:
4506 1. A change was made to the text since it was last written. Using the
4507 |undo| command to go back to the original text will reset the
4508 option. But undoing changes that were made before writing the
4509 buffer will set the option again, since the text is different from
4510 when it was written.
4511 2. 'fileformat' or 'fileencoding' is different from its original
4512 value. The original value is set when the buffer is read or
4513 written. A ":set nomodified" command also resets the original
4514 values to the current values and the 'modified' option will be
4515 reset.
4516 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4517 will be ignored.
4518
4519 *'more'* *'nomore'*
4520'more' boolean (Vim default: on, Vi default: off)
4521 global
4522 {not in Vi}
4523 When on, listings pause when the whole screen is filled. You will get
4524 the |more-prompt|. When this option is off there are no pauses, the
4525 listing continues until finished.
4526 NOTE: This option is set to the Vi default value when 'compatible' is
4527 set and to the Vim default value when 'compatible' is reset.
4528
4529 *'mouse'* *E538*
4530'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4531 global
4532 {not in Vi}
4533 Enable the use of the mouse. Only works for certain terminals
4534 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4535 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4536 The mouse can be enabled for different modes:
4537 n Normal mode
4538 v Visual mode
4539 i Insert mode
4540 c Command-line mode
4541 h all previous modes when editing a help file
4542 a all previous modes
4543 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004544 Normally you would enable the mouse in all four modes with: >
4545 :set mouse=a
4546< When the mouse is not enabled, the GUI will still use the mouse for
4547 modeless selection. This doesn't move the text cursor.
4548
4549 See |mouse-using|. Also see |'clipboard'|.
4550
4551 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004552 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004553 the mouse buttons can still be used by keeping the shift key pressed.
4554 Also see the 'clipboard' option.
4555
4556 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4557'mousefocus' 'mousef' boolean (default off)
4558 global
4559 {not in Vi}
4560 {only works in the GUI}
4561 The window that the mouse pointer is on is automatically activated.
4562 When changing the window layout or window focus in another way, the
4563 mouse pointer is moved to the window with keyboard focus. Off is the
4564 default because it makes using the pull down menus a little goofy, as
4565 a pointer transit may activate a window unintentionally.
4566
4567 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4568'mousehide' 'mh' boolean (default on)
4569 global
4570 {not in Vi}
4571 {only works in the GUI}
4572 When on, the mouse pointer is hidden when characters are typed.
4573 The mouse pointer is restored when the mouse is moved.
4574
4575 *'mousemodel'* *'mousem'*
4576'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4577 global
4578 {not in Vi}
4579 Sets the model to use for the mouse. The name mostly specifies what
4580 the right mouse button is used for:
4581 extend Right mouse button extends a selection. This works
4582 like in an xterm.
4583 popup Right mouse button pops up a menu. The shifted left
4584 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004585 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004586 popup_setpos Like "popup", but the cursor will be moved to the
4587 position where the mouse was clicked, and thus the
4588 selected operation will act upon the clicked object.
4589 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004590 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004591 course, that right clicking outside a selection will
4592 end Visual mode.
4593 Overview of what button does what for each model:
4594 mouse extend popup(_setpos) ~
4595 left click place cursor place cursor
4596 left drag start selection start selection
4597 shift-left search word extend selection
4598 right click extend selection popup menu (place cursor)
4599 right drag extend selection -
4600 middle click paste paste
4601
4602 In the "popup" model the right mouse button produces a pop-up menu.
4603 You need to define this first, see |popup-menu|.
4604
4605 Note that you can further refine the meaning of buttons with mappings.
4606 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4607 selection (because that's handled in the GUI code directly).
4608
4609 The 'mousemodel' option is set by the |:behave| command.
4610
4611 *'mouseshape'* *'mouses'* *E547*
4612'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004613 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004614 global
4615 {not in Vi}
4616 {only available when compiled with the |+mouseshape|
4617 feature}
4618 This option tells Vim what the mouse pointer should look like in
4619 different modes. The option is a comma separated list of parts, much
4620 like used for 'guicursor'. Each part consist of a mode/location-list
4621 and an argument-list:
4622 mode-list:shape,mode-list:shape,..
4623 The mode-list is a dash separated list of these modes/locations:
4624 In a normal window: ~
4625 n Normal mode
4626 v Visual mode
4627 ve Visual mode with 'selection' "exclusive" (same as 'v',
4628 if not specified)
4629 o Operator-pending mode
4630 i Insert mode
4631 r Replace mode
4632
4633 Others: ~
4634 c appending to the command-line
4635 ci inserting in the command-line
4636 cr replacing in the command-line
4637 m at the 'Hit ENTER' or 'More' prompts
4638 ml idem, but cursor in the last line
4639 e any mode, pointer below last window
4640 s any mode, pointer on a status line
4641 sd any mode, while dragging a status line
4642 vs any mode, pointer on a vertical separator line
4643 vd any mode, while dragging a vertical separator line
4644 a everywhere
4645
4646 The shape is one of the following:
4647 avail name looks like ~
4648 w x arrow Normal mouse pointer
4649 w x blank no pointer at all (use with care!)
4650 w x beam I-beam
4651 w x updown up-down sizing arrows
4652 w x leftright left-right sizing arrows
4653 w x busy The system's usual busy pointer
4654 w x no The system's usual 'no input' pointer
4655 x udsizing indicates up-down resizing
4656 x lrsizing indicates left-right resizing
4657 x crosshair like a big thin +
4658 x hand1 black hand
4659 x hand2 white hand
4660 x pencil what you write with
4661 x question big ?
4662 x rightup-arrow arrow pointing right-up
4663 w x up-arrow arrow pointing up
4664 x <number> any X11 pointer number (see X11/cursorfont.h)
4665
4666 The "avail" column contains a 'w' if the shape is available for Win32,
4667 x for X11.
4668 Any modes not specified or shapes not available use the normal mouse
4669 pointer.
4670
4671 Example: >
4672 :set mouseshape=s:udsizing,m:no
4673< will make the mouse turn to a sizing arrow over the status lines and
4674 indicate no input when the hit-enter prompt is displayed (since
4675 clicking the mouse has no effect in this state.)
4676
4677 *'mousetime'* *'mouset'*
4678'mousetime' 'mouset' number (default 500)
4679 global
4680 {not in Vi}
4681 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4682 time in msec between two mouse clicks for the second click to be
4683 recognized as a multi click.
4684
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004685 *'mzquantum'* *'mzq'*
4686'mzquantum' 'mzq' number (default 100)
4687 global
4688 {not in Vi}
4689 {not available when compiled without the |+mzscheme|
4690 feature}
4691 The number of milliseconds between polls for MzScheme threads.
4692 Negative or zero value means no thread scheduling.
4693
Bram Moolenaar071d4272004-06-13 20:20:40 +00004694 *'nrformats'* *'nf'*
4695'nrformats' 'nf' string (default "octal,hex")
4696 local to buffer
4697 {not in Vi}
4698 This defines what bases Vim will consider for numbers when using the
4699 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4700 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004701 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004702 incremented or decremented. This is useful for a list with a
4703 letter index a), b), etc.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004704 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004705 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004706 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004707 considered to be hexadecimal. Example: Using CTRL-X on
4708 "0x100" results in "0x0ff".
4709 Numbers which simply begin with a digit in the range 1-9 are always
4710 considered decimal. This also happens for numbers that are not
4711 recognized as octal or hex.
4712
4713 *'number'* *'nu'* *'nonumber'* *'nonu'*
4714'number' 'nu' boolean (default off)
4715 local to window
4716 Print the line number in front of each line. When the 'n' option is
4717 excluded from 'cpoptions' a wrapped line will not use the column of
4718 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004719 The 'numberwidth' option can be used to set the room used for the line
4720 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004721 When a long, wrapped line doesn't start with the first character, '-'
4722 characters are put before the number.
4723 See |hl-LineNr| for the highlighting used for the number.
4724
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004725 *'numberwidth'* *'nuw'*
4726'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4727 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004728 {not in Vi}
4729 {only available when compiled with the |+linebreak|
4730 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004731 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00004732 when the 'number' option is set or printing lines with a line number.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004733 Since one space is always between the number and the text, there is
4734 one less character for the number itself.
4735 The value is the minimum width. A bigger width is used when needed to
4736 fit the highest line number in the buffer. Thus with the Vim default
4737 of 4 there is room for a line number up to 999. When the buffer has
4738 1000 lines five columns will be used.
4739 The minimum value is 1, the maximum value is 10.
4740 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4741
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004742 *'omnifunc'* *'ofu'*
4743'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00004744 local to buffer
4745 {not in Vi}
4746 {not available when compiled without the +eval
4747 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00004748 This option specifies a function to be used for Insert mode omni
4749 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00004750 See |complete-functions| for an explanation of how the function is
4751 invoked and what it should return.
Bram Moolenaare344bea2005-09-01 20:46:49 +00004752
4753
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00004754 *'operatorfunc'* *'opfunc'*
4755'operatorfunc' 'opfunc' string (default: empty)
4756 global
4757 {not in Vi}
4758 This option specifies a function to be called by the |g@| operator.
4759 See |:map-operator| for more info and an example.
4760
4761 This option cannot be set from a |modeline| or in the |sandbox|, for
4762 security reasons.
4763
4764
Bram Moolenaar071d4272004-06-13 20:20:40 +00004765 *'osfiletype'* *'oft'* *E366*
4766'osfiletype' 'oft' string (RISC-OS default: "Text",
4767 others default: "")
4768 local to buffer
4769 {not in Vi}
4770 {only available when compiled with the |+osfiletype|
4771 feature}
4772 Some operating systems store extra information about files besides
4773 name, datestamp and permissions. This option contains the extra
4774 information, the nature of which will vary between systems.
4775 The value of this option is usually set when the file is loaded, and
4776 use to set the file type when file is written.
4777 It can affect the pattern matching of the automatic commands.
4778 |autocmd-osfiletypes|
4779
4780 *'paragraphs'* *'para'*
4781'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4782 global
4783 Specifies the nroff macros that separate paragraphs. These are pairs
4784 of two letters (see |object-motions|).
4785
4786 *'paste'* *'nopaste'*
4787'paste' boolean (default off)
4788 global
4789 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004790 Put Vim in Paste mode. This is useful if you want to cut or copy
4791 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004792 unexpected effects.
4793 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004794 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004795 knows about pasting and will mostly do the right thing without 'paste'
4796 being set. The same is true for a terminal where Vim handles the
4797 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004798 This option is reset when starting the GUI. Thus if you set it in
4799 your .vimrc it will work in a terminal, but not in the GUI. Setting
4800 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4801 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004802 When the 'paste' option is switched on (also when it was already on):
4803 - mapping in Insert mode and Command-line mode is disabled
4804 - abbreviations are disabled
4805 - 'textwidth' is set to 0
4806 - 'wrapmargin' is set to 0
4807 - 'autoindent' is reset
4808 - 'smartindent' is reset
4809 - 'softtabstop' is set to 0
4810 - 'revins' is reset
4811 - 'ruler' is reset
4812 - 'showmatch' is reset
4813 - 'formatoptions' is used like it is empty
4814 These options keep their value, but their effect is disabled:
4815 - 'lisp'
4816 - 'indentexpr'
4817 - 'cindent'
4818 NOTE: When you start editing another file while the 'paste' option is
4819 on, settings from the modelines or autocommands may change the
4820 settings again, causing trouble when pasting text. You might want to
4821 set the 'paste' option again.
4822 When the 'paste' option is reset the mentioned options are restored to
4823 the value before the moment 'paste' was switched from off to on.
4824 Resetting 'paste' before ever setting it does not have any effect.
4825 Since mapping doesn't work while 'paste' is active, you need to use
4826 the 'pastetoggle' option to toggle the 'paste' option with some key.
4827
4828 *'pastetoggle'* *'pt'*
4829'pastetoggle' 'pt' string (default "")
4830 global
4831 {not in Vi}
4832 When non-empty, specifies the key sequence that toggles the 'paste'
4833 option. This is like specifying a mapping: >
4834 :map {keys} :set invpaste<CR>
4835< Where {keys} is the value of 'pastetoggle'.
4836 The difference is that it will work even when 'paste' is set.
4837 'pastetoggle' works in Insert mode and Normal mode, but not in
4838 Command-line mode.
4839 Mappings are checked first, thus overrule 'pastetoggle'. However,
4840 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4841 this: >
4842 :map <F10> :set paste<CR>
4843 :map <F11> :set nopaste<CR>
4844 :imap <F10> <C-O>:set paste<CR>
4845 :imap <F11> <nop>
4846 :set pastetoggle=<F11>
4847< This will make <F10> start paste mode and <F11> stop paste mode.
4848 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4849 mode everything is inserted literally, except the 'pastetoggle' key
4850 sequence.
4851
4852 *'pex'* *'patchexpr'*
4853'patchexpr' 'pex' string (default "")
4854 global
4855 {not in Vi}
4856 {not available when compiled without the |+diff|
4857 feature}
4858 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004859 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004860
4861 *'patchmode'* *'pm'* *E206*
4862'patchmode' 'pm' string (default "")
4863 global
4864 {not in Vi}
4865 When non-empty the oldest version of a file is kept. This can be used
4866 to keep the original version of a file if you are changing files in a
4867 source distribution. Only the first time that a file is written a
4868 copy of the original file will be kept. The name of the copy is the
4869 name of the original file with the string in the 'patchmode' option
4870 appended. This option should start with a dot. Use a string like
4871 ".org". 'backupdir' must not be empty for this to work (Detail: The
4872 backup file is renamed to the patchmode file after the new file has
4873 been successfully written, that's why it must be possible to write a
4874 backup file). If there was no file to be backed up, an empty file is
4875 created.
4876 When the 'backupskip' pattern matches, a patchmode file is not made.
4877 Using 'patchmode' for compressed files appends the extension at the
4878 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4879 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004880 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881
4882 *'path'* *'pa'* *E343* *E345* *E347*
4883'path' 'pa' string (default on Unix: ".,/usr/include,,"
4884 on OS/2: ".,/emx/include,,"
4885 other systems: ".,,")
4886 global or local to buffer |global-local|
4887 {not in Vi}
4888 This is a list of directories which will be searched when using the
4889 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4890 being searched for has a relative path (not starting with '/'). The
4891 directories in the 'path' option may be relative or absolute.
4892 - Use commas to separate directory names: >
4893 :set path=.,/usr/local/include,/usr/include
4894< - Spaces can also be used to separate directory names (for backwards
4895 compatibility with version 3.0). To have a space in a directory
4896 name, precede it with an extra backslash, and escape the space: >
4897 :set path=.,/dir/with\\\ space
4898< - To include a comma in a directory name precede it with an extra
4899 backslash: >
4900 :set path=.,/dir/with\\,comma
4901< - To search relative to the directory of the current file, use: >
4902 :set path=.
4903< - To search in the current directory use an empty string between two
4904 commas: >
4905 :set path=,,
4906< - A directory name may end in a ':' or '/'.
4907 - Environment variables are expanded |:set_env|.
4908 - When using |netrw.vim| URLs can be used. For example, adding
4909 "http://www.vim.org" will make ":find index.html" work.
4910 - Search upwards and downwards in a directory tree:
4911 1) "*" matches a sequence of characters, e.g.: >
4912 :set path=/usr/include/*
4913< means all subdirectories in /usr/include (but not /usr/include
4914 itself). >
4915 :set path=/usr/*c
4916< matches /usr/doc and /usr/src.
4917 2) "**" matches a subtree, up to 100 directories deep. Example: >
4918 :set path=/home/user_x/src/**
4919< means search in the whole subtree under "/home/usr_x/src".
4920 3) If the path ends with a ';', this path is the startpoint
4921 for upward search.
4922 See |file-searching| for more info and exact syntax.
4923 {not available when compiled without the |+path_extra| feature}
4924 - Careful with '\' characters, type two to get one in the option: >
4925 :set path=.,c:\\include
4926< Or just use '/' instead: >
4927 :set path=.,c:/include
4928< Don't forget "." or files won't even be found in the same directory as
4929 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004930 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004931 it is something like 256 or 1024 characters.
4932 You can check if all the include files are found, using the value of
4933 'path', see |:checkpath|.
4934 The use of |:set+=| and |:set-=| is preferred when adding or removing
4935 directories from the list. This avoids problems when a future version
4936 uses another default. To remove the current directory use: >
4937 :set path-=
4938< To add the current directory use: >
4939 :set path+=
4940< To use an environment variable, you probably need to replace the
4941 separator. Here is an example to append $INCL, in which directory
4942 names are separated with a semi-colon: >
4943 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4944< Replace the ';' with a ':' or whatever separator is used. Note that
4945 this doesn't work when $INCL contains a comma or white space.
4946
4947 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4948'preserveindent' 'pi' boolean (default off)
4949 local to buffer
4950 {not in Vi}
4951 When changing the indent of the current line, preserve as much of the
4952 indent structure as possible. Normally the indent is replaced by a
4953 series of tabs followed by spaces as required (unless |'expandtab'| is
4954 enabled, in which case only spaces are used). Enabling this option
4955 means the indent will preserve as many existing characters as possible
4956 for indenting, and only add additional tabs or spaces as required.
4957 NOTE: When using ">>" multiple times the resulting indent is a mix of
4958 tabs and spaces. You might not like this.
4959 NOTE: 'preserveindent' is reset when 'compatible' is set.
4960 Also see 'copyindent'.
4961 Use |:retab| to clean up white space.
4962
4963 *'previewheight'* *'pvh'*
4964'previewheight' 'pvh' number (default 12)
4965 global
4966 {not in Vi}
4967 {not available when compiled without the |+windows| or
4968 |+quickfix| feature}
4969 Default height for a preview window. Used for |:ptag| and associated
4970 commands. Used for |CTRL-W_}| when no count is given.
4971
4972 *'previewwindow'* *'nopreviewwindow'*
4973 *'pvw'* *'nopvw'* *E590*
4974'previewwindow' 'pvw' boolean (default off)
4975 local to window
4976 {not in Vi}
4977 {not available when compiled without the |+windows| or
4978 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004979 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004980 set. It's normally not set directly, but by using one of the commands
4981 |:ptag|, |:pedit|, etc.
4982
4983 *'printdevice'* *'pdev'*
4984'printdevice' 'pdev' string (default empty)
4985 global
4986 {not in Vi}
4987 {only available when compiled with the |+printer|
4988 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004989 The name of the printer to be used for |:hardcopy|.
4990 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004991 This option cannot be set from a |modeline| or in the |sandbox|, for
4992 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004993
Bram Moolenaar8299df92004-07-10 09:47:34 +00004994 *'printencoding'* *'penc'*
4995'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004996 global
4997 {not in Vi}
4998 {only available when compiled with the |+printer|
4999 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005000 Sets the character encoding used when printing.
5001 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005002
5003 *'printexpr'* *'pexpr'*
5004'printexpr' 'pexpr' String (default: see below)
5005 global
5006 {not in Vi}
5007 {only available when compiled with the |+printer|
5008 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005009 Expression used to print the PostScript produced with |:hardcopy|.
5010 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005011
Bram Moolenaar8299df92004-07-10 09:47:34 +00005012 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005013'printfont' 'pfn' string (default "courier")
5014 global
5015 {not in Vi}
5016 {only available when compiled with the |+printer|
5017 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005018 The name of the font that will be used for |:hardcopy|.
5019 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005020
5021 *'printheader'* *'pheader'*
5022'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5023 global
5024 {not in Vi}
5025 {only available when compiled with the |+printer|
5026 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005027 The format of the header produced in |:hardcopy| output.
5028 See |pheader-option|.
5029
5030 *'printmbcharset'* *'pmbcs'*
5031'printmbcharset' 'pmbcs' string (default "")
5032 global
5033 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005034 {only available when compiled with the |+printer|,
5035 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005036 The CJK character set to be used for CJK output from |:hardcopy|.
5037 See |pmbcs-option|.
5038
5039 *'printmbfont'* *'pmbfn'*
5040'printmbfont' 'pmbfn' string (default "")
5041 global
5042 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005043 {only available when compiled with the |+printer|,
5044 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005045 List of font names to be used for CJK output from |:hardcopy|.
5046 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005047
5048 *'printoptions'* *'popt'*
5049'printoptions' 'popt' string (default "")
5050 global
5051 {not in Vi}
5052 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005053 List of items that control the format of the output of |:hardcopy|.
5054 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005055
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005056 *'prompt'* *'noprompt'*
5057'prompt' boolean (default on)
5058 global
5059 When on a ":" prompt is used in Ex mode.
5060
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005061 *'pumheight'* *'ph'*
5062'pumheight' 'ph' number (default 0)
5063 global
5064 {not available when compiled without the
5065 |+insert_expand| feature}
5066 {not in Vi}
5067 Determines the maximum number of items to show in the popup menu.
5068 When zero as much space as available is used.
5069 |ins-completion-menu|.
5070
5071
Bram Moolenaar677ee682005-01-27 14:41:15 +00005072 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005073'quoteescape' 'qe' string (default "\")
5074 local to buffer
5075 {not in Vi}
5076 The characters that are used to escape quotes in a string. Used for
5077 objects like a', a" and a` |a'|.
5078 When one of the characters in this option is found inside a string,
5079 the following character will be skipped. The default value makes the
5080 text "foo\"bar\\" considered to be one string.
5081
Bram Moolenaar071d4272004-06-13 20:20:40 +00005082 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5083'readonly' 'ro' boolean (default off)
5084 local to buffer
5085 If on, writes fail unless you use a '!'. Protects you from
5086 accidentally overwriting a file. Default on when Vim is started
5087 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005088 When using ":w!" the 'readonly' option is reset for the current
5089 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005090 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005091 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005092
5093 *'remap'* *'noremap'*
5094'remap' boolean (default on)
5095 global
5096 Allows for mappings to work recursively. If you do not want this for
5097 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005098 NOTE: To avoid portability problems with Vim scripts, always keep
5099 this option at the default "on". Only switch it off when working with
5100 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005101
5102 *'report'*
5103'report' number (default 2)
5104 global
5105 Threshold for reporting number of lines changed. When the number of
5106 changed lines is more than 'report' a message will be given for most
5107 ":" commands. If you want it always, set 'report' to 0.
5108 For the ":substitute" command the number of substitutions is used
5109 instead of the number of lines.
5110
5111 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5112'restorescreen' 'rs' boolean (default on)
5113 global
5114 {not in Vi} {only in Windows 95/NT console version}
5115 When set, the screen contents is restored when exiting Vim. This also
5116 happens when executing external commands.
5117
5118 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5119 options in your .vimrc. To disable restoring:
5120 set t_ti= t_te=
5121 To enable restoring (for an xterm):
5122 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5123 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5124
5125 *'revins'* *'ri'* *'norevins'* *'nori'*
5126'revins' 'ri' boolean (default off)
5127 global
5128 {not in Vi}
5129 {only available when compiled with the |+rightleft|
5130 feature}
5131 Inserting characters in Insert mode will work backwards. See "typing
5132 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5133 command in Insert mode, when 'allowrevins' is set.
5134 NOTE: This option is reset when 'compatible' or 'paste' is set.
5135
5136 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5137'rightleft' 'rl' boolean (default off)
5138 local to window
5139 {not in Vi}
5140 {only available when compiled with the |+rightleft|
5141 feature}
5142 When on, display orientation becomes right-to-left, i.e., characters
5143 that are stored in the file appear from the right to the left.
5144 Using this option, it is possible to edit files for languages that
5145 are written from the right to the left such as Hebrew and Arabic.
5146 This option is per window, so it is possible to edit mixed files
5147 simultaneously, or to view the same file in both ways (this is
5148 useful whenever you have a mixed text file with both right-to-left
5149 and left-to-right strings so that both sets are displayed properly
5150 in different windows). Also see |rileft.txt|.
5151
5152 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
5153'rightleftcmd' 'rlc' string (default "search")
5154 local to window
5155 {not in Vi}
5156 {only available when compiled with the |+rightleft|
5157 feature}
5158 Each word in this option enables the command line editing to work in
5159 right-to-left mode for a group of commands:
5160
5161 search "/" and "?" commands
5162
5163 This is useful for languages such as Hebrew, Arabic and Farsi.
5164 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5165
5166 *'ruler'* *'ru'* *'noruler'* *'noru'*
5167'ruler' 'ru' boolean (default off)
5168 global
5169 {not in Vi}
5170 {not available when compiled without the
5171 |+cmdline_info| feature}
5172 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005173 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005174 text in the file is shown on the far right:
5175 Top first line is visible
5176 Bot last line is visible
5177 All first and last line are visible
5178 45% relative position in the file
5179 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005180 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005181 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005182 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005183 this option takes precedence over 'ruler' and 'rulerformat'
5184 If the number of characters displayed is different from the number of
5185 bytes in the text (e.g., for a TAB or a multi-byte character), both
5186 the text column (byte number) and the screen column are shown,
5187 separated with a dash.
5188 For an empty line "0-1" is shown.
5189 For an empty buffer the line number will also be zero: "0,0-1".
5190 This option is reset when the 'paste' option is set.
5191 If you don't want to see the ruler all the time but want to know where
5192 you are, use "g CTRL-G" |g_CTRL-G|.
5193 NOTE: This option is reset when 'compatible' is set.
5194
5195 *'rulerformat'* *'ruf'*
5196'rulerformat' 'ruf' string (default empty)
5197 global
5198 {not in Vi}
5199 {not available when compiled without the |+statusline|
5200 feature}
5201 When this option is not empty, it determines the content of the ruler
5202 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005203 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005204 The default ruler width is 17 characters. To make the ruler 15
5205 characters wide, put "%15(" at the start and "%)" at the end.
5206 Example: >
5207 :set rulerformat=%15(%c%V\ %p%%%)
5208<
5209 *'runtimepath'* *'rtp'* *vimfiles*
5210'runtimepath' 'rtp' string (default:
5211 Unix: "$HOME/.vim,
5212 $VIM/vimfiles,
5213 $VIMRUNTIME,
5214 $VIM/vimfiles/after,
5215 $HOME/.vim/after"
5216 Amiga: "home:vimfiles,
5217 $VIM/vimfiles,
5218 $VIMRUNTIME,
5219 $VIM/vimfiles/after,
5220 home:vimfiles/after"
5221 PC, OS/2: "$HOME/vimfiles,
5222 $VIM/vimfiles,
5223 $VIMRUNTIME,
5224 $VIM/vimfiles/after,
5225 $HOME/vimfiles/after"
5226 Macintosh: "$VIM:vimfiles,
5227 $VIMRUNTIME,
5228 $VIM:vimfiles:after"
5229 RISC-OS: "Choices:vimfiles,
5230 $VIMRUNTIME,
5231 Choices:vimfiles/after"
5232 VMS: "sys$login:vimfiles,
5233 $VIM/vimfiles,
5234 $VIMRUNTIME,
5235 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005236 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005237 global
5238 {not in Vi}
5239 This is a list of directories which will be searched for runtime
5240 files:
5241 filetype.vim filetypes by file name |new-filetype|
5242 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005243 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005244 colors/ color scheme files |:colorscheme|
5245 compiler/ compiler files |:compiler|
5246 doc/ documentation |write-local-help|
5247 ftplugin/ filetype plugins |write-filetype-plugin|
5248 indent/ indent scripts |indent-expression|
5249 keymap/ key mapping files |mbyte-keymap|
5250 lang/ menu translations |:menutrans|
5251 menu.vim GUI menus |menu.vim|
5252 plugin/ plugin scripts |write-plugin|
5253 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005254 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005255 syntax/ syntax files |mysyntaxfile|
5256 tutor/ files for vimtutor |tutor|
5257
5258 And any other file searched for with the |:runtime| command.
5259
5260 The defaults for most systems are setup to search five locations:
5261 1. In your home directory, for your personal preferences.
5262 2. In a system-wide Vim directory, for preferences from the system
5263 administrator.
5264 3. In $VIMRUNTIME, for files distributed with Vim.
5265 *after-directory*
5266 4. In the "after" directory in the system-wide Vim directory. This is
5267 for the system administrator to overrule or add to the distributed
5268 defaults (rarely needed)
5269 5. In the "after" directory in your home directory. This is for
5270 personal preferences to overrule or add to the distributed defaults
5271 or system-wide settings (rarely needed).
5272
5273 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5274 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005275 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005276 wildcards.
5277 See |:runtime|.
5278 Example: >
5279 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5280< This will use the directory "~/vimruntime" first (containing your
5281 personal Vim runtime files), then "/mygroup/vim" (shared between a
5282 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5283 files).
5284 You probably should always include $VIMRUNTIME somewhere, to use the
5285 distributed runtime files. You can put a directory before $VIMRUNTIME
5286 to find files which replace a distributed runtime files. You can put
5287 a directory after $VIMRUNTIME to find files which add to distributed
5288 runtime files.
5289 This option cannot be set from a |modeline| or in the |sandbox|, for
5290 security reasons.
5291
5292 *'scroll'* *'scr'*
5293'scroll' 'scr' number (default: half the window height)
5294 local to window
5295 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5296 set to half the number of lines in the window when the window size
5297 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005298 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005299 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5300 the number of screen lines instead of file lines, makes a difference
5301 when lines wrap}
5302
5303 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5304'scrollbind' 'scb' boolean (default off)
5305 local to window
5306 {not in Vi}
5307 {not available when compiled without the |+scrollbind|
5308 feature}
5309 See also |scroll-binding|. When this option is set, the current
5310 window scrolls as other scrollbind windows (windows that also have
5311 this option set) scroll. This option is useful for viewing the
5312 differences between two versions of a file, see 'diff'.
5313 See |'scrollopt'| for options that determine how this option should be
5314 interpreted.
5315 This option is mostly reset when splitting a window to edit another
5316 file. This means that ":split | edit file" results in two windows
5317 with scroll-binding, but ":split file" does not.
5318
5319 *'scrolljump'* *'sj'*
5320'scrolljump' 'sj' number (default 1)
5321 global
5322 {not in Vi}
5323 Minimal number of lines to scroll when the cursor gets off the
5324 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5325 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005326 When set to a negative number from -1 to -100 this is used as the
5327 percentage of the window height. Thus -50 scrolls half the window
5328 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005329 NOTE: This option is set to 1 when 'compatible' is set.
5330
5331 *'scrolloff'* *'so'*
5332'scrolloff' 'so' number (default 0)
5333 global
5334 {not in Vi}
5335 Minimal number of screen lines to keep above and below the cursor.
5336 This will make some context visible around where you are working. If
5337 you set it to a very large value (999) the cursor line will always be
5338 in the middle of the window (except at the start or end of the file or
5339 when long lines wrap).
5340 For scrolling horizontally see 'sidescrolloff'.
5341 NOTE: This option is set to 0 when 'compatible' is set.
5342
5343 *'scrollopt'* *'sbo'*
5344'scrollopt' 'sbo' string (default "ver,jump")
5345 global
5346 {not available when compiled without the |+scrollbind|
5347 feature}
5348 {not in Vi}
5349 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005350 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5351 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005352 The following words are available:
5353 ver Bind vertical scrolling for 'scrollbind' windows
5354 hor Bind horizontal scrolling for 'scrollbind' windows
5355 jump Applies to the offset between two windows for vertical
5356 scrolling. This offset is the difference in the first
5357 displayed line of the bound windows. When moving
5358 around in a window, another 'scrollbind' window may
5359 reach a position before the start or after the end of
5360 the buffer. The offset is not changed though, when
5361 moving back the 'scrollbind' window will try to scroll
5362 to the desired position when possible.
5363 When now making that window the current one, two
5364 things can be done with the relative offset:
5365 1. When "jump" is not included, the relative offset is
5366 adjusted for the scroll position in the new current
5367 window. When going back to the other window, the
5368 the new relative offset will be used.
5369 2. When "jump" is included, the other windows are
5370 scrolled to keep the same relative offset. When
5371 going back to the other window, it still uses the
5372 same relative offset.
5373 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005374 When 'diff' mode is active there always is vertical scroll binding,
5375 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005376
5377 *'sections'* *'sect'*
5378'sections' 'sect' string (default "SHNHH HUnhsh")
5379 global
5380 Specifies the nroff macros that separate sections. These are pairs of
5381 two letters (See |object-motions|). The default makes a section start
5382 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5383
5384 *'secure'* *'nosecure'* *E523*
5385'secure' boolean (default off)
5386 global
5387 {not in Vi}
5388 When on, ":autocmd", shell and write commands are not allowed in
5389 ".vimrc" and ".exrc" in the current directory and map commands are
5390 displayed. Switch it off only if you know that you will not run into
5391 problems, or when the 'exrc' option is off. On Unix this option is
5392 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005393 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005394 'secure' at the end of your ~/.vimrc then.
5395 This option cannot be set from a |modeline| or in the |sandbox|, for
5396 security reasons.
5397
5398 *'selection'* *'sel'*
5399'selection' 'sel' string (default "inclusive")
5400 global
5401 {not in Vi}
5402 This option defines the behavior of the selection. It is only used
5403 in Visual and Select mode.
5404 Possible values:
5405 value past line inclusive ~
5406 old no yes
5407 inclusive yes yes
5408 exclusive yes no
5409 "past line" means that the cursor is allowed to be positioned one
5410 character past the line.
5411 "inclusive" means that the last character of the selection is included
5412 in an operation. For example, when "x" is used to delete the
5413 selection.
5414 Note that when "exclusive" is used and selecting from the end
5415 backwards, you cannot include the last character of a line, when
5416 starting in Normal mode and 'virtualedit' empty.
5417
5418 The 'selection' option is set by the |:behave| command.
5419
5420 *'selectmode'* *'slm'*
5421'selectmode' 'slm' string (default "")
5422 global
5423 {not in Vi}
5424 This is a comma separated list of words, which specifies when to start
5425 Select mode instead of Visual mode, when a selection is started.
5426 Possible values:
5427 mouse when using the mouse
5428 key when using shifted special keys
5429 cmd when using "v", "V" or CTRL-V
5430 See |Select-mode|.
5431 The 'selectmode' option is set by the |:behave| command.
5432
5433 *'sessionoptions'* *'ssop'*
5434'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
5435 help,options,winsize")
5436 global
5437 {not in Vi}
5438 {not available when compiled without the +mksession
5439 feature}
5440 Changes the effect of the |:mksession| command. It is a comma
5441 separated list of words. Each word enables saving and restoring
5442 something:
5443 word save and restore ~
5444 blank empty windows
5445 buffers hidden and unloaded buffers, not just those in windows
5446 curdir the current directory
5447 folds manually created folds, opened/closed folds and local
5448 fold options
5449 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005450 and contain at least one lowercase letter. Only
5451 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005452 help the help window
5453 localoptions options and mappings local to a window or buffer (not
5454 global values for local options)
5455 options all options and mappings (also global values for local
5456 options)
5457 resize size of the Vim window: 'lines' and 'columns'
5458 sesdir the directory in which the session file is located
5459 will become the current directory (useful with
5460 projects accessed over a network from different
5461 systems)
5462 slash backslashes in file names replaced with forward
5463 slashes
5464 unix with Unix end-of-line format (single <NL>), even when
5465 on Windows or DOS
5466 winpos position of the whole Vim window
5467 winsize window sizes
5468
5469 Don't include both "curdir" and "sesdir".
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00005470 There is no option to include tab pages yet, only the current tab page
5471 is stored in the session. |tab-page|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005472 When "curdir" nor "sesdir" is included, file names are stored with
5473 absolute paths.
5474 "slash" and "unix" are useful on Windows when sharing session files
5475 with Unix. The Unix version of Vim cannot source dos format scripts,
5476 but the Windows version of Vim can source unix format scripts.
5477
5478 *'shell'* *'sh'* *E91*
5479'shell' 'sh' string (default $SHELL or "sh",
5480 MS-DOS and Win32: "command.com" or
5481 "cmd.exe", OS/2: "cmd")
5482 global
5483 Name of the shell to use for ! and :! commands. When changing the
5484 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5485 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005486 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005487 See |option-backslash| about including spaces and backslashes.
5488 Environment variables are expanded |:set_env|.
5489 If the name of the shell contains a space, you might need to enclose
5490 it in quotes. Example: >
5491 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5492< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005493 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005494 "-f" is not inside the quotes, because it is not part of the command
5495 name. And Vim automagically recognizes the backslashes that are path
5496 separators.
5497 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5498 variable to change the way external commands are executed. See the
5499 libc.inf file of DJGPP.
5500 Under MS-Windows, when the executable ends in ".com" it must be
5501 included. Thus setting the shell to "command.com" or "4dos.com"
5502 works, but "command" and "4dos" do not work for all commands (e.g.,
5503 filtering).
5504 For unknown reasons, when using "4dos.com" the current directory is
5505 changed to "C:\". To avoid this set 'shell' like this: >
5506 :set shell=command.com\ /c\ 4dos
5507< This option cannot be set from a |modeline| or in the |sandbox|, for
5508 security reasons.
5509
5510 *'shellcmdflag'* *'shcf'*
5511'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5512 does not contain "sh" somewhere: "/c")
5513 global
5514 {not in Vi}
5515 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5516 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5517 systems, the default is set according to the value of 'shell', to
5518 reduce the need to set this option by the user. It's not used for
5519 OS/2 (EMX figures this out itself). See |option-backslash| about
5520 including spaces and backslashes. See |dos-shell|.
5521 This option cannot be set from a |modeline| or in the |sandbox|, for
5522 security reasons.
5523
5524 *'shellpipe'* *'sp'*
5525'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5526 global
5527 {not in Vi}
5528 {not available when compiled without the |+quickfix|
5529 feature}
5530 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005531 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005532 including spaces and backslashes.
5533 The name of the temporary file can be represented by "%s" if necessary
5534 (the file name is appended automatically if no %s appears in the value
5535 of this option).
5536 For the Amiga and MS-DOS the default is ">". The output is directly
5537 saved in a file and not echoed to the screen.
5538 For Unix the default it "| tee". The stdout of the compiler is saved
5539 in a file and echoed to the screen. If the 'shell' option is "csh" or
5540 "tcsh" after initializations, the default becomes "|& tee". If the
5541 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5542 "2>&1| tee". This means that stderr is also included.
5543 The initialization of this option is done after reading the ".vimrc"
5544 and the other initializations, so that when the 'shell' option is set
5545 there, the 'shellpipe' option changes automatically, unless it was
5546 explicitly set before.
5547 When 'shellpipe' is set to an empty string, no redirection of the
5548 ":make" output will be done. This is useful if you use a 'makeprg'
5549 that writes to 'makeef' by itself. If you want no piping, but do
5550 want to include the 'makeef', set 'shellpipe' to a single space.
5551 Don't forget to precede the space with a backslash: ":set sp=\ ".
5552 In the future pipes may be used for filtering and this option will
5553 become obsolete (at least for Unix).
5554 This option cannot be set from a |modeline| or in the |sandbox|, for
5555 security reasons.
5556
5557 *'shellquote'* *'shq'*
5558'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5559 contains "sh" somewhere: "\"")
5560 global
5561 {not in Vi}
5562 Quoting character(s), put around the command passed to the shell, for
5563 the "!" and ":!" commands. The redirection is kept outside of the
5564 quoting. See 'shellxquote' to include the redirection. It's
5565 probably not useful to set both options.
5566 This is an empty string by default. Only known to be useful for
5567 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5568 or bash, where it should be "\"". The default is adjusted according
5569 the value of 'shell', to reduce the need to set this option by the
5570 user. See |dos-shell|.
5571 This option cannot be set from a |modeline| or in the |sandbox|, for
5572 security reasons.
5573
5574 *'shellredir'* *'srr'*
5575'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5576 global
5577 {not in Vi}
5578 String to be used to put the output of a filter command in a temporary
5579 file. See also |:!|. See |option-backslash| about including spaces
5580 and backslashes.
5581 The name of the temporary file can be represented by "%s" if necessary
5582 (the file name is appended automatically if no %s appears in the value
5583 of this option).
5584 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5585 or "zsh" during initializations, the default becomes ">&". If the
5586 'shell' option is "sh", "ksh" or "bash" the default becomes
5587 ">%s 2>&1". This means that stderr is also included.
5588 For Win32, the Unix checks are done and additionally "cmd" is checked
5589 for, which makes the default ">%s 2>&1". Also, the same names with
5590 ".exe" appended are checked for.
5591 The initialization of this option is done after reading the ".vimrc"
5592 and the other initializations, so that when the 'shell' option is set
5593 there, the 'shellredir' option changes automatically unless it was
5594 explicitly set before.
5595 In the future pipes may be used for filtering and this option will
5596 become obsolete (at least for Unix).
5597 This option cannot be set from a |modeline| or in the |sandbox|, for
5598 security reasons.
5599
5600 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5601'shellslash' 'ssl' boolean (default off)
5602 global
5603 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5604 When set, a forward slash is used when expanding file names. This is
5605 useful when a Unix-like shell is used instead of command.com or
5606 cmd.exe. Backward slashes can still be typed, but they are changed to
5607 forward slashes by Vim.
5608 Note that setting or resetting this option has no effect for some
5609 existing file names, thus this option needs to be set before opening
5610 any file for best results. This might change in the future.
5611 'shellslash' only works when a backslash can be used as a path
5612 separator. To test if this is so use: >
5613 if exists('+shellslash')
5614<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005615 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5616'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5617 global
5618 {not in Vi}
5619 When on, use temp files for shell commands. When off use a pipe.
5620 When using a pipe is not possible temp files are used anyway.
5621 Currently a pipe is only supported on Unix. You can check it with: >
5622 :if has("filterpipe")
5623< The advantage of using a pipe is that nobody can read the temp file
5624 and the 'shell' command does not need to support redirection.
5625 The advantage of using a temp file is that the file type and encoding
5626 can be detected.
5627 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5628 |FilterWritePost| autocommands event are not triggered when
5629 'shelltemp' is off.
5630
Bram Moolenaar071d4272004-06-13 20:20:40 +00005631 *'shelltype'* *'st'*
5632'shelltype' 'st' number (default 0)
5633 global
5634 {not in Vi} {only for the Amiga}
5635 On the Amiga this option influences the way how the commands work
5636 which use a shell.
5637 0 and 1: always use the shell
5638 2 and 3: use the shell only to filter lines
5639 4 and 5: use shell only for ':sh' command
5640 When not using the shell, the command is executed directly.
5641
5642 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5643 1 and 3: use "shell cmd" to start external commands
5644
5645 *'shellxquote'* *'sxq'*
5646'shellxquote' 'sxq' string (default: "";
5647 for Win32, when 'shell' contains "sh"
5648 somewhere: "\""
5649 for Unix, when using system(): "\"")
5650 global
5651 {not in Vi}
5652 Quoting character(s), put around the command passed to the shell, for
5653 the "!" and ":!" commands. Includes the redirection. See
5654 'shellquote' to exclude the redirection. It's probably not useful
5655 to set both options.
5656 This is an empty string by default. Known to be useful for
5657 third-party shells when using the Win32 version, such as the MKS Korn
5658 Shell or bash, where it should be "\"". The default is adjusted
5659 according the value of 'shell', to reduce the need to set this option
5660 by the user. See |dos-shell|.
5661 This option cannot be set from a |modeline| or in the |sandbox|, for
5662 security reasons.
5663
5664 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5665'shiftround' 'sr' boolean (default off)
5666 global
5667 {not in Vi}
5668 Round indent to multiple of 'shiftwidth'. Applies to > and <
5669 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5670 a multiple of 'shiftwidth' (this is Vi compatible).
5671 NOTE: This option is reset when 'compatible' is set.
5672
5673 *'shiftwidth'* *'sw'*
5674'shiftwidth' 'sw' number (default 8)
5675 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005676 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005677 |'cindent'|, |>>|, |<<|, etc.
5678
5679 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005680'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5681 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005682 global
5683 {not in Vi}
5684 This option helps to avoid all the |hit-enter| prompts caused by file
5685 messages, for example with CTRL-G, and to avoid some other messages.
5686 It is a list of flags:
5687 flag meaning when present ~
5688 f use "(3 of 5)" instead of "(file 3 of 5)"
5689 i use "[noeol]" instead of "[Incomplete last line]"
5690 l use "999L, 888C" instead of "999 lines, 888 characters"
5691 m use "[+]" instead of "[Modified]"
5692 n use "[New]" instead of "[New File]"
5693 r use "[RO]" instead of "[readonly]"
5694 w use "[w]" instead of "written" for file write message
5695 and "[a]" instead of "appended" for ':w >> file' command
5696 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5697 "[unix format]" and "[mac]" instead of "[mac format]".
5698 a all of the above abbreviations
5699
5700 o overwrite message for writing a file with subsequent message
5701 for reading a file (useful for ":wn" or when 'autowrite' on)
5702 O message for reading a file overwrites any previous message.
5703 Also for quickfix message (e.g., ":cn").
5704 s don't give "search hit BOTTOM, continuing at TOP" or "search
5705 hit TOP, continuing at BOTTOM" messages
5706 t truncate file message at the start if it is too long to fit
5707 on the command-line, "<" will appear in the left most column.
5708 Ignored in Ex mode.
5709 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005710 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005711 Ignored in Ex mode.
5712 W don't give "written" or "[w]" when writing a file
5713 A don't give the "ATTENTION" message when an existing swap file
5714 is found.
5715 I don't give the intro message when starting Vim |:intro|.
5716
5717 This gives you the opportunity to avoid that a change between buffers
5718 requires you to hit <Enter>, but still gives as useful a message as
5719 possible for the space available. To get the whole message that you
5720 would have got with 'shm' empty, use ":file!"
5721 Useful values:
5722 shm= No abbreviation of message.
5723 shm=a Abbreviation, but no loss of information.
5724 shm=at Abbreviation, and truncate message when necessary.
5725
5726 NOTE: This option is set to the Vi default value when 'compatible' is
5727 set and to the Vim default value when 'compatible' is reset.
5728
5729 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5730'shortname' 'sn' boolean (default off)
5731 local to buffer
5732 {not in Vi, not in MS-DOS versions}
5733 Filenames are assumed to be 8 characters plus one extension of 3
5734 characters. Multiple dots in file names are not allowed. When this
5735 option is on, dots in file names are replaced with underscores when
5736 adding an extension (".~" or ".swp"). This option is not available
5737 for MS-DOS, because then it would always be on. This option is useful
5738 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5739 or crossdos. When running the Win32 GUI version under Win32s, this
5740 option is always on by default.
5741
5742 *'showbreak'* *'sbr'* *E595*
5743'showbreak' 'sbr' string (default "")
5744 global
5745 {not in Vi}
5746 {not available when compiled without the |+linebreak|
5747 feature}
5748 String to put at the start of lines that have been wrapped. Useful
5749 values are "> " or "+++ ".
5750 Only printable single-cell characters are allowed, excluding <Tab> and
5751 comma (in a future version the comma might be used to separate the
5752 part that is shown at the end and at the start of a line).
5753 The characters are highlighted according to the '@' flag in
5754 'highlight'.
5755 Note that tabs after the showbreak will be displayed differently.
5756 If you want the 'showbreak' to appear in between line numbers, add the
5757 "n" flag to 'cpoptions'.
5758
5759 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5760'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5761 off)
5762 global
5763 {not in Vi}
5764 {not available when compiled without the
5765 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005766 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005767 terminal is slow.
5768 In Visual mode the size of the selected area is shown:
5769 - When selecting characters within a line, the number of characters.
5770 - When selecting more than one line, the number of lines.
5771 - When selecting a block, the size in screen characters: linesxcolumns.
5772 NOTE: This option is set to the Vi default value when 'compatible' is
5773 set and to the Vim default value when 'compatible' is reset.
5774
5775 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5776'showfulltag' 'sft' boolean (default off)
5777 global
5778 {not in Vi}
5779 When completing a word in insert mode (see |ins-completion|) from the
5780 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005781 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005782 matched a C function, you can see a template for what arguments are
5783 required (coding style permitting).
5784
5785 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5786'showmatch' 'sm' boolean (default off)
5787 global
5788 When a bracket is inserted, briefly jump to the matching one. The
5789 jump is only done if the match can be seen on the screen. The time to
5790 show the match can be set with 'matchtime'.
5791 A Beep is given if there is no match (no matter if the match can be
5792 seen or not). This option is reset when the 'paste' option is set.
5793 When the 'm' flag is not included in 'cpoptions', typing a character
5794 will immediately move the cursor back to where it belongs.
5795 See the "sm" field in 'guicursor' for setting the cursor shape and
5796 blinking when showing the match.
5797 The 'matchpairs' option can be used to specify the characters to show
5798 matches for. 'rightleft' and 'revins' are used to look for opposite
5799 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005800 Also see the matchparen plugin for highlighting the match when moving
5801 around |pi_paren.txt|.
5802 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005803
5804 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5805'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5806 global
5807 If in Insert, Replace or Visual mode put a message on the last line.
5808 Use the 'M' flag in 'highlight' to set the type of highlighting for
5809 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005810 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005811 doesn't mean XIM is really active, especially when 'imactivatekey' is
5812 not set.
5813 NOTE: This option is set to the Vi default value when 'compatible' is
5814 set and to the Vim default value when 'compatible' is reset.
5815
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00005816 *'showtabline'* *'stal'*
5817'showtabline' 'stal' number (default 1)
5818 global
5819 {not in Vi}
5820 {not available when compiled without the +windows
5821 feature}
5822 The value of this option specifies when the line with tab page labels
5823 will be displayed:
5824 0: never
5825 1: only if there are at least two tab pages
5826 2: always
5827 This is both for the GUI and non-GUI implementation of the tab pages
5828 line.
5829 See |tab-page| for more information about tab pages.
5830
Bram Moolenaar071d4272004-06-13 20:20:40 +00005831 *'sidescroll'* *'ss'*
5832'sidescroll' 'ss' number (default 0)
5833 global
5834 {not in Vi}
5835 The minimal number of columns to scroll horizontally. Used only when
5836 the 'wrap' option is off and the cursor is moved off of the screen.
5837 When it is zero the cursor will be put in the middle of the screen.
5838 When using a slow terminal set it to a large number or 0. When using
5839 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5840 commands.
5841
5842 *'sidescrolloff'* *'siso'*
5843'sidescrolloff' 'siso' number (default 0)
5844 global
5845 {not in Vi}
5846 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005847 right of the cursor if 'nowrap' is set. Setting this option to a
5848 value greater than 0 while having |'sidescroll'| also at a non-zero
5849 value makes some context visible in the line you are scrolling in
5850 horizontally (except at beginning of the line). Setting this option
5851 to a large value (like 999) has the effect of keeping the cursor
5852 horizontally centered in the window, as long as one does not come too
5853 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005854 NOTE: This option is set to 0 when 'compatible' is set.
5855
5856 Example: Try this together with 'sidescroll' and 'listchars' as
5857 in the following example to never allow the cursor to move
5858 onto the "extends" character:
5859
5860 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5861 :set sidescrolloff=1
5862
5863
5864 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5865'smartcase' 'scs' boolean (default off)
5866 global
5867 {not in Vi}
5868 Override the 'ignorecase' option if the search pattern contains upper
5869 case characters. Only used when the search pattern is typed and
5870 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005871 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005872 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5873 recalling the search pattern from history and hitting <Enter>.
5874 NOTE: This option is reset when 'compatible' is set.
5875
5876 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5877'smartindent' 'si' boolean (default off)
5878 local to buffer
5879 {not in Vi}
5880 {not available when compiled without the
5881 |+smartindent| feature}
5882 Do smart autoindenting when starting a new line. Works for C-like
5883 programs, but can also be used for other languages. 'cindent' does
5884 something like this, works better in most cases, but is more strict,
5885 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5886 'indentexpr' is a more advanced alternative.
5887 Normally 'autoindent' should also be on when using 'smartindent'.
5888 An indent is automatically inserted:
5889 - After a line ending in '{'.
5890 - After a line starting with a keyword from 'cinwords'.
5891 - Before a line starting with '}' (only with the "O" command).
5892 When typing '}' as the first character in a new line, that line is
5893 given the same indent as the matching '{'.
5894 When typing '#' as the first character in a new line, the indent for
5895 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005896 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005897 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5898 When using the ">>" command, lines starting with '#' are not shifted
5899 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005900 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005901 is set smart indenting is disabled.
5902
5903 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5904'smarttab' 'sta' boolean (default off)
5905 global
5906 {not in Vi}
5907 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00005908 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
5909 <BS> will delete a 'shiftwidth' worth of space at the start of the
5910 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005911 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00005912 'softtabstop'. 'shiftwidth' is only used for shifting text left or
5913 right |shift-left-right|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005914 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5915 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005916 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005917 NOTE: This option is reset when 'compatible' is set.
5918
5919 *'softtabstop'* *'sts'*
5920'softtabstop' 'sts' number (default 0)
5921 local to buffer
5922 {not in Vi}
5923 Number of spaces that a <Tab> counts for while performing editing
5924 operations, like inserting a <Tab> or using <BS>. It "feels" like
5925 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5926 used. This is useful to keep the 'ts' setting at its standard value
5927 of 8, while being able to edit like it is set to 'sts'. However,
5928 commands like "x" still work on the actual characters.
5929 When 'sts' is zero, this feature is off.
5930 'softtabstop' is set to 0 when the 'paste' option is set.
5931 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5932 spaces is minimized by using <Tab>s.
5933 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5934 set.
5935 NOTE: This option is set to 0 when 'compatible' is set.
5936
Bram Moolenaar217ad922005-03-20 22:37:15 +00005937 *'spell'* *'nospell'*
5938'spell' boolean (default off)
5939 local to window
5940 {not in Vi}
5941 {not available when compiled without the |+syntax|
5942 feature}
5943 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005944 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005945
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005946 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005947'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005948 local to buffer
5949 {not in Vi}
5950 {not available when compiled without the |+syntax|
5951 feature}
5952 Pattern to locate the end of a sentence. The following word will be
5953 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005954 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005955 When this check is not wanted make this option empty.
5956 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005957 Be careful with special characters, see |option-backslash| about
5958 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005959 To set this option automatically depending on the language, see
5960 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005961
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005962 *'spellfile'* *'spf'*
5963'spellfile' 'spf' string (default empty)
5964 local to buffer
5965 {not in Vi}
5966 {not available when compiled without the |+syntax|
5967 feature}
5968 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00005969 commands. It must end in ".{encoding}.add". You need to include the
5970 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005971 *E765*
5972 It may also be a comma separated list of names. A count before the
5973 |zg| and |zw| commands can be used to access each. This allows using
5974 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005975 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005976 you: Using the first directory in 'runtimepath' that is writable. If
5977 there is no "spell" directory yet it will be created. For the file
5978 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00005979 ignoring the region.
5980 The resulting ".spl" file will be used for spell checking, it does not
5981 have to appear in 'spelllang'.
5982 Normally one file is used for all regions, but you can add the region
5983 name if you want to. However, it will then only be used when
5984 'spellfile' is set to it, for entries in 'spelllang' only files
5985 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00005986 This option cannot be set from a |modeline| or in the |sandbox|, for
5987 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005988
Bram Moolenaar217ad922005-03-20 22:37:15 +00005989 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005990'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00005991 local to buffer
5992 {not in Vi}
5993 {not available when compiled without the |+syntax|
5994 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00005995 A comma separated list of word list names. When the 'spell' option is
5996 on spellchecking will be done for these languages. Example: >
5997 set spelllang=en_us,nl,medical
5998< This means US English, Dutch and medical words are recognized. Words
5999 that are not recognized will be highlighted.
6000 The word list name must not include a comma or dot. Using a dash is
6001 recommended to separate the two letter language name from a
6002 specification. Thus "en-rare" is used for rare English words.
6003 A region name must come last and have the form "_xx", where "xx" is
6004 the two-letter, lower case region name. You can use more than one
6005 region by listing them: "en_us,en_ca" supports both US and Canadian
6006 English, but not words specific for Australia, New Zealand or Great
6007 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006008 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006009 As a special case the name of a .spl file can be given as-is. The
6010 first "_xx" in the name is removed and used as the region name
6011 (_xx is an underscore, two letters and followed by a non-letter).
6012 This is mainly for testing purposes. You must make sure the correct
6013 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006014 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006015 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6016 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006017 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006018
Bram Moolenaar98692072006-02-04 00:57:42 +00006019 If the |spellfile.vim| plugin is active and you use a language name
6020 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6021 will ask you if you want to download the file.
6022
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006023 After this option has been set successfully, Vim will source the files
6024 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006025 up to the first comma, dot or underscore.
6026 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006027
6028
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006029 *'spellsuggest'* *'sps'*
6030'spellsuggest' 'sps' string (default "best")
6031 global
6032 {not in Vi}
6033 {not available when compiled without the |+syntax|
6034 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006035 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006036 the |spellsuggest()| function. This is a comma-separated list of
6037 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006038
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006039 best Internal method that works best for English. Finds
6040 changes like "fast" and uses a bit of sound-a-like
6041 scoring to improve the ordering.
6042
6043 double Internal method that uses two methods and mixes the
6044 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006045 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006046 word. That only works when the language specifies
6047 sound folding. Can be slow and doesn't always give
6048 better results.
6049
6050 fast Internal method that only checks for simple changes:
6051 character inserts/deletes/swaps. Works well for
6052 simple typing mistakes.
6053
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006054 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006055 Not used for |spellsuggest()|. The number of
6056 suggestions is never more than the value of 'lines'
6057 minus two.
6058
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006059 file:{filename} Read file {filename}, which must have two columns,
6060 separated by a slash. The first column contains the
6061 bad word, the second column the suggested good word.
6062 Example:
6063 theribal/terrible ~
6064 Use this for common mistakes that do not appear at the
6065 top of the suggestion list with the internal methods.
6066 Lines without a slash are ignored, use this for
6067 comments.
6068 The file is used for all languages.
6069
6070 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6071 trouble with spaces. |v:val| holds the badly spelled
6072 word. The expression must evaluate to a List of
6073 Lists, each with a suggestion and a score.
6074 Example:
6075 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006076 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006077 internal methods use. A lower score is better.
6078 This may invoke |spellsuggest()| if you temporarily
6079 set 'spellsuggest' to exclude the "expr:" part.
6080 Errors are silently ignored, unless you set the
6081 'verbose' option to a non-zero value.
6082
6083 Only one of "best", "double" or "fast" may be used. The others may
6084 appear several times in any order. Example: >
6085 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6086<
6087 This option cannot be set from a |modeline| or in the |sandbox|, for
6088 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006089
6090
Bram Moolenaar071d4272004-06-13 20:20:40 +00006091 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6092'splitbelow' 'sb' boolean (default off)
6093 global
6094 {not in Vi}
6095 {not available when compiled without the +windows
6096 feature}
6097 When on, splitting a window will put the new window below the current
6098 one. |:split|
6099
6100 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6101'splitright' 'spr' boolean (default off)
6102 global
6103 {not in Vi}
6104 {not available when compiled without the +vertsplit
6105 feature}
6106 When on, splitting a window will put the new window right of the
6107 current one. |:vsplit|
6108
6109 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6110'startofline' 'sol' boolean (default on)
6111 global
6112 {not in Vi}
6113 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006114 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006115 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006116 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006117 with a linewise operator, with "%" with a count and to buffer changing
6118 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6119 only has a line number, e.g., ":25" or ":+".
6120 In case of buffer changing commands the cursor is placed at the column
6121 where it was the last time the buffer was edited.
6122 NOTE: This option is set when 'compatible' is set.
6123
6124 *'statusline'* *'stl'* *E540* *E541* *E542*
6125'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006126 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006127 {not in Vi}
6128 {not available when compiled without the |+statusline|
6129 feature}
6130 When nonempty, this option determines the content of the status line.
6131 Also see |status-line|.
6132
6133 The option consists of printf style '%' items interspersed with
6134 normal text. Each status line item is of the form:
6135 %-0{minwid}.{maxwid}{item}
6136 All fields except the {item} is optional. A single percent sign can
6137 be given as "%%". Up to 80 items can be specified.
6138
Bram Moolenaar238a5642006-02-21 22:12:05 +00006139 When the option starts with "%!" then it is used as an expression,
6140 evaluated and the result is used as the option value. Example: >
6141 :set statusline=%!MyStatusLine()
6142< The result can contain %{} items that will be evaluated too.
6143
6144 When there is error while evaluating the option then it will be made
6145 empty to avoid further errors. Otherwise screen updating would loop.
6146
Bram Moolenaar071d4272004-06-13 20:20:40 +00006147 Note that the only effect of 'ruler' when this option is set (and
6148 'laststatus' is 2) is controlling the output of |CTRL-G|.
6149
6150 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006151 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006152 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006153 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006154 minwid Minimum width of the item, padding as set by '-' & '0'.
6155 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006156 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006157 on the left for text items. Numeric items will be
6158 shifted down to maxwid-2 digits followed by '>'number
6159 where number is the amount of missing digits, much like
6160 an exponential notation.
6161 item A one letter code as described below.
6162
6163 Following is a description of the possible statusline items. The
6164 second character in "item" is the type:
6165 N for number
6166 S for string
6167 F for flags as described below
6168 - not applicable
6169
6170 item meaning ~
6171 f S Path to the file in the buffer, relative to current directory.
6172 F S Full path to the file in the buffer.
6173 t S File name (tail) of file in the buffer.
6174 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
6175 M F Modified flag, text is ",+" or ",-".
6176 r F Readonly flag, text is " [RO]".
6177 R F Readonly flag, text is ",RO".
6178 h F Help buffer flag, text is " [help]".
6179 H F Help buffer flag, text is ",HLP".
6180 w F Preview window flag, text is " [Preview]".
6181 W F Preview window flag, text is ",PRV".
6182 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
6183 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6184 {not available when compiled without |+autocmd| feature}
6185 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6186 being used: "<keymap>"
6187 n N Buffer number.
6188 b N Value of byte under cursor.
6189 B N As above, in hexadecimal.
6190 o N Byte number in file of byte under cursor, first byte is 1.
6191 Mnemonic: Offset from start of file (with one added)
6192 {not available when compiled without |+byte_offset| feature}
6193 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006194 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006195 l N Line number.
6196 L N Number of lines in buffer.
6197 c N Column number.
6198 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006199 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006200 p N Percentage through file in lines as in |CTRL-G|.
6201 P S Percentage through file of displayed window. This is like the
6202 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006203 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006204 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006205 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006206 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006207 ( - Start of item group. Can be used for setting the width and
6208 alignment of a section. Must be followed by %) somewhere.
6209 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006210 T N For 'tabline': start of tab page N label. Use %T after the last
6211 label. This information is used for mouse clicks.
6212 X N For 'tabline': start of close tab N label. Use %X after the
6213 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6214 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006215 < - Where to truncate line if too long. Default is at the start.
6216 No width fields allowed.
6217 = - Separation point between left and right aligned items.
6218 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006219 # - Set highlight group. The name must follow and then a # again.
6220 Thus use %#HLname# for highlight group HLname. The same
6221 highlighting is used, also for the statusline of non-current
6222 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006223 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006224 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006225 The difference between User{N} and StatusLine will be applied
6226 to StatusLineNC for the statusline of non-current windows.
6227 The number N must be between 1 and 9. See |hl-User1..9|
6228
6229 Display of flags are controlled by the following heuristic:
6230 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006231 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00006232 with a space it is assumed that it wants to separate itself from
6233 anything but other flags. That is: A leading comma is removed if the
6234 preceding character stems from plaintext. A leading space is removed
Bram Moolenaar582fd852005-03-28 20:58:01 +00006235 if the preceding character stems from another active flag. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006236 make a nice display when flags are used like in the examples below.
6237
Bram Moolenaar582fd852005-03-28 20:58:01 +00006238 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006239 not set) and a minwid is not set for the group, the whole group will
6240 become empty. This will make a group like the following disappear
6241 completely from the statusline when none of the flags are set. >
6242 :set statusline=...%(\ [%M%R%H]%)...
6243<
6244 Beware that an expression is evaluated each and every time the status
6245 line is displayed. The current buffer and current window will be set
6246 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006247 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006248 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006249 real current buffer.
6250
6251 The 'statusline' option may be evaluated in the |sandbox|, see
6252 |sandbox-option|.
6253
6254 It is not allowed to change text or jump to another window while
6255 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006256
6257 If the statusline is not updated when you want it (e.g., after setting
6258 a variable that's used in an expression), you can force an update by
6259 setting an option without changing its value. Example: >
6260 :let &ro = &ro
6261
6262< A result of all digits is regarded a number for display purposes.
6263 Otherwise the result is taken as flag text and applied to the rules
6264 described above.
6265
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006266 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006267 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6268 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6269
6270 Examples:
6271 Emulate standard status line with 'ruler' set >
6272 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6273< Similar, but add ASCII value of char under the cursor (like "ga") >
6274 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6275< Display byte count and byte value, modified flag in red. >
6276 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6277 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6278< Display a ,GZ flag if a compressed file is loaded >
6279 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6280< In the |:autocmd|'s: >
6281 :let b:gzflag = 1
6282< And: >
6283 :unlet b:gzflag
6284< And define this function: >
6285 :function VarExists(var, val)
6286 : if exists(a:var) | return a:val | else | return '' | endif
6287 :endfunction
6288<
6289 *'suffixes'* *'su'*
6290'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6291 global
6292 {not in Vi}
6293 Files with these suffixes get a lower priority when multiple files
6294 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006295 suffixes. Spaces after the comma are ignored. A dot is also seen as
6296 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006297 separator, precede it with a backslash (see |option-backslash| about
6298 including spaces and backslashes).
6299 See 'wildignore' for completely ignoring files.
6300 The use of |:set+=| and |:set-=| is preferred when adding or removing
6301 suffixes from the list. This avoids problems when a future version
6302 uses another default.
6303
6304 *'suffixesadd'* *'sua'*
6305'suffixesadd' 'sua' string (default "")
6306 local to buffer
6307 {not in Vi}
6308 {not available when compiled without the
6309 |+file_in_path| feature}
6310 Comma separated list of suffixes, which are used when searching for a
6311 file for the "gf", "[I", etc. commands. Example: >
6312 :set suffixesadd=.java
6313<
6314 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6315'swapfile' 'swf' boolean (default on)
6316 local to buffer
6317 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006318 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006319 swapfile is not wanted for a specific buffer. For example, with
6320 confidential information that even root must not be able to access.
6321 Careful: All text will be in memory:
6322 - Don't use this for big files.
6323 - Recovery will be impossible!
6324 A swapfile will only be present when |'updatecount'| is non-zero and
6325 'swapfile' is set.
6326 When 'swapfile' is reset, the swap file for the current buffer is
6327 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6328 non-zero, a swap file is immediately created.
6329 Also see |swap-file| and |'swapsync'|.
6330
6331 This option is used together with 'bufhidden' and 'buftype' to
6332 specify special kinds of buffers. See |special-buffers|.
6333
6334 *'swapsync'* *'sws'*
6335'swapsync' 'sws' string (default "fsync")
6336 global
6337 {not in Vi}
6338 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006339 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006340 When this option is empty parts of the swap file may be in memory and
6341 not written to disk. When the system crashes you may lose more work.
6342 On Unix the system does a sync now and then without Vim asking for it,
6343 so the disadvantage of setting this option off is small. On some
6344 systems the swap file will not be written at all. For a unix system
6345 setting it to "sync" will use the sync() call instead of the default
6346 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006347 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006348
6349 *'switchbuf'* *'swb'*
6350'switchbuf' 'swb' string (default "")
6351 global
6352 {not in Vi}
6353 This option controls the behavior when switching between buffers.
6354 Possible values (comma separated list):
6355 useopen If included, jump to the first open window that
6356 contains the specified buffer (if there is one).
6357 Otherwise: Do not examine other windows.
6358 This setting is checked with |quickfix| commands, when
6359 jumping to errors (":cc", ":cn", "cp", etc.). It is
6360 also used in all buffer related split commands, for
6361 example ":sbuffer", ":sbnext", or ":sbrewind".
6362 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006363 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006364 Supported in |quickfix| commands that display errors.
6365
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006366 *'synmaxcol'* *'smc'*
6367'synmaxcol' 'smc' number (default 3000)
6368 local to buffer
6369 {not in Vi}
6370 {not available when compiled without the |+syntax|
6371 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006372 Maximum column in which to search for syntax items. In long lines the
6373 text after this column is not highlighted and following lines may not
6374 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006375 This helps to avoid very slow redrawing for an XML file that is one
6376 long line.
6377 Set to zero to remove the limit.
6378
Bram Moolenaar071d4272004-06-13 20:20:40 +00006379 *'syntax'* *'syn'*
6380'syntax' 'syn' string (default empty)
6381 local to buffer
6382 {not in Vi}
6383 {not available when compiled without the |+syntax|
6384 feature}
6385 When this option is set, the syntax with this name is loaded, unless
6386 syntax highlighting has been switched off with ":syntax off".
6387 Otherwise this option does not always reflect the current syntax (the
6388 b:current_syntax variable does).
6389 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006390 not automatically recognized. Example, in an IDL file:
6391 /* vim: set syntax=idl : */ ~
6392 When a dot appears in the value then this separates two filetype
6393 names. Example:
6394 /* vim: set syntax=c.doxygen : */ ~
6395 This will use the "c" syntax first, then the "doxygen" syntax.
6396 Note that the second one must be prepared to be loaded as an addition,
6397 otherwise it will be skipped. More than one dot may appear.
6398 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006399 :set syntax=OFF
6400< To switch syntax highlighting on according to the current value of the
6401 'filetype' option: >
6402 :set syntax=ON
6403< What actually happens when setting the 'syntax' option is that the
6404 Syntax autocommand event is triggered with the value as argument.
6405 This option is not copied to another buffer, independent of the 's' or
6406 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006407 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006408
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006409 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006410'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006411 global
6412 {not in Vi}
6413 {not available when compiled without the +windows
6414 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006415 When nonempty, this option determines the content of the tab pages
6416 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006417 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006418
6419 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006420 option and only when there is no GUI tab line. When 'e' is in
6421 'guioptions' and the GUI supports a tab line 'guitablabel' is used
6422 instead.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006423
6424 The value is evaluated like with 'statusline'. You can use
6425 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006426 the text to be displayed. Use "%1T" for the first label, "%2T" for
6427 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006428
6429 Keep in mind that only one of the tab pages is the current one, others
6430 are invisible and you can't jump to their windows.
6431
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006432
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006433 *'tabpagemax'* *'tpm'*
6434'tabpagemax' 'tpm' number (default 10)
6435 global
6436 {not in Vi}
6437 {not available when compiled without the +windows
6438 feature}
6439 Maximum number of tab pages to be opened by the |-p| command line
6440 argument or the ":tab all" command. |tabpage|
6441
6442
6443 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006444'tabstop' 'ts' number (default 8)
6445 local to buffer
6446 Number of spaces that a <Tab> in the file counts for. Also see
6447 |:retab| command, and 'softtabstop' option.
6448
6449 Note: Setting 'tabstop' to any other value than 8 can make your file
6450 appear wrong in many places (e.g., when printing it).
6451
6452 There are four main ways to use tabs in Vim:
6453 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6454 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
6455 will use a mix of tabs and spaces, but typing Tab and BS will
6456 behave like a tab appears every 4 (or 3) characters.
6457 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6458 'expandtab'. This way you will always insert spaces. The
6459 formatting will never be messed up when 'tabstop' is changed.
6460 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006461 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006462 works when using Vim to edit the file.
6463 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6464 'noexpandtab'. This should then work (for initial indents only)
6465 for any tabstop setting that people use. It might be nice to have
6466 tabs after the first non-blank inserted as spaces if you do this
6467 though. Otherwise aligned comments will be wrong when 'tabstop' is
6468 changed.
6469
6470 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6471'tagbsearch' 'tbs' boolean (default on)
6472 global
6473 {not in Vi}
6474 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006475 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006476 searching makes searching for a tag a LOT faster, but a linear search
6477 will find more tags if the tags file wasn't properly sorted.
6478 Vim normally assumes that your tags files are sorted, or indicate that
6479 they are not sorted. Only when this is not the case does the
6480 'tagbsearch' option need to be switched off.
6481
6482 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006483 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006484 certain files, or retry all files with a linear search. When
6485 'tagbsearch' is off, only a linear search is done.
6486
6487 Linear searching is done anyway, for one file, when Vim finds a line
6488 at the start of the file indicating that it's not sorted: >
6489 !_TAG_FILE_SORTED 0 /some command/
6490< [The whitespace before and after the '0' must be a single <Tab>]
6491
6492 When a binary search was done and no match was found in any of the
6493 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6494 instead of a normal tag name, a retry is done with a linear search.
6495 Tags in unsorted tags files, and matches with different case will only
6496 be found in the retry.
6497
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006498 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006499 linear search can be avoided for the 'ignorecase' case. Use a value
6500 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6501 case-fold sorted with the -f switch to "sort" in most unices, as in
6502 the command: "sort -f -o tags tags". For "Exuberant ctags" version
6503 5.3 or higher the -f or --fold-case-sort switch can be used for this
6504 as well. Note that case must be folded to uppercase for this to work.
6505
6506 When 'tagbsearch' is off, tags searching is slower when a full match
6507 exists, but faster when no full match exists. Tags in unsorted tags
6508 files may only be found with 'tagbsearch' off.
6509 When the tags file is not sorted, or sorted in a wrong way (not on
6510 ASCII byte value), 'tagbsearch' should be off, or the line given above
6511 must be included in the tags file.
6512 This option doesn't affect commands that find all matching tags (e.g.,
6513 command-line completion and ":help").
6514 {Vi: always uses binary search in some versions}
6515
6516 *'taglength'* *'tl'*
6517'taglength' 'tl' number (default 0)
6518 global
6519 If non-zero, tags are significant up to this number of characters.
6520
6521 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6522'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6523 global
6524 {not in Vi}
6525 If on and using a tag file in another directory, file names in that
6526 tag file are relative to the directory where the tag file is.
6527 NOTE: This option is set to the Vi default value when 'compatible' is
6528 set and to the Vim default value when 'compatible' is reset.
6529
6530 *'tags'* *'tag'* *E433*
6531'tags' 'tag' string (default "./tags,tags", when compiled with
6532 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6533 global or local to buffer |global-local|
6534 Filenames for the tag command, separated by spaces or commas. To
6535 include a space or comma in a file name, precede it with a backslash
6536 (see |option-backslash| about including spaces and backslashes).
6537 When a file name starts with "./", the '.' is replaced with the path
6538 of the current file. But only when the 'd' flag is not included in
6539 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6540 |tags-option|.
6541 "*", "**" and other wildcards can be used to search for tags files in
6542 a directory tree. See |file-searching|. {not available when compiled
6543 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006544 The |tagfiles()| function can be used to get a list of the file names
6545 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006546 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6547 files are also supported. They are automatically recognized. The
6548 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6549 differences are ignored (MS-Windows). |emacs-tags|
6550 The use of |:set+=| and |:set-=| is preferred when adding or removing
6551 file names from the list. This avoids problems when a future version
6552 uses another default.
6553 {Vi: default is "tags /usr/lib/tags"}
6554
6555 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6556'tagstack' 'tgst' boolean (default on)
6557 global
6558 {not in all versions of Vi}
6559 When on, the |tagstack| is used normally. When off, a ":tag" or
6560 ":tselect" command with an argument will not push the tag onto the
6561 tagstack. A following ":tag" without an argument, a ":pop" command or
6562 any other command that uses the tagstack will use the unmodified
6563 tagstack, but does change the pointer to the active entry.
6564 Resetting this option is useful when using a ":tag" command in a
6565 mapping which should not change the tagstack.
6566
6567 *'term'* *E529* *E530* *E531*
6568'term' string (default is $TERM, if that fails:
6569 in the GUI: "builtin_gui"
6570 on Amiga: "amiga"
6571 on BeOS: "beos-ansi"
6572 on Mac: "mac-ansi"
6573 on MiNT: "vt52"
6574 on MS-DOS: "pcterm"
6575 on OS/2: "os2ansi"
6576 on Unix: "ansi"
6577 on VMS: "ansi"
6578 on Win 32: "win32")
6579 global
6580 Name of the terminal. Used for choosing the terminal control
6581 characters. Environment variables are expanded |:set_env|.
6582 For example: >
6583 :set term=$TERM
6584< See |termcap|.
6585
6586 *'termbidi'* *'tbidi'*
6587 *'notermbidi'* *'notbidi'*
6588'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6589 global
6590 {not in Vi}
6591 {only available when compiled with the |+arabic|
6592 feature}
6593 The terminal is in charge of Bi-directionality of text (as specified
6594 by Unicode). The terminal is also expected to do the required shaping
6595 that some languages (such as Arabic) require.
6596 Setting this option implies that 'rightleft' will not be set when
6597 'arabic' is set and the value of 'arabicshape' will be ignored.
6598 Note that setting 'termbidi' has the immediate effect that
6599 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6600 This option is reset when the GUI is started.
6601 For further details see |arabic.txt|.
6602
6603 *'termencoding'* *'tenc'*
6604'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6605 Macintosh GUI: "macroman")
6606 global
6607 {only available when compiled with the |+multi_byte|
6608 feature}
6609 {not in Vi}
6610 Encoding used for the terminal. This specifies what character
6611 encoding the keyboard produces and the display will understand. For
6612 the GUI it only applies to the keyboard ('encoding' is used for the
6613 display).
6614 In the Win32 console version the default value is the console codepage
6615 when it differs from the ANSI codepage.
6616 *E617*
6617 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6618 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6619 Any attempts to set a different value will be rejected, and an error
6620 message is shown.
6621 For the Win32 GUI 'termencoding' is not used for typed characters,
6622 because the Win32 system always passes Unicode characters.
6623 When empty, the same encoding is used as for the 'encoding' option.
6624 This is the normal value.
6625 Not all combinations for 'termencoding' and 'encoding' are valid. See
6626 |encoding-table|.
6627 The value for this option must be supported by internal conversions or
6628 iconv(). When this is not possible no conversion will be done and you
6629 will probably experience problems with non-ASCII characters.
6630 Example: You are working with the locale set to euc-jp (Japanese) and
6631 want to edit a UTF-8 file: >
6632 :let &termencoding = &encoding
6633 :set encoding=utf-8
6634< You need to do this when your system has no locale support for UTF-8.
6635
6636 *'terse'* *'noterse'*
6637'terse' boolean (default off)
6638 global
6639 When set: Add 's' flag to 'shortmess' option (this makes the message
6640 for a search that hits the start or end of the file not being
6641 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6642 shortens a lot of messages}
6643
6644 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6645'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6646 global
6647 {not in Vi}
6648 This option is obsolete. Use 'fileformats'.
6649 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6650 set to the default value for the current system. When 'textauto' is
6651 reset, 'fileformats' is made empty.
6652 NOTE: This option is set to the Vi default value when 'compatible' is
6653 set and to the Vim default value when 'compatible' is reset.
6654
6655 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6656'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6657 others: default off)
6658 local to buffer
6659 {not in Vi}
6660 This option is obsolete. Use 'fileformat'.
6661 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6662 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6663 "unix".
6664
6665 *'textwidth'* *'tw'*
6666'textwidth' 'tw' number (default 0)
6667 local to buffer
6668 {not in Vi}
6669 Maximum width of text that is being inserted. A longer line will be
6670 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006671 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6672 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006673 'formatoptions' and |ins-textwidth|.
6674 NOTE: This option is set to 0 when 'compatible' is set.
6675
6676 *'thesaurus'* *'tsr'*
6677'thesaurus' 'tsr' string (default "")
6678 global or local to buffer |global-local|
6679 {not in Vi}
6680 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006681 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006682 the file should contain words with similar meaning, separated by
6683 non-keyword characters (white space is preferred). Maximum line
6684 length is 510 bytes.
6685 To obtain a file to be used here, check out the wordlist FAQ at
6686 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006687 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006688 after a comma are ignored, otherwise spaces are included in the file
6689 name. See |option-backslash| about using backslashes.
6690 The use of |:set+=| and |:set-=| is preferred when adding or removing
6691 directories from the list. This avoids problems when a future version
6692 uses another default.
6693 Backticks cannot be used in this option for security reasons.
6694
6695 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6696'tildeop' 'top' boolean (default off)
6697 global
6698 {not in Vi}
6699 When on: The tilde command "~" behaves like an operator.
6700 NOTE: This option is reset when 'compatible' is set.
6701
6702 *'timeout'* *'to'* *'notimeout'* *'noto'*
6703'timeout' 'to' boolean (default on)
6704 global
6705 *'ttimeout'* *'nottimeout'*
6706'ttimeout' boolean (default off)
6707 global
6708 {not in Vi}
6709 These two options together determine the behavior when part of a
6710 mapped key sequence or keyboard code has been received:
6711
6712 'timeout' 'ttimeout' action ~
6713 off off do not time out
6714 on on or off time out on :mappings and key codes
6715 off on time out on key codes
6716
6717 If both options are off, Vim will wait until either the complete
6718 mapping or key sequence has been received, or it is clear that there
6719 is no mapping or key sequence for the received characters. For
6720 example: if you have mapped "vl" and Vim has received 'v', the next
6721 character is needed to see if the 'v' is followed by an 'l'.
6722 When one of the options is on, Vim will wait for about 1 second for
6723 the next character to arrive. After that the already received
6724 characters are interpreted as single characters. The waiting time can
6725 be changed with the 'timeoutlen' option.
6726 On slow terminals or very busy systems timing out may cause
6727 malfunctioning cursor keys. If both options are off, Vim waits
6728 forever after an entered <Esc> if there are key codes that start
6729 with <Esc>. You will have to type <Esc> twice. If you do not have
6730 problems with key codes, but would like to have :mapped key
6731 sequences not timing out in 1 second, set the 'ttimeout' option and
6732 reset the 'timeout' option.
6733
6734 NOTE: 'ttimeout' is reset when 'compatible' is set.
6735
6736 *'timeoutlen'* *'tm'*
6737'timeoutlen' 'tm' number (default 1000)
6738 global
6739 {not in all versions of Vi}
6740 *'ttimeoutlen'* *'ttm'*
6741'ttimeoutlen' 'ttm' number (default -1)
6742 global
6743 {not in Vi}
6744 The time in milliseconds that is waited for a key code or mapped key
6745 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6746 when part of a command has been typed.
6747 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6748 different timeout value for key codes is desired set 'ttimeoutlen' to
6749 a non-negative number.
6750
6751 ttimeoutlen mapping delay key code delay ~
6752 < 0 'timeoutlen' 'timeoutlen'
6753 >= 0 'timeoutlen' 'ttimeoutlen'
6754
6755 The timeout only happens when the 'timeout' and 'ttimeout' options
6756 tell so. A useful setting would be >
6757 :set timeout timeoutlen=3000 ttimeoutlen=100
6758< (time out on mapping after three seconds, time out on key codes after
6759 a tenth of a second).
6760
6761 *'title'* *'notitle'*
6762'title' boolean (default off, on when title can be restored)
6763 global
6764 {not in Vi}
6765 {not available when compiled without the |+title|
6766 feature}
6767 When on, the title of the window will be set to the value of
6768 'titlestring' (if it is not empty), or to:
6769 filename [+=-] (path) - VIM
6770 Where:
6771 filename the name of the file being edited
6772 - indicates the file cannot be modified, 'ma' off
6773 + indicates the file was modified
6774 = indicates the file is read-only
6775 =+ indicates the file is read-only and modified
6776 (path) is the path of the file being edited
6777 - VIM the server name |v:servername| or "VIM"
6778 Only works if the terminal supports setting window titles
6779 (currently Amiga console, Win32 console, all GUI versions and
6780 terminals with a non- empty 't_ts' option - these are Unix xterm and
6781 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6782 *X11*
6783 When Vim was compiled with HAVE_X11 defined, the original title will
6784 be restored if possible. The output of ":version" will include "+X11"
6785 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6786 works for the icon name |'icon'|.
6787 But: When Vim was started with the |-X| argument, restoring the title
6788 will not work (except in the GUI).
6789 If the title cannot be restored, it is set to the value of 'titleold'.
6790 You might want to restore the title outside of Vim then.
6791 When using an xterm from a remote machine you can use this command:
6792 rsh machine_name xterm -display $DISPLAY &
6793 then the WINDOWID environment variable should be inherited and the
6794 title of the window should change back to what it should be after
6795 exiting Vim.
6796
6797 *'titlelen'*
6798'titlelen' number (default 85)
6799 global
6800 {not in Vi}
6801 {not available when compiled without the |+title|
6802 feature}
6803 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006804 title. When the title is longer, only the end of the path name is
6805 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006806 Using a percentage makes this adapt to the width of the window. But
6807 it won't work perfectly, because the actual number of characters
6808 available also depends on the font used and other things in the title
6809 bar. When 'titlelen' is zero the full path is used. Otherwise,
6810 values from 1 to 30000 percent can be used.
6811 'titlelen' is also used for the 'titlestring' option.
6812
6813 *'titleold'*
6814'titleold' string (default "Thanks for flying Vim")
6815 global
6816 {not in Vi}
6817 {only available when compiled with the |+title|
6818 feature}
6819 This option will be used for the window title when exiting Vim if the
6820 original title cannot be restored. Only happens if 'title' is on or
6821 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006822 This option cannot be set from a |modeline| or in the |sandbox|, for
6823 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006824 *'titlestring'*
6825'titlestring' string (default "")
6826 global
6827 {not in Vi}
6828 {not available when compiled without the |+title|
6829 feature}
6830 When this option is not empty, it will be used for the title of the
6831 window. This happens only when the 'title' option is on.
6832 Only works if the terminal supports setting window titles (currently
6833 Amiga console, Win32 console, all GUI versions and terminals with a
6834 non-empty 't_ts' option).
6835 When Vim was compiled with HAVE_X11 defined, the original title will
6836 be restored if possible |X11|.
6837 When this option contains printf-style '%' items, they will be
6838 expanded according to the rules used for 'statusline'.
6839 Example: >
6840 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6841 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6842< The value of 'titlelen' is used to align items in the middle or right
6843 of the available space.
6844 Some people prefer to have the file name first: >
6845 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6846< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006847 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006848 separating space only when needed.
6849 NOTE: Use of special characters in 'titlestring' may cause the display
6850 to be garbled (e.g., when it contains a CR or NL character).
6851 {not available when compiled without the |+statusline| feature}
6852
6853 *'toolbar'* *'tb'*
6854'toolbar' 'tb' string (default "icons,tooltips")
6855 global
6856 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6857 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006858 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006859 possible values are:
6860 icons Toolbar buttons are shown with icons.
6861 text Toolbar buttons shown with text.
6862 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006863 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006864 tooltips Tooltips are active for toolbar buttons.
6865 Tooltips refer to the popup help text which appears after the mouse
6866 cursor is placed over a toolbar button for a brief moment.
6867
6868 If you want the toolbar to be shown with icons as well as text, do the
6869 following: >
6870 :set tb=icons,text
6871< Motif and Athena cannot display icons and text at the same time. They
6872 will show icons if both are requested.
6873
6874 If none of the strings specified in 'toolbar' are valid or if
6875 'toolbar' is empty, this option is ignored. If you want to disable
6876 the toolbar, you need to set the 'guioptions' option. For example: >
6877 :set guioptions-=T
6878< Also see |gui-toolbar|.
6879
6880 *'toolbariconsize'* *'tbis'*
6881'toolbariconsize' 'tbis' string (default "small")
6882 global
6883 {not in Vi}
6884 {only in the GTK+ 2 GUI}
6885 Controls the size of toolbar icons. The possible values are:
6886 tiny Use tiny toolbar icons.
6887 small Use small toolbar icons (default).
6888 medium Use medium-sized toolbar icons.
6889 large Use large toolbar icons.
6890 The exact dimensions in pixels of the various icon sizes depend on
6891 the current theme. Common dimensions are large=32x32, medium=24x24,
6892 small=20x20 and tiny=16x16.
6893
6894 If 'toolbariconsize' is empty, the global default size as determined
6895 by user preferences or the current theme is used.
6896
6897 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6898'ttybuiltin' 'tbi' boolean (default on)
6899 global
6900 {not in Vi}
6901 When on, the builtin termcaps are searched before the external ones.
6902 When off the builtin termcaps are searched after the external ones.
6903 When this option is changed, you should set the 'term' option next for
6904 the change to take effect, for example: >
6905 :set notbi term=$TERM
6906< See also |termcap|.
6907 Rationale: The default for this option is "on", because the builtin
6908 termcap entries are generally better (many systems contain faulty
6909 xterm entries...).
6910
6911 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6912'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6913 sun-cmd, screen, rxvt, dtterm or
6914 iris-ansi; also on when running Vim in
6915 a DOS console)
6916 global
6917 {not in Vi}
6918 Indicates a fast terminal connection. More characters will be sent to
6919 the screen for redrawing, instead of using insert/delete line
6920 commands. Improves smoothness of redrawing when there are multiple
6921 windows and the terminal does not support a scrolling region.
6922 Also enables the extra writing of characters at the end of each screen
6923 line for lines that wrap. This helps when using copy/paste with the
6924 mouse in an xterm and other terminals.
6925
6926 *'ttymouse'* *'ttym'*
6927'ttymouse' 'ttym' string (default depends on 'term')
6928 global
6929 {not in Vi}
6930 {only in Unix and VMS, doesn't work in the GUI; not
6931 available when compiled without |+mouse|}
6932 Name of the terminal type for which mouse codes are to be recognized.
6933 Currently these three strings are valid:
6934 *xterm-mouse*
6935 xterm xterm-like mouse handling. The mouse generates
6936 "<Esc>[Mscr", where "scr" is three bytes:
6937 "s" = button state
6938 "c" = column plus 33
6939 "r" = row plus 33
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006940 This only works up to 223 columns! See "dec" for a
6941 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006942 xterm2 Works like "xterm", but with the xterm reporting the
6943 mouse position while the mouse is dragged. This works
6944 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006945 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00006946 work. See below for how Vim detects this
6947 automatically.
6948 *netterm-mouse*
6949 netterm NetTerm mouse handling. The mouse generates
6950 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6951 for the row and column.
6952 *dec-mouse*
6953 dec DEC terminal mouse handling. The mouse generates a
6954 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006955 This is also available for an Xterm, if it was
6956 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006957 *jsbterm-mouse*
6958 jsbterm JSB term mouse handling.
6959 *pterm-mouse*
6960 pterm QNX pterm mouse handling.
6961
6962 The mouse handling must be enabled at compile time |+mouse_xterm|
6963 |+mouse_dec| |+mouse_netterm|.
6964 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6965 recognized, if enabled at compile time. DEC terminal mouse codes
6966 are recognized if enabled at compile time, and 'ttymouse' is not
6967 "xterm" (because the xterm and dec mouse codes conflict).
6968 This option is automatically set to "xterm", when the 'term' option is
6969 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6970 or "xterm2" already. The main use of this option is to set it to
6971 "xterm", when the terminal name doesn't start with "xterm", but it can
6972 handle xterm mouse codes.
6973 The "xterm2" value will be set if the xterm version is reported to be
6974 95 of higher. This only works when compiled with the |+termresponse|
6975 feature and if |t_RV| is set to the escape sequence to request the
6976 xterm version number. Otherwise "xterm2" must be set explicitly.
6977 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6978 t_RV to an empty string: >
6979 :set t_RV=
6980<
6981 *'ttyscroll'* *'tsl'*
6982'ttyscroll' 'tsl' number (default 999)
6983 global
6984 Maximum number of lines to scroll the screen. If there are more lines
6985 to scroll the window is redrawn. For terminals where scrolling is
6986 very slow and redrawing is not slow this can be set to a small number,
6987 e.g., 3, to speed up displaying.
6988
6989 *'ttytype'* *'tty'*
6990'ttytype' 'tty' string (default from $TERM)
6991 global
6992 Alias for 'term', see above.
6993
6994 *'undolevels'* *'ul'*
6995'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
6996 Win32 and OS/2)
6997 global
6998 {not in Vi}
6999 Maximum number of changes that can be undone. Since undo information
7000 is kept in memory, higher numbers will cause more memory to be used
7001 (nevertheless, a single change can use an unlimited amount of memory).
7002 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7003 itself: >
7004 set ul=0
7005< But you can also get Vi compatibility by including the 'u' flag in
7006 'cpoptions', and still be able to use CTRL-R to repeat undo.
7007 Set to a negative number for no undo at all: >
7008 set ul=-1
7009< This helps when you run out of memory for a single change.
7010 Also see |undo-two-ways|.
7011
7012 *'updatecount'* *'uc'*
7013'updatecount' 'uc' number (default: 200)
7014 global
7015 {not in Vi}
7016 After typing this many characters the swap file will be written to
7017 disk. When zero, no swap file will be created at all (see chapter on
7018 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7019 Vim with the "-n" option, see |startup|. When editing in readonly
7020 mode this option will be initialized to 10000.
7021 The swapfile can be disabled per buffer with |'swapfile'|.
7022 When 'updatecount' is set from zero to non-zero, swap files are
7023 created for all buffers that have 'swapfile' set. When 'updatecount'
7024 is set to zero, existing swap files are not deleted.
7025 Also see |'swapsync'|.
7026 This option has no meaning in buffers where |'buftype'| is "nofile"
7027 or "nowrite".
7028
7029 *'updatetime'* *'ut'*
7030'updatetime' 'ut' number (default 4000)
7031 global
7032 {not in Vi}
7033 If this many milliseconds nothing is typed the swap file will be
7034 written to disk (see |crash-recovery|). Also used for the
7035 |CursorHold| autocommand event.
7036
7037 *'verbose'* *'vbs'*
7038'verbose' 'vbs' number (default 0)
7039 global
7040 {not in Vi, although some versions have a boolean
7041 verbose option}
7042 When bigger than zero, Vim will give messages about what it is doing.
7043 Currently, these messages are given:
7044 >= 1 When the viminfo file is read or written.
7045 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007046 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007047 >= 8 Files for which a group of autocommands is executed.
7048 >= 9 Every executed autocommand.
7049 >= 12 Every executed function.
7050 >= 13 When an exception is thrown, caught, finished, or discarded.
7051 >= 14 Anything pending in a ":finally" clause.
7052 >= 15 Every executed Ex command (truncated at 200 characters).
7053
7054 This option can also be set with the "-V" argument. See |-V|.
7055 This option is also set by the |:verbose| command.
7056
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007057 When the 'verbosefile' option is set then the verbose messages are not
7058 displayed.
7059
7060 *'verbosefile'* *'vfile'*
7061'verbosefile' 'vfile' string (default empty)
7062 global
7063 {not in Vi}
7064 When not empty all messages are written in a file with this name.
7065 When the file exists messages are appended.
7066 Writing to the file ends when Vim exits or when 'verbosefile' is made
7067 empty.
7068 Setting 'verbosefile' to a new value is like making it empty first.
7069 The difference with |:redir| is that verbose messages are not
7070 displayed when 'verbosefile' is set.
7071
Bram Moolenaar071d4272004-06-13 20:20:40 +00007072 *'viewdir'* *'vdir'*
7073'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7074 "$VIM/vimfiles/view",
7075 for Unix: "~/.vim/view",
7076 for Macintosh: "$VIM:vimfiles:view"
7077 for VMS: "sys$login:vimfiles/view"
7078 for RiscOS: "Choices:vimfiles/view")
7079 global
7080 {not in Vi}
7081 {not available when compiled without the +mksession
7082 feature}
7083 Name of the directory where to store files for |:mkview|.
7084 This option cannot be set from a |modeline| or in the |sandbox|, for
7085 security reasons.
7086
7087 *'viewoptions'* *'vop'*
7088'viewoptions' 'vop' string (default: "folds,options,cursor")
7089 global
7090 {not in Vi}
7091 {not available when compiled without the +mksession
7092 feature}
7093 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007094 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007095 word save and restore ~
7096 cursor cursor position in file and in window
7097 folds manually created folds, opened/closed folds and local
7098 fold options
7099 options options and mappings local to a window or buffer (not
7100 global values for local options)
7101 slash backslashes in file names replaced with forward
7102 slashes
7103 unix with Unix end-of-line format (single <NL>), even when
7104 on Windows or DOS
7105
7106 "slash" and "unix" are useful on Windows when sharing view files
7107 with Unix. The Unix version of Vim cannot source dos format scripts,
7108 but the Windows version of Vim can source unix format scripts.
7109
7110 *'viminfo'* *'vi'* *E526* *E527* *E528*
7111'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
7112 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
7113 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
7114 for others: '20,<50,s10,h)
7115 global
7116 {not in Vi}
7117 {not available when compiled without the |+viminfo|
7118 feature}
7119 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007120 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007121 separated list of parameters, each consisting of a single character
7122 identifying the particular parameter, followed by a number or string
7123 which specifies the value of that parameter. If a particular
7124 character is left out, then the default value is used for that
7125 parameter. The following is a list of the identifying characters and
7126 the effect of their value.
7127 CHAR VALUE ~
7128 ! When included, save and restore global variables that start
7129 with an uppercase letter, and don't contain a lowercase
7130 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007131 and "_K_L_M" are not. Only String and Number types are
7132 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007133 " Maximum number of lines saved for each register. Old name of
7134 the '<' item, with the disadvantage that you need to put a
7135 backslash before the ", otherwise it will be recognized as the
7136 start of a comment!
7137 % When included, save and restore the buffer list. If Vim is
7138 started with a file name argument, the buffer list is not
7139 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007140 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007141 without a file name and buffers for help files are not written
7142 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007143 When followed by a number, the number specifies the maximum
7144 number of buffers that are stored. Without a number all
7145 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007146 ' Maximum number of previously edited files for which the marks
7147 are remembered. This parameter must always be included when
7148 'viminfo' is non-empty.
7149 Including this item also means that the |jumplist| and the
7150 |changelist| are stored in the viminfo file.
7151 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007152 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007153 patterns are also saved. When not included, the value of
7154 'history' is used.
7155 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007156 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007157 < Maximum number of lines saved for each register. If zero then
7158 registers are not saved. When not included, all lines are
7159 saved. '"' is the old name for this item.
7160 Also see the 's' item below: limit specified in Kbyte.
7161 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007162 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007163 c When included, convert the text in the viminfo file from the
7164 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007165 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007166 f Whether file marks need to be stored. If zero, file marks ('0
7167 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007168 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007169 cursor position (when exiting or when doing ":wviminfo").
7170 h Disable the effect of 'hlsearch' when loading the viminfo
7171 file. When not included, it depends on whether ":nohlsearch"
7172 has been used since the last search command.
7173 n Name of the viminfo file. The name must immediately follow
7174 the 'n'. Must be the last one! If the "-i" argument was
7175 given when starting Vim, that file name overrides the one
7176 given here with 'viminfo'. Environment variables are expanded
7177 when opening the file, not when setting the option.
7178 r Removable media. The argument is a string (up to the next
7179 ','). This parameter can be given several times. Each
7180 specifies the start of a path for which no marks will be
7181 stored. This is to avoid removable media. For MS-DOS you
7182 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7183 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7184 ignored. Maximum length of each 'r' argument is 50
7185 characters.
7186 s Maximum size of an item in Kbyte. If zero then registers are
7187 not saved. Currently only applies to registers. The default
7188 "s10" will exclude registers with more than 10 Kbyte of text.
7189 Also see the '<' item above: line count limit.
7190
7191 Example: >
7192 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7193<
7194 '50 Marks will be remembered for the last 50 files you
7195 edited.
7196 <1000 Contents of registers (up to 1000 lines each) will be
7197 remembered.
7198 s100 Registers with more than 100 Kbyte text are skipped.
7199 :0 Command-line history will not be saved.
7200 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7201 no / Since '/' is not specified, the default will be used,
7202 that is, save all of the search history, and also the
7203 previous search and substitute patterns.
7204 no % The buffer list will not be saved nor read back.
7205 no h 'hlsearch' highlighting will be restored.
7206
7207 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7208 load the contents of the file, this is not done automatically.
7209
7210 This option cannot be set from a |modeline| or in the |sandbox|, for
7211 security reasons.
7212
7213 *'virtualedit'* *'ve'*
7214'virtualedit' 've' string (default "")
7215 global
7216 {not in Vi}
7217 {not available when compiled without the
7218 |+virtualedit| feature}
7219 A comma separated list of these words:
7220 block Allow virtual editing in Visual block mode.
7221 insert Allow virtual editing in Insert mode.
7222 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007223 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007224
Bram Moolenaar071d4272004-06-13 20:20:40 +00007225 Virtual editing means that the cursor can be positioned where there is
7226 no actual character. This can be halfway into a Tab or beyond the end
7227 of the line. Useful for selecting a rectangle in Visual mode and
7228 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007229 "onemore" is not the same, it will only allow moving the cursor just
7230 after the last character of the line. This makes some commands more
7231 consistent. Previously the cursor was always past the end of the line
7232 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007233 break some plugins or Vim scripts. For example because |l| can move
7234 the cursor after the last character. Use with care!
7235 Using the |$| command will move to the last character in the line, not
7236 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007237 It doesn't make sense to combine "all" with "onemore", but you will
7238 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007239
7240 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7241'visualbell' 'vb' boolean (default off)
7242 global
7243 {not in Vi}
7244 Use visual bell instead of beeping. The terminal code to display the
7245 visual bell is given with 't_vb'. When no beep or flash is wanted,
7246 use ":set vb t_vb=".
7247 Note: When the GUI starts, 't_vb' is reset to its default value. You
7248 might want to set it again in your |gvimrc|.
7249 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7250 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7251 where 40 is the time in msec.
7252 Does not work on the Amiga, you always get a screen flash.
7253 Also see 'errorbells'.
7254
7255 *'warn'* *'nowarn'*
7256'warn' boolean (default on)
7257 global
7258 Give a warning message when a shell command is used while the buffer
7259 has been changed.
7260
7261 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7262'weirdinvert' 'wiv' boolean (default off)
7263 global
7264 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007265 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007266 It is provided for backwards compatibility with version 4.x.
7267 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7268 vice versa. Has no effect when the GUI is running.
7269
7270 *'whichwrap'* *'ww'*
7271'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7272 global
7273 {not in Vi}
7274 Allow specified keys that move the cursor left/right to move to the
7275 previous/next line when the cursor is on the first/last character in
7276 the line. Concatenate characters to allow this for these keys:
7277 char key mode ~
7278 b <BS> Normal and Visual
7279 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007280 h "h" Normal and Visual (not recommended)
7281 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007282 < <Left> Normal and Visual
7283 > <Right> Normal and Visual
7284 ~ "~" Normal
7285 [ <Left> Insert and Replace
7286 ] <Right> Insert and Replace
7287 For example: >
7288 :set ww=<,>,[,]
7289< allows wrap only when cursor keys are used.
7290 When the movement keys are used in combination with a delete or change
7291 operator, the <EOL> also counts for a character. This makes "3h"
7292 different from "3dh" when the cursor crosses the end of a line. This
7293 is also true for "x" and "X", because they do the same as "dl" and
7294 "dh". If you use this, you may also want to use the mapping
7295 ":map <BS> X" to make backspace delete the character in front of the
7296 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007297 When 'l' is included and it is used after an operator at the end of a
7298 line then it will not move to the next line. This makes "dl", "cl",
7299 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007300 NOTE: This option is set to the Vi default value when 'compatible' is
7301 set and to the Vim default value when 'compatible' is reset.
7302
7303 *'wildchar'* *'wc'*
7304'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7305 global
7306 {not in Vi}
7307 Character you have to type to start wildcard expansion in the
7308 command-line, as specified with 'wildmode'.
7309 The character is not recognized when used inside a macro. See
7310 'wildcharm' for that.
7311 Although 'wc' is a number option, you can set it to a special key: >
7312 :set wc=<Esc>
7313< NOTE: This option is set to the Vi default value when 'compatible' is
7314 set and to the Vim default value when 'compatible' is reset.
7315
7316 *'wildcharm'* *'wcm'*
7317'wildcharm' 'wcm' number (default: none (0))
7318 global
7319 {not in Vi}
7320 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007321 recognized when used inside a macro. You can find "spare" command-line
7322 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007323 you'll never actually type 'wildcharm', just use it in mappings that
7324 automatically invoke completion mode, e.g.: >
7325 :set wcm=<C-Z>
7326 :cmap ss so $vim/sessions/*.vim<C-Z>
7327< Then after typing :ss you can use CTRL-P & CTRL-N.
7328
7329 *'wildignore'* *'wig'*
7330'wildignore' 'wig' string (default "")
7331 global
7332 {not in Vi}
7333 {not available when compiled without the |+wildignore|
7334 feature}
7335 A list of file patterns. A file that matches with one of these
7336 patterns is ignored when completing file or directory names.
7337 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7338 Also see 'suffixes'.
7339 Example: >
7340 :set wildignore=*.o,*.obj
7341< The use of |:set+=| and |:set-=| is preferred when adding or removing
7342 a pattern from the list. This avoids problems when a future version
7343 uses another default.
7344
7345 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7346'wildmenu' 'wmnu' boolean (default off)
7347 global
7348 {not in Vi}
7349 {not available if compiled without the |+wildmenu|
7350 feature}
7351 When 'wildmenu' is on, command-line completion operates in an enhanced
7352 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7353 the possible matches are shown just above the command line, with the
7354 first match highlighted (overwriting the status line, if there is
7355 one). Keys that show the previous/next match, such as <Tab> or
7356 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7357 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7358 specified. "longest" and "list" do not start "wildmenu" mode.
7359 If there are more matches than can fit in the line, a ">" is shown on
7360 the right and/or a "<" is shown on the left. The status line scrolls
7361 as needed.
7362 The "wildmenu" mode is abandoned when a key is hit that is not used
7363 for selecting a completion.
7364 While the "wildmenu" is active the following keys have special
7365 meanings:
7366
7367 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7368 <Down> - in filename/menu name completion: move into a
7369 subdirectory or submenu.
7370 <CR> - in menu completion, when the cursor is just after a
7371 dot: move into a submenu.
7372 <Up> - in filename/menu name completion: move up into
7373 parent directory or parent menu.
7374
7375 This makes the menus accessible from the console |console-menus|.
7376
7377 If you prefer the <Left> and <Right> keys to move the cursor instead
7378 of selecting a different match, use this: >
7379 :cnoremap <Left> <Space><BS><Left>
7380 :cnoremap <Right> <Space><BS><Right>
7381<
7382 The "WildMenu" highlighting is used for displaying the current match
7383 |hl-WildMenu|.
7384
7385 *'wildmode'* *'wim'*
7386'wildmode' 'wim' string (Vim default: "full")
7387 global
7388 {not in Vi}
7389 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007390 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00007391 part specifies what to do for each consecutive use of 'wildchar. The
7392 first part specifies the behavior for the first use of 'wildchar',
7393 The second part for the second use, etc.
7394 These are the possible values for each part:
7395 "" Complete only the first match.
7396 "full" Complete the next full match. After the last match,
7397 the original string is used and then the first match
7398 again.
7399 "longest" Complete till longest common string. If this doesn't
7400 result in a longer string, use the next part.
7401 "longest:full" Like "longest", but also start 'wildmenu' if it is
7402 enabled.
7403 "list" When more than one match, list all matches.
7404 "list:full" When more than one match, list all matches and
7405 complete first match.
7406 "list:longest" When more than one match, list all matches and
7407 complete till longest common string.
7408 When there is only a single match, it is fully completed in all cases.
7409
7410 Examples: >
7411 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007412< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007413 :set wildmode=longest,full
7414< Complete longest common string, then each full match >
7415 :set wildmode=list:full
7416< List all matches and complete each full match >
7417 :set wildmode=list,full
7418< List all matches without completing, then each full match >
7419 :set wildmode=longest,list
7420< Complete longest common string, then list alternatives.
7421
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007422 *'wildoptions'* *'wop'*
7423'wildoptions' 'wop' string (default "")
7424 global
7425 {not in Vi}
7426 {not available when compiled without the |+wildignore|
7427 feature}
7428 A list of words that change how command line completion is done.
7429 Currently only one word is allowed:
7430 tagfile When using CTRL-D to list matching tags, the kind of
7431 tag and the file of the tag is listed. Only one match
7432 is displayed per line. Often used tag kinds are:
7433 d #define
7434 f function
7435 Also see |cmdline-completion|.
7436
Bram Moolenaar071d4272004-06-13 20:20:40 +00007437 *'winaltkeys'* *'wak'*
7438'winaltkeys' 'wak' string (default "menu")
7439 global
7440 {not in Vi}
7441 {only used in Win32, Motif, GTK and Photon GUI}
7442 Some GUI versions allow the access to menu entries by using the ALT
7443 key in combination with a character that appears underlined in the
7444 menu. This conflicts with the use of the ALT key for mappings and
7445 entering special characters. This option tells what to do:
7446 no Don't use ALT keys for menus. ALT key combinations can be
7447 mapped, but there is no automatic handling. This can then be
7448 done with the |:simalt| command.
7449 yes ALT key handling is done by the windowing system. ALT key
7450 combinations cannot be mapped.
7451 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007452 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007453 keys can be mapped.
7454 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7455 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007456 This option is not used for <F10>; on Win32 and with GTK <F10> will
7457 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007458
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007459 *'window'* *'wi'*
7460'window' 'wi' number (default screen height - 1)
7461 global
7462 Window height. Do not confuse this with the height of the Vim window,
7463 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007464 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7465 value is smaller than 'lines' minus one. The screen will scroll
7466 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007467 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7468 in a much smarter way, taking care of wrapping lines.
7469 When resizing the Vim window, the value is smaller than 1 or more than
7470 or equal to 'lines' it will be set to 'lines' minus 1.
7471 {Vi also uses the option to specify the number of displayed lines}
7472
Bram Moolenaar071d4272004-06-13 20:20:40 +00007473 *'winheight'* *'wh'* *E591*
7474'winheight' 'wh' number (default 1)
7475 global
7476 {not in Vi}
7477 {not available when compiled without the +windows
7478 feature}
7479 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007480 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007481 current window is smaller, its size is increased, at the cost of the
7482 height of other windows. Set it to 999 to make the current window
7483 always fill the screen (although this has the drawback that ":all"
7484 will create only two windows). Set it to a small number for normal
7485 editing.
7486 Minimum value is 1.
7487 The height is not adjusted after one of the commands to change the
7488 height of the current window.
7489 'winheight' applies to the current window. Use 'winminheight' to set
7490 the minimal height for other windows.
7491
7492 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7493'winfixheight' 'wfh' boolean (default off)
7494 local to window
7495 {not in Vi}
7496 {not available when compiled without the +windows
7497 feature}
7498 Keep the window height when windows are opened or closed and
7499 'equalalways' is set. Set by default for the |preview-window| and
7500 |quickfix-window|.
7501 The height may be changed anyway when running out of room.
7502
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007503 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7504'winfixwidth' 'wfw' boolean (default off)
7505 local to window
7506 {not in Vi}
7507 {not available when compiled without the +windows
7508 feature}
7509 Keep the window width when windows are opened or closed and
7510 'equalalways' is set.
7511 The width may be changed anyway when running out of room.
7512
Bram Moolenaar071d4272004-06-13 20:20:40 +00007513 *'winminheight'* *'wmh'*
7514'winminheight' 'wmh' number (default 1)
7515 global
7516 {not in Vi}
7517 {not available when compiled without the +windows
7518 feature}
7519 The minimal height of a window, when it's not the current window.
7520 This is a hard minimum, windows will never become smaller.
7521 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7522 status bar) if necessary. They will return to at least one line when
7523 they become active (since the cursor has to have somewhere to go.)
7524 Use 'winheight' to set the minimal height of the current window.
7525 This option is only checked when making a window smaller. Don't use a
7526 large number, it will cause errors when opening more than a few
7527 windows. A value of 0 to 3 is reasonable.
7528
7529 *'winminwidth'* *'wmw'*
7530'winminwidth' 'wmw' number (default 1)
7531 global
7532 {not in Vi}
7533 {not available when compiled without the +vertsplit
7534 feature}
7535 The minimal width of a window, when it's not the current window.
7536 This is a hard minimum, windows will never become smaller.
7537 When set to zero, windows may be "squashed" to zero columns (i.e. just
7538 a vertical separator) if necessary. They will return to at least one
7539 line when they become active (since the cursor has to have somewhere
7540 to go.)
7541 Use 'winwidth' to set the minimal width of the current window.
7542 This option is only checked when making a window smaller. Don't use a
7543 large number, it will cause errors when opening more than a few
7544 windows. A value of 0 to 12 is reasonable.
7545
7546 *'winwidth'* *'wiw'* *E592*
7547'winwidth' 'wiw' number (default 20)
7548 global
7549 {not in Vi}
7550 {not available when compiled without the +vertsplit
7551 feature}
7552 Minimal number of columns for the current window. This is not a hard
7553 minimum, Vim will use fewer columns if there is not enough room. If
7554 the current window is smaller, its size is increased, at the cost of
7555 the width of other windows. Set it to 999 to make the current window
7556 always fill the screen. Set it to a small number for normal editing.
7557 The width is not adjusted after one of the commands to change the
7558 width of the current window.
7559 'winwidth' applies to the current window. Use 'winminwidth' to set
7560 the minimal width for other windows.
7561
7562 *'wrap'* *'nowrap'*
7563'wrap' boolean (default on)
7564 local to window
7565 {not in Vi}
7566 This option changes how text is displayed. It doesn't change the text
7567 in the buffer, see 'textwidth' for that.
7568 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007569 displaying continues on the next line. When off lines will not wrap
7570 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007571 moved to a part that is not shown, the screen will scroll
7572 horizontally.
7573 The line will be broken in the middle of a word if necessary. See
7574 'linebreak' to get the break at a word boundary.
7575 To make scrolling horizontally a bit more useful, try this: >
7576 :set sidescroll=5
7577 :set listchars+=precedes:<,extends:>
7578< See 'sidescroll', 'listchars' and |wrap-off|.
7579
7580 *'wrapmargin'* *'wm'*
7581'wrapmargin' 'wm' number (default 0)
7582 local to buffer
7583 Number of characters from the right window border where wrapping
7584 starts. When typing text beyond this limit, an <EOL> will be inserted
7585 and inserting continues on the next line.
7586 Options that add a margin, such as 'number' and 'foldcolumn', cause
7587 the text width to be further reduced. This is Vi compatible.
7588 When 'textwidth' is non-zero, this option is not used.
7589 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7590 and less usefully}
7591
7592 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7593'wrapscan' 'ws' boolean (default on) *E384* *E385*
7594 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007595 Searches wrap around the end of the file. Also applies to |]s| and
7596 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007597
7598 *'write'* *'nowrite'*
7599'write' boolean (default on)
7600 global
7601 {not in Vi}
7602 Allows writing files. When not set, writing a file is not allowed.
7603 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007604 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007605 argument. Filtering text is still possible, even though this requires
7606 writing a temporary file.
7607
7608 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7609'writeany' 'wa' boolean (default off)
7610 global
7611 Allows writing to any file with no need for "!" override.
7612
7613 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7614'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7615 otherwise)
7616 global
7617 {not in Vi}
7618 Make a backup before overwriting a file. The backup is removed after
7619 the file was successfully written, unless the 'backup' option is
7620 also on. Reset this option if your file system is almost full. See
7621 |backup-table| for another explanation.
7622 When the 'backupskip' pattern matches, a backup is not made anyway.
7623 NOTE: This option is set to the default value when 'compatible' is
7624 set.
7625
7626 *'writedelay'* *'wd'*
7627'writedelay' 'wd' number (default 0)
7628 global
7629 {not in Vi}
7630 The number of microseconds to wait for each character sent to the
7631 screen. When non-zero, characters are sent to the terminal one by
7632 one. For MS-DOS pcterm this does not work. For debugging purposes.
7633
7634 vim:tw=78:ts=8:ft=help:norl: