blob: 1c5f5def5e3dfa98a2e08e1e8949e7d9afd05c58 [file] [log] [blame]
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001*options.txt* For Vim version 7.0c. Last change: 2006 Apr 09
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.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001445 The value of this option is stored with the tab page, so that each tab
1446 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001447
1448 *'cmdwinheight'* *'cwh'*
1449'cmdwinheight' 'cwh' number (default 7)
1450 global
1451 {not in Vi}
1452 {not available when compiled without the |+vertsplit|
1453 feature}
1454 Number of screen lines to use for the command-line window. |cmdwin|
1455
1456 *'columns'* *'co'* *E594*
1457'columns' 'co' number (default 80 or terminal width)
1458 global
1459 {not in Vi}
1460 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001461 initialization and does not have to be set by hand. Also see
1462 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001463 When Vim is running in the GUI or in a resizable window, setting this
1464 option will cause the window size to be changed. When you only want
1465 to use the size for the GUI, put the command in your |gvimrc| file.
1466 When you set this option and Vim is unable to change the physical
1467 number of columns of the display, the display may be messed up.
Bram Moolenaarf4d11452005-12-02 00:46:37 +00001468 Mimimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001469
1470 *'comments'* *'com'* *E524* *E525*
1471'comments' 'com' string (default
1472 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1473 local to buffer
1474 {not in Vi}
1475 {not available when compiled without the |+comments|
1476 feature}
1477 A comma separated list of strings that can start a comment line. See
1478 |format-comments|. See |option-backslash| about using backslashes to
1479 insert a space.
1480
1481 *'commentstring'* *'cms'* *E537*
1482'commentstring' 'cms' string (default "/*%s*/")
1483 local to buffer
1484 {not in Vi}
1485 {not available when compiled without the |+folding|
1486 feature}
1487 A template for a comment. The "%s" in the value is replaced with the
1488 comment text. Currently only used to add markers for folding, see
1489 |fold-marker|.
1490
1491 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001492'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1493 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001494 global
1495 {not in Vi}
1496 This option has the effect of making Vim either more Vi-compatible, or
1497 make Vim behave in a more useful way.
1498 This is a special kind of option, because when it's set or reset,
1499 other options are also changed as a side effect. CAREFUL: Setting or
1500 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001501 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001502 set this option in your vimrc file, you should probably put it at the
1503 very start.
1504 By default this option is on and the Vi defaults are used for the
1505 options. This default was chosen for those people who want to use Vim
1506 just like Vi, and don't even (want to) know about the 'compatible'
1507 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001508 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001509 this option is switched off, and all options that have not been
1510 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001511 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001512 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
1513 happen for the system-wide vimrc or gvimrc file). Also see
1514 |compatible-default| and |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001515 You can also set this option with the "-C" argument, and reset it with
1516 "-N". See |-C| and |-N|.
1517 Switching this option off makes the Vim defaults be used for options
1518 that have a different Vi and Vim default value. See the options
1519 marked with a '+' below. Other options are not modified.
1520 At the moment this option is set, several other options will be set
1521 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001522 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001523 editing.
1524 See also 'cpoptions'.
1525
1526 option + set value effect ~
1527
1528 'allowrevins' off no CTRL-_ command
1529 'backupcopy' Unix: "yes" backup file is a copy
1530 others: "auto" copy or rename backup file
1531 'backspace' "" normal backspace
1532 'backup' off no backup file
1533 'cindent' off no C code indentation
1534 'cedit' + "" no key to open the |cmdwin|
1535 'cpoptions' + (all flags) Vi-compatible flags
1536 'cscopetag' off don't use cscope for ":tag"
1537 'cscopetagorder' 0 see |cscopetagorder|
1538 'cscopeverbose' off see |cscopeverbose|
1539 'digraph' off no digraphs
1540 'esckeys' + off no <Esc>-keys in Insert mode
1541 'expandtab' off tabs not expanded to spaces
1542 'fileformats' + "" no automatic file format detection,
1543 "dos,unix" except for DOS, Windows and OS/2
1544 'formatoptions' + "vt" Vi compatible formatting
1545 'gdefault' off no default 'g' flag for ":s"
1546 'history' + 0 no commandline history
1547 'hkmap' off no Hebrew keyboard mapping
1548 'hkmapp' off no phonetic Hebrew keyboard mapping
1549 'hlsearch' off no highlighting of search matches
1550 'incsearch' off no incremental searching
1551 'indentexpr' "" no indenting by expression
1552 'insertmode' off do not start in Insert mode
1553 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1554 characters and '_'
1555 'joinspaces' on insert 2 spaces after period
1556 'modeline' + off no modelines
1557 'more' + off no pauses in listings
1558 'revins' off no reverse insert
1559 'ruler' off no ruler
1560 'scrolljump' 1 no jump scroll
1561 'scrolloff' 0 no scroll offset
1562 'shiftround' off indent not rounded to shiftwidth
1563 'shortmess' + "" no shortening of messages
1564 'showcmd' + off command characters not shown
1565 'showmode' + off current mode not shown
1566 'smartcase' off no automatic ignore case switch
1567 'smartindent' off no smart indentation
1568 'smarttab' off no smart tab size
1569 'softtabstop' 0 tabs are always 'tabstop' positions
1570 'startofline' on goto startofline with some commands
1571 'tagrelative' + off tag file names are not relative
1572 'textauto' + off no automatic textmode detection
1573 'textwidth' 0 no automatic line wrap
1574 'tildeop' off tilde is not an operator
1575 'ttimeout' off no terminal timeout
1576 'whichwrap' + "" left-right movements don't wrap
1577 'wildchar' + CTRL-E only when the current value is <Tab>
1578 use CTRL-E for cmdline completion
1579 'writebackup' on or off depends on +writebackup feature
1580
1581 *'complete'* *'cpt'* *E535*
1582'complete' 'cpt' string (default: ".,w,b,u,t,i")
1583 local to buffer
1584 {not in Vi}
1585 This option specifies how keyword completion |ins-completion| works
1586 when CTRL-P or CTRL-N are used. It is also used for whole-line
1587 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1588 and the places to scan. It is a comma separated list of flags:
1589 . scan the current buffer ('wrapscan' is ignored)
1590 w scan buffers from other windows
1591 b scan other loaded buffers that are in the buffer list
1592 u scan the unloaded buffers that are in the buffer list
1593 U scan the buffers that are not in the buffer list
1594 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001595 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001596 k{dict} scan the file {dict}. Several "k" flags can be given,
1597 patterns are valid too. For example: >
1598 :set cpt=k/usr/dict/*,k~/spanish
1599< s scan the files given with the 'thesaurus' option
1600 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1601 are valid too.
1602 i scan current and included files
1603 d scan current and included files for defined name or macro
1604 |i_CTRL-X_CTRL-D|
1605 ] tag completion
1606 t same as "]"
1607
1608 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1609 not executed, this may lead to unexpected completions from some files
1610 (gzipped files for example). Unloaded buffers are not scanned for
1611 whole-line completion.
1612
1613 The default is ".,w,b,u,t,i", which means to scan:
1614 1. the current buffer
1615 2. buffers in other windows
1616 3. other loaded buffers
1617 4. unloaded buffers
1618 5. tags
1619 6. included files
1620
1621 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001622 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1623 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001624
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001625 *'completefunc'* *'cfu'*
1626'completefunc' 'cfu' string (default: empty)
1627 local to buffer
1628 {not in Vi}
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001629 {not available when compiled without the +eval
1630 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001631 This option specifies a function to be used for Insert mode completion
1632 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001633 See |complete-functions| for an explanation of how the function is
1634 invoked and what it should return.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001635
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001636
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001637 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001638'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001639 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001640 {not available when compiled without the
1641 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001642 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001643 A comma separated list of options for Insert mode completion
1644 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001645
1646 menu Use a popup menu to show the possible completions. The
1647 menu is only shown when there is more than one match and
1648 sufficient colors are available. |ins-completion-menu|
1649
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001650 menuone Use the popup menu also when there is only one match.
1651 Useful when there is additional information about the
1652 match, e.g., what file it comes from.
1653
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001654 longest Only insert the longest common text of the matches. Use
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001655 CTRL-L to add more characters. Whether case is ignored
Bram Moolenaard1f56e62006-02-22 21:25:37 +00001656 depends on the kind of completion. For buffer text the
1657 'ignorecase' option is used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001658
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001659 preview Show extra information about the currently selected
1660 completion in the preview window.
1661
Bram Moolenaar071d4272004-06-13 20:20:40 +00001662 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1663'confirm' 'cf' boolean (default off)
1664 global
1665 {not in Vi}
1666 When 'confirm' is on, certain operations that would normally
1667 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1668 instead raise a |dialog| asking if you wish to save the current
1669 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1670 If 'confirm' is off you can still activate confirmation for one
1671 command only (this is most useful in mappings) with the |:confirm|
1672 command.
1673 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1674
1675 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1676'conskey' 'consk' boolean (default off)
1677 global
1678 {not in Vi} {only for MS-DOS}
1679 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001680 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001681 three methods of console input are available:
1682 'conskey' 'bioskey' action ~
1683 on on or off direct console input
1684 off on BIOS
1685 off off STDIN
1686
1687 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1688'copyindent' 'ci' boolean (default off)
1689 local to buffer
1690 {not in Vi}
1691 Copy the structure of the existing lines indent when autoindenting a
1692 new line. Normally the new indent is reconstructed by a series of
1693 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1694 in which case only spaces are used). Enabling this option makes the
1695 new line copy whatever characters were used for indenting on the
1696 existing line. If the new indent is greater than on the existing
1697 line, the remaining space is filled in the normal manner.
1698 NOTE: 'copyindent' is reset when 'compatible' is set.
1699 Also see 'preserveindent'.
1700
1701 *'cpoptions'* *'cpo'*
1702'cpoptions' 'cpo' string (Vim default: "aABceFs",
1703 Vi default: all flags)
1704 global
1705 {not in Vi}
1706 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001707 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001708 not being vi-compatible is mostly or sometimes preferred.
1709 'cpoptions' stands for "compatible-options".
1710 Commas can be added for readability.
1711 To avoid problems with flags that are added in the future, use the
1712 "+=" and "-=" feature of ":set" |add-option-flags|.
1713 NOTE: This option is set to the Vi default value when 'compatible' is
1714 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001715 NOTE: This option is set to the POSIX default value at startup when
1716 the Vi default value would be used and the $VIM_POSIX environment
1717 variable exists |posix|. This means tries to behave like the POSIX
1718 specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001719
1720 contains behavior ~
1721 *cpo-a*
1722 a When included, a ":read" command with a file name
1723 argument will set the alternate file name for the
1724 current window.
1725 *cpo-A*
1726 A When included, a ":write" command with a file name
1727 argument will set the alternate file name for the
1728 current window.
1729 *cpo-b*
1730 b "\|" in a ":map" command is recognized as the end of
1731 the map command. The '\' is included in the mapping,
1732 the text after the '|' is interpreted as the next
1733 command. Use a CTRL-V instead of a backslash to
1734 include the '|' in the mapping. Applies to all
1735 mapping, abbreviation, menu and autocmd commands.
1736 See also |map_bar|.
1737 *cpo-B*
1738 B A backslash has no special meaning in mappings,
1739 abbreviations and the "to" part of the menu commands.
1740 Remove this flag to be able to use a backslash like a
1741 CTRL-V. For example, the command ":map X \<Esc>"
1742 results in X being mapped to:
1743 'B' included: "\^[" (^[ is a real <Esc>)
1744 'B' excluded: "<Esc>" (5 characters)
1745 ('<' excluded in both cases)
1746 *cpo-c*
1747 c Searching continues at the end of any match at the
1748 cursor position, but not further than the start of the
1749 next line. When not present searching continues
1750 one character from the cursor position. With 'c'
1751 "abababababab" only gets three matches when repeating
1752 "/abab", without 'c' there are five matches.
1753 *cpo-C*
1754 C Do not concatenate sourced lines that start with a
1755 backslash. See |line-continuation|.
1756 *cpo-d*
1757 d Using "./" in the 'tags' option doesn't mean to use
1758 the tags file relative to the current file, but the
1759 tags file in the current directory.
1760 *cpo-D*
1761 D Can't use CTRL-K to enter a digraph after Normal mode
1762 commands with a character argument, like |r|, |f| and
1763 |t|.
1764 *cpo-e*
1765 e When executing a register with ":@r", always add a
1766 <CR> to the last line, also when the register is not
1767 linewise. If this flag is not present, the register
1768 is not linewise and the last line does not end in a
1769 <CR>, then the last line is put on the command-line
1770 and can be edited before hitting <CR>.
1771 *cpo-E*
1772 E It is an error when using "y", "d", "c", "g~", "gu" or
1773 "gU" on an Empty region. The operators only work when
1774 at least one character is to be operate on. Example:
1775 This makes "y0" fail in the first column.
1776 *cpo-f*
1777 f When included, a ":read" command with a file name
1778 argument will set the file name for the current buffer,
1779 if the current buffer doesn't have a file name yet.
1780 *cpo-F*
1781 F When included, a ":write" command with a file name
1782 argument will set the file name for the current
1783 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001784 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001785 *cpo-g*
1786 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001787 *cpo-H*
1788 H When using "I" on a line with only blanks, insert
1789 before the last blank. Without this flag insert after
1790 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001791 *cpo-i*
1792 i When included, interrupting the reading of a file will
1793 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001794 *cpo-I*
1795 I When moving the cursor up or down just after inserting
1796 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001797 *cpo-j*
1798 j When joining lines, only add two spaces after a '.',
1799 not after '!' or '?'. Also see 'joinspaces'.
1800 *cpo-J*
1801 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001802 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001803 white space.
1804 *cpo-k*
1805 k Disable the recognition of raw key codes in
1806 mappings, abbreviations, and the "to" part of menu
1807 commands. For example, if <Key> sends ^[OA (where ^[
1808 is <Esc>), the command ":map X ^[OA" results in X
1809 being mapped to:
1810 'k' included: "^[OA" (3 characters)
1811 'k' excluded: "<Key>" (one key code)
1812 Also see the '<' flag below.
1813 *cpo-K*
1814 K Don't wait for a key code to complete when it is
1815 halfway a mapping. This breaks mapping <F1><F1> when
1816 only part of the second <F1> has been read. It
1817 enables cancelling the mapping by typing <F1><Esc>.
1818 *cpo-l*
1819 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001820 literally, only "\]", "\^", "\-" and "\\" are special.
1821 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001822 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1823 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001824 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001825 *cpo-L*
1826 L When the 'list' option is set, 'wrapmargin',
1827 'textwidth', 'softtabstop' and Virtual Replace mode
1828 (see |gR|) count a <Tab> as two characters, instead of
1829 the normal behavior of a <Tab>.
1830 *cpo-m*
1831 m When included, a showmatch will always wait half a
1832 second. When not included, a showmatch will wait half
1833 a second or until a character is typed. |'showmatch'|
1834 *cpo-M*
1835 M When excluded, "%" matching will take backslashes into
1836 account. Thus in "( \( )" and "\( ( \)" the outer
1837 parenthesis match. When included "%" ignores
1838 backslashes, which is Vi compatible.
1839 *cpo-n*
1840 n When included, the column used for 'number' will also
1841 be used for text of wrapped lines.
1842 *cpo-o*
1843 o Line offset to search command is not remembered for
1844 next search.
1845 *cpo-O*
1846 O Don't complain if a file is being overwritten, even
1847 when it didn't exist when editing it. This is a
1848 protection against a file unexpectedly created by
1849 someone else. Vi didn't complain about this.
1850 *cpo-p*
1851 p Vi compatible Lisp indenting. When not present, a
1852 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001853 *cpo-P*
1854 P When included, a ":write" command that appends to a
1855 file will set the file name for the current buffer, if
1856 the current buffer doesn't have a file name yet and
1857 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001858 *cpo-q*
1859 q When joining multiple lines leave the cursor at the
1860 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001861 *cpo-r*
1862 r Redo ("." command) uses "/" to repeat a search
1863 command, instead of the actually used search string.
1864 *cpo-R*
1865 R Remove marks from filtered lines. Without this flag
1866 marks are kept like |:keepmarks| was used.
1867 *cpo-s*
1868 s Set buffer options when entering the buffer for the
1869 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001870 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001871 set when the buffer is created.
1872 *cpo-S*
1873 S Set buffer options always when entering a buffer
1874 (except 'readonly', 'fileformat', 'filetype' and
1875 'syntax'). This is the (most) Vi compatible setting.
1876 The options are set to the values in the current
1877 buffer. When you change an option and go to another
1878 buffer, the value is copied. Effectively makes the
1879 buffer options global to all buffers.
1880
1881 's' 'S' copy buffer options
1882 no no when buffer created
1883 yes no when buffer first entered (default)
1884 X yes each time when buffer entered (vi comp.)
1885 *cpo-t*
1886 t Search pattern for the tag command is remembered for
1887 "n" command. Otherwise Vim only puts the pattern in
1888 the history for search pattern, but doesn't change the
1889 last used search pattern.
1890 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001891 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001892 *cpo-v*
1893 v Backspaced characters remain visible on the screen in
1894 Insert mode. Without this flag the characters are
1895 erased from the screen right away. With this flag the
1896 screen newly typed text overwrites backspaced
1897 characters.
1898 *cpo-w*
1899 w When using "cw" on a blank character, only change one
1900 character and not all blanks until the start of the
1901 next word.
1902 *cpo-W*
1903 W Don't overwrite a readonly file. When omitted, ":w!"
1904 overwrites a readonly file, if possible.
1905 *cpo-x*
1906 x <Esc> on the command-line executes the command-line.
1907 The default in Vim is to abandon the command-line,
1908 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001909 *cpo-X*
1910 X When using a count with "R" the replaced text is
1911 deleted only once. Also when repeating "R" with "."
1912 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001913 *cpo-y*
1914 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001915 *cpo-Z*
1916 Z When using "w!" while the 'readonly' option is set,
1917 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001918 *cpo-!*
1919 ! When redoing a filter command, use the last used
1920 external command, whatever it was. Otherwise the last
1921 used -filter- command is used.
1922 *cpo-$*
1923 $ When making a change to one line, don't redisplay the
1924 line, but put a '$' at the end of the changed text.
1925 The changed text will be overwritten when you type the
1926 new text. The line is redisplayed if you type any
1927 command that moves the cursor from the insertion
1928 point.
1929 *cpo-%*
1930 % Vi-compatible matching is done for the "%" command.
1931 Does not recognize "#if", "#endif", etc.
1932 Does not recognize "/*" and "*/".
1933 Parens inside single and double quotes are also
1934 counted, causing a string that contains a paren to
1935 disturb the matching. For example, in a line like
1936 "if (strcmp("foo(", s))" the first paren does not
1937 match the last one. When this flag is not included,
1938 parens inside single and double quotes are treated
1939 specially. When matching a paren outside of quotes,
1940 everything inside quotes is ignored. When matching a
1941 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001942 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001943 This flag is also used for other features, such as
1944 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001945 *cpo--*
1946 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001947 it would go above the first line or below the last
1948 line. Without it the cursor moves to the first or
1949 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001950 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001951 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001952 *cpo-+*
1953 + When included, a ":write file" command will reset the
1954 'modified' flag of the buffer, even though the buffer
1955 itself may still be different from its file.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001956 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001957 * Use ":*" in the same way as ":@". When not included,
1958 ":*" is an alias for ":'<,'>", select the Visual area.
1959 *cpo-<*
1960 < Disable the recognition of special key codes in |<>|
1961 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001962 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001963 ":map X <Tab>" results in X being mapped to:
1964 '<' included: "<Tab>" (5 characters)
1965 '<' excluded: "^I" (^I is a real <Tab>)
1966 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001967 *cpo->*
1968 > When appending to a register, put a line break before
1969 the appended text.
1970
1971 POSIX flags. These are not included in the Vi default value, except
1972 when $VIM_POSIX was set on startup. |posix|
1973
1974 contains behavior ~
1975 *cpo-#*
1976 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001977 *cpo-&*
1978 & When ":preserve" was used keep the swap file when
1979 exiting normally while this buffer is still loaded.
1980 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001981 *cpo-\*
1982 \ Backslash in a [] range in a search pattern is taken
1983 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00001984 '\' included: "/[ \-]" finds <Space>, '\' and '-'
1985 '\' excluded: "/[ \-]" finds <Space> and '-'
1986 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001987 *cpo-/*
1988 / When "%" is used as the replacement string in a |:s|
1989 command, use the previous replacement string. |:s%|
1990 *cpo-{*
1991 { The |{| and |}| commands also stop at a "{" character
1992 at the start of a line.
1993 *cpo-.*
1994 . The ":chdir" and ":cd" commands fail if the current
1995 buffer is modified, unless ! is used. Vim doesn't
1996 need this, since it remembers the full path of an
1997 opened file.
1998 *cpo-bar*
1999 | The value of the $LINES and $COLUMNS environment
2000 variables overrule the terminal size values obtained
2001 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002002
Bram Moolenaar071d4272004-06-13 20:20:40 +00002003
2004 *'cscopepathcomp'* *'cspc'*
2005'cscopepathcomp' 'cspc' number (default 0)
2006 global
2007 {not available when compiled without the |+cscope|
2008 feature}
2009 {not in Vi}
2010 Determines how many components of the path to show in a list of tags.
2011 See |cscopepathcomp|.
2012
2013 *'cscopeprg'* *'csprg'*
2014'cscopeprg' 'csprg' string (default "cscope")
2015 global
2016 {not available when compiled without the |+cscope|
2017 feature}
2018 {not in Vi}
2019 Specifies the command to execute cscope. See |cscopeprg|.
2020 This option cannot be set from a |modeline| or in the |sandbox|, for
2021 security reasons.
2022
2023 *'cscopequickfix'* *'csqf'*
2024'cscopequickfix' 'csqf' string (default "")
2025 global
2026 {not available when compiled without the |+cscope|
2027 or |+quickfix| features}
2028 {not in Vi}
2029 Specifies whether to use quickfix window to show cscope results.
2030 See |cscopequickfix|.
2031
2032 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2033'cscopetag' 'cst' boolean (default off)
2034 global
2035 {not available when compiled without the |+cscope|
2036 feature}
2037 {not in Vi}
2038 Use cscope for tag commands. See |cscope-options|.
2039 NOTE: This option is reset when 'compatible' is set.
2040
2041 *'cscopetagorder'* *'csto'*
2042'cscopetagorder' 'csto' number (default 0)
2043 global
2044 {not available when compiled without the |+cscope|
2045 feature}
2046 {not in Vi}
2047 Determines the order in which ":cstag" performs a search. See
2048 |cscopetagorder|.
2049 NOTE: This option is set to 0 when 'compatible' is set.
2050
2051 *'cscopeverbose'* *'csverb'*
2052 *'nocscopeverbose'* *'nocsverb'*
2053'cscopeverbose' 'csverb' boolean (default off)
2054 global
2055 {not available when compiled without the |+cscope|
2056 feature}
2057 {not in Vi}
2058 Give messages when adding a cscope database. See |cscopeverbose|.
2059 NOTE: This option is reset when 'compatible' is set.
2060
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002061
2062 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2063'cursorcolumn' 'cuc' boolean (default off)
2064 local to window
2065 {not in Vi}
2066 {not available when compiled without the |+syntax|
2067 feature}
2068 Highlight the screen column of the cursor with CursorColumn
2069 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2070 slower.
2071
2072 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2073'cursorline' 'cul' boolean (default off)
2074 local to window
2075 {not in Vi}
2076 {not available when compiled without the |+syntax|
2077 feature}
2078 Highlight the screen line of the cursor with CursorLine
2079 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2080 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002081 When Visual mode is active the highlighting isn't used to make it
2082 easier to spot where the selected area.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002083
2084
Bram Moolenaar071d4272004-06-13 20:20:40 +00002085 *'debug'*
2086'debug' string (default "")
2087 global
2088 {not in Vi}
2089 When set to "msg", error messages that would otherwise be omitted will
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002090 be given anyway. This is useful when debugging 'foldexpr',
2091 'formatexpr' or 'indentexpr'.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002092 When set to "beep", a message will be given when otherwise only a beep
2093 would be produced.
2094 The values can be combined, separated by a comma.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002095
2096 *'define'* *'def'*
2097'define' 'def' string (default "^\s*#\s*define")
2098 global or local to buffer |global-local|
2099 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002100 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002101 pattern, just like for the "/" command. This option is used for the
2102 commands like "[i" and "[d" |include-search|. The 'isident' option is
2103 used to recognize the defined name after the match:
2104 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2105 See |option-backslash| about inserting backslashes to include a space
2106 or backslash.
2107 The default value is for C programs. For C++ this value would be
2108 useful, to include const type declarations: >
2109 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2110< When using the ":set" command, you need to double the backslashes!
2111
2112 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2113'delcombine' 'deco' boolean (default off)
2114 global
2115 {not in Vi}
2116 {only available when compiled with the |+multi_byte|
2117 feature}
2118 If editing Unicode and this option is set, backspace and Normal mode
2119 "x" delete each combining character on its own. When it is off (the
2120 default) the character along with its combining characters are
2121 deleted.
2122 Note: When 'delcombine' is set "xx" may work different from "2x"!
2123
2124 This is useful for Arabic, Hebrew and many other languages where one
2125 may have combining characters overtop of base characters, and want
2126 to remove only the combining ones.
2127
2128 *'dictionary'* *'dict'*
2129'dictionary' 'dict' string (default "")
2130 global or local to buffer |global-local|
2131 {not in Vi}
2132 List of file names, separated by commas, that are used to lookup words
2133 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2134 contain a list of words. This can be one word per line, or several
2135 words per line, separated by non-keyword characters (white space is
2136 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002137 When this option is empty, or an entry "spell" is present, spell
2138 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002139 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002140 after a comma are ignored, otherwise spaces are included in the file
2141 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002142 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002143 Where to find a list of words?
2144 - On FreeBSD, there is the file "/usr/share/dict/words".
2145 - In the Simtel archive, look in the "msdos/linguist" directory.
2146 - In "miscfiles" of the GNU collection.
2147 The use of |:set+=| and |:set-=| is preferred when adding or removing
2148 directories from the list. This avoids problems when a future version
2149 uses another default.
2150 Backticks cannot be used in this option for security reasons.
2151
2152 *'diff'* *'nodiff'*
2153'diff' boolean (default off)
2154 local to window
2155 {not in Vi}
2156 {not available when compiled without the |+diff|
2157 feature}
2158 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002159 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002160
2161 *'dex'* *'diffexpr'*
2162'diffexpr' 'dex' string (default "")
2163 global
2164 {not in Vi}
2165 {not available when compiled without the |+diff|
2166 feature}
2167 Expression which is evaluated to obtain an ed-style diff file from two
2168 versions of a file. See |diff-diffexpr|.
2169 This option cannot be set from a |modeline| or in the |sandbox|, for
2170 security reasons.
2171
2172 *'dip'* *'diffopt'*
2173'diffopt' 'dip' string (default "filler")
2174 global
2175 {not in Vi}
2176 {not available when compiled without the |+diff|
2177 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002178 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002179 All are optional. Items must be separated by a comma.
2180
2181 filler Show filler lines, to keep the text
2182 synchronized with a window that has inserted
2183 lines at the same position. Mostly useful
2184 when windows are side-by-side and 'scrollbind'
2185 is set.
2186
2187 context:{n} Use a context of {n} lines between a change
2188 and a fold that contains unchanged lines.
2189 When omitted a context of six lines is used.
2190 See |fold-diff|.
2191
2192 icase Ignore changes in case of text. "a" and "A"
2193 are considered the same. Adds the "-i" flag
2194 to the "diff" command if 'diffexpr' is empty.
2195
2196 iwhite Ignore changes in amount of white space. Adds
2197 the "-b" flag to the "diff" command if
2198 'diffexpr' is empty. Check the documentation
2199 of the "diff" command for what this does
2200 exactly. It should ignore adding trailing
2201 white space, but not leading white space.
2202
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002203 horizontal Start diff mode with horizontal splits (unless
2204 explicitly specified otherwise).
2205
2206 vertical Start diff mode with vertical splits (unless
2207 explicitly specified otherwise).
2208
2209 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2210 starting diff mode. Without this 2 is used.
2211
Bram Moolenaar071d4272004-06-13 20:20:40 +00002212 Examples: >
2213
2214 :set diffopt=filler,context:4
2215 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002216 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002217<
2218 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2219'digraph' 'dg' boolean (default off)
2220 global
2221 {not in Vi}
2222 {not available when compiled without the |+digraphs|
2223 feature}
2224 Enable the entering of digraphs in Insert mode with {char1} <BS>
2225 {char2}. See |digraphs|.
2226 NOTE: This option is reset when 'compatible' is set.
2227
2228 *'directory'* *'dir'*
2229'directory' 'dir' string (default for Amiga: ".,t:",
2230 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2231 for Unix: ".,~/tmp,/var/tmp,/tmp")
2232 global
2233 List of directory names for the swap file, separated with commas.
2234 - The swap file will be created in the first directory where this is
2235 possible.
2236 - Empty means that no swap file will be used (recovery is
2237 impossible!).
2238 - A directory "." means to put the swap file in the same directory as
2239 the edited file. On Unix, a dot is prepended to the file name, so
2240 it doesn't show in a directory listing. On MS-Windows the "hidden"
2241 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002242 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002243 put the swap file relative to where the edited file is. The leading
2244 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002245 - For Unix and Win32, if a directory ends in two path separators "//"
2246 or "\\", the swap file name will be built from the complete path to
2247 the file with all path separators substituted to percent '%' signs.
2248 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002249 - Spaces after the comma are ignored, other spaces are considered part
2250 of the directory name. To have a space at the start of a directory
2251 name, precede it with a backslash.
2252 - To include a comma in a directory name precede it with a backslash.
2253 - A directory name may end in an ':' or '/'.
2254 - Environment variables are expanded |:set_env|.
2255 - Careful with '\' characters, type one before a space, type two to
2256 get one in the option (see |option-backslash|), for example: >
2257 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2258< - For backwards compatibility with Vim version 3.0 a '>' at the start
2259 of the option is removed.
2260 Using "." first in the list is recommended. This means that editing
2261 the same file twice will result in a warning. Using "/tmp" on Unix is
2262 discouraged: When the system crashes you lose the swap file.
2263 "/var/tmp" is often not cleared when rebooting, thus is a better
2264 choice than "/tmp". But it can contain a lot of files, your swap
2265 files get lost in the crowd. That is why a "tmp" directory in your
2266 home directory is tried first.
2267 The use of |:set+=| and |:set-=| is preferred when adding or removing
2268 directories from the list. This avoids problems when a future version
2269 uses another default.
2270 This option cannot be set from a |modeline| or in the |sandbox|, for
2271 security reasons.
2272 {Vi: directory to put temp file in, defaults to "/tmp"}
2273
2274 *'display'* *'dy'*
2275'display' 'dy' string (default "")
2276 global
2277 {not in Vi}
2278 Change the way text is displayed. This is comma separated list of
2279 flags:
2280 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002281 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002282 last line that doesn't fit is replaced with "@" lines.
2283 uhex Show unprintable characters hexadecimal as <xx>
2284 instead of using ^C and ~C.
2285
2286 *'eadirection'* *'ead'*
2287'eadirection' 'ead' string (default "both")
2288 global
2289 {not in Vi}
2290 {not available when compiled without the +vertsplit
2291 feature}
2292 Tells when the 'equalalways' option applies:
2293 ver vertically, width of windows is not affected
2294 hor horizontally, height of windows is not affected
2295 both width and height of windows is affected
2296
2297 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2298'edcompatible' 'ed' boolean (default off)
2299 global
2300 Makes the 'g' and 'c' flags of the ":substitute" command to be
2301 toggled each time the flag is given. See |complex-change|. See
2302 also 'gdefault' option.
2303 Switching this option on is discouraged!
2304
2305 *'encoding'* *'enc'* *E543*
2306'encoding' 'enc' string (default: "latin1" or value from $LANG)
2307 global
2308 {only available when compiled with the |+multi_byte|
2309 feature}
2310 {not in Vi}
2311 Sets the character encoding used inside Vim. It applies to text in
2312 the buffers, registers, Strings in expressions, text stored in the
2313 viminfo file, etc. It sets the kind of characters which Vim can work
2314 with. See |encoding-names| for the possible values.
2315
2316 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002317 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002318 It should normally be kept at its default value, or set when Vim
2319 starts up. See |multibyte|.
2320
2321 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2322 "utf-8". Although care has been taken to allow different values of
2323 'encoding', "utf-8" is the natural choice for the environment and
2324 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002325 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002326 versions, and to avoid changing the encoding of newly created files
2327 without your knowledge (in case 'fileencodings' is empty).
2328
2329 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002330 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002331 iconv() or as specified with 'charconvert'.
2332
2333 Normally 'encoding' will be equal to your current locale. This will
2334 be the default if Vim recognizes your environment settings. If
2335 'encoding' is not set to the current locale, 'termencoding' must be
2336 set to convert typed and displayed text. See |encoding-table|.
2337
2338 When you set this option, it fires the |EncodingChanged| autocommand
2339 event so that you can set up fonts if necessary.
2340
2341 When the option is set, the value is converted to lowercase. Thus
2342 you can set it with uppercase values too. Underscores are translated
2343 to '-' signs.
2344 When the encoding is recognized, it is changed to the standard name.
2345 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2346 "iso-8859-2" and "utf8" becomes "utf-8".
2347
2348 Note: "latin1" is also used when the encoding could not be detected.
2349 This only works when editing files in the same encoding! When the
2350 actual character set is not latin1, make sure 'fileencoding' and
2351 'fileencodings' are empty. When conversion is needed, switch to using
2352 utf-8.
2353
2354 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2355 You don't notice this while editing, but it does matter for the
2356 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2357 setting 'encoding' to one of these values instead of utf-8 only has
2358 effect for encoding used for files when 'fileencoding' is empty.
2359
Bram Moolenaar661b1822005-07-28 22:36:45 +00002360 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2361 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002362
2363 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2364'endofline' 'eol' boolean (default on)
2365 local to buffer
2366 {not in Vi}
2367 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002368 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002369 option is automatically set when starting to edit a new file, unless
2370 the file does not have an <EOL> for the last line in the file, in
2371 which case it is reset. Normally you don't have to set or reset this
2372 option. When 'binary' is off the value is not used when writing the
2373 file. When 'binary' is on it is used to remember the presence of a
2374 <EOL> for the last line in the file, so that when you write the file
2375 the situation from the original file can be kept. But you can change
2376 it if you want to.
2377
2378 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2379'equalalways' 'ea' boolean (default on)
2380 global
2381 {not in Vi}
2382 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002383 splitting or closing a window. This also happens the moment the
2384 option is switched on. When off, splitting a window will reduce the
2385 size of the current window and leave the other windows the same. When
2386 closing a window the extra lines are given to the window next to it
2387 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002388 When mixing vertically and horizontally split windows, a minimal size
2389 is computed and some windows may be larger if there is room. The
2390 'eadirection' option tells in which direction the size is affected.
2391 Changing the height of a window can be avoided by setting
2392 'winfixheight'.
2393
2394 *'equalprg'* *'ep'*
2395'equalprg' 'ep' string (default "")
2396 global or local to buffer |global-local|
2397 {not in Vi}
2398 External program to use for "=" command. When this option is empty
2399 the internal formatting functions are used ('lisp', 'cindent' or
2400 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002401 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002402 about including spaces and backslashes.
2403 This option cannot be set from a |modeline| or in the |sandbox|, for
2404 security reasons.
2405
2406 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2407'errorbells' 'eb' boolean (default off)
2408 global
2409 Ring the bell (beep or screen flash) for error messages. This only
2410 makes a difference for error messages, the bell will be used always
2411 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002412 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002413 screen flash or do nothing.
2414
2415 *'errorfile'* *'ef'*
2416'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2417 others: "errors.err")
2418 global
2419 {not in Vi}
2420 {not available when compiled without the |+quickfix|
2421 feature}
2422 Name of the errorfile for the QuickFix mode (see |:cf|).
2423 When the "-q" command-line argument is used, 'errorfile' is set to the
2424 following argument. See |-q|.
2425 NOT used for the ":make" command. See 'makeef' for that.
2426 Environment variables are expanded |:set_env|.
2427 See |option-backslash| about including spaces and backslashes.
2428 This option cannot be set from a |modeline| or in the |sandbox|, for
2429 security reasons.
2430
2431 *'errorformat'* *'efm'*
2432'errorformat' 'efm' string (default is very long)
2433 global or local to buffer |global-local|
2434 {not in Vi}
2435 {not available when compiled without the |+quickfix|
2436 feature}
2437 Scanf-like description of the format for the lines in the error file
2438 (see |errorformat|).
2439
2440 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2441'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2442 global
2443 {not in Vi}
2444 Function keys that start with an <Esc> are recognized in Insert
2445 mode. When this option is off, the cursor and function keys cannot be
2446 used in Insert mode if they start with an <Esc>. The advantage of
2447 this is that the single <Esc> is recognized immediately, instead of
2448 after one second. Instead of resetting this option, you might want to
2449 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2450 when 'esckeys' is off, you can still map anything, but the cursor keys
2451 won't work by default.
2452 NOTE: This option is set to the Vi default value when 'compatible' is
2453 set and to the Vim default value when 'compatible' is reset.
2454
2455 *'eventignore'* *'ei'*
2456'eventignore' 'ei' string (default "")
2457 global
2458 {not in Vi}
2459 {not available when compiled without the |+autocmd|
2460 feature}
2461 A list of autocommand event names, which are to be ignored.
2462 When set to "all", all autocommand events are ignored, autocommands
2463 will not be executed.
2464 Otherwise this is a comma separated list of event names. Example: >
2465 :set ei=WinEnter,WinLeave
2466<
2467 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2468'expandtab' 'et' boolean (default off)
2469 local to buffer
2470 {not in Vi}
2471 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002472 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002473 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2474 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2475 NOTE: This option is reset when 'compatible' is set.
2476
2477 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2478'exrc' 'ex' boolean (default off)
2479 global
2480 {not in Vi}
2481 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2482 directory. If you switch this option on you should also consider
2483 setting the 'secure' option (see |initialization|). Using a local
2484 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2485 also see |.vimrc| and |gui-init|.
2486 This option cannot be set from a |modeline| or in the |sandbox|, for
2487 security reasons.
2488
2489 *'fileencoding'* *'fenc'* *E213*
2490'fileencoding' 'fenc' string (default: "")
2491 local to buffer
2492 {only available when compiled with the |+multi_byte|
2493 feature}
2494 {not in Vi}
2495 Sets the character encoding for the file of this buffer.
2496 When 'fileencoding' is different from 'encoding', conversion will be
2497 done when reading and writing the file.
2498 When 'fileencoding' is empty, the same value as 'encoding' will be
2499 used (no conversion when reading or writing a file).
2500 WARNING: Conversion can cause loss of information! When
2501 'encoding' is "utf-8" conversion is most likely done in a way
2502 that the reverse conversion results in the same text. When
2503 'encoding' is not "utf-8" some characters may be lost!
2504 See 'encoding' for the possible values. Additionally, values may be
2505 specified that can be handled by the converter, see
2506 |mbyte-conversion|.
2507 When reading a file 'fileencoding' will be set from 'fileencodings'.
2508 To read a file in a certain encoding it won't work by setting
2509 'fileencoding', use the |++enc| argument.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002510 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002511 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2512 When the option is set, the value is converted to lowercase. Thus
2513 you can set it with uppercase values too. '_' characters are
2514 replaced with '-'. If a name is recognized from the list for
2515 'encoding', it is replaced by the standard name. For example
2516 "ISO8859-2" becomes "iso-8859-2".
2517 When this option is set, after starting to edit a file, the 'modified'
2518 option is set, because the file would be different when written.
2519 If you do this in a modeline, you might want to set 'nomodified' to
2520 avoid this.
2521 This option can not be changed when 'modifiable' is off.
2522
2523 *'fe'*
2524 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002525 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002526 old short name was 'fe', which is no longer used.
2527
2528 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002529'fileencodings' 'fencs' string (default: "ucs-bom",
2530 "ucs-bom,utf-8,default,latin1" when
2531 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002532 global
2533 {only available when compiled with the |+multi_byte|
2534 feature}
2535 {not in Vi}
2536 This is a list of character encodings considered when starting to edit
2537 an existing file. When a file is read, Vim tries to use the first
2538 mentioned character encoding. If an error is detected, the next one
2539 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002540 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002541 an empty string, which means the value of 'encoding' is used.
2542 WARNING: Conversion can cause loss of information! When
2543 'encoding' is "utf-8" (or one of the other Unicode variants)
2544 conversion is most likely done in a way that the reverse
2545 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002546 "utf-8" some non-ASCII characters may be lost! You can use
2547 the |++bad| argument to specify what is done with characters
2548 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002549 For an empty file or a file with only ASCII characters most encodings
2550 will work and the first entry of 'fileencodings' will be used (except
2551 "ucs-bom", which requires the BOM to be present). If you prefer
2552 another encoding use an BufReadPost autocommand event to test if your
2553 preferred encoding is to be used. Example: >
2554 au BufReadPost * if search('\S', 'w') == 0 |
2555 \ set fenc=iso-2022-jp | endif
2556< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2557 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002558 When the |++enc| argument is used then the value of 'fileencodings' is
2559 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002560 Note that 'fileencodings' is not used for a new file, the global value
2561 of 'fileencoding' is used instead. You can set it with: >
2562 :setglobal fenc=iso-8859-2
2563< This means that a non-existing file may get a different encoding than
2564 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002565 The special value "ucs-bom" can be used to check for a Unicode BOM
2566 (Byte Order Mark) at the start of the file. It must not be preceded
2567 by "utf-8" or another Unicode encoding for this to work properly.
2568 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2569 because Vim cannot detect an error, thus the encoding is always
2570 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002571 The special value "default" can be used for the encoding from the
2572 environment. This is the default value for 'encoding'. It is useful
2573 when 'encoding' is set to "utf-8" and your environment uses a
2574 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002575 When 'encoding' is "utf-8" and a file contains an illegal byte
2576 sequence it won't be recognized as UTF-8. You can use the |8g8|
2577 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002578 WRONG VALUES: WHAT'S WRONG:
2579 latin1,utf-8 "latin1" will always be used
2580 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2581 file
2582 cp1250,latin1 "cp1250" will always be used
2583 If 'fileencodings' is empty, 'fileencoding' is not modified.
2584 See 'fileencoding' for the possible values.
2585 Setting this option does not have an effect until the next time a file
2586 is read.
2587
2588 *'fileformat'* *'ff'*
2589'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2590 Unix default: "unix",
2591 Macintosh default: "mac")
2592 local to buffer
2593 {not in Vi}
2594 This gives the <EOL> of the current buffer, which is used for
2595 reading/writing the buffer from/to a file:
2596 dos <CR> <NL>
2597 unix <NL>
2598 mac <CR>
2599 When "dos" is used, CTRL-Z at the end of a file is ignored.
2600 See |file-formats| and |file-read|.
2601 For the character encoding of the file see 'fileencoding'.
2602 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2603 works like it was set to "unix'.
2604 This option is set automatically when starting to edit a file and
2605 'fileformats' is not empty and 'binary' is off.
2606 When this option is set, after starting to edit a file, the 'modified'
2607 option is set, because the file would be different when written.
2608 This option can not be changed when 'modifiable' is off.
2609 For backwards compatibility: When this option is set to "dos",
2610 'textmode' is set, otherwise 'textmode' is reset.
2611
2612 *'fileformats'* *'ffs'*
2613'fileformats' 'ffs' string (default:
2614 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2615 Vim Unix: "unix,dos",
2616 Vim Mac: "mac,unix,dos",
2617 Vi Cygwin: "unix,dos",
2618 Vi others: "")
2619 global
2620 {not in Vi}
2621 This gives the end-of-line (<EOL>) formats that will be tried when
2622 starting to edit a new buffer and when reading a file into an existing
2623 buffer:
2624 - When empty, the format defined with 'fileformat' will be used
2625 always. It is not set automatically.
2626 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002627 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002628 'fileformats' name will be used when a file is read into an existing
2629 buffer, no matter what 'fileformat' for that buffer is set to.
2630 - When more than one name is present, separated by commas, automatic
2631 <EOL> detection will be done when reading a file. When starting to
2632 edit a file, a check is done for the <EOL>:
2633 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2634 'fileformat' is set to "dos".
2635 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002636 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002637 preceding <CR>, "unix" is preferred over "dos".
2638 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2639 This means that "mac" is only chosen when "unix" is not present,
2640 or when no <NL> is found in the file, and when "dos" is not
2641 present, or no <CR><NL> is present in the file.
2642 Also if "unix" was first chosen, but the first <CR> is before
2643 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2644 the file, then 'fileformat' is set to "mac".
2645 4. If 'fileformat' is still not set, the first name from
2646 'fileformats' is used.
2647 When reading a file into an existing buffer, the same is done, but
2648 this happens like 'fileformat' has been set appropriately for that
2649 file only, the option is not changed.
2650 When 'binary' is set, the value of 'fileformats' is not used.
2651
2652 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2653 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2654 done:
2655 - When 'fileformats' is empty, there is no automatic detection. Dos
2656 format will be used.
2657 - When 'fileformats' is set to one or more names, automatic detection
2658 is done. This is based on the first <NL> in the file: If there is a
2659 <CR> in front of it, Dos format is used, otherwise Unix format is
2660 used.
2661 Also see |file-formats|.
2662 For backwards compatibility: When this option is set to an empty
2663 string or one format (no comma is included), 'textauto' is reset,
2664 otherwise 'textauto' is set.
2665 NOTE: This option is set to the Vi default value when 'compatible' is
2666 set and to the Vim default value when 'compatible' is reset.
2667
2668 *'filetype'* *'ft'*
2669'filetype' 'ft' string (default: "")
2670 local to buffer
2671 {not in Vi}
2672 {not available when compiled without the |+autocmd|
2673 feature}
2674 When this option is set, the FileType autocommand event is triggered.
2675 All autocommands that match with the value of this option will be
2676 executed. Thus the value of 'filetype' is used in place of the file
2677 name.
2678 Otherwise this option does not always reflect the current file type.
2679 This option is normally set when the file type is detected. To enable
2680 this use the ":filetype on" command. |:filetype|
2681 Setting this option to a different value is most useful in a modeline,
2682 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002683 Example, for in an IDL file:
2684 /* vim: set filetype=idl : */ ~
2685 |FileType| |filetypes|
2686 When a dot appears in the value then this separates two filetype
2687 names. Example:
2688 /* vim: set filetype=c.doxygen : */ ~
2689 This will use the "c" filetype first, then the "doxygen" filetype.
2690 This works both for filetype plugins and for syntax files. More than
2691 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002692 Do not confuse this option with 'osfiletype', which is for the file
2693 type that is actually stored with the file.
2694 This option is not copied to another buffer, independent of the 's' or
2695 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002696 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002697
2698 *'fillchars'* *'fcs'*
2699'fillchars' 'fcs' string (default "vert:|,fold:-")
2700 global
2701 {not in Vi}
2702 {not available when compiled without the |+windows|
2703 and |+folding| features}
2704 Characters to fill the statuslines and vertical separators.
2705 It is a comma separated list of items:
2706
2707 item default Used for ~
2708 stl:c ' ' or '^' statusline of the current window
2709 stlnc:c ' ' or '-' statusline of the non-current windows
2710 vert:c '|' vertical separators |:vsplit|
2711 fold:c '-' filling 'foldtext'
2712 diff:c '-' deleted lines of the 'diff' option
2713
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002714 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002715 "stlnc" the space will be used when there is highlighting, '^' or '-'
2716 otherwise.
2717
2718 Example: >
2719 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2720< This is similar to the default, except that these characters will also
2721 be used when there is highlighting.
2722
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002723 for "stl" and "stlnc" only single-byte values are supported.
2724
Bram Moolenaar071d4272004-06-13 20:20:40 +00002725 The highlighting used for these items:
2726 item highlight group ~
2727 stl:c StatusLine |hl-StatusLine|
2728 stlnc:c StatusLineNC |hl-StatusLineNC|
2729 vert:c VertSplit |hl-VertSplit|
2730 fold:c Folded |hl-Folded|
2731 diff:c DiffDelete |hl-DiffDelete|
2732
2733 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2734'fkmap' 'fk' boolean (default off) *E198*
2735 global
2736 {not in Vi}
2737 {only available when compiled with the |+rightleft|
2738 feature}
2739 When on, the keyboard is mapped for the Farsi character set.
2740 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002741 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002742
2743 *'foldclose'* *'fcl'*
2744'foldclose' 'fcl' string (default "")
2745 global
2746 {not in Vi}
2747 {not available when compiled without the |+folding|
2748 feature}
2749 When set to "all", a fold is closed when the cursor isn't in it and
2750 its level is higher than 'foldlevel'. Useful if you want folds to
2751 automatically close when moving out of them.
2752
2753 *'foldcolumn'* *'fdc'*
2754'foldcolumn' 'fdc' number (default 0)
2755 local to window
2756 {not in Vi}
2757 {not available when compiled without the |+folding|
2758 feature}
2759 When non-zero, a column with the specified width is shown at the side
2760 of the window which indicates open and closed folds. The maximum
2761 value is 12.
2762 See |folding|.
2763
2764 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2765'foldenable' 'fen' boolean (default on)
2766 local to window
2767 {not in Vi}
2768 {not available when compiled without the |+folding|
2769 feature}
2770 When off, all folds are open. This option can be used to quickly
2771 switch between showing all text unfolded and viewing the text with
2772 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002773 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002774 'foldenable' is off.
2775 This option is set by commands that create a new fold or close a fold.
2776 See |folding|.
2777
2778 *'foldexpr'* *'fde'*
2779'foldexpr' 'fde' string (default: "0")
2780 local to window
2781 {not in Vi}
2782 {not available when compiled without the |+folding|
2783 or |+eval| feature}
2784 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002785 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002786
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002787 The expression may be evaluated in the |sandbox|, see
2788 |sandbox-option|.
2789
2790 It is not allowed to change text or jump to another window while
2791 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002792
2793 *'foldignore'* *'fdi'*
2794'foldignore' 'fdi' string (default: "#")
2795 local to window
2796 {not in Vi}
2797 {not available when compiled without the |+folding|
2798 feature}
2799 Used only when 'foldmethod' is "indent". Lines starting with
2800 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002801 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002802 The default "#" works well for C programs. See |fold-indent|.
2803
2804 *'foldlevel'* *'fdl'*
2805'foldlevel' 'fdl' number (default: 0)
2806 local to window
2807 {not in Vi}
2808 {not available when compiled without the |+folding|
2809 feature}
2810 Sets the fold level: Folds with a higher level will be closed.
2811 Setting this option to zero will close all folds. Higher numbers will
2812 close fewer folds.
2813 This option is set by commands like |zm|, |zM| and |zR|.
2814 See |fold-foldlevel|.
2815
2816 *'foldlevelstart'* *'fdls'*
2817'foldlevelstart' 'fdls' number (default: -1)
2818 global
2819 {not in Vi}
2820 {not available when compiled without the |+folding|
2821 feature}
2822 Sets 'foldlevel' when starting to edit another buffer in a window.
2823 Useful to always start editing with all folds closed (value zero),
2824 some folds closed (one) or no folds closed (99).
2825 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002826 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002827 ignores this option and closes all folds.
2828 It is also done before BufReadPre autocommands, to allow an autocmd to
2829 overrule the 'foldlevel' value for specific files.
2830 When the value is negative, it is not used.
2831
2832 *'foldmarker'* *'fmr'* *E536*
2833'foldmarker' 'fmr' string (default: "{{{,}}}")
2834 local to window
2835 {not in Vi}
2836 {not available when compiled without the |+folding|
2837 feature}
2838 The start and end marker used when 'foldmethod' is "marker". There
2839 must be one comma, which separates the start and end marker. The
2840 marker is a literal string (a regular expression would be too slow).
2841 See |fold-marker|.
2842
2843 *'foldmethod'* *'fdm'*
2844'foldmethod' 'fdm' string (default: "manual")
2845 local to window
2846 {not in Vi}
2847 {not available when compiled without the |+folding|
2848 feature}
2849 The kind of folding used for the current window. Possible values:
2850 |fold-manual| manual Folds are created manually.
2851 |fold-indent| indent Lines with equal indent form a fold.
2852 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2853 |fold-marker| marker Markers are used to specify folds.
2854 |fold-syntax| syntax Syntax highlighting items specify folds.
2855 |fold-diff| diff Fold text that is not changed.
2856
2857 *'foldminlines'* *'fml'*
2858'foldminlines' 'fml' number (default: 1)
2859 local to window
2860 {not in Vi}
2861 {not available when compiled without the |+folding|
2862 feature}
2863 Sets the minimum number of screen lines for a fold to be displayed
2864 closed. Also for manually closed folds.
2865 Note that this only has an effect of what is displayed. After using
2866 "zc" to close a fold, which is displayed open because it's smaller
2867 than 'foldminlines', a following "zc" may close a containing fold.
2868
2869 *'foldnestmax'* *'fdn'*
2870'foldnestmax' 'fdn' number (default: 20)
2871 local to window
2872 {not in Vi}
2873 {not available when compiled without the |+folding|
2874 feature}
2875 Sets the maximum nesting of folds for the "indent" and "syntax"
2876 methods. This avoids that too many folds will be created. Using more
2877 than 20 doesn't work, because the internal limit is 20.
2878
2879 *'foldopen'* *'fdo'*
2880'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2881 search,tag,undo")
2882 global
2883 {not in Vi}
2884 {not available when compiled without the |+folding|
2885 feature}
2886 Specifies for which type of commands folds will be opened, if the
2887 command moves the cursor into a closed fold. It is a comma separated
2888 list of items.
2889 item commands ~
2890 all any
2891 block "(", "{", "[[", "[{", etc.
2892 hor horizontal movements: "l", "w", "fx", etc.
2893 insert any command in Insert mode
2894 jump far jumps: "G", "gg", etc.
2895 mark jumping to a mark: "'m", CTRL-O, etc.
2896 percent "%"
2897 quickfix ":cn", ":crew", ":make", etc.
2898 search search for a pattern: "/", "n", "*", "gd", etc.
2899 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002900 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002901 tag jumping to a tag: ":ta", CTRL-T, etc.
2902 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002903 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002904 the |zv| command to the mapping to get the same effect.
2905 When a movement command is used for an operator (e.g., "dl" or "y%")
2906 this option is not used. This means the operator will include the
2907 whole closed fold.
2908 Note that vertical movements are not here, because it would make it
2909 very difficult to move onto a closed fold.
2910 In insert mode the folds containing the cursor will always be open
2911 when text is inserted.
2912 To close folds you can re-apply 'foldlevel' with the |zx| command or
2913 set the 'foldclose' option to "all".
2914
2915 *'foldtext'* *'fdt'*
2916'foldtext' 'fdt' string (default: "foldtext()")
2917 local to window
2918 {not in Vi}
2919 {not available when compiled without the |+folding|
2920 feature}
2921 An expression which is used to specify the text displayed for a closed
2922 fold. See |fold-foldtext|.
2923
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002924 The expression may be evaluated in the |sandbox|, see
2925 |sandbox-option|.
2926
2927 It is not allowed to change text or jump to another window while
2928 evaluating 'foldtext' |textlock|.
2929
Bram Moolenaar071d4272004-06-13 20:20:40 +00002930 *'formatoptions'* *'fo'*
2931'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2932 local to buffer
2933 {not in Vi}
2934 This is a sequence of letters which describes how automatic
2935 formatting is to be done. See |fo-table|. When the 'paste' option is
2936 on, no formatting is done (like 'formatoptions' is empty). Commas can
2937 be inserted for readability.
2938 To avoid problems with flags that are added in the future, use the
2939 "+=" and "-=" feature of ":set" |add-option-flags|.
2940 NOTE: This option is set to the Vi default value when 'compatible' is
2941 set and to the Vim default value when 'compatible' is reset.
2942
Bram Moolenaar86b68352004-12-27 21:59:20 +00002943 *'formatlistpat'* *'flp'*
2944'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
2945 local to buffer
2946 {not in Vi}
2947 A pattern that is used to recognize a list header. This is used for
2948 the "n" flag in 'formatoptions'.
2949 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00002950 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00002951 while still checking more characters. There must be a character
2952 following the pattern, when it matches the whole line it is handled
2953 like there is no match.
2954 The default recognizes a number, followed by an optional punctuation
2955 character and white space.
2956
Bram Moolenaar071d4272004-06-13 20:20:40 +00002957 *'formatprg'* *'fp'*
2958'formatprg' 'fp' string (default "")
2959 global
2960 {not in Vi}
2961 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002962 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00002964 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002965 If the 'formatexpr' option is not empty it will be used instead.
2966 Otherwise, if 'formatprg' option is an empty string, the internal
2967 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00002968 Environment variables are expanded |:set_env|. See |option-backslash|
2969 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002970 The expression may be evaluated in the |sandbox|, see
2971 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002973 *'formatexpr'* *'fex'*
2974'formatexpr' 'fex' string (default "")
2975 local to buffer
2976 {not in Vi}
2977 {not available when compiled without the |+eval|
2978 feature}
2979 Expression which is evaluated to format a range of lines for the |gq|
2980 operator. The |v:lnum| variable holds the first line to be formatted,
2981 |v:count| the number of lines to be formatted.
2982 When this option is empty 'formatprg' is used.
2983 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00002984 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002985< This will invoke the mylang#Format() function in the
2986 autoload/mylang.vim file in 'runtimepath'. |autoload|
2987
2988 The expression is also evaluated when 'textwidth' is set and adding
2989 text beyond that limit. This happens under the same conditions as
2990 when internal formatting is used. Make sure the cursor is kept in the
2991 same spot relative to the text then! The |mode()| function will
2992 return "i" or "R" in this situation. When the function returns
2993 non-zero Vim will fall back to using the internal format mechanism.
2994
2995 The expression may be evaluated in the |sandbox|, see
2996 |sandbox-option|.
2997
2998 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002999'fsync' 'fs' boolean (default on)
3000 global
3001 {not in Vi}
3002 When on, the library function fsync() will be called after writing a
3003 file. This will flush a file to disk, ensuring that it is safely
3004 written even on filesystems which do metadata-only journaling. This
3005 will force the harddrive to spin up on Linux systems running in laptop
3006 mode, so it may be undesirable in some situations. Be warned that
3007 turning this off increases the chances of data loss after a crash. On
3008 systems without an fsync() implementation, this variable is always
3009 off.
3010 Also see 'swapsync' for controlling fsync() on swap files.
3011
Bram Moolenaar071d4272004-06-13 20:20:40 +00003012 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3013'gdefault' 'gd' boolean (default off)
3014 global
3015 {not in Vi}
3016 When on, the ":substitute" flag 'g' is default on. This means that
3017 all matches in a line are substituted instead of one. When a 'g' flag
3018 is given to a ":substitute" command, this will toggle the substitution
3019 of all or one match. See |complex-change|.
3020
3021 command 'gdefault' on 'gdefault' off ~
3022 :s/// subst. all subst. one
3023 :s///g subst. one subst. all
3024 :s///gg subst. all subst. one
3025
3026 NOTE: This option is reset when 'compatible' is set.
3027
3028 *'grepformat'* *'gfm'*
3029'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3030 global
3031 {not in Vi}
3032 Format to recognize for the ":grep" command output.
3033 This is a scanf-like string that uses the same format as the
3034 'errorformat' option: see |errorformat|.
3035
3036 *'grepprg'* *'gp'*
3037'grepprg' 'gp' string (default "grep -n ",
3038 Unix: "grep -n $* /dev/null",
3039 Win32: "findstr /n" or "grep -n",
3040 VMS: "SEARCH/NUMBERS ")
3041 global or local to buffer |global-local|
3042 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003043 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003044 and '#' characters, which are expanded like when used in a command-
3045 line. The placeholder "$*" is allowed to specify where the arguments
3046 will be included. Environment variables are expanded |:set_env|. See
3047 |option-backslash| about including spaces and backslashes.
3048 When your "grep" accepts the "-H" argument, use this to make ":grep"
3049 also work well with a single file: >
3050 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003051< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003052 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3053 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003054 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003055 apply equally to 'grepprg'.
3056 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3057 otherwise it's "grep -n".
3058 This option cannot be set from a |modeline| or in the |sandbox|, for
3059 security reasons.
3060
3061 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3062'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3063 ve:ver35-Cursor,
3064 o:hor50-Cursor,
3065 i-ci:ver25-Cursor/lCursor,
3066 r-cr:hor20-Cursor/lCursor,
3067 sm:block-Cursor
3068 -blinkwait175-blinkoff150-blinkon175",
3069 for MS-DOS and Win32 console:
3070 "n-v-c:block,o:hor50,i-ci:hor15,
3071 r-cr:hor30,sm:block")
3072 global
3073 {not in Vi}
3074 {only available when compiled with GUI enabled, and
3075 for MS-DOS and Win32 console}
3076 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003077 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003078 the height of the cursor can be changed. This can be done by
3079 specifying a block cursor, or a percentage for a vertical or
3080 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003081 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003082
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003083 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003084 mode-list and an argument-list:
3085 mode-list:argument-list,mode-list:argument-list,..
3086 The mode-list is a dash separated list of these modes:
3087 n Normal mode
3088 v Visual mode
3089 ve Visual mode with 'selection' "exclusive" (same as 'v',
3090 if not specified)
3091 o Operator-pending mode
3092 i Insert mode
3093 r Replace mode
3094 c Command-line Normal (append) mode
3095 ci Command-line Insert mode
3096 cr Command-line Replace mode
3097 sm showmatch in Insert mode
3098 a all modes
3099 The argument-list is a dash separated list of these arguments:
3100 hor{N} horizontal bar, {N} percent of the character height
3101 ver{N} vertical bar, {N} percent of the character width
3102 block block cursor, fills the whole character
3103 [only one of the above three should be present]
3104 blinkwait{N} *cursor-blinking*
3105 blinkon{N}
3106 blinkoff{N}
3107 blink times for cursor: blinkwait is the delay before
3108 the cursor starts blinking, blinkon is the time that
3109 the cursor is shown and blinkoff is the time that the
3110 cursor is not shown. The times are in msec. When one
3111 of the numbers is zero, there is no blinking. The
3112 default is: "blinkwait700-blinkon400-blinkoff250".
3113 These numbers are used for a missing entry. This
3114 means that blinking is enabled by default. To switch
3115 blinking off you can use "blinkon0". The cursor only
3116 blinks when Vim is waiting for input, not while
3117 executing a command.
3118 To make the cursor blink in an xterm, see
3119 |xterm-blink|.
3120 {group-name}
3121 a highlight group name, that sets the color and font
3122 for the cursor
3123 {group-name}/{group-name}
3124 Two highlight group names, the first is used when
3125 no language mappings are used, the other when they
3126 are. |language-mapping|
3127
3128 Examples of parts:
3129 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3130 block cursor with colors from the "nCursor"
3131 highlight group
3132 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3133 In Insert and Command-line Insert mode, use a
3134 30% vertical bar cursor with colors from the
3135 "iCursor" highlight group. Blink a bit
3136 faster.
3137
3138 The 'a' mode is different. It will set the given argument-list for
3139 all modes. It does not reset anything to defaults. This can be used
3140 to do a common setting for all modes. For example, to switch off
3141 blinking: "a:blinkon0"
3142
3143 Examples of cursor highlighting: >
3144 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3145 :highlight Cursor gui=NONE guifg=bg guibg=fg
3146<
3147 *'guifont'* *'gfn'*
3148 *E235* *E596* *E610* *E611*
3149'guifont' 'gfn' string (default "")
3150 global
3151 {not in Vi}
3152 {only available when compiled with GUI enabled}
3153 This is a list of fonts which will be used for the GUI version of Vim.
3154 In its simplest form the value is just one font name. When
3155 the font cannot be found you will get an error message. To try other
3156 font names a list can be specified, font names separated with commas.
3157 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003158
Bram Moolenaar05159a02005-02-26 23:04:13 +00003159 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3160 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003161
Bram Moolenaar071d4272004-06-13 20:20:40 +00003162 Spaces after a comma are ignored. To include a comma in a font name
3163 precede it with a backslash. Setting an option requires an extra
3164 backslash before a space and a backslash. See also
3165 |option-backslash|. For example: >
3166 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003167< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003168 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003169
3170 If none of the fonts can be loaded, Vim will keep the current setting.
3171 If an empty font list is given, Vim will try using other resource
3172 settings (for X, it will use the Vim.font resource), and finally it
3173 will try some builtin default which should always be there ("7x13" in
3174 the case of X). The font names given should be "normal" fonts. Vim
3175 will try to find the related bold and italic fonts.
3176
Bram Moolenaar05159a02005-02-26 23:04:13 +00003177 For Win32, GTK, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003178 :set guifont=*
3179< will bring up a font requester, where you can pick the font you want.
3180
3181 The font name depends on the GUI used. See |setting-guifont| for a
3182 way to set 'guifont' for various systems.
3183
Bram Moolenaar071d4272004-06-13 20:20:40 +00003184 For the GTK+ 2 GUI the font name looks like this: >
3185 :set guifont=Andale\ Mono\ 11
3186< That's all. XLFDs are no longer accepted.
Bram Moolenaar05159a02005-02-26 23:04:13 +00003187
3188 For Mac OSX you can use something like this: >
3189 :set guifont=Monaco:h10
3190< *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003191 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003192 width). An exception is GTK 2: all fonts are accepted, but
3193 mono-spaced fonts look best.
3194
Bram Moolenaar071d4272004-06-13 20:20:40 +00003195 To preview a font on X11, you might be able to use the "xfontsel"
3196 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003197
Bram Moolenaar071d4272004-06-13 20:20:40 +00003198 For the Win32 GUI *E244* *E245*
3199 - takes these options in the font name:
3200 hXX - height is XX (points, can be floating-point)
3201 wXX - width is XX (points, can be floating-point)
3202 b - bold
3203 i - italic
3204 u - underline
3205 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003206 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003207 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3208 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3209 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003210 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003211
3212 Use a ':' to separate the options.
3213 - A '_' can be used in the place of a space, so you don't need to use
3214 backslashes to escape the spaces.
3215 - Examples: >
3216 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3217 :set guifont=Andale_Mono:h7.5:w4.5
3218< See also |font-sizes|.
3219
3220 *'guifontset'* *'gfs'*
3221 *E250* *E252* *E234* *E597* *E598*
3222'guifontset' 'gfs' string (default "")
3223 global
3224 {not in Vi}
3225 {only available when compiled with GUI enabled and
3226 with the |+xfontset| feature}
3227 {not available in the GTK+ 2 GUI}
3228 When not empty, specifies two (or more) fonts to be used. The first
3229 one for normal English, the second one for your special language. See
3230 |xfontset|.
3231 Setting this option also means that all font names will be handled as
3232 a fontset name. Also the ones used for the "font" argument of the
3233 |:highlight| command.
3234 The fonts must match with the current locale. If fonts for the
3235 character sets that the current locale uses are not included, setting
3236 'guifontset' will fail.
3237 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3238 the comma-separated names are alternative names, one of which will be
3239 used. In 'guifontset' the whole string is one fontset name,
3240 including the commas. It is not possible to specify alternative
3241 fontset names.
3242 This example works on many X11 systems: >
3243 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3244<
3245 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3246'guifontwide' 'gfw' string (default "")
3247 global
3248 {not in Vi}
3249 {only available when compiled with GUI enabled}
3250 When not empty, specifies a comma-separated list of fonts to be used
3251 for double-width characters. The first font that can be loaded is
3252 used.
3253 Note: The size of these fonts must be exactly twice as wide as the one
3254 specified with 'guifont' and the same height.
3255
3256 All GUI versions but GTK+ 2:
3257
3258 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3259 'guifontset' is empty or invalid.
3260 When 'guifont' is set and a valid font is found in it and
3261 'guifontwide' is empty Vim will attempt to find a matching
3262 double-width font and set 'guifontwide' to it.
3263
3264 GTK+ 2 GUI only: *guifontwide_gtk2*
3265
3266 If set and valid, 'guifontwide' is always used for double width
3267 characters, even if 'encoding' is not set to "utf-8".
3268 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003269 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003270 font for characters not available in 'guifont'. Thus you do not need
3271 to set 'guifontwide' at all unless you want to override the choice
3272 made by Pango/Xft.
3273
3274 *'guiheadroom'* *'ghr'*
3275'guiheadroom' 'ghr' number (default 50)
3276 global
3277 {not in Vi} {only for GTK and X11 GUI}
3278 The number of pixels subtracted from the screen height when fitting
3279 the GUI window on the screen. Set this before the GUI is started,
3280 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003281 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003282 lines will be left for window decorations and other items on the
3283 screen. Set it to a negative value to allow windows taller than the
3284 screen.
3285
3286 *'guioptions'* *'go'*
3287'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003288 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003289 global
3290 {not in Vi}
3291 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003292 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003293 sequence of letters which describes what components and options of the
3294 GUI should be used.
3295 To avoid problems with flags that are added in the future, use the
3296 "+=" and "-=" feature of ":set" |add-option-flags|.
3297
3298 Valid letters are as follows:
3299 *guioptions_a*
3300 'a' Autoselect: If present, then whenever VISUAL mode is started,
3301 or the Visual area extended, Vim tries to become the owner of
3302 the windowing system's global selection. This means that the
3303 Visually highlighted text is available for pasting into other
3304 applications as well as into Vim itself. When the Visual mode
3305 ends, possibly due to an operation on the text, or when an
3306 application wants to paste the selection, the highlighted text
3307 is automatically yanked into the "* selection register.
3308 Thus the selection is still available for pasting into other
3309 applications after the VISUAL mode has ended.
3310 If not present, then Vim won't become the owner of the
3311 windowing system's global selection unless explicitly told to
3312 by a yank or delete operation for the "* register.
3313 The same applies to the modeless selection.
3314
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003315 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003316 applies to the modeless selection.
3317
3318 'guioptions' autoselect Visual autoselect modeless ~
3319 "" - -
3320 "a" yes yes
3321 "A" - yes
3322 "aA" yes yes
3323
3324 'c' Use console dialogs instead of popup dialogs for simple
3325 choices.
3326
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003327 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003328 'guitablabel' can be used to change the text in the labels.
3329 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00003330 The GUI tabs are only supported on some systens, currently
3331 only for GTK.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003332
Bram Moolenaar071d4272004-06-13 20:20:40 +00003333 'f' Foreground: Don't use fork() to detach the GUI from the shell
3334 where it was started. Use this for programs that wait for the
3335 editor to finish (e.g., an e-mail program). Alternatively you
3336 can use "gvim -f" or ":gui -f" to start the GUI in the
3337 foreground. |gui-fork|
3338 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003339 happened already when the |gvimrc| file is read.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003340
3341 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3342 corner of the window. It's black&white on non-GTK, because of
3343 limitations of X11. For a color icon, see |X11-icon|.
3344
3345 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003346 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003347 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003348 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003349 file is sourced the system menu has already been loaded; the
3350 ":syntax on" and ":filetype on" commands load the menu too).
3351 'g' Grey menu items: Make menu items that are not active grey. If
3352 'g' is not included inactive menu items are not shown at all.
3353 Exception: Athena will always use grey menu items.
3354
3355 't' Include tearoff menu items. Currently only works for Win32,
3356 GTK+, and Motif 1.2 GUI.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003357 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
3358 and Athena GUIs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003359
3360 'r' Right-hand scrollbar is always present.
3361 'R' Right-hand scrollbar is present when there is a vertically
3362 split window.
3363 'l' Left-hand scrollbar is always present.
3364 'L' Left-hand scrollbar is present when there is a vertically
3365 split window.
3366 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3367 the longest visible line, or on the cursor line if the 'h'
3368 flag is included. |gui-horiz-scroll|
3369 'h' Limit horizontal scrollbar size to the length of the cursor
3370 line. Reduces computations. |gui-horiz-scroll|
3371
3372 And yes, you may even have scrollbars on the left AND the right if
3373 you really want to :-). See |gui-scrollbars| for more information.
3374
3375 'v' Use a vertical button layout for dialogs. When not included,
3376 a horizontal layout is preferred, but when it doesn't fit a
3377 vertical layout is used anyway.
3378 'p' Use Pointer callbacks for X11 GUI. This is required for some
3379 window managers. If the cursor is not blinking or hollow at
3380 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003381 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003382 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003383 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003384
3385 *'guipty'* *'noguipty'*
3386'guipty' boolean (default on)
3387 global
3388 {not in Vi}
3389 {only available when compiled with GUI enabled}
3390 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3391 I/O to/from shell commands. See |gui-pty|.
3392
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003393 *'guitablabel'* *'gtl'*
3394'guitablabel' 'gtl' string (default empty)
3395 global
3396 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003397 {only available when compiled with GUI enabled and
3398 with the +windows feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003399 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003400 pages line. When empty Vim will use a default label. See
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003401 |setting-guitablabel| for more info.
3402
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003403 The format of this option is like that of 'statusline'.
3404
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003405 Only used when the GUI tab pages line is displayed. 'e' must be
3406 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3407 used.
3408
Bram Moolenaar071d4272004-06-13 20:20:40 +00003409 *'helpfile'* *'hf'*
3410'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3411 (others) "$VIMRUNTIME/doc/help.txt")
3412 global
3413 {not in Vi}
3414 Name of the main help file. All distributed help files should be
3415 placed together in one directory. Additionally, all "doc" directories
3416 in 'runtimepath' will be used.
3417 Environment variables are expanded |:set_env|. For example:
3418 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003419 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003420 spaces and backslashes.
3421 This option cannot be set from a |modeline| or in the |sandbox|, for
3422 security reasons.
3423
3424 *'helpheight'* *'hh'*
3425'helpheight' 'hh' number (default 20)
3426 global
3427 {not in Vi}
3428 {not available when compiled without the +windows
3429 feature}
3430 Minimal initial height of the help window when it is opened with the
3431 ":help" command. The initial height of the help window is half of the
3432 current window, or (when the 'ea' option is on) the same as other
3433 windows. When the height is less than 'helpheight', the height is
3434 set to 'helpheight'. Set to zero to disable.
3435
3436 *'helplang'* *'hlg'*
3437'helplang' 'hlg' string (default: messages language or empty)
3438 global
3439 {only available when compiled with the |+multi_lang|
3440 feature}
3441 {not in Vi}
3442 Comma separated list of languages. Vim will use the first language
3443 for which the desired help can be found. The English help will always
3444 be used as a last resort. You can add "en" to prefer English over
3445 another language, but that will only find tags that exist in that
3446 language and not in the English help.
3447 Example: >
3448 :set helplang=de,it
3449< This will first search German, then Italian and finally English help
3450 files.
3451 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3452 try to find the tag in the current language before using this option.
3453 See |help-translated|.
3454
3455 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3456'hidden' 'hid' boolean (default off)
3457 global
3458 {not in Vi}
3459 When off a buffer is unloaded when it is |abandon|ed. When on a
3460 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3461 displayed in another window, it does not become hidden, of course.
3462 The commands that move through the buffer list sometimes make a buffer
3463 hidden although the 'hidden' option is off: When the buffer is
3464 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003465 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003466 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003467 This option is set for one command with ":hide {command}" |:hide|.
3468 WARNING: It's easy to forget that you have changes in hidden buffers.
3469 Think twice when using ":q!" or ":qa!".
3470
3471 *'highlight'* *'hl'*
3472'highlight' 'hl' string (default (as a single string):
3473 "8:SpecialKey,@:NonText,d:Directory,
3474 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3475 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003476 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003477 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3478 f:Folded,F:FoldColumn,A:DiffAdd,
3479 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003480 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003481 R:SpellRare,L:SpellLocal,
3482 +:Pmenu,=:PmenuSel,
3483 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003484 global
3485 {not in Vi}
3486 This option can be used to set highlighting mode for various
3487 occasions. It is a comma separated list of character pairs. The
3488 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003489 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3491 |hl-NonText| @ '~' and '@' at the end of the window and
3492 characters from 'showbreak'
3493 |hl-Directory| d directories in CTRL-D listing and other special
3494 things in listings
3495 |hl-ErrorMsg| e error messages
3496 h (obsolete, ignored)
3497 |hl-IncSearch| i 'incsearch' highlighting
3498 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3499 |hl-MoreMsg| m |more-prompt|
3500 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3501 |hl-LineNr| n line number for ":number" and ":#" commands
3502 |hl-Question| r |hit-enter| prompt and yes/no questions
3503 |hl-StatusLine| s status line of current window |status-line|
3504 |hl-StatusLineNC| S status lines of not-current windows
3505 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3506 |hl-VertSplit| c column used to separate vertically split windows
3507 |hl-Visual| v Visual mode
3508 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3509 Selection" Only X11 Gui's |gui-x11| and
3510 |xterm-clipboard|.
3511 |hl-WarningMsg| w warning messages
3512 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3513 |hl-Folded| f line used for closed folds
3514 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003515 |hl-DiffAdd| A added line in diff mode
3516 |hl-DiffChange| C changed line in diff mode
3517 |hl-DiffDelete| D deleted line in diff mode
3518 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003519 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003520 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003521 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003522 |hl-SpellRare| R rare word |spell|
3523 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003524 |hl-Pmenu| + popup menu normal line
3525 |hl-PmenuSel| = popup menu normal line
3526 |hl-PmenuSbar| x popup menu scrollbar
3527 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003528
3529 The display modes are:
3530 r reverse (termcap entry "mr" and "me")
3531 i italic (termcap entry "ZH" and "ZR")
3532 b bold (termcap entry "md" and "me")
3533 s standout (termcap entry "so" and "se")
3534 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003535 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003536 n no highlighting
3537 - no highlighting
3538 : use a highlight group
3539 The default is used for occasions that are not included.
3540 If you want to change what the display modes do, see |dos-colors|
3541 for an example.
3542 When using the ':' display mode, this must be followed by the name of
3543 a highlight group. A highlight group can be used to define any type
3544 of highlighting, including using color. See |:highlight| on how to
3545 define one. The default uses a different group for each occasion.
3546 See |highlight-default| for the default highlight groups.
3547
3548 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3549'hlsearch' 'hls' boolean (default off)
3550 global
3551 {not in Vi}
3552 {not available when compiled without the
3553 |+extra_search| feature}
3554 When there is a previous search pattern, highlight all its matches.
3555 The type of highlighting used can be set with the 'l' occasion in the
3556 'highlight' option. This uses the "Search" highlight group by
3557 default. Note that only the matching text is highlighted, any offsets
3558 are not applied.
3559 See also: 'incsearch' and |:match|.
3560 When you get bored looking at the highlighted matches, you can turn it
3561 off with |:nohlsearch|. As soon as you use a search command, the
3562 highlighting comes back.
3563 When the search pattern can match an end-of-line, Vim will try to
3564 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003565 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003566 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003567 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003568 NOTE: This option is reset when 'compatible' is set.
3569
3570 *'history'* *'hi'*
3571'history' 'hi' number (Vim default: 20, Vi default: 0)
3572 global
3573 {not in Vi}
3574 A history of ":" commands, and a history of previous search patterns
3575 are remembered. This option decides how many entries may be stored in
3576 each of these histories (see |cmdline-editing|).
3577 NOTE: This option is set to the Vi default value when 'compatible' is
3578 set and to the Vim default value when 'compatible' is reset.
3579
3580 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3581'hkmap' 'hk' boolean (default off)
3582 global
3583 {not in Vi}
3584 {only available when compiled with the |+rightleft|
3585 feature}
3586 When on, the keyboard is mapped for the Hebrew character set.
3587 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3588 toggle this option. See |rileft.txt|.
3589 NOTE: This option is reset when 'compatible' is set.
3590
3591 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3592'hkmapp' 'hkp' boolean (default off)
3593 global
3594 {not in Vi}
3595 {only available when compiled with the |+rightleft|
3596 feature}
3597 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3598 This is useful if you have a non-Hebrew keyboard.
3599 See |rileft.txt|.
3600 NOTE: This option is reset when 'compatible' is set.
3601
3602 *'icon'* *'noicon'*
3603'icon' boolean (default off, on when title can be restored)
3604 global
3605 {not in Vi}
3606 {not available when compiled without the |+title|
3607 feature}
3608 When on, the icon text of the window will be set to the value of
3609 'iconstring' (if it is not empty), or to the name of the file
3610 currently being edited. Only the last part of the name is used.
3611 Overridden by the 'iconstring' option.
3612 Only works if the terminal supports setting window icons (currently
3613 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3614 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3615 builtin termcap).
3616 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003617 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003618 X11.
3619
3620 *'iconstring'*
3621'iconstring' string (default "")
3622 global
3623 {not in Vi}
3624 {not available when compiled without the |+title|
3625 feature}
3626 When this option is not empty, it will be used for the icon text of
3627 the window. This happens only when the 'icon' option is on.
3628 Only works if the terminal supports setting window icon text
3629 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3630 Does not work for MS Windows.
3631 When Vim was compiled with HAVE_X11 defined, the original icon will be
3632 restored if possible |X11|.
3633 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003634 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003635 'titlestring' for example settings.
3636 {not available when compiled without the |+statusline| feature}
3637
3638 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3639'ignorecase' 'ic' boolean (default off)
3640 global
3641 Ignore case in search patterns. Also used when searching in the tags
3642 file.
3643 Also see 'smartcase'.
3644 Can be overruled by using "\c" or "\C" in the pattern, see
3645 |/ignorecase|.
3646
3647 *'imactivatekey'* *'imak'*
3648'imactivatekey' 'imak' string (default "")
3649 global
3650 {not in Vi}
3651 {only available when compiled with |+xim| and
3652 |+GUI_GTK|}
3653 Specifies the key that your Input Method in X-Windows uses for
3654 activation. When this is specified correctly, vim can fully control
3655 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3656 You can't use this option to change the activation key, the option
3657 tells Vim what the key is.
3658 Format:
3659 [MODIFIER_FLAG-]KEY_STRING
3660
3661 These characters can be used for MODIFIER_FLAG (case is ignored):
3662 S Shift key
3663 L Lock key
3664 C Control key
3665 1 Mod1 key
3666 2 Mod2 key
3667 3 Mod3 key
3668 4 Mod4 key
3669 5 Mod5 key
3670 Combinations are allowed, for example "S-C-space" or "SC-space" are
3671 both shift+ctrl+space.
3672 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3673
3674 Example: >
3675 :set imactivatekey=S-space
3676< "S-space" means shift+space. This is the activation key for kinput2 +
3677 canna (Japanese), and ami (Korean).
3678
3679 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3680'imcmdline' 'imc' boolean (default off)
3681 global
3682 {not in Vi}
3683 {only available when compiled with the |+xim|
3684 |+multi_byte_ime| or |global-ime| feature}
3685 When set the Input Method is always on when starting to edit a command
3686 line, unless entering a search pattern (see 'imsearch' for that).
3687 Setting this option is useful when your input method allows entering
3688 English characters directly, e.g., when it's used to type accented
3689 characters with dead keys.
3690
3691 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3692'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3693 global
3694 {not in Vi}
3695 {only available when compiled with the |+xim|
3696 |+multi_byte_ime| or |global-ime| feature}
3697 When set the Input Method is never used. This is useful to disable
3698 the IM when it doesn't work properly.
3699 Currently this option is on by default for SGI/IRIX machines. This
3700 may change in later releases.
3701
3702 *'iminsert'* *'imi'*
3703'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3704 local to buffer
3705 {not in Vi}
3706 Specifies whether :lmap or an Input Method (IM) is to be used in
3707 Insert mode. Valid values:
3708 0 :lmap is off and IM is off
3709 1 :lmap is ON and IM is off
3710 2 :lmap is off and IM is ON
3711 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3712 or |global-ime|.
3713 To always reset the option to zero when leaving Insert mode with <Esc>
3714 this can be used: >
3715 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3716< This makes :lmap and IM turn off automatically when leaving Insert
3717 mode.
3718 Note that this option changes when using CTRL-^ in Insert mode
3719 |i_CTRL-^|.
3720 The value is set to 1 when setting 'keymap' to a valid keymap name.
3721 It is also used for the argument of commands like "r" and "f".
3722 The value 0 may not work correctly with Athena and Motif with some XIM
3723 methods. Use 'imdisable' to disable XIM then.
3724
3725 *'imsearch'* *'ims'*
3726'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3727 local to buffer
3728 {not in Vi}
3729 Specifies whether :lmap or an Input Method (IM) is to be used when
3730 entering a search pattern. Valid values:
3731 -1 the value of 'iminsert' is used, makes it look like
3732 'iminsert' is also used when typing a search pattern
3733 0 :lmap is off and IM is off
3734 1 :lmap is ON and IM is off
3735 2 :lmap is off and IM is ON
3736 Note that this option changes when using CTRL-^ in Command-line mode
3737 |c_CTRL-^|.
3738 The value is set to 1 when it is not -1 and setting the 'keymap'
3739 option to a valid keymap name.
3740 The value 0 may not work correctly with Athena and Motif with some XIM
3741 methods. Use 'imdisable' to disable XIM then.
3742
3743 *'include'* *'inc'*
3744'include' 'inc' string (default "^\s*#\s*include")
3745 global or local to buffer |global-local|
3746 {not in Vi}
3747 {not available when compiled without the
3748 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003749 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003750 pattern, just like for the "/" command (See |pattern|). The default
3751 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003752 "]I", "[d", etc.
3753 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003754 comes after the matched pattern. But if "\zs" appears in the pattern
3755 then the text matched from "\zs" to the end, or until "\ze" if it
3756 appears, is used as the file name. Use this to include characters
3757 that are not in 'isfname', such as a space. You can then use
3758 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003759 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003760
3761 *'includeexpr'* *'inex'*
3762'includeexpr' 'inex' string (default "")
3763 local to buffer
3764 {not in Vi}
3765 {not available when compiled without the
3766 |+find_in_path| or |+eval| feature}
3767 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003768 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003769 :set includeexpr=substitute(v:fname,'\\.','/','g')
3770< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003771
Bram Moolenaar071d4272004-06-13 20:20:40 +00003772 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003773 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003774 Also used for |<cfile>|.
3775
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003776 The expression may be evaluated in the |sandbox|, see
3777 |sandbox-option|.
3778
3779 It is not allowed to change text or jump to another window while
3780 evaluating 'includeexpr' |textlock|.
3781
Bram Moolenaar071d4272004-06-13 20:20:40 +00003782 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3783'incsearch' 'is' boolean (default off)
3784 global
3785 {not in Vi}
3786 {not available when compiled without the
3787 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003788 While typing a search command, show where the pattern, as it was typed
3789 so far, matches. The matched string is highlighted. If the pattern
3790 is invalid or not found, nothing is shown. The screen will be updated
3791 often, this is only useful on fast terminals.
3792 Note that the match will be shown, but the cursor will return to its
3793 original position when no match is found and when pressing <Esc>. You
3794 still need to finish the search command with <Enter> to move the
3795 cursor to the match.
3796 The highlighting can be set with the 'i' flag in 'highlight'.
3797 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00003798 CTRL-L can be used to add one character from after the current match
3799 to the command line.
3800 CTRL-R CTRL-W can be used to add the word at the end of the current
3801 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003802 NOTE: This option is reset when 'compatible' is set.
3803
3804 *'indentexpr'* *'inde'*
3805'indentexpr' 'inde' string (default "")
3806 local to buffer
3807 {not in Vi}
3808 {not available when compiled without the |+cindent|
3809 or |+eval| features}
3810 Expression which is evaluated to obtain the proper indent for a line.
3811 It is used when a new line is created, for the |=| operator and
3812 in Insert mode as specified with the 'indentkeys' option.
3813 When this option is not empty, it overrules the 'cindent' and
3814 'smartindent' indenting.
3815 When 'paste' is set this option is not used for indenting.
3816 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003817 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818 when the expression is evaluated (but it may be moved around).
3819 The expression must return the number of spaces worth of indent. It
3820 can return "-1" to keep the current indent (this means 'autoindent' is
3821 used for the indent).
3822 Functions useful for computing the indent are |indent()|, |cindent()|
3823 and |lispindent()|.
3824 The evaluation of the expression must not have side effects! It must
3825 not change the text, jump to another window, etc. Afterwards the
3826 cursor position is always restored, thus the cursor may be moved.
3827 Normally this option would be set to call a function: >
3828 :set indentexpr=GetMyIndent()
3829< Error messages will be suppressed, unless the 'debug' option contains
3830 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003831 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003832 NOTE: This option is made empty when 'compatible' is set.
3833
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003834 The expression may be evaluated in the |sandbox|, see
3835 |sandbox-option|.
3836
3837 It is not allowed to change text or jump to another window while
3838 evaluating 'indentexpr' |textlock|.
3839
3840
Bram Moolenaar071d4272004-06-13 20:20:40 +00003841 *'indentkeys'* *'indk'*
3842'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3843 local to buffer
3844 {not in Vi}
3845 {not available when compiled without the |+cindent|
3846 feature}
3847 A list of keys that, when typed in Insert mode, cause reindenting of
3848 the current line. Only happens if 'indentexpr' isn't empty.
3849 The format is identical to 'cinkeys', see |indentkeys-format|.
3850 See |C-indenting| and |indent-expression|.
3851
3852 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3853'infercase' 'inf' boolean (default off)
3854 local to buffer
3855 {not in Vi}
3856 When doing keyword completion in insert mode |ins-completion|, and
3857 'ignorecase' is also on, the case of the match is adjusted. If the
3858 typed text contains a lowercase letter where the match has an upper
3859 case letter, the completed part is made lowercase. If the typed text
3860 has no lowercase letters and the match has a lowercase letter where
3861 the typed text has an uppercase letter, and there is a letter before
3862 it, the completed part is made uppercase.
3863
3864 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3865'insertmode' 'im' boolean (default off)
3866 global
3867 {not in Vi}
3868 Makes Vim work in a way that Insert mode is the default mode. Useful
3869 if you want to use Vim as a modeless editor. Used for |evim|.
3870 These Insert mode commands will be useful:
3871 - Use the cursor keys to move around.
3872 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3873 this is a mapping, it is executed as if 'insertmode' was off.
3874 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003875 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00003876 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
3877 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003878
3879 These items change when 'insertmode' is set:
3880 - when starting to edit of a file, Vim goes to Insert mode.
3881 - <Esc> in Insert mode is a no-op and beeps.
3882 - <Esc> in Normal mode makes Vim go to Insert mode.
3883 - CTRL-L in Insert mode is a command, it is not inserted.
3884 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3885 However, when <Esc> is used inside a mapping, it behaves like
3886 'insertmode' was not set. This was done to be able to use the same
3887 mappings with 'insertmode' set or not set.
3888 When executing commands with |:normal| 'insertmode' is not used.
3889
3890 NOTE: This option is reset when 'compatible' is set.
3891
3892 *'isfname'* *'isf'*
3893'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3894 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3895 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3896 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3897 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3898 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3899 global
3900 {not in Vi}
3901 The characters specified by this option are included in file names and
3902 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003903 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003904 Multi-byte characters 256 and above are always included, only the
3905 characters up to 255 are specified with this option.
3906 For UTF-8 the characters 0xa0 to 0xff are included as well.
3907
3908 Note that on systems using a backslash as path separator, Vim tries to
3909 do its best to make it work as you would expect. That is a bit
3910 tricky, since Vi originally used the backslash to escape special
3911 characters. Vim will not remove a backslash in front of a normal file
3912 name character on these systems, but it will on Unix and alikes. The
3913 '&' and '^' are not included by default, because these are special for
3914 cmd.exe.
3915
3916 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003917 Each part can be a single character number or a range. A range is two
3918 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003919 decimal number between 0 and 255 or the ASCII character itself (does
3920 not work for digits). Example:
3921 "_,-,128-140,#-43" (include '_' and '-' and the range
3922 128 to 140 and '#' to 43)
3923 If a part starts with '^', the following character number or range
3924 will be excluded from the option. The option is interpreted from left
3925 to right. Put the excluded character after the range where it is
3926 included. To include '^' itself use it as the last character of the
3927 option or the end of a range. Example:
3928 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3929 If the character is '@', all characters where isalpha() returns TRUE
3930 are included. Normally these are the characters a to z and A to Z,
3931 plus accented characters. To include '@' itself use "@-@". Examples:
3932 "@,^a-z" All alphabetic characters, excluding lower
3933 case letters.
3934 "a-z,A-Z,@-@" All letters plus the '@' character.
3935 A comma can be included by using it where a character number is
3936 expected. Example:
3937 "48-57,,,_" Digits, comma and underscore.
3938 A comma can be excluded by prepending a '^'. Example:
3939 " -~,^,,9" All characters from space to '~', excluding
3940 comma, plus <Tab>.
3941 See |option-backslash| about including spaces and backslashes.
3942
3943 *'isident'* *'isi'*
3944'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3945 "@,48-57,_,128-167,224-235"
3946 otherwise: "@,48-57,_,192-255")
3947 global
3948 {not in Vi}
3949 The characters given by this option are included in identifiers.
3950 Identifiers are used in recognizing environment variables and after a
3951 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00003952 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00003953 option.
3954 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003955 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003956 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3957
3958 *'iskeyword'* *'isk'*
3959'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3960 "@,48-57,_,128-167,224-235"
3961 otherwise: "@,48-57,_,192-255"
3962 Vi default: "@,48-57,_")
3963 local to buffer
3964 {not in Vi}
3965 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003966 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003967 'isfname' for a description of the format of this option. For C
3968 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3969 For a help file it is set to all non-blank printable characters except
3970 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3971 command).
3972 When the 'lisp' option is on the '-' character is always included.
3973 NOTE: This option is set to the Vi default value when 'compatible' is
3974 set and to the Vim default value when 'compatible' is reset.
3975
3976 *'isprint'* *'isp'*
3977'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3978 "@,~-255"; otherwise: "@,161-255")
3979 global
3980 {not in Vi}
3981 The characters given by this option are displayed directly on the
3982 screen. It is also used for "\p" in a |pattern|. The characters from
3983 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3984 even when they are not included in 'isprint' or excluded. See
3985 'isfname' for a description of the format of this option.
3986
3987 Non-printable characters are displayed with two characters:
3988 0 - 31 "^@" - "^_"
3989 32 - 126 always single characters
3990 127 "^?"
3991 128 - 159 "~@" - "~_"
3992 160 - 254 "| " - "|~"
3993 255 "~?"
3994 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3995 displayed as <xx>, with the hexadecimal value of the byte.
3996 When 'display' contains "uhex" all unprintable characters are
3997 displayed as <xx>.
3998 The NonText highlighting will be used for unprintable characters.
3999 |hl-NonText|
4000
4001 Multi-byte characters 256 and above are always included, only the
4002 characters up to 255 are specified with this option. When a character
4003 is printable but it is not available in the current font, a
4004 replacement character will be shown.
4005 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4006 There is no option to specify these characters.
4007
4008 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4009'joinspaces' 'js' boolean (default on)
4010 global
4011 {not in Vi}
4012 Insert two spaces after a '.', '?' and '!' with a join command.
4013 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4014 Otherwise only one space is inserted.
4015 NOTE: This option is set when 'compatible' is set.
4016
4017 *'key'*
4018'key' string (default "")
4019 local to buffer
4020 {not in Vi}
4021 The key that is used for encrypting and decrypting the current buffer.
4022 See |encryption|.
4023 Careful: Do not set the key value by hand, someone might see the typed
4024 key. Use the |:X| command. But you can make 'key' empty: >
4025 :set key=
4026< It is not possible to get the value of this option with ":set key" or
4027 "echo &key". This is to avoid showing it to someone who shouldn't
4028 know. It also means you cannot see it yourself once you have set it,
4029 be careful not to make a typing error!
4030
4031 *'keymap'* *'kmp'* *E544*
4032'keymap' 'kmp' string (default "")
4033 local to buffer
4034 {not in Vi}
4035 {only available when compiled with the |+keymap|
4036 feature}
4037 Name of a keyboard mapping. See |mbyte-keymap|.
4038 Setting this option to a valid keymap name has the side effect of
4039 setting 'iminsert' to one, so that the keymap becomes effective.
4040 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004041 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004042
4043 *'keymodel'* *'km'*
4044'keymodel' 'km' string (default "")
4045 global
4046 {not in Vi}
4047 List of comma separated words, which enable special things that keys
4048 can do. These values can be used:
4049 startsel Using a shifted special key starts selection (either
4050 Select mode or Visual mode, depending on "key" being
4051 present in 'selectmode').
4052 stopsel Using a not-shifted special key stops selection.
4053 Special keys in this context are the cursor keys, <End>, <Home>,
4054 <PageUp> and <PageDown>.
4055 The 'keymodel' option is set by the |:behave| command.
4056
4057 *'keywordprg'* *'kp'*
4058'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4059 OS/2: "view /", VMS: "help")
4060 global or local to buffer |global-local|
4061 {not in Vi}
4062 Program to use for the |K| command. Environment variables are
4063 expanded |:set_env|. ":help" may be used to access the Vim internal
4064 help. (Note that previously setting the global option to the empty
4065 value did this, which is now deprecated.)
4066 When "man" is used, Vim will automatically translate a count for the
4067 "K" command to a section number. Also for "man -s", in which case the
4068 "-s" is removed when there is no count.
4069 See |option-backslash| about including spaces and backslashes.
4070 Example: >
4071 :set keywordprg=man\ -s
4072< This option cannot be set from a |modeline| or in the |sandbox|, for
4073 security reasons.
4074
4075 *'langmap'* *'lmap'* *E357* *E358*
4076'langmap' 'lmap' string (default "")
4077 global
4078 {not in Vi}
4079 {only available when compiled with the |+langmap|
4080 feature}
4081 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004082 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004083 inserted directly. When in command mode the 'langmap' option takes
4084 care of translating these special characters to the original meaning
4085 of the key. This means you don't have to change the keyboard mode to
4086 be able to execute Normal mode commands.
4087 This is the opposite of the 'keymap' option, where characters are
4088 mapped in Insert mode.
4089 This only works for 8-bit characters. The value of 'langmap' may be
4090 specified with multi-byte characters (e.g., UTF-8), but only the lower
4091 8 bits of each character will be used.
4092
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004093 Example (for Greek, in UTF-8): *greek* >
4094 :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 +00004095< Example (exchanges meaning of z and y for commands): >
4096 :set langmap=zy,yz,ZY,YZ
4097<
4098 The 'langmap' option is a list of parts, separated with commas. Each
4099 part can be in one of two forms:
4100 1. A list of pairs. Each pair is a "from" character immediately
4101 followed by the "to" character. Examples: "aA", "aAbBcC".
4102 2. A list of "from" characters, a semi-colon and a list of "to"
4103 characters. Example: "abc;ABC"
4104 Example: "aA,fgh;FGH,cCdDeE"
4105 Special characters need to be preceded with a backslash. These are
4106 ";", ',' and backslash itself.
4107
4108 This will allow you to activate vim actions without having to switch
4109 back and forth between the languages. Your language characters will
4110 be understood as normal vim English characters (according to the
4111 langmap mappings) in the following cases:
4112 o Normal/Visual mode (commands, buffer/register names, user mappings)
4113 o Insert/Replace Mode: Register names after CTRL-R
4114 o Insert/Replace Mode: Mappings
4115 Characters entered in Command-line mode will NOT be affected by
4116 this option. Note that this option can be changed at any time
4117 allowing to switch between mappings for different languages/encodings.
4118 Use a mapping to avoid having to type it each time!
4119
4120 *'langmenu'* *'lm'*
4121'langmenu' 'lm' string (default "")
4122 global
4123 {not in Vi}
4124 {only available when compiled with the |+menu| and
4125 |+multi_lang| features}
4126 Language to use for menu translation. Tells which file is loaded
4127 from the "lang" directory in 'runtimepath': >
4128 "lang/menu_" . &langmenu . ".vim"
4129< (without the spaces). For example, to always use the Dutch menus, no
4130 matter what $LANG is set to: >
4131 :set langmenu=nl_NL.ISO_8859-1
4132< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004133 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004134 If your $LANG is set to a non-English language but you do want to use
4135 the English menus: >
4136 :set langmenu=none
4137< This option must be set before loading menus, switching on filetype
4138 detection or syntax highlighting. Once the menus are defined setting
4139 this option has no effect. But you could do this: >
4140 :source $VIMRUNTIME/delmenu.vim
4141 :set langmenu=de_DE.ISO_8859-1
4142 :source $VIMRUNTIME/menu.vim
4143< Warning: This deletes all menus that you defined yourself!
4144
4145 *'laststatus'* *'ls'*
4146'laststatus' 'ls' number (default 1)
4147 global
4148 {not in Vi}
4149 The value of this option influences when the last window will have a
4150 status line:
4151 0: never
4152 1: only if there are at least two windows
4153 2: always
4154 The screen looks nicer with a status line if you have several
4155 windows, but it takes another screen line. |status-line|
4156
4157 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4158'lazyredraw' 'lz' boolean (default off)
4159 global
4160 {not in Vi}
4161 When this option is set, the screen will not be redrawn while
4162 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004163 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004164 update use |:redraw|.
4165
4166 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4167'linebreak' 'lbr' boolean (default off)
4168 local to window
4169 {not in Vi}
4170 {not available when compiled without the |+linebreak|
4171 feature}
4172 If on Vim will wrap long lines at a character in 'breakat' rather
4173 than at the last character that fits on the screen. Unlike
4174 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4175 it only affects the way the file is displayed, not its contents. The
4176 value of 'showbreak' is used to put in front of wrapped lines.
4177 This option is not used when the 'wrap' option is off or 'list' is on.
4178 Note that <Tab> characters after an <EOL> are mostly not displayed
4179 with the right amount of white space.
4180
4181 *'lines'* *E593*
4182'lines' number (default 24 or terminal height)
4183 global
4184 Number of lines of the Vim window.
4185 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004186 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004187 When Vim is running in the GUI or in a resizable window, setting this
4188 option will cause the window size to be changed. When you only want
4189 to use the size for the GUI, put the command in your |gvimrc| file.
4190 Vim limits the number of lines to what fits on the screen. You can
4191 use this command to get the tallest window possible: >
4192 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004193< Minimum value is 2, maximum value is 1000.
4194 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004195 When you set this option and Vim is unable to change the physical
4196 number of lines of the display, the display may be messed up.
4197
4198 *'linespace'* *'lsp'*
4199'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4200 global
4201 {not in Vi}
4202 {only in the GUI}
4203 Number of pixel lines inserted between characters. Useful if the font
4204 uses the full character cell height, making lines touch each other.
4205 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004206 With some fonts there can be too much room between lines (to have
4207 space for ascents and descents). Then it makes sense to set
4208 'linespace' to a negative value. This may cause display problems
4209 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004210
4211 *'lisp'* *'nolisp'*
4212'lisp' boolean (default off)
4213 local to buffer
4214 {not available when compiled without the |+lispindent|
4215 feature}
4216 Lisp mode: When <Enter> is typed in insert mode set the indent for
4217 the next line to Lisp standards (well, sort of). Also happens with
4218 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4219 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4220 better. Also see 'lispwords'.
4221 The '-' character is included in keyword characters. Redefines the
4222 "=" operator to use this same indentation algorithm rather than
4223 calling an external program if 'equalprg' is empty.
4224 This option is not used when 'paste' is set.
4225 {Vi: Does it a little bit differently}
4226
4227 *'lispwords'* *'lw'*
4228'lispwords' 'lw' string (default is very long)
4229 global
4230 {not in Vi}
4231 {not available when compiled without the |+lispindent|
4232 feature}
4233 Comma separated list of words that influence the Lisp indenting.
4234 |'lisp'|
4235
4236 *'list'* *'nolist'*
4237'list' boolean (default off)
4238 local to window
4239 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
4240 see the difference between tabs and spaces and for trailing blanks.
4241 Note that this will also affect formatting (set with 'textwidth' or
4242 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
4243 changing the way tabs are displayed.
4244
4245 *'listchars'* *'lcs'*
4246'listchars' 'lcs' string (default "eol:$")
4247 global
4248 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004249 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004250 settings.
4251 eol:c Character to show at the end of each line. When
4252 omitted, there is no extra character at the end of the
4253 line.
4254 tab:xy Two characters to be used to show a Tab. The first
4255 char is used once. The second char is repeated to
4256 fill the space that the Tab normally occupies.
4257 "tab:>-" will show a Tab that takes four spaces as
4258 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004259 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004260 trailing spaces are blank.
4261 extends:c Character to show in the last column, when 'wrap' is
4262 off and the line continues beyond the right of the
4263 screen.
4264 precedes:c Character to show in the first column, when 'wrap'
4265 is off and there is text preceding the character
4266 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004267 nbsp:c Character to show for a non-breakable space (character
4268 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004269
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004270 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004271 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004272 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004273
4274 Examples: >
4275 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004276 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004277 :set lcs=extends:>,precedes:<
4278< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004279 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004280
4281 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4282'loadplugins' 'lpl' boolean (default on)
4283 global
4284 {not in Vi}
4285 When on the plugin scripts are loaded when starting up |load-plugins|.
4286 This option can be reset in your |vimrc| file to disable the loading
4287 of plugins.
4288 Note that using the "-u NONE" and "--noplugin" command line arguments
4289 reset this option. |-u| |--noplugin|
4290
4291 *'magic'* *'nomagic'*
4292'magic' boolean (default on)
4293 global
4294 Changes the special characters that can be used in search patterns.
4295 See |pattern|.
4296 NOTE: To avoid portability problems with using patterns, always keep
4297 this option at the default "on". Only switch it off when working with
4298 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004299 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004300
4301 *'makeef'* *'mef'*
4302'makeef' 'mef' string (default: "")
4303 global
4304 {not in Vi}
4305 {not available when compiled without the |+quickfix|
4306 feature}
4307 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4308 and the |:grep| command.
4309 When it is empty, an internally generated temp file will be used.
4310 When "##" is included, it is replaced by a number to make the name
4311 unique. This makes sure that the ":make" command doesn't overwrite an
4312 existing file.
4313 NOT used for the ":cf" command. See 'errorfile' for that.
4314 Environment variables are expanded |:set_env|.
4315 See |option-backslash| about including spaces and backslashes.
4316 This option cannot be set from a |modeline| or in the |sandbox|, for
4317 security reasons.
4318
4319 *'makeprg'* *'mp'*
4320'makeprg' 'mp' string (default "make", VMS: "MMS")
4321 global or local to buffer |global-local|
4322 {not in Vi}
4323 Program to use for the ":make" command. See |:make_makeprg|. This
4324 option may contain '%' and '#' characters, which are expanded like
4325 when used in a command-line. Environment variables are expanded
4326 |:set_env|. See |option-backslash| about including spaces and
4327 backslashes. Note that a '|' must be escaped twice: once for ":set"
4328 and once for the interpretation of a command. When you use a filter
4329 called "myfilter" do it like this: >
4330 :set makeprg=gmake\ \\\|\ myfilter
4331< The placeholder "$*" can be given (even multiple times) to specify
4332 where the arguments will be included, for example: >
4333 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4334< This option cannot be set from a |modeline| or in the |sandbox|, for
4335 security reasons.
4336
4337 *'matchpairs'* *'mps'*
4338'matchpairs' 'mps' string (default "(:),{:},[:]")
4339 local to buffer
4340 {not in Vi}
4341 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004342 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00004343 must be different. The characters must be separated by a colon. The
4344 pairs must be separated by a comma. Example for including '<' and '>'
4345 (HTML): >
4346 :set mps+=<:>
4347
4348< A more exotic example, to jump between the '=' and ';' in an
4349 assignment, useful for languages like C and Java: >
4350 :au FileType c,cpp,java set mps+==:;
4351
4352< For a more advanced way of using "%", see the matchit.vim plugin in
4353 the $VIMRUNTIME/macros directory. |add-local-help|
4354
4355 *'matchtime'* *'mat'*
4356'matchtime' 'mat' number (default 5)
4357 global
4358 {not in Vi}{in Nvi}
4359 Tenths of a second to show the matching paren, when 'showmatch' is
4360 set. Note that this is not in milliseconds, like other options that
4361 set a time. This is to be compatible with Nvi.
4362
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004363 *'maxcombine'* *'mco'*
4364'maxcombine' 'mco' number (default 2)
4365 global
4366 {not in Vi}
4367 {only available when compiled with the |+multi_byte|
4368 feature}
4369 The maximum number of combining characters supported for displaying.
4370 Only used when 'encoding' is "utf-8".
4371 The default is OK for most languages. Hebrew may require 4.
4372 Maximum value is 6.
4373 Even when this option is set to 2 you can still edit text with more
4374 combining characters, you just can't see them. Use |g8| or |ga|.
4375 See |mbyte-combining|.
4376
Bram Moolenaar071d4272004-06-13 20:20:40 +00004377 *'maxfuncdepth'* *'mfd'*
4378'maxfuncdepth' 'mfd' number (default 100)
4379 global
4380 {not in Vi}
4381 Maximum depth of function calls for user functions. This normally
4382 catches endless recursion. When using a recursive function with
4383 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4384 more memory, there is the danger of failing when memory is exhausted.
4385 See also |:function|.
4386
4387 *'maxmapdepth'* *'mmd'* *E223*
4388'maxmapdepth' 'mmd' number (default 1000)
4389 global
4390 {not in Vi}
4391 Maximum number of times a mapping is done without resulting in a
4392 character to be used. This normally catches endless mappings, like
4393 ":map x y" with ":map y x". It still does not catch ":map g wg",
4394 because the 'w' is used before the next mapping is done. See also
4395 |key-mapping|.
4396
4397 *'maxmem'* *'mm'*
4398'maxmem' 'mm' number (default between 256 to 5120 (system
4399 dependent) or half the amount of memory
4400 available)
4401 global
4402 {not in Vi}
4403 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4404 limit is reached allocating extra memory for a buffer will cause
4405 other memory to be freed. Maximum value 2000000. Use this to work
4406 without a limit. Also see 'maxmemtot'.
4407
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004408 *'maxmempattern'* *'mmp'*
4409'maxmempattern' 'mmp' number (default 1000)
4410 global
4411 {not in Vi}
4412 Maximum amount of memory (in Kbyte) to use for pattern matching.
4413 Maximum value 2000000. Use this to work without a limit.
4414 *E363*
4415 When Vim runs into the limit it gives an error message mostly behaves
4416 like CTRL-C was typed.
4417 Running into the limit often means that the pattern is very
4418 inefficient or too complex. This may already happen with the pattern
4419 "\(.\)*" on a very long line. ".*" works much better.
4420 Vim may run out of memory before hitting the 'maxmempattern' limit.
4421
Bram Moolenaar071d4272004-06-13 20:20:40 +00004422 *'maxmemtot'* *'mmt'*
4423'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4424 dependent) or half the amount of memory
4425 available)
4426 global
4427 {not in Vi}
4428 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004429 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004430 'maxmem'.
4431
4432 *'menuitems'* *'mis'*
4433'menuitems' 'mis' number (default 25)
4434 global
4435 {not in Vi}
4436 {not available when compiled without the |+menu|
4437 feature}
4438 Maximum number of items to use in a menu. Used for menus that are
4439 generated from a list of items, e.g., the Buffers menu. Changing this
4440 option has no direct effect, the menu must be refreshed first.
4441
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004442 *'mkspellmem'* *'msm'*
4443'mkspellmem' 'msm' string (default "460000,2000,500")
4444 global
4445 {not in Vi}
4446 {not available when compiled without the |+syntax|
4447 feature}
4448 Parameters for |:mkspell|. This tunes when to start compressing the
4449 word tree. Compression can be slow when there are many words, but
4450 it's needed to avoid running out of memory. The amount of memory used
4451 per word depends very much on how similar the words are, that's why
4452 this tuning is complicated.
4453
4454 There are three numbers, separated by commas:
4455 {start},{inc},{added}
4456
4457 For most languages the uncompressed word tree fits in memory. {start}
4458 gives the amount of memory in Kbyte that can be used before any
4459 compression is done. It should be a bit smaller than the amount of
4460 memory that is available to Vim.
4461
4462 When going over the {start} limit the {inc} number specifies the
4463 amount of memory in Kbyte that can be allocated before another
4464 compression is done. A low number means compression is done after
4465 less words are added, which is slow. A high number means more memory
4466 will be allocated.
4467
4468 After doing compression, {added} times 1024 words can be added before
4469 the {inc} limit is ignored and compression is done when any extra
4470 amount of memory is needed. A low number means there is a smaller
4471 chance of hitting the {inc} limit, less memory is used but it's
4472 slower.
4473
4474 The languages for which these numbers are important are Italian and
4475 Hungarian. The default works for when you have about 512 Mbyte. If
4476 you have 1 Gbyte you could use: >
4477 :set mkspellmem=900000,3000,800
4478< If you have less than 512 Mbyte |:mkspell| may fail for some
4479 languages, no matter what you set 'mkspellmem' to.
4480
Bram Moolenaar071d4272004-06-13 20:20:40 +00004481 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4482'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4483 local to buffer
4484 *'modelines'* *'mls'*
4485'modelines' 'mls' number (default 5)
4486 global
4487 {not in Vi}
4488 If 'modeline' is on 'modelines' gives the number of lines that is
4489 checked for set commands. If 'modeline' is off or 'modelines' is zero
4490 no lines are checked. See |modeline|.
4491 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4492 set and to the Vim default value when 'compatible' is reset.
4493
4494 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4495'modifiable' 'ma' boolean (default on)
4496 local to buffer
4497 {not in Vi} *E21*
4498 When off the buffer contents cannot be changed. The 'fileformat' and
4499 'fileencoding' options also can't be changed.
4500 Can be reset with the |-M| command line argument.
4501
4502 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4503'modified' 'mod' boolean (default off)
4504 local to buffer
4505 {not in Vi}
4506 When on, the buffer is considered to be modified. This option is set
4507 when:
4508 1. A change was made to the text since it was last written. Using the
4509 |undo| command to go back to the original text will reset the
4510 option. But undoing changes that were made before writing the
4511 buffer will set the option again, since the text is different from
4512 when it was written.
4513 2. 'fileformat' or 'fileencoding' is different from its original
4514 value. The original value is set when the buffer is read or
4515 written. A ":set nomodified" command also resets the original
4516 values to the current values and the 'modified' option will be
4517 reset.
4518 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4519 will be ignored.
4520
4521 *'more'* *'nomore'*
4522'more' boolean (Vim default: on, Vi default: off)
4523 global
4524 {not in Vi}
4525 When on, listings pause when the whole screen is filled. You will get
4526 the |more-prompt|. When this option is off there are no pauses, the
4527 listing continues until finished.
4528 NOTE: This option is set to the Vi default value when 'compatible' is
4529 set and to the Vim default value when 'compatible' is reset.
4530
4531 *'mouse'* *E538*
4532'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4533 global
4534 {not in Vi}
4535 Enable the use of the mouse. Only works for certain terminals
4536 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4537 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4538 The mouse can be enabled for different modes:
4539 n Normal mode
4540 v Visual mode
4541 i Insert mode
4542 c Command-line mode
4543 h all previous modes when editing a help file
4544 a all previous modes
4545 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004546 Normally you would enable the mouse in all four modes with: >
4547 :set mouse=a
4548< When the mouse is not enabled, the GUI will still use the mouse for
4549 modeless selection. This doesn't move the text cursor.
4550
4551 See |mouse-using|. Also see |'clipboard'|.
4552
4553 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004554 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004555 the mouse buttons can still be used by keeping the shift key pressed.
4556 Also see the 'clipboard' option.
4557
4558 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4559'mousefocus' 'mousef' boolean (default off)
4560 global
4561 {not in Vi}
4562 {only works in the GUI}
4563 The window that the mouse pointer is on is automatically activated.
4564 When changing the window layout or window focus in another way, the
4565 mouse pointer is moved to the window with keyboard focus. Off is the
4566 default because it makes using the pull down menus a little goofy, as
4567 a pointer transit may activate a window unintentionally.
4568
4569 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4570'mousehide' 'mh' boolean (default on)
4571 global
4572 {not in Vi}
4573 {only works in the GUI}
4574 When on, the mouse pointer is hidden when characters are typed.
4575 The mouse pointer is restored when the mouse is moved.
4576
4577 *'mousemodel'* *'mousem'*
4578'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4579 global
4580 {not in Vi}
4581 Sets the model to use for the mouse. The name mostly specifies what
4582 the right mouse button is used for:
4583 extend Right mouse button extends a selection. This works
4584 like in an xterm.
4585 popup Right mouse button pops up a menu. The shifted left
4586 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004587 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004588 popup_setpos Like "popup", but the cursor will be moved to the
4589 position where the mouse was clicked, and thus the
4590 selected operation will act upon the clicked object.
4591 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004592 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004593 course, that right clicking outside a selection will
4594 end Visual mode.
4595 Overview of what button does what for each model:
4596 mouse extend popup(_setpos) ~
4597 left click place cursor place cursor
4598 left drag start selection start selection
4599 shift-left search word extend selection
4600 right click extend selection popup menu (place cursor)
4601 right drag extend selection -
4602 middle click paste paste
4603
4604 In the "popup" model the right mouse button produces a pop-up menu.
4605 You need to define this first, see |popup-menu|.
4606
4607 Note that you can further refine the meaning of buttons with mappings.
4608 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4609 selection (because that's handled in the GUI code directly).
4610
4611 The 'mousemodel' option is set by the |:behave| command.
4612
4613 *'mouseshape'* *'mouses'* *E547*
4614'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004615 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004616 global
4617 {not in Vi}
4618 {only available when compiled with the |+mouseshape|
4619 feature}
4620 This option tells Vim what the mouse pointer should look like in
4621 different modes. The option is a comma separated list of parts, much
4622 like used for 'guicursor'. Each part consist of a mode/location-list
4623 and an argument-list:
4624 mode-list:shape,mode-list:shape,..
4625 The mode-list is a dash separated list of these modes/locations:
4626 In a normal window: ~
4627 n Normal mode
4628 v Visual mode
4629 ve Visual mode with 'selection' "exclusive" (same as 'v',
4630 if not specified)
4631 o Operator-pending mode
4632 i Insert mode
4633 r Replace mode
4634
4635 Others: ~
4636 c appending to the command-line
4637 ci inserting in the command-line
4638 cr replacing in the command-line
4639 m at the 'Hit ENTER' or 'More' prompts
4640 ml idem, but cursor in the last line
4641 e any mode, pointer below last window
4642 s any mode, pointer on a status line
4643 sd any mode, while dragging a status line
4644 vs any mode, pointer on a vertical separator line
4645 vd any mode, while dragging a vertical separator line
4646 a everywhere
4647
4648 The shape is one of the following:
4649 avail name looks like ~
4650 w x arrow Normal mouse pointer
4651 w x blank no pointer at all (use with care!)
4652 w x beam I-beam
4653 w x updown up-down sizing arrows
4654 w x leftright left-right sizing arrows
4655 w x busy The system's usual busy pointer
4656 w x no The system's usual 'no input' pointer
4657 x udsizing indicates up-down resizing
4658 x lrsizing indicates left-right resizing
4659 x crosshair like a big thin +
4660 x hand1 black hand
4661 x hand2 white hand
4662 x pencil what you write with
4663 x question big ?
4664 x rightup-arrow arrow pointing right-up
4665 w x up-arrow arrow pointing up
4666 x <number> any X11 pointer number (see X11/cursorfont.h)
4667
4668 The "avail" column contains a 'w' if the shape is available for Win32,
4669 x for X11.
4670 Any modes not specified or shapes not available use the normal mouse
4671 pointer.
4672
4673 Example: >
4674 :set mouseshape=s:udsizing,m:no
4675< will make the mouse turn to a sizing arrow over the status lines and
4676 indicate no input when the hit-enter prompt is displayed (since
4677 clicking the mouse has no effect in this state.)
4678
4679 *'mousetime'* *'mouset'*
4680'mousetime' 'mouset' number (default 500)
4681 global
4682 {not in Vi}
4683 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4684 time in msec between two mouse clicks for the second click to be
4685 recognized as a multi click.
4686
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004687 *'mzquantum'* *'mzq'*
4688'mzquantum' 'mzq' number (default 100)
4689 global
4690 {not in Vi}
4691 {not available when compiled without the |+mzscheme|
4692 feature}
4693 The number of milliseconds between polls for MzScheme threads.
4694 Negative or zero value means no thread scheduling.
4695
Bram Moolenaar071d4272004-06-13 20:20:40 +00004696 *'nrformats'* *'nf'*
4697'nrformats' 'nf' string (default "octal,hex")
4698 local to buffer
4699 {not in Vi}
4700 This defines what bases Vim will consider for numbers when using the
4701 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4702 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004703 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004704 incremented or decremented. This is useful for a list with a
4705 letter index a), b), etc.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004706 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004707 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004708 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004709 considered to be hexadecimal. Example: Using CTRL-X on
4710 "0x100" results in "0x0ff".
4711 Numbers which simply begin with a digit in the range 1-9 are always
4712 considered decimal. This also happens for numbers that are not
4713 recognized as octal or hex.
4714
4715 *'number'* *'nu'* *'nonumber'* *'nonu'*
4716'number' 'nu' boolean (default off)
4717 local to window
4718 Print the line number in front of each line. When the 'n' option is
4719 excluded from 'cpoptions' a wrapped line will not use the column of
4720 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004721 The 'numberwidth' option can be used to set the room used for the line
4722 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004723 When a long, wrapped line doesn't start with the first character, '-'
4724 characters are put before the number.
4725 See |hl-LineNr| for the highlighting used for the number.
4726
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004727 *'numberwidth'* *'nuw'*
4728'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4729 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004730 {not in Vi}
4731 {only available when compiled with the |+linebreak|
4732 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004733 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00004734 when the 'number' option is set or printing lines with a line number.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004735 Since one space is always between the number and the text, there is
4736 one less character for the number itself.
4737 The value is the minimum width. A bigger width is used when needed to
4738 fit the highest line number in the buffer. Thus with the Vim default
4739 of 4 there is room for a line number up to 999. When the buffer has
4740 1000 lines five columns will be used.
4741 The minimum value is 1, the maximum value is 10.
4742 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4743
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004744 *'omnifunc'* *'ofu'*
4745'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00004746 local to buffer
4747 {not in Vi}
4748 {not available when compiled without the +eval
4749 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00004750 This option specifies a function to be used for Insert mode omni
4751 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00004752 See |complete-functions| for an explanation of how the function is
4753 invoked and what it should return.
Bram Moolenaare344bea2005-09-01 20:46:49 +00004754
4755
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00004756 *'operatorfunc'* *'opfunc'*
4757'operatorfunc' 'opfunc' string (default: empty)
4758 global
4759 {not in Vi}
4760 This option specifies a function to be called by the |g@| operator.
4761 See |:map-operator| for more info and an example.
4762
4763 This option cannot be set from a |modeline| or in the |sandbox|, for
4764 security reasons.
4765
4766
Bram Moolenaar071d4272004-06-13 20:20:40 +00004767 *'osfiletype'* *'oft'* *E366*
4768'osfiletype' 'oft' string (RISC-OS default: "Text",
4769 others default: "")
4770 local to buffer
4771 {not in Vi}
4772 {only available when compiled with the |+osfiletype|
4773 feature}
4774 Some operating systems store extra information about files besides
4775 name, datestamp and permissions. This option contains the extra
4776 information, the nature of which will vary between systems.
4777 The value of this option is usually set when the file is loaded, and
4778 use to set the file type when file is written.
4779 It can affect the pattern matching of the automatic commands.
4780 |autocmd-osfiletypes|
4781
4782 *'paragraphs'* *'para'*
4783'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4784 global
4785 Specifies the nroff macros that separate paragraphs. These are pairs
4786 of two letters (see |object-motions|).
4787
4788 *'paste'* *'nopaste'*
4789'paste' boolean (default off)
4790 global
4791 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004792 Put Vim in Paste mode. This is useful if you want to cut or copy
4793 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004794 unexpected effects.
4795 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004796 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004797 knows about pasting and will mostly do the right thing without 'paste'
4798 being set. The same is true for a terminal where Vim handles the
4799 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004800 This option is reset when starting the GUI. Thus if you set it in
4801 your .vimrc it will work in a terminal, but not in the GUI. Setting
4802 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4803 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004804 When the 'paste' option is switched on (also when it was already on):
4805 - mapping in Insert mode and Command-line mode is disabled
4806 - abbreviations are disabled
4807 - 'textwidth' is set to 0
4808 - 'wrapmargin' is set to 0
4809 - 'autoindent' is reset
4810 - 'smartindent' is reset
4811 - 'softtabstop' is set to 0
4812 - 'revins' is reset
4813 - 'ruler' is reset
4814 - 'showmatch' is reset
4815 - 'formatoptions' is used like it is empty
4816 These options keep their value, but their effect is disabled:
4817 - 'lisp'
4818 - 'indentexpr'
4819 - 'cindent'
4820 NOTE: When you start editing another file while the 'paste' option is
4821 on, settings from the modelines or autocommands may change the
4822 settings again, causing trouble when pasting text. You might want to
4823 set the 'paste' option again.
4824 When the 'paste' option is reset the mentioned options are restored to
4825 the value before the moment 'paste' was switched from off to on.
4826 Resetting 'paste' before ever setting it does not have any effect.
4827 Since mapping doesn't work while 'paste' is active, you need to use
4828 the 'pastetoggle' option to toggle the 'paste' option with some key.
4829
4830 *'pastetoggle'* *'pt'*
4831'pastetoggle' 'pt' string (default "")
4832 global
4833 {not in Vi}
4834 When non-empty, specifies the key sequence that toggles the 'paste'
4835 option. This is like specifying a mapping: >
4836 :map {keys} :set invpaste<CR>
4837< Where {keys} is the value of 'pastetoggle'.
4838 The difference is that it will work even when 'paste' is set.
4839 'pastetoggle' works in Insert mode and Normal mode, but not in
4840 Command-line mode.
4841 Mappings are checked first, thus overrule 'pastetoggle'. However,
4842 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4843 this: >
4844 :map <F10> :set paste<CR>
4845 :map <F11> :set nopaste<CR>
4846 :imap <F10> <C-O>:set paste<CR>
4847 :imap <F11> <nop>
4848 :set pastetoggle=<F11>
4849< This will make <F10> start paste mode and <F11> stop paste mode.
4850 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4851 mode everything is inserted literally, except the 'pastetoggle' key
4852 sequence.
4853
4854 *'pex'* *'patchexpr'*
4855'patchexpr' 'pex' string (default "")
4856 global
4857 {not in Vi}
4858 {not available when compiled without the |+diff|
4859 feature}
4860 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004861 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004862
4863 *'patchmode'* *'pm'* *E206*
4864'patchmode' 'pm' string (default "")
4865 global
4866 {not in Vi}
4867 When non-empty the oldest version of a file is kept. This can be used
4868 to keep the original version of a file if you are changing files in a
4869 source distribution. Only the first time that a file is written a
4870 copy of the original file will be kept. The name of the copy is the
4871 name of the original file with the string in the 'patchmode' option
4872 appended. This option should start with a dot. Use a string like
4873 ".org". 'backupdir' must not be empty for this to work (Detail: The
4874 backup file is renamed to the patchmode file after the new file has
4875 been successfully written, that's why it must be possible to write a
4876 backup file). If there was no file to be backed up, an empty file is
4877 created.
4878 When the 'backupskip' pattern matches, a patchmode file is not made.
4879 Using 'patchmode' for compressed files appends the extension at the
4880 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4881 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004882 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004883
4884 *'path'* *'pa'* *E343* *E345* *E347*
4885'path' 'pa' string (default on Unix: ".,/usr/include,,"
4886 on OS/2: ".,/emx/include,,"
4887 other systems: ".,,")
4888 global or local to buffer |global-local|
4889 {not in Vi}
4890 This is a list of directories which will be searched when using the
4891 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4892 being searched for has a relative path (not starting with '/'). The
4893 directories in the 'path' option may be relative or absolute.
4894 - Use commas to separate directory names: >
4895 :set path=.,/usr/local/include,/usr/include
4896< - Spaces can also be used to separate directory names (for backwards
4897 compatibility with version 3.0). To have a space in a directory
4898 name, precede it with an extra backslash, and escape the space: >
4899 :set path=.,/dir/with\\\ space
4900< - To include a comma in a directory name precede it with an extra
4901 backslash: >
4902 :set path=.,/dir/with\\,comma
4903< - To search relative to the directory of the current file, use: >
4904 :set path=.
4905< - To search in the current directory use an empty string between two
4906 commas: >
4907 :set path=,,
4908< - A directory name may end in a ':' or '/'.
4909 - Environment variables are expanded |:set_env|.
4910 - When using |netrw.vim| URLs can be used. For example, adding
4911 "http://www.vim.org" will make ":find index.html" work.
4912 - Search upwards and downwards in a directory tree:
4913 1) "*" matches a sequence of characters, e.g.: >
4914 :set path=/usr/include/*
4915< means all subdirectories in /usr/include (but not /usr/include
4916 itself). >
4917 :set path=/usr/*c
4918< matches /usr/doc and /usr/src.
4919 2) "**" matches a subtree, up to 100 directories deep. Example: >
4920 :set path=/home/user_x/src/**
4921< means search in the whole subtree under "/home/usr_x/src".
4922 3) If the path ends with a ';', this path is the startpoint
4923 for upward search.
4924 See |file-searching| for more info and exact syntax.
4925 {not available when compiled without the |+path_extra| feature}
4926 - Careful with '\' characters, type two to get one in the option: >
4927 :set path=.,c:\\include
4928< Or just use '/' instead: >
4929 :set path=.,c:/include
4930< Don't forget "." or files won't even be found in the same directory as
4931 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004932 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004933 it is something like 256 or 1024 characters.
4934 You can check if all the include files are found, using the value of
4935 'path', see |:checkpath|.
4936 The use of |:set+=| and |:set-=| is preferred when adding or removing
4937 directories from the list. This avoids problems when a future version
4938 uses another default. To remove the current directory use: >
4939 :set path-=
4940< To add the current directory use: >
4941 :set path+=
4942< To use an environment variable, you probably need to replace the
4943 separator. Here is an example to append $INCL, in which directory
4944 names are separated with a semi-colon: >
4945 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4946< Replace the ';' with a ':' or whatever separator is used. Note that
4947 this doesn't work when $INCL contains a comma or white space.
4948
4949 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4950'preserveindent' 'pi' boolean (default off)
4951 local to buffer
4952 {not in Vi}
4953 When changing the indent of the current line, preserve as much of the
4954 indent structure as possible. Normally the indent is replaced by a
4955 series of tabs followed by spaces as required (unless |'expandtab'| is
4956 enabled, in which case only spaces are used). Enabling this option
4957 means the indent will preserve as many existing characters as possible
4958 for indenting, and only add additional tabs or spaces as required.
4959 NOTE: When using ">>" multiple times the resulting indent is a mix of
4960 tabs and spaces. You might not like this.
4961 NOTE: 'preserveindent' is reset when 'compatible' is set.
4962 Also see 'copyindent'.
4963 Use |:retab| to clean up white space.
4964
4965 *'previewheight'* *'pvh'*
4966'previewheight' 'pvh' number (default 12)
4967 global
4968 {not in Vi}
4969 {not available when compiled without the |+windows| or
4970 |+quickfix| feature}
4971 Default height for a preview window. Used for |:ptag| and associated
4972 commands. Used for |CTRL-W_}| when no count is given.
4973
4974 *'previewwindow'* *'nopreviewwindow'*
4975 *'pvw'* *'nopvw'* *E590*
4976'previewwindow' 'pvw' boolean (default off)
4977 local to window
4978 {not in Vi}
4979 {not available when compiled without the |+windows| or
4980 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004981 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004982 set. It's normally not set directly, but by using one of the commands
4983 |:ptag|, |:pedit|, etc.
4984
4985 *'printdevice'* *'pdev'*
4986'printdevice' 'pdev' string (default empty)
4987 global
4988 {not in Vi}
4989 {only available when compiled with the |+printer|
4990 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004991 The name of the printer to be used for |:hardcopy|.
4992 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004993 This option cannot be set from a |modeline| or in the |sandbox|, for
4994 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004995
Bram Moolenaar8299df92004-07-10 09:47:34 +00004996 *'printencoding'* *'penc'*
4997'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004998 global
4999 {not in Vi}
5000 {only available when compiled with the |+printer|
5001 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005002 Sets the character encoding used when printing.
5003 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005004
5005 *'printexpr'* *'pexpr'*
5006'printexpr' 'pexpr' String (default: see below)
5007 global
5008 {not in Vi}
5009 {only available when compiled with the |+printer|
5010 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005011 Expression used to print the PostScript produced with |:hardcopy|.
5012 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005013
Bram Moolenaar8299df92004-07-10 09:47:34 +00005014 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005015'printfont' 'pfn' string (default "courier")
5016 global
5017 {not in Vi}
5018 {only available when compiled with the |+printer|
5019 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005020 The name of the font that will be used for |:hardcopy|.
5021 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005022
5023 *'printheader'* *'pheader'*
5024'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5025 global
5026 {not in Vi}
5027 {only available when compiled with the |+printer|
5028 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005029 The format of the header produced in |:hardcopy| output.
5030 See |pheader-option|.
5031
5032 *'printmbcharset'* *'pmbcs'*
5033'printmbcharset' 'pmbcs' string (default "")
5034 global
5035 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005036 {only available when compiled with the |+printer|,
5037 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005038 The CJK character set to be used for CJK output from |:hardcopy|.
5039 See |pmbcs-option|.
5040
5041 *'printmbfont'* *'pmbfn'*
5042'printmbfont' 'pmbfn' string (default "")
5043 global
5044 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005045 {only available when compiled with the |+printer|,
5046 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005047 List of font names to be used for CJK output from |:hardcopy|.
5048 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005049
5050 *'printoptions'* *'popt'*
5051'printoptions' 'popt' string (default "")
5052 global
5053 {not in Vi}
5054 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005055 List of items that control the format of the output of |:hardcopy|.
5056 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005057
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005058 *'prompt'* *'noprompt'*
5059'prompt' boolean (default on)
5060 global
5061 When on a ":" prompt is used in Ex mode.
5062
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005063 *'pumheight'* *'ph'*
5064'pumheight' 'ph' number (default 0)
5065 global
5066 {not available when compiled without the
5067 |+insert_expand| feature}
5068 {not in Vi}
5069 Determines the maximum number of items to show in the popup menu.
5070 When zero as much space as available is used.
5071 |ins-completion-menu|.
5072
5073
Bram Moolenaar677ee682005-01-27 14:41:15 +00005074 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005075'quoteescape' 'qe' string (default "\")
5076 local to buffer
5077 {not in Vi}
5078 The characters that are used to escape quotes in a string. Used for
5079 objects like a', a" and a` |a'|.
5080 When one of the characters in this option is found inside a string,
5081 the following character will be skipped. The default value makes the
5082 text "foo\"bar\\" considered to be one string.
5083
Bram Moolenaar071d4272004-06-13 20:20:40 +00005084 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5085'readonly' 'ro' boolean (default off)
5086 local to buffer
5087 If on, writes fail unless you use a '!'. Protects you from
5088 accidentally overwriting a file. Default on when Vim is started
5089 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005090 When using ":w!" the 'readonly' option is reset for the current
5091 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005092 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005093 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005094
5095 *'remap'* *'noremap'*
5096'remap' boolean (default on)
5097 global
5098 Allows for mappings to work recursively. If you do not want this for
5099 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005100 NOTE: To avoid portability problems with Vim scripts, always keep
5101 this option at the default "on". Only switch it off when working with
5102 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005103
5104 *'report'*
5105'report' number (default 2)
5106 global
5107 Threshold for reporting number of lines changed. When the number of
5108 changed lines is more than 'report' a message will be given for most
5109 ":" commands. If you want it always, set 'report' to 0.
5110 For the ":substitute" command the number of substitutions is used
5111 instead of the number of lines.
5112
5113 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5114'restorescreen' 'rs' boolean (default on)
5115 global
5116 {not in Vi} {only in Windows 95/NT console version}
5117 When set, the screen contents is restored when exiting Vim. This also
5118 happens when executing external commands.
5119
5120 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5121 options in your .vimrc. To disable restoring:
5122 set t_ti= t_te=
5123 To enable restoring (for an xterm):
5124 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5125 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5126
5127 *'revins'* *'ri'* *'norevins'* *'nori'*
5128'revins' 'ri' boolean (default off)
5129 global
5130 {not in Vi}
5131 {only available when compiled with the |+rightleft|
5132 feature}
5133 Inserting characters in Insert mode will work backwards. See "typing
5134 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5135 command in Insert mode, when 'allowrevins' is set.
5136 NOTE: This option is reset when 'compatible' or 'paste' is set.
5137
5138 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5139'rightleft' 'rl' boolean (default off)
5140 local to window
5141 {not in Vi}
5142 {only available when compiled with the |+rightleft|
5143 feature}
5144 When on, display orientation becomes right-to-left, i.e., characters
5145 that are stored in the file appear from the right to the left.
5146 Using this option, it is possible to edit files for languages that
5147 are written from the right to the left such as Hebrew and Arabic.
5148 This option is per window, so it is possible to edit mixed files
5149 simultaneously, or to view the same file in both ways (this is
5150 useful whenever you have a mixed text file with both right-to-left
5151 and left-to-right strings so that both sets are displayed properly
5152 in different windows). Also see |rileft.txt|.
5153
5154 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
5155'rightleftcmd' 'rlc' string (default "search")
5156 local to window
5157 {not in Vi}
5158 {only available when compiled with the |+rightleft|
5159 feature}
5160 Each word in this option enables the command line editing to work in
5161 right-to-left mode for a group of commands:
5162
5163 search "/" and "?" commands
5164
5165 This is useful for languages such as Hebrew, Arabic and Farsi.
5166 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5167
5168 *'ruler'* *'ru'* *'noruler'* *'noru'*
5169'ruler' 'ru' boolean (default off)
5170 global
5171 {not in Vi}
5172 {not available when compiled without the
5173 |+cmdline_info| feature}
5174 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005175 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005176 text in the file is shown on the far right:
5177 Top first line is visible
5178 Bot last line is visible
5179 All first and last line are visible
5180 45% relative position in the file
5181 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005182 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005183 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005184 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005185 this option takes precedence over 'ruler' and 'rulerformat'
5186 If the number of characters displayed is different from the number of
5187 bytes in the text (e.g., for a TAB or a multi-byte character), both
5188 the text column (byte number) and the screen column are shown,
5189 separated with a dash.
5190 For an empty line "0-1" is shown.
5191 For an empty buffer the line number will also be zero: "0,0-1".
5192 This option is reset when the 'paste' option is set.
5193 If you don't want to see the ruler all the time but want to know where
5194 you are, use "g CTRL-G" |g_CTRL-G|.
5195 NOTE: This option is reset when 'compatible' is set.
5196
5197 *'rulerformat'* *'ruf'*
5198'rulerformat' 'ruf' string (default empty)
5199 global
5200 {not in Vi}
5201 {not available when compiled without the |+statusline|
5202 feature}
5203 When this option is not empty, it determines the content of the ruler
5204 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005205 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005206 The default ruler width is 17 characters. To make the ruler 15
5207 characters wide, put "%15(" at the start and "%)" at the end.
5208 Example: >
5209 :set rulerformat=%15(%c%V\ %p%%%)
5210<
5211 *'runtimepath'* *'rtp'* *vimfiles*
5212'runtimepath' 'rtp' string (default:
5213 Unix: "$HOME/.vim,
5214 $VIM/vimfiles,
5215 $VIMRUNTIME,
5216 $VIM/vimfiles/after,
5217 $HOME/.vim/after"
5218 Amiga: "home:vimfiles,
5219 $VIM/vimfiles,
5220 $VIMRUNTIME,
5221 $VIM/vimfiles/after,
5222 home:vimfiles/after"
5223 PC, OS/2: "$HOME/vimfiles,
5224 $VIM/vimfiles,
5225 $VIMRUNTIME,
5226 $VIM/vimfiles/after,
5227 $HOME/vimfiles/after"
5228 Macintosh: "$VIM:vimfiles,
5229 $VIMRUNTIME,
5230 $VIM:vimfiles:after"
5231 RISC-OS: "Choices:vimfiles,
5232 $VIMRUNTIME,
5233 Choices:vimfiles/after"
5234 VMS: "sys$login:vimfiles,
5235 $VIM/vimfiles,
5236 $VIMRUNTIME,
5237 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005238 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005239 global
5240 {not in Vi}
5241 This is a list of directories which will be searched for runtime
5242 files:
5243 filetype.vim filetypes by file name |new-filetype|
5244 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005245 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005246 colors/ color scheme files |:colorscheme|
5247 compiler/ compiler files |:compiler|
5248 doc/ documentation |write-local-help|
5249 ftplugin/ filetype plugins |write-filetype-plugin|
5250 indent/ indent scripts |indent-expression|
5251 keymap/ key mapping files |mbyte-keymap|
5252 lang/ menu translations |:menutrans|
5253 menu.vim GUI menus |menu.vim|
5254 plugin/ plugin scripts |write-plugin|
5255 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005256 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005257 syntax/ syntax files |mysyntaxfile|
5258 tutor/ files for vimtutor |tutor|
5259
5260 And any other file searched for with the |:runtime| command.
5261
5262 The defaults for most systems are setup to search five locations:
5263 1. In your home directory, for your personal preferences.
5264 2. In a system-wide Vim directory, for preferences from the system
5265 administrator.
5266 3. In $VIMRUNTIME, for files distributed with Vim.
5267 *after-directory*
5268 4. In the "after" directory in the system-wide Vim directory. This is
5269 for the system administrator to overrule or add to the distributed
5270 defaults (rarely needed)
5271 5. In the "after" directory in your home directory. This is for
5272 personal preferences to overrule or add to the distributed defaults
5273 or system-wide settings (rarely needed).
5274
5275 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5276 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005277 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005278 wildcards.
5279 See |:runtime|.
5280 Example: >
5281 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5282< This will use the directory "~/vimruntime" first (containing your
5283 personal Vim runtime files), then "/mygroup/vim" (shared between a
5284 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5285 files).
5286 You probably should always include $VIMRUNTIME somewhere, to use the
5287 distributed runtime files. You can put a directory before $VIMRUNTIME
5288 to find files which replace a distributed runtime files. You can put
5289 a directory after $VIMRUNTIME to find files which add to distributed
5290 runtime files.
5291 This option cannot be set from a |modeline| or in the |sandbox|, for
5292 security reasons.
5293
5294 *'scroll'* *'scr'*
5295'scroll' 'scr' number (default: half the window height)
5296 local to window
5297 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5298 set to half the number of lines in the window when the window size
5299 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005300 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005301 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5302 the number of screen lines instead of file lines, makes a difference
5303 when lines wrap}
5304
5305 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5306'scrollbind' 'scb' boolean (default off)
5307 local to window
5308 {not in Vi}
5309 {not available when compiled without the |+scrollbind|
5310 feature}
5311 See also |scroll-binding|. When this option is set, the current
5312 window scrolls as other scrollbind windows (windows that also have
5313 this option set) scroll. This option is useful for viewing the
5314 differences between two versions of a file, see 'diff'.
5315 See |'scrollopt'| for options that determine how this option should be
5316 interpreted.
5317 This option is mostly reset when splitting a window to edit another
5318 file. This means that ":split | edit file" results in two windows
5319 with scroll-binding, but ":split file" does not.
5320
5321 *'scrolljump'* *'sj'*
5322'scrolljump' 'sj' number (default 1)
5323 global
5324 {not in Vi}
5325 Minimal number of lines to scroll when the cursor gets off the
5326 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5327 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005328 When set to a negative number from -1 to -100 this is used as the
5329 percentage of the window height. Thus -50 scrolls half the window
5330 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005331 NOTE: This option is set to 1 when 'compatible' is set.
5332
5333 *'scrolloff'* *'so'*
5334'scrolloff' 'so' number (default 0)
5335 global
5336 {not in Vi}
5337 Minimal number of screen lines to keep above and below the cursor.
5338 This will make some context visible around where you are working. If
5339 you set it to a very large value (999) the cursor line will always be
5340 in the middle of the window (except at the start or end of the file or
5341 when long lines wrap).
5342 For scrolling horizontally see 'sidescrolloff'.
5343 NOTE: This option is set to 0 when 'compatible' is set.
5344
5345 *'scrollopt'* *'sbo'*
5346'scrollopt' 'sbo' string (default "ver,jump")
5347 global
5348 {not available when compiled without the |+scrollbind|
5349 feature}
5350 {not in Vi}
5351 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005352 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5353 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005354 The following words are available:
5355 ver Bind vertical scrolling for 'scrollbind' windows
5356 hor Bind horizontal scrolling for 'scrollbind' windows
5357 jump Applies to the offset between two windows for vertical
5358 scrolling. This offset is the difference in the first
5359 displayed line of the bound windows. When moving
5360 around in a window, another 'scrollbind' window may
5361 reach a position before the start or after the end of
5362 the buffer. The offset is not changed though, when
5363 moving back the 'scrollbind' window will try to scroll
5364 to the desired position when possible.
5365 When now making that window the current one, two
5366 things can be done with the relative offset:
5367 1. When "jump" is not included, the relative offset is
5368 adjusted for the scroll position in the new current
5369 window. When going back to the other window, the
5370 the new relative offset will be used.
5371 2. When "jump" is included, the other windows are
5372 scrolled to keep the same relative offset. When
5373 going back to the other window, it still uses the
5374 same relative offset.
5375 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005376 When 'diff' mode is active there always is vertical scroll binding,
5377 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005378
5379 *'sections'* *'sect'*
5380'sections' 'sect' string (default "SHNHH HUnhsh")
5381 global
5382 Specifies the nroff macros that separate sections. These are pairs of
5383 two letters (See |object-motions|). The default makes a section start
5384 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5385
5386 *'secure'* *'nosecure'* *E523*
5387'secure' boolean (default off)
5388 global
5389 {not in Vi}
5390 When on, ":autocmd", shell and write commands are not allowed in
5391 ".vimrc" and ".exrc" in the current directory and map commands are
5392 displayed. Switch it off only if you know that you will not run into
5393 problems, or when the 'exrc' option is off. On Unix this option is
5394 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005395 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005396 'secure' at the end of your ~/.vimrc then.
5397 This option cannot be set from a |modeline| or in the |sandbox|, for
5398 security reasons.
5399
5400 *'selection'* *'sel'*
5401'selection' 'sel' string (default "inclusive")
5402 global
5403 {not in Vi}
5404 This option defines the behavior of the selection. It is only used
5405 in Visual and Select mode.
5406 Possible values:
5407 value past line inclusive ~
5408 old no yes
5409 inclusive yes yes
5410 exclusive yes no
5411 "past line" means that the cursor is allowed to be positioned one
5412 character past the line.
5413 "inclusive" means that the last character of the selection is included
5414 in an operation. For example, when "x" is used to delete the
5415 selection.
5416 Note that when "exclusive" is used and selecting from the end
5417 backwards, you cannot include the last character of a line, when
5418 starting in Normal mode and 'virtualedit' empty.
5419
5420 The 'selection' option is set by the |:behave| command.
5421
5422 *'selectmode'* *'slm'*
5423'selectmode' 'slm' string (default "")
5424 global
5425 {not in Vi}
5426 This is a comma separated list of words, which specifies when to start
5427 Select mode instead of Visual mode, when a selection is started.
5428 Possible values:
5429 mouse when using the mouse
5430 key when using shifted special keys
5431 cmd when using "v", "V" or CTRL-V
5432 See |Select-mode|.
5433 The 'selectmode' option is set by the |:behave| command.
5434
5435 *'sessionoptions'* *'ssop'*
5436'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
5437 help,options,winsize")
5438 global
5439 {not in Vi}
5440 {not available when compiled without the +mksession
5441 feature}
5442 Changes the effect of the |:mksession| command. It is a comma
5443 separated list of words. Each word enables saving and restoring
5444 something:
5445 word save and restore ~
5446 blank empty windows
5447 buffers hidden and unloaded buffers, not just those in windows
5448 curdir the current directory
5449 folds manually created folds, opened/closed folds and local
5450 fold options
5451 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005452 and contain at least one lowercase letter. Only
5453 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005454 help the help window
5455 localoptions options and mappings local to a window or buffer (not
5456 global values for local options)
5457 options all options and mappings (also global values for local
5458 options)
5459 resize size of the Vim window: 'lines' and 'columns'
5460 sesdir the directory in which the session file is located
5461 will become the current directory (useful with
5462 projects accessed over a network from different
5463 systems)
5464 slash backslashes in file names replaced with forward
5465 slashes
5466 unix with Unix end-of-line format (single <NL>), even when
5467 on Windows or DOS
5468 winpos position of the whole Vim window
5469 winsize window sizes
5470
5471 Don't include both "curdir" and "sesdir".
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00005472 There is no option to include tab pages yet, only the current tab page
5473 is stored in the session. |tab-page|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005474 When "curdir" nor "sesdir" is included, file names are stored with
5475 absolute paths.
5476 "slash" and "unix" are useful on Windows when sharing session files
5477 with Unix. The Unix version of Vim cannot source dos format scripts,
5478 but the Windows version of Vim can source unix format scripts.
5479
5480 *'shell'* *'sh'* *E91*
5481'shell' 'sh' string (default $SHELL or "sh",
5482 MS-DOS and Win32: "command.com" or
5483 "cmd.exe", OS/2: "cmd")
5484 global
5485 Name of the shell to use for ! and :! commands. When changing the
5486 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5487 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005488 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005489 See |option-backslash| about including spaces and backslashes.
5490 Environment variables are expanded |:set_env|.
5491 If the name of the shell contains a space, you might need to enclose
5492 it in quotes. Example: >
5493 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5494< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005495 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005496 "-f" is not inside the quotes, because it is not part of the command
5497 name. And Vim automagically recognizes the backslashes that are path
5498 separators.
5499 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5500 variable to change the way external commands are executed. See the
5501 libc.inf file of DJGPP.
5502 Under MS-Windows, when the executable ends in ".com" it must be
5503 included. Thus setting the shell to "command.com" or "4dos.com"
5504 works, but "command" and "4dos" do not work for all commands (e.g.,
5505 filtering).
5506 For unknown reasons, when using "4dos.com" the current directory is
5507 changed to "C:\". To avoid this set 'shell' like this: >
5508 :set shell=command.com\ /c\ 4dos
5509< This option cannot be set from a |modeline| or in the |sandbox|, for
5510 security reasons.
5511
5512 *'shellcmdflag'* *'shcf'*
5513'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5514 does not contain "sh" somewhere: "/c")
5515 global
5516 {not in Vi}
5517 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5518 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5519 systems, the default is set according to the value of 'shell', to
5520 reduce the need to set this option by the user. It's not used for
5521 OS/2 (EMX figures this out itself). See |option-backslash| about
5522 including spaces and backslashes. See |dos-shell|.
5523 This option cannot be set from a |modeline| or in the |sandbox|, for
5524 security reasons.
5525
5526 *'shellpipe'* *'sp'*
5527'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5528 global
5529 {not in Vi}
5530 {not available when compiled without the |+quickfix|
5531 feature}
5532 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005533 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005534 including spaces and backslashes.
5535 The name of the temporary file can be represented by "%s" if necessary
5536 (the file name is appended automatically if no %s appears in the value
5537 of this option).
5538 For the Amiga and MS-DOS the default is ">". The output is directly
5539 saved in a file and not echoed to the screen.
5540 For Unix the default it "| tee". The stdout of the compiler is saved
5541 in a file and echoed to the screen. If the 'shell' option is "csh" or
5542 "tcsh" after initializations, the default becomes "|& tee". If the
5543 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5544 "2>&1| tee". This means that stderr is also included.
5545 The initialization of this option is done after reading the ".vimrc"
5546 and the other initializations, so that when the 'shell' option is set
5547 there, the 'shellpipe' option changes automatically, unless it was
5548 explicitly set before.
5549 When 'shellpipe' is set to an empty string, no redirection of the
5550 ":make" output will be done. This is useful if you use a 'makeprg'
5551 that writes to 'makeef' by itself. If you want no piping, but do
5552 want to include the 'makeef', set 'shellpipe' to a single space.
5553 Don't forget to precede the space with a backslash: ":set sp=\ ".
5554 In the future pipes may be used for filtering and this option will
5555 become obsolete (at least for Unix).
5556 This option cannot be set from a |modeline| or in the |sandbox|, for
5557 security reasons.
5558
5559 *'shellquote'* *'shq'*
5560'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5561 contains "sh" somewhere: "\"")
5562 global
5563 {not in Vi}
5564 Quoting character(s), put around the command passed to the shell, for
5565 the "!" and ":!" commands. The redirection is kept outside of the
5566 quoting. See 'shellxquote' to include the redirection. It's
5567 probably not useful to set both options.
5568 This is an empty string by default. Only known to be useful for
5569 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5570 or bash, where it should be "\"". The default is adjusted according
5571 the value of 'shell', to reduce the need to set this option by the
5572 user. See |dos-shell|.
5573 This option cannot be set from a |modeline| or in the |sandbox|, for
5574 security reasons.
5575
5576 *'shellredir'* *'srr'*
5577'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5578 global
5579 {not in Vi}
5580 String to be used to put the output of a filter command in a temporary
5581 file. See also |:!|. See |option-backslash| about including spaces
5582 and backslashes.
5583 The name of the temporary file can be represented by "%s" if necessary
5584 (the file name is appended automatically if no %s appears in the value
5585 of this option).
5586 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5587 or "zsh" during initializations, the default becomes ">&". If the
5588 'shell' option is "sh", "ksh" or "bash" the default becomes
5589 ">%s 2>&1". This means that stderr is also included.
5590 For Win32, the Unix checks are done and additionally "cmd" is checked
5591 for, which makes the default ">%s 2>&1". Also, the same names with
5592 ".exe" appended are checked for.
5593 The initialization of this option is done after reading the ".vimrc"
5594 and the other initializations, so that when the 'shell' option is set
5595 there, the 'shellredir' option changes automatically unless it was
5596 explicitly set before.
5597 In the future pipes may be used for filtering and this option will
5598 become obsolete (at least for Unix).
5599 This option cannot be set from a |modeline| or in the |sandbox|, for
5600 security reasons.
5601
5602 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5603'shellslash' 'ssl' boolean (default off)
5604 global
5605 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5606 When set, a forward slash is used when expanding file names. This is
5607 useful when a Unix-like shell is used instead of command.com or
5608 cmd.exe. Backward slashes can still be typed, but they are changed to
5609 forward slashes by Vim.
5610 Note that setting or resetting this option has no effect for some
5611 existing file names, thus this option needs to be set before opening
5612 any file for best results. This might change in the future.
5613 'shellslash' only works when a backslash can be used as a path
5614 separator. To test if this is so use: >
5615 if exists('+shellslash')
5616<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005617 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5618'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5619 global
5620 {not in Vi}
5621 When on, use temp files for shell commands. When off use a pipe.
5622 When using a pipe is not possible temp files are used anyway.
5623 Currently a pipe is only supported on Unix. You can check it with: >
5624 :if has("filterpipe")
5625< The advantage of using a pipe is that nobody can read the temp file
5626 and the 'shell' command does not need to support redirection.
5627 The advantage of using a temp file is that the file type and encoding
5628 can be detected.
5629 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5630 |FilterWritePost| autocommands event are not triggered when
5631 'shelltemp' is off.
5632
Bram Moolenaar071d4272004-06-13 20:20:40 +00005633 *'shelltype'* *'st'*
5634'shelltype' 'st' number (default 0)
5635 global
5636 {not in Vi} {only for the Amiga}
5637 On the Amiga this option influences the way how the commands work
5638 which use a shell.
5639 0 and 1: always use the shell
5640 2 and 3: use the shell only to filter lines
5641 4 and 5: use shell only for ':sh' command
5642 When not using the shell, the command is executed directly.
5643
5644 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5645 1 and 3: use "shell cmd" to start external commands
5646
5647 *'shellxquote'* *'sxq'*
5648'shellxquote' 'sxq' string (default: "";
5649 for Win32, when 'shell' contains "sh"
5650 somewhere: "\""
5651 for Unix, when using system(): "\"")
5652 global
5653 {not in Vi}
5654 Quoting character(s), put around the command passed to the shell, for
5655 the "!" and ":!" commands. Includes the redirection. See
5656 'shellquote' to exclude the redirection. It's probably not useful
5657 to set both options.
5658 This is an empty string by default. Known to be useful for
5659 third-party shells when using the Win32 version, such as the MKS Korn
5660 Shell or bash, where it should be "\"". The default is adjusted
5661 according the value of 'shell', to reduce the need to set this option
5662 by the user. See |dos-shell|.
5663 This option cannot be set from a |modeline| or in the |sandbox|, for
5664 security reasons.
5665
5666 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5667'shiftround' 'sr' boolean (default off)
5668 global
5669 {not in Vi}
5670 Round indent to multiple of 'shiftwidth'. Applies to > and <
5671 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5672 a multiple of 'shiftwidth' (this is Vi compatible).
5673 NOTE: This option is reset when 'compatible' is set.
5674
5675 *'shiftwidth'* *'sw'*
5676'shiftwidth' 'sw' number (default 8)
5677 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005678 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005679 |'cindent'|, |>>|, |<<|, etc.
5680
5681 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005682'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5683 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005684 global
5685 {not in Vi}
5686 This option helps to avoid all the |hit-enter| prompts caused by file
5687 messages, for example with CTRL-G, and to avoid some other messages.
5688 It is a list of flags:
5689 flag meaning when present ~
5690 f use "(3 of 5)" instead of "(file 3 of 5)"
5691 i use "[noeol]" instead of "[Incomplete last line]"
5692 l use "999L, 888C" instead of "999 lines, 888 characters"
5693 m use "[+]" instead of "[Modified]"
5694 n use "[New]" instead of "[New File]"
5695 r use "[RO]" instead of "[readonly]"
5696 w use "[w]" instead of "written" for file write message
5697 and "[a]" instead of "appended" for ':w >> file' command
5698 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5699 "[unix format]" and "[mac]" instead of "[mac format]".
5700 a all of the above abbreviations
5701
5702 o overwrite message for writing a file with subsequent message
5703 for reading a file (useful for ":wn" or when 'autowrite' on)
5704 O message for reading a file overwrites any previous message.
5705 Also for quickfix message (e.g., ":cn").
5706 s don't give "search hit BOTTOM, continuing at TOP" or "search
5707 hit TOP, continuing at BOTTOM" messages
5708 t truncate file message at the start if it is too long to fit
5709 on the command-line, "<" will appear in the left most column.
5710 Ignored in Ex mode.
5711 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005712 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005713 Ignored in Ex mode.
5714 W don't give "written" or "[w]" when writing a file
5715 A don't give the "ATTENTION" message when an existing swap file
5716 is found.
5717 I don't give the intro message when starting Vim |:intro|.
5718
5719 This gives you the opportunity to avoid that a change between buffers
5720 requires you to hit <Enter>, but still gives as useful a message as
5721 possible for the space available. To get the whole message that you
5722 would have got with 'shm' empty, use ":file!"
5723 Useful values:
5724 shm= No abbreviation of message.
5725 shm=a Abbreviation, but no loss of information.
5726 shm=at Abbreviation, and truncate message when necessary.
5727
5728 NOTE: This option is set to the Vi default value when 'compatible' is
5729 set and to the Vim default value when 'compatible' is reset.
5730
5731 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5732'shortname' 'sn' boolean (default off)
5733 local to buffer
5734 {not in Vi, not in MS-DOS versions}
5735 Filenames are assumed to be 8 characters plus one extension of 3
5736 characters. Multiple dots in file names are not allowed. When this
5737 option is on, dots in file names are replaced with underscores when
5738 adding an extension (".~" or ".swp"). This option is not available
5739 for MS-DOS, because then it would always be on. This option is useful
5740 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5741 or crossdos. When running the Win32 GUI version under Win32s, this
5742 option is always on by default.
5743
5744 *'showbreak'* *'sbr'* *E595*
5745'showbreak' 'sbr' string (default "")
5746 global
5747 {not in Vi}
5748 {not available when compiled without the |+linebreak|
5749 feature}
5750 String to put at the start of lines that have been wrapped. Useful
5751 values are "> " or "+++ ".
5752 Only printable single-cell characters are allowed, excluding <Tab> and
5753 comma (in a future version the comma might be used to separate the
5754 part that is shown at the end and at the start of a line).
5755 The characters are highlighted according to the '@' flag in
5756 'highlight'.
5757 Note that tabs after the showbreak will be displayed differently.
5758 If you want the 'showbreak' to appear in between line numbers, add the
5759 "n" flag to 'cpoptions'.
5760
5761 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5762'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5763 off)
5764 global
5765 {not in Vi}
5766 {not available when compiled without the
5767 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005768 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005769 terminal is slow.
5770 In Visual mode the size of the selected area is shown:
5771 - When selecting characters within a line, the number of characters.
5772 - When selecting more than one line, the number of lines.
5773 - When selecting a block, the size in screen characters: linesxcolumns.
5774 NOTE: This option is set to the Vi default value when 'compatible' is
5775 set and to the Vim default value when 'compatible' is reset.
5776
5777 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5778'showfulltag' 'sft' boolean (default off)
5779 global
5780 {not in Vi}
5781 When completing a word in insert mode (see |ins-completion|) from the
5782 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005783 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005784 matched a C function, you can see a template for what arguments are
5785 required (coding style permitting).
5786
5787 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5788'showmatch' 'sm' boolean (default off)
5789 global
5790 When a bracket is inserted, briefly jump to the matching one. The
5791 jump is only done if the match can be seen on the screen. The time to
5792 show the match can be set with 'matchtime'.
5793 A Beep is given if there is no match (no matter if the match can be
5794 seen or not). This option is reset when the 'paste' option is set.
5795 When the 'm' flag is not included in 'cpoptions', typing a character
5796 will immediately move the cursor back to where it belongs.
5797 See the "sm" field in 'guicursor' for setting the cursor shape and
5798 blinking when showing the match.
5799 The 'matchpairs' option can be used to specify the characters to show
5800 matches for. 'rightleft' and 'revins' are used to look for opposite
5801 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005802 Also see the matchparen plugin for highlighting the match when moving
5803 around |pi_paren.txt|.
5804 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005805
5806 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5807'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5808 global
5809 If in Insert, Replace or Visual mode put a message on the last line.
5810 Use the 'M' flag in 'highlight' to set the type of highlighting for
5811 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005812 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005813 doesn't mean XIM is really active, especially when 'imactivatekey' is
5814 not set.
5815 NOTE: This option is set to the Vi default value when 'compatible' is
5816 set and to the Vim default value when 'compatible' is reset.
5817
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00005818 *'showtabline'* *'stal'*
5819'showtabline' 'stal' number (default 1)
5820 global
5821 {not in Vi}
5822 {not available when compiled without the +windows
5823 feature}
5824 The value of this option specifies when the line with tab page labels
5825 will be displayed:
5826 0: never
5827 1: only if there are at least two tab pages
5828 2: always
5829 This is both for the GUI and non-GUI implementation of the tab pages
5830 line.
5831 See |tab-page| for more information about tab pages.
5832
Bram Moolenaar071d4272004-06-13 20:20:40 +00005833 *'sidescroll'* *'ss'*
5834'sidescroll' 'ss' number (default 0)
5835 global
5836 {not in Vi}
5837 The minimal number of columns to scroll horizontally. Used only when
5838 the 'wrap' option is off and the cursor is moved off of the screen.
5839 When it is zero the cursor will be put in the middle of the screen.
5840 When using a slow terminal set it to a large number or 0. When using
5841 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5842 commands.
5843
5844 *'sidescrolloff'* *'siso'*
5845'sidescrolloff' 'siso' number (default 0)
5846 global
5847 {not in Vi}
5848 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005849 right of the cursor if 'nowrap' is set. Setting this option to a
5850 value greater than 0 while having |'sidescroll'| also at a non-zero
5851 value makes some context visible in the line you are scrolling in
5852 horizontally (except at beginning of the line). Setting this option
5853 to a large value (like 999) has the effect of keeping the cursor
5854 horizontally centered in the window, as long as one does not come too
5855 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005856 NOTE: This option is set to 0 when 'compatible' is set.
5857
5858 Example: Try this together with 'sidescroll' and 'listchars' as
5859 in the following example to never allow the cursor to move
5860 onto the "extends" character:
5861
5862 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5863 :set sidescrolloff=1
5864
5865
5866 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5867'smartcase' 'scs' boolean (default off)
5868 global
5869 {not in Vi}
5870 Override the 'ignorecase' option if the search pattern contains upper
5871 case characters. Only used when the search pattern is typed and
5872 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005873 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005874 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5875 recalling the search pattern from history and hitting <Enter>.
5876 NOTE: This option is reset when 'compatible' is set.
5877
5878 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5879'smartindent' 'si' boolean (default off)
5880 local to buffer
5881 {not in Vi}
5882 {not available when compiled without the
5883 |+smartindent| feature}
5884 Do smart autoindenting when starting a new line. Works for C-like
5885 programs, but can also be used for other languages. 'cindent' does
5886 something like this, works better in most cases, but is more strict,
5887 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5888 'indentexpr' is a more advanced alternative.
5889 Normally 'autoindent' should also be on when using 'smartindent'.
5890 An indent is automatically inserted:
5891 - After a line ending in '{'.
5892 - After a line starting with a keyword from 'cinwords'.
5893 - Before a line starting with '}' (only with the "O" command).
5894 When typing '}' as the first character in a new line, that line is
5895 given the same indent as the matching '{'.
5896 When typing '#' as the first character in a new line, the indent for
5897 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005898 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005899 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5900 When using the ">>" command, lines starting with '#' are not shifted
5901 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005902 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005903 is set smart indenting is disabled.
5904
5905 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5906'smarttab' 'sta' boolean (default off)
5907 global
5908 {not in Vi}
5909 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00005910 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
5911 <BS> will delete a 'shiftwidth' worth of space at the start of the
5912 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005913 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00005914 'softtabstop'. 'shiftwidth' is only used for shifting text left or
5915 right |shift-left-right|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005916 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5917 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005918 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005919 NOTE: This option is reset when 'compatible' is set.
5920
5921 *'softtabstop'* *'sts'*
5922'softtabstop' 'sts' number (default 0)
5923 local to buffer
5924 {not in Vi}
5925 Number of spaces that a <Tab> counts for while performing editing
5926 operations, like inserting a <Tab> or using <BS>. It "feels" like
5927 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5928 used. This is useful to keep the 'ts' setting at its standard value
5929 of 8, while being able to edit like it is set to 'sts'. However,
5930 commands like "x" still work on the actual characters.
5931 When 'sts' is zero, this feature is off.
5932 'softtabstop' is set to 0 when the 'paste' option is set.
5933 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5934 spaces is minimized by using <Tab>s.
5935 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5936 set.
5937 NOTE: This option is set to 0 when 'compatible' is set.
5938
Bram Moolenaar217ad922005-03-20 22:37:15 +00005939 *'spell'* *'nospell'*
5940'spell' boolean (default off)
5941 local to window
5942 {not in Vi}
5943 {not available when compiled without the |+syntax|
5944 feature}
5945 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005946 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005947
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005948 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005949'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005950 local to buffer
5951 {not in Vi}
5952 {not available when compiled without the |+syntax|
5953 feature}
5954 Pattern to locate the end of a sentence. The following word will be
5955 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005956 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005957 When this check is not wanted make this option empty.
5958 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005959 Be careful with special characters, see |option-backslash| about
5960 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005961 To set this option automatically depending on the language, see
5962 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005963
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005964 *'spellfile'* *'spf'*
5965'spellfile' 'spf' string (default empty)
5966 local to buffer
5967 {not in Vi}
5968 {not available when compiled without the |+syntax|
5969 feature}
5970 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00005971 commands. It must end in ".{encoding}.add". You need to include the
5972 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005973 *E765*
5974 It may also be a comma separated list of names. A count before the
5975 |zg| and |zw| commands can be used to access each. This allows using
5976 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005977 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005978 you: Using the first directory in 'runtimepath' that is writable. If
5979 there is no "spell" directory yet it will be created. For the file
5980 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00005981 ignoring the region.
5982 The resulting ".spl" file will be used for spell checking, it does not
5983 have to appear in 'spelllang'.
5984 Normally one file is used for all regions, but you can add the region
5985 name if you want to. However, it will then only be used when
5986 'spellfile' is set to it, for entries in 'spelllang' only files
5987 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00005988 This option cannot be set from a |modeline| or in the |sandbox|, for
5989 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005990
Bram Moolenaar217ad922005-03-20 22:37:15 +00005991 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005992'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00005993 local to buffer
5994 {not in Vi}
5995 {not available when compiled without the |+syntax|
5996 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00005997 A comma separated list of word list names. When the 'spell' option is
5998 on spellchecking will be done for these languages. Example: >
5999 set spelllang=en_us,nl,medical
6000< This means US English, Dutch and medical words are recognized. Words
6001 that are not recognized will be highlighted.
6002 The word list name must not include a comma or dot. Using a dash is
6003 recommended to separate the two letter language name from a
6004 specification. Thus "en-rare" is used for rare English words.
6005 A region name must come last and have the form "_xx", where "xx" is
6006 the two-letter, lower case region name. You can use more than one
6007 region by listing them: "en_us,en_ca" supports both US and Canadian
6008 English, but not words specific for Australia, New Zealand or Great
6009 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006010 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006011 As a special case the name of a .spl file can be given as-is. The
6012 first "_xx" in the name is removed and used as the region name
6013 (_xx is an underscore, two letters and followed by a non-letter).
6014 This is mainly for testing purposes. You must make sure the correct
6015 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006016 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006017 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6018 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006019 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006020
Bram Moolenaar98692072006-02-04 00:57:42 +00006021 If the |spellfile.vim| plugin is active and you use a language name
6022 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6023 will ask you if you want to download the file.
6024
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006025 After this option has been set successfully, Vim will source the files
6026 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006027 up to the first comma, dot or underscore.
6028 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006029
6030
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006031 *'spellsuggest'* *'sps'*
6032'spellsuggest' 'sps' string (default "best")
6033 global
6034 {not in Vi}
6035 {not available when compiled without the |+syntax|
6036 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006037 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006038 the |spellsuggest()| function. This is a comma-separated list of
6039 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006040
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006041 best Internal method that works best for English. Finds
6042 changes like "fast" and uses a bit of sound-a-like
6043 scoring to improve the ordering.
6044
6045 double Internal method that uses two methods and mixes the
6046 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006047 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006048 word. That only works when the language specifies
6049 sound folding. Can be slow and doesn't always give
6050 better results.
6051
6052 fast Internal method that only checks for simple changes:
6053 character inserts/deletes/swaps. Works well for
6054 simple typing mistakes.
6055
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006056 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006057 Not used for |spellsuggest()|. The number of
6058 suggestions is never more than the value of 'lines'
6059 minus two.
6060
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006061 file:{filename} Read file {filename}, which must have two columns,
6062 separated by a slash. The first column contains the
6063 bad word, the second column the suggested good word.
6064 Example:
6065 theribal/terrible ~
6066 Use this for common mistakes that do not appear at the
6067 top of the suggestion list with the internal methods.
6068 Lines without a slash are ignored, use this for
6069 comments.
6070 The file is used for all languages.
6071
6072 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6073 trouble with spaces. |v:val| holds the badly spelled
6074 word. The expression must evaluate to a List of
6075 Lists, each with a suggestion and a score.
6076 Example:
6077 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006078 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006079 internal methods use. A lower score is better.
6080 This may invoke |spellsuggest()| if you temporarily
6081 set 'spellsuggest' to exclude the "expr:" part.
6082 Errors are silently ignored, unless you set the
6083 'verbose' option to a non-zero value.
6084
6085 Only one of "best", "double" or "fast" may be used. The others may
6086 appear several times in any order. Example: >
6087 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6088<
6089 This option cannot be set from a |modeline| or in the |sandbox|, for
6090 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006091
6092
Bram Moolenaar071d4272004-06-13 20:20:40 +00006093 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6094'splitbelow' 'sb' boolean (default off)
6095 global
6096 {not in Vi}
6097 {not available when compiled without the +windows
6098 feature}
6099 When on, splitting a window will put the new window below the current
6100 one. |:split|
6101
6102 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6103'splitright' 'spr' boolean (default off)
6104 global
6105 {not in Vi}
6106 {not available when compiled without the +vertsplit
6107 feature}
6108 When on, splitting a window will put the new window right of the
6109 current one. |:vsplit|
6110
6111 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6112'startofline' 'sol' boolean (default on)
6113 global
6114 {not in Vi}
6115 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006116 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006117 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006118 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006119 with a linewise operator, with "%" with a count and to buffer changing
6120 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6121 only has a line number, e.g., ":25" or ":+".
6122 In case of buffer changing commands the cursor is placed at the column
6123 where it was the last time the buffer was edited.
6124 NOTE: This option is set when 'compatible' is set.
6125
6126 *'statusline'* *'stl'* *E540* *E541* *E542*
6127'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006128 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006129 {not in Vi}
6130 {not available when compiled without the |+statusline|
6131 feature}
6132 When nonempty, this option determines the content of the status line.
6133 Also see |status-line|.
6134
6135 The option consists of printf style '%' items interspersed with
6136 normal text. Each status line item is of the form:
6137 %-0{minwid}.{maxwid}{item}
6138 All fields except the {item} is optional. A single percent sign can
6139 be given as "%%". Up to 80 items can be specified.
6140
Bram Moolenaar238a5642006-02-21 22:12:05 +00006141 When the option starts with "%!" then it is used as an expression,
6142 evaluated and the result is used as the option value. Example: >
6143 :set statusline=%!MyStatusLine()
6144< The result can contain %{} items that will be evaluated too.
6145
6146 When there is error while evaluating the option then it will be made
6147 empty to avoid further errors. Otherwise screen updating would loop.
6148
Bram Moolenaar071d4272004-06-13 20:20:40 +00006149 Note that the only effect of 'ruler' when this option is set (and
6150 'laststatus' is 2) is controlling the output of |CTRL-G|.
6151
6152 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006153 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006154 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006155 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006156 minwid Minimum width of the item, padding as set by '-' & '0'.
6157 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006158 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006159 on the left for text items. Numeric items will be
6160 shifted down to maxwid-2 digits followed by '>'number
6161 where number is the amount of missing digits, much like
6162 an exponential notation.
6163 item A one letter code as described below.
6164
6165 Following is a description of the possible statusline items. The
6166 second character in "item" is the type:
6167 N for number
6168 S for string
6169 F for flags as described below
6170 - not applicable
6171
6172 item meaning ~
6173 f S Path to the file in the buffer, relative to current directory.
6174 F S Full path to the file in the buffer.
6175 t S File name (tail) of file in the buffer.
6176 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
6177 M F Modified flag, text is ",+" or ",-".
6178 r F Readonly flag, text is " [RO]".
6179 R F Readonly flag, text is ",RO".
6180 h F Help buffer flag, text is " [help]".
6181 H F Help buffer flag, text is ",HLP".
6182 w F Preview window flag, text is " [Preview]".
6183 W F Preview window flag, text is ",PRV".
6184 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
6185 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6186 {not available when compiled without |+autocmd| feature}
6187 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6188 being used: "<keymap>"
6189 n N Buffer number.
6190 b N Value of byte under cursor.
6191 B N As above, in hexadecimal.
6192 o N Byte number in file of byte under cursor, first byte is 1.
6193 Mnemonic: Offset from start of file (with one added)
6194 {not available when compiled without |+byte_offset| feature}
6195 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006196 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006197 l N Line number.
6198 L N Number of lines in buffer.
6199 c N Column number.
6200 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006201 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006202 p N Percentage through file in lines as in |CTRL-G|.
6203 P S Percentage through file of displayed window. This is like the
6204 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006205 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006206 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006207 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006208 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006209 ( - Start of item group. Can be used for setting the width and
6210 alignment of a section. Must be followed by %) somewhere.
6211 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006212 T N For 'tabline': start of tab page N label. Use %T after the last
6213 label. This information is used for mouse clicks.
6214 X N For 'tabline': start of close tab N label. Use %X after the
6215 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6216 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006217 < - Where to truncate line if too long. Default is at the start.
6218 No width fields allowed.
6219 = - Separation point between left and right aligned items.
6220 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006221 # - Set highlight group. The name must follow and then a # again.
6222 Thus use %#HLname# for highlight group HLname. The same
6223 highlighting is used, also for the statusline of non-current
6224 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006225 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006226 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006227 The difference between User{N} and StatusLine will be applied
6228 to StatusLineNC for the statusline of non-current windows.
6229 The number N must be between 1 and 9. See |hl-User1..9|
6230
6231 Display of flags are controlled by the following heuristic:
6232 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006233 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00006234 with a space it is assumed that it wants to separate itself from
6235 anything but other flags. That is: A leading comma is removed if the
6236 preceding character stems from plaintext. A leading space is removed
Bram Moolenaar582fd852005-03-28 20:58:01 +00006237 if the preceding character stems from another active flag. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006238 make a nice display when flags are used like in the examples below.
6239
Bram Moolenaar582fd852005-03-28 20:58:01 +00006240 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006241 not set) and a minwid is not set for the group, the whole group will
6242 become empty. This will make a group like the following disappear
6243 completely from the statusline when none of the flags are set. >
6244 :set statusline=...%(\ [%M%R%H]%)...
6245<
6246 Beware that an expression is evaluated each and every time the status
6247 line is displayed. The current buffer and current window will be set
6248 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006249 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006250 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006251 real current buffer.
6252
6253 The 'statusline' option may be evaluated in the |sandbox|, see
6254 |sandbox-option|.
6255
6256 It is not allowed to change text or jump to another window while
6257 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006258
6259 If the statusline is not updated when you want it (e.g., after setting
6260 a variable that's used in an expression), you can force an update by
6261 setting an option without changing its value. Example: >
6262 :let &ro = &ro
6263
6264< A result of all digits is regarded a number for display purposes.
6265 Otherwise the result is taken as flag text and applied to the rules
6266 described above.
6267
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006268 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006269 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6270 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6271
6272 Examples:
6273 Emulate standard status line with 'ruler' set >
6274 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6275< Similar, but add ASCII value of char under the cursor (like "ga") >
6276 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6277< Display byte count and byte value, modified flag in red. >
6278 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6279 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6280< Display a ,GZ flag if a compressed file is loaded >
6281 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6282< In the |:autocmd|'s: >
6283 :let b:gzflag = 1
6284< And: >
6285 :unlet b:gzflag
6286< And define this function: >
6287 :function VarExists(var, val)
6288 : if exists(a:var) | return a:val | else | return '' | endif
6289 :endfunction
6290<
6291 *'suffixes'* *'su'*
6292'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6293 global
6294 {not in Vi}
6295 Files with these suffixes get a lower priority when multiple files
6296 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006297 suffixes. Spaces after the comma are ignored. A dot is also seen as
6298 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006299 separator, precede it with a backslash (see |option-backslash| about
6300 including spaces and backslashes).
6301 See 'wildignore' for completely ignoring files.
6302 The use of |:set+=| and |:set-=| is preferred when adding or removing
6303 suffixes from the list. This avoids problems when a future version
6304 uses another default.
6305
6306 *'suffixesadd'* *'sua'*
6307'suffixesadd' 'sua' string (default "")
6308 local to buffer
6309 {not in Vi}
6310 {not available when compiled without the
6311 |+file_in_path| feature}
6312 Comma separated list of suffixes, which are used when searching for a
6313 file for the "gf", "[I", etc. commands. Example: >
6314 :set suffixesadd=.java
6315<
6316 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6317'swapfile' 'swf' boolean (default on)
6318 local to buffer
6319 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006320 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006321 swapfile is not wanted for a specific buffer. For example, with
6322 confidential information that even root must not be able to access.
6323 Careful: All text will be in memory:
6324 - Don't use this for big files.
6325 - Recovery will be impossible!
6326 A swapfile will only be present when |'updatecount'| is non-zero and
6327 'swapfile' is set.
6328 When 'swapfile' is reset, the swap file for the current buffer is
6329 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6330 non-zero, a swap file is immediately created.
6331 Also see |swap-file| and |'swapsync'|.
6332
6333 This option is used together with 'bufhidden' and 'buftype' to
6334 specify special kinds of buffers. See |special-buffers|.
6335
6336 *'swapsync'* *'sws'*
6337'swapsync' 'sws' string (default "fsync")
6338 global
6339 {not in Vi}
6340 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006341 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006342 When this option is empty parts of the swap file may be in memory and
6343 not written to disk. When the system crashes you may lose more work.
6344 On Unix the system does a sync now and then without Vim asking for it,
6345 so the disadvantage of setting this option off is small. On some
6346 systems the swap file will not be written at all. For a unix system
6347 setting it to "sync" will use the sync() call instead of the default
6348 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006349 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006350
6351 *'switchbuf'* *'swb'*
6352'switchbuf' 'swb' string (default "")
6353 global
6354 {not in Vi}
6355 This option controls the behavior when switching between buffers.
6356 Possible values (comma separated list):
6357 useopen If included, jump to the first open window that
6358 contains the specified buffer (if there is one).
6359 Otherwise: Do not examine other windows.
6360 This setting is checked with |quickfix| commands, when
6361 jumping to errors (":cc", ":cn", "cp", etc.). It is
6362 also used in all buffer related split commands, for
6363 example ":sbuffer", ":sbnext", or ":sbrewind".
6364 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006365 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006366 Supported in |quickfix| commands that display errors.
6367
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006368 *'synmaxcol'* *'smc'*
6369'synmaxcol' 'smc' number (default 3000)
6370 local to buffer
6371 {not in Vi}
6372 {not available when compiled without the |+syntax|
6373 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006374 Maximum column in which to search for syntax items. In long lines the
6375 text after this column is not highlighted and following lines may not
6376 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006377 This helps to avoid very slow redrawing for an XML file that is one
6378 long line.
6379 Set to zero to remove the limit.
6380
Bram Moolenaar071d4272004-06-13 20:20:40 +00006381 *'syntax'* *'syn'*
6382'syntax' 'syn' string (default empty)
6383 local to buffer
6384 {not in Vi}
6385 {not available when compiled without the |+syntax|
6386 feature}
6387 When this option is set, the syntax with this name is loaded, unless
6388 syntax highlighting has been switched off with ":syntax off".
6389 Otherwise this option does not always reflect the current syntax (the
6390 b:current_syntax variable does).
6391 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006392 not automatically recognized. Example, in an IDL file:
6393 /* vim: set syntax=idl : */ ~
6394 When a dot appears in the value then this separates two filetype
6395 names. Example:
6396 /* vim: set syntax=c.doxygen : */ ~
6397 This will use the "c" syntax first, then the "doxygen" syntax.
6398 Note that the second one must be prepared to be loaded as an addition,
6399 otherwise it will be skipped. More than one dot may appear.
6400 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006401 :set syntax=OFF
6402< To switch syntax highlighting on according to the current value of the
6403 'filetype' option: >
6404 :set syntax=ON
6405< What actually happens when setting the 'syntax' option is that the
6406 Syntax autocommand event is triggered with the value as argument.
6407 This option is not copied to another buffer, independent of the 's' or
6408 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006409 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006410
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006411 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006412'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006413 global
6414 {not in Vi}
6415 {not available when compiled without the +windows
6416 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006417 When nonempty, this option determines the content of the tab pages
6418 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006419 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006420
6421 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006422 option and only when there is no GUI tab line. When 'e' is in
6423 'guioptions' and the GUI supports a tab line 'guitablabel' is used
6424 instead.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006425
6426 The value is evaluated like with 'statusline'. You can use
6427 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006428 the text to be displayed. Use "%1T" for the first label, "%2T" for
6429 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006430
6431 Keep in mind that only one of the tab pages is the current one, others
6432 are invisible and you can't jump to their windows.
6433
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006434
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006435 *'tabpagemax'* *'tpm'*
6436'tabpagemax' 'tpm' number (default 10)
6437 global
6438 {not in Vi}
6439 {not available when compiled without the +windows
6440 feature}
6441 Maximum number of tab pages to be opened by the |-p| command line
6442 argument or the ":tab all" command. |tabpage|
6443
6444
6445 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006446'tabstop' 'ts' number (default 8)
6447 local to buffer
6448 Number of spaces that a <Tab> in the file counts for. Also see
6449 |:retab| command, and 'softtabstop' option.
6450
6451 Note: Setting 'tabstop' to any other value than 8 can make your file
6452 appear wrong in many places (e.g., when printing it).
6453
6454 There are four main ways to use tabs in Vim:
6455 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6456 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
6457 will use a mix of tabs and spaces, but typing Tab and BS will
6458 behave like a tab appears every 4 (or 3) characters.
6459 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6460 'expandtab'. This way you will always insert spaces. The
6461 formatting will never be messed up when 'tabstop' is changed.
6462 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006463 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006464 works when using Vim to edit the file.
6465 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6466 'noexpandtab'. This should then work (for initial indents only)
6467 for any tabstop setting that people use. It might be nice to have
6468 tabs after the first non-blank inserted as spaces if you do this
6469 though. Otherwise aligned comments will be wrong when 'tabstop' is
6470 changed.
6471
6472 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6473'tagbsearch' 'tbs' boolean (default on)
6474 global
6475 {not in Vi}
6476 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006477 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006478 searching makes searching for a tag a LOT faster, but a linear search
6479 will find more tags if the tags file wasn't properly sorted.
6480 Vim normally assumes that your tags files are sorted, or indicate that
6481 they are not sorted. Only when this is not the case does the
6482 'tagbsearch' option need to be switched off.
6483
6484 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006485 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006486 certain files, or retry all files with a linear search. When
6487 'tagbsearch' is off, only a linear search is done.
6488
6489 Linear searching is done anyway, for one file, when Vim finds a line
6490 at the start of the file indicating that it's not sorted: >
6491 !_TAG_FILE_SORTED 0 /some command/
6492< [The whitespace before and after the '0' must be a single <Tab>]
6493
6494 When a binary search was done and no match was found in any of the
6495 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6496 instead of a normal tag name, a retry is done with a linear search.
6497 Tags in unsorted tags files, and matches with different case will only
6498 be found in the retry.
6499
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006500 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006501 linear search can be avoided for the 'ignorecase' case. Use a value
6502 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6503 case-fold sorted with the -f switch to "sort" in most unices, as in
6504 the command: "sort -f -o tags tags". For "Exuberant ctags" version
6505 5.3 or higher the -f or --fold-case-sort switch can be used for this
6506 as well. Note that case must be folded to uppercase for this to work.
6507
6508 When 'tagbsearch' is off, tags searching is slower when a full match
6509 exists, but faster when no full match exists. Tags in unsorted tags
6510 files may only be found with 'tagbsearch' off.
6511 When the tags file is not sorted, or sorted in a wrong way (not on
6512 ASCII byte value), 'tagbsearch' should be off, or the line given above
6513 must be included in the tags file.
6514 This option doesn't affect commands that find all matching tags (e.g.,
6515 command-line completion and ":help").
6516 {Vi: always uses binary search in some versions}
6517
6518 *'taglength'* *'tl'*
6519'taglength' 'tl' number (default 0)
6520 global
6521 If non-zero, tags are significant up to this number of characters.
6522
6523 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6524'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6525 global
6526 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006527 If on and using a tags file in another directory, file names in that
6528 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006529 NOTE: This option is set to the Vi default value when 'compatible' is
6530 set and to the Vim default value when 'compatible' is reset.
6531
6532 *'tags'* *'tag'* *E433*
6533'tags' 'tag' string (default "./tags,tags", when compiled with
6534 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6535 global or local to buffer |global-local|
6536 Filenames for the tag command, separated by spaces or commas. To
6537 include a space or comma in a file name, precede it with a backslash
6538 (see |option-backslash| about including spaces and backslashes).
6539 When a file name starts with "./", the '.' is replaced with the path
6540 of the current file. But only when the 'd' flag is not included in
6541 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6542 |tags-option|.
6543 "*", "**" and other wildcards can be used to search for tags files in
6544 a directory tree. See |file-searching|. {not available when compiled
6545 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006546 The |tagfiles()| function can be used to get a list of the file names
6547 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006548 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6549 files are also supported. They are automatically recognized. The
6550 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6551 differences are ignored (MS-Windows). |emacs-tags|
6552 The use of |:set+=| and |:set-=| is preferred when adding or removing
6553 file names from the list. This avoids problems when a future version
6554 uses another default.
6555 {Vi: default is "tags /usr/lib/tags"}
6556
6557 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6558'tagstack' 'tgst' boolean (default on)
6559 global
6560 {not in all versions of Vi}
6561 When on, the |tagstack| is used normally. When off, a ":tag" or
6562 ":tselect" command with an argument will not push the tag onto the
6563 tagstack. A following ":tag" without an argument, a ":pop" command or
6564 any other command that uses the tagstack will use the unmodified
6565 tagstack, but does change the pointer to the active entry.
6566 Resetting this option is useful when using a ":tag" command in a
6567 mapping which should not change the tagstack.
6568
6569 *'term'* *E529* *E530* *E531*
6570'term' string (default is $TERM, if that fails:
6571 in the GUI: "builtin_gui"
6572 on Amiga: "amiga"
6573 on BeOS: "beos-ansi"
6574 on Mac: "mac-ansi"
6575 on MiNT: "vt52"
6576 on MS-DOS: "pcterm"
6577 on OS/2: "os2ansi"
6578 on Unix: "ansi"
6579 on VMS: "ansi"
6580 on Win 32: "win32")
6581 global
6582 Name of the terminal. Used for choosing the terminal control
6583 characters. Environment variables are expanded |:set_env|.
6584 For example: >
6585 :set term=$TERM
6586< See |termcap|.
6587
6588 *'termbidi'* *'tbidi'*
6589 *'notermbidi'* *'notbidi'*
6590'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6591 global
6592 {not in Vi}
6593 {only available when compiled with the |+arabic|
6594 feature}
6595 The terminal is in charge of Bi-directionality of text (as specified
6596 by Unicode). The terminal is also expected to do the required shaping
6597 that some languages (such as Arabic) require.
6598 Setting this option implies that 'rightleft' will not be set when
6599 'arabic' is set and the value of 'arabicshape' will be ignored.
6600 Note that setting 'termbidi' has the immediate effect that
6601 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6602 This option is reset when the GUI is started.
6603 For further details see |arabic.txt|.
6604
6605 *'termencoding'* *'tenc'*
6606'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6607 Macintosh GUI: "macroman")
6608 global
6609 {only available when compiled with the |+multi_byte|
6610 feature}
6611 {not in Vi}
6612 Encoding used for the terminal. This specifies what character
6613 encoding the keyboard produces and the display will understand. For
6614 the GUI it only applies to the keyboard ('encoding' is used for the
6615 display).
6616 In the Win32 console version the default value is the console codepage
6617 when it differs from the ANSI codepage.
6618 *E617*
6619 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6620 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6621 Any attempts to set a different value will be rejected, and an error
6622 message is shown.
6623 For the Win32 GUI 'termencoding' is not used for typed characters,
6624 because the Win32 system always passes Unicode characters.
6625 When empty, the same encoding is used as for the 'encoding' option.
6626 This is the normal value.
6627 Not all combinations for 'termencoding' and 'encoding' are valid. See
6628 |encoding-table|.
6629 The value for this option must be supported by internal conversions or
6630 iconv(). When this is not possible no conversion will be done and you
6631 will probably experience problems with non-ASCII characters.
6632 Example: You are working with the locale set to euc-jp (Japanese) and
6633 want to edit a UTF-8 file: >
6634 :let &termencoding = &encoding
6635 :set encoding=utf-8
6636< You need to do this when your system has no locale support for UTF-8.
6637
6638 *'terse'* *'noterse'*
6639'terse' boolean (default off)
6640 global
6641 When set: Add 's' flag to 'shortmess' option (this makes the message
6642 for a search that hits the start or end of the file not being
6643 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6644 shortens a lot of messages}
6645
6646 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6647'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6648 global
6649 {not in Vi}
6650 This option is obsolete. Use 'fileformats'.
6651 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6652 set to the default value for the current system. When 'textauto' is
6653 reset, 'fileformats' is made empty.
6654 NOTE: This option is set to the Vi default value when 'compatible' is
6655 set and to the Vim default value when 'compatible' is reset.
6656
6657 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6658'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6659 others: default off)
6660 local to buffer
6661 {not in Vi}
6662 This option is obsolete. Use 'fileformat'.
6663 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6664 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6665 "unix".
6666
6667 *'textwidth'* *'tw'*
6668'textwidth' 'tw' number (default 0)
6669 local to buffer
6670 {not in Vi}
6671 Maximum width of text that is being inserted. A longer line will be
6672 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006673 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6674 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006675 'formatoptions' and |ins-textwidth|.
6676 NOTE: This option is set to 0 when 'compatible' is set.
6677
6678 *'thesaurus'* *'tsr'*
6679'thesaurus' 'tsr' string (default "")
6680 global or local to buffer |global-local|
6681 {not in Vi}
6682 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006683 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006684 the file should contain words with similar meaning, separated by
6685 non-keyword characters (white space is preferred). Maximum line
6686 length is 510 bytes.
6687 To obtain a file to be used here, check out the wordlist FAQ at
6688 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006689 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006690 after a comma are ignored, otherwise spaces are included in the file
6691 name. See |option-backslash| about using backslashes.
6692 The use of |:set+=| and |:set-=| is preferred when adding or removing
6693 directories from the list. This avoids problems when a future version
6694 uses another default.
6695 Backticks cannot be used in this option for security reasons.
6696
6697 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6698'tildeop' 'top' boolean (default off)
6699 global
6700 {not in Vi}
6701 When on: The tilde command "~" behaves like an operator.
6702 NOTE: This option is reset when 'compatible' is set.
6703
6704 *'timeout'* *'to'* *'notimeout'* *'noto'*
6705'timeout' 'to' boolean (default on)
6706 global
6707 *'ttimeout'* *'nottimeout'*
6708'ttimeout' boolean (default off)
6709 global
6710 {not in Vi}
6711 These two options together determine the behavior when part of a
6712 mapped key sequence or keyboard code has been received:
6713
6714 'timeout' 'ttimeout' action ~
6715 off off do not time out
6716 on on or off time out on :mappings and key codes
6717 off on time out on key codes
6718
6719 If both options are off, Vim will wait until either the complete
6720 mapping or key sequence has been received, or it is clear that there
6721 is no mapping or key sequence for the received characters. For
6722 example: if you have mapped "vl" and Vim has received 'v', the next
6723 character is needed to see if the 'v' is followed by an 'l'.
6724 When one of the options is on, Vim will wait for about 1 second for
6725 the next character to arrive. After that the already received
6726 characters are interpreted as single characters. The waiting time can
6727 be changed with the 'timeoutlen' option.
6728 On slow terminals or very busy systems timing out may cause
6729 malfunctioning cursor keys. If both options are off, Vim waits
6730 forever after an entered <Esc> if there are key codes that start
6731 with <Esc>. You will have to type <Esc> twice. If you do not have
6732 problems with key codes, but would like to have :mapped key
6733 sequences not timing out in 1 second, set the 'ttimeout' option and
6734 reset the 'timeout' option.
6735
6736 NOTE: 'ttimeout' is reset when 'compatible' is set.
6737
6738 *'timeoutlen'* *'tm'*
6739'timeoutlen' 'tm' number (default 1000)
6740 global
6741 {not in all versions of Vi}
6742 *'ttimeoutlen'* *'ttm'*
6743'ttimeoutlen' 'ttm' number (default -1)
6744 global
6745 {not in Vi}
6746 The time in milliseconds that is waited for a key code or mapped key
6747 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6748 when part of a command has been typed.
6749 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6750 different timeout value for key codes is desired set 'ttimeoutlen' to
6751 a non-negative number.
6752
6753 ttimeoutlen mapping delay key code delay ~
6754 < 0 'timeoutlen' 'timeoutlen'
6755 >= 0 'timeoutlen' 'ttimeoutlen'
6756
6757 The timeout only happens when the 'timeout' and 'ttimeout' options
6758 tell so. A useful setting would be >
6759 :set timeout timeoutlen=3000 ttimeoutlen=100
6760< (time out on mapping after three seconds, time out on key codes after
6761 a tenth of a second).
6762
6763 *'title'* *'notitle'*
6764'title' boolean (default off, on when title can be restored)
6765 global
6766 {not in Vi}
6767 {not available when compiled without the |+title|
6768 feature}
6769 When on, the title of the window will be set to the value of
6770 'titlestring' (if it is not empty), or to:
6771 filename [+=-] (path) - VIM
6772 Where:
6773 filename the name of the file being edited
6774 - indicates the file cannot be modified, 'ma' off
6775 + indicates the file was modified
6776 = indicates the file is read-only
6777 =+ indicates the file is read-only and modified
6778 (path) is the path of the file being edited
6779 - VIM the server name |v:servername| or "VIM"
6780 Only works if the terminal supports setting window titles
6781 (currently Amiga console, Win32 console, all GUI versions and
6782 terminals with a non- empty 't_ts' option - these are Unix xterm and
6783 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6784 *X11*
6785 When Vim was compiled with HAVE_X11 defined, the original title will
6786 be restored if possible. The output of ":version" will include "+X11"
6787 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6788 works for the icon name |'icon'|.
6789 But: When Vim was started with the |-X| argument, restoring the title
6790 will not work (except in the GUI).
6791 If the title cannot be restored, it is set to the value of 'titleold'.
6792 You might want to restore the title outside of Vim then.
6793 When using an xterm from a remote machine you can use this command:
6794 rsh machine_name xterm -display $DISPLAY &
6795 then the WINDOWID environment variable should be inherited and the
6796 title of the window should change back to what it should be after
6797 exiting Vim.
6798
6799 *'titlelen'*
6800'titlelen' number (default 85)
6801 global
6802 {not in Vi}
6803 {not available when compiled without the |+title|
6804 feature}
6805 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006806 title. When the title is longer, only the end of the path name is
6807 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006808 Using a percentage makes this adapt to the width of the window. But
6809 it won't work perfectly, because the actual number of characters
6810 available also depends on the font used and other things in the title
6811 bar. When 'titlelen' is zero the full path is used. Otherwise,
6812 values from 1 to 30000 percent can be used.
6813 'titlelen' is also used for the 'titlestring' option.
6814
6815 *'titleold'*
6816'titleold' string (default "Thanks for flying Vim")
6817 global
6818 {not in Vi}
6819 {only available when compiled with the |+title|
6820 feature}
6821 This option will be used for the window title when exiting Vim if the
6822 original title cannot be restored. Only happens if 'title' is on or
6823 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006824 This option cannot be set from a |modeline| or in the |sandbox|, for
6825 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006826 *'titlestring'*
6827'titlestring' string (default "")
6828 global
6829 {not in Vi}
6830 {not available when compiled without the |+title|
6831 feature}
6832 When this option is not empty, it will be used for the title of the
6833 window. This happens only when the 'title' option is on.
6834 Only works if the terminal supports setting window titles (currently
6835 Amiga console, Win32 console, all GUI versions and terminals with a
6836 non-empty 't_ts' option).
6837 When Vim was compiled with HAVE_X11 defined, the original title will
6838 be restored if possible |X11|.
6839 When this option contains printf-style '%' items, they will be
6840 expanded according to the rules used for 'statusline'.
6841 Example: >
6842 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6843 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6844< The value of 'titlelen' is used to align items in the middle or right
6845 of the available space.
6846 Some people prefer to have the file name first: >
6847 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6848< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006849 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006850 separating space only when needed.
6851 NOTE: Use of special characters in 'titlestring' may cause the display
6852 to be garbled (e.g., when it contains a CR or NL character).
6853 {not available when compiled without the |+statusline| feature}
6854
6855 *'toolbar'* *'tb'*
6856'toolbar' 'tb' string (default "icons,tooltips")
6857 global
6858 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6859 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006860 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006861 possible values are:
6862 icons Toolbar buttons are shown with icons.
6863 text Toolbar buttons shown with text.
6864 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006865 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006866 tooltips Tooltips are active for toolbar buttons.
6867 Tooltips refer to the popup help text which appears after the mouse
6868 cursor is placed over a toolbar button for a brief moment.
6869
6870 If you want the toolbar to be shown with icons as well as text, do the
6871 following: >
6872 :set tb=icons,text
6873< Motif and Athena cannot display icons and text at the same time. They
6874 will show icons if both are requested.
6875
6876 If none of the strings specified in 'toolbar' are valid or if
6877 'toolbar' is empty, this option is ignored. If you want to disable
6878 the toolbar, you need to set the 'guioptions' option. For example: >
6879 :set guioptions-=T
6880< Also see |gui-toolbar|.
6881
6882 *'toolbariconsize'* *'tbis'*
6883'toolbariconsize' 'tbis' string (default "small")
6884 global
6885 {not in Vi}
6886 {only in the GTK+ 2 GUI}
6887 Controls the size of toolbar icons. The possible values are:
6888 tiny Use tiny toolbar icons.
6889 small Use small toolbar icons (default).
6890 medium Use medium-sized toolbar icons.
6891 large Use large toolbar icons.
6892 The exact dimensions in pixels of the various icon sizes depend on
6893 the current theme. Common dimensions are large=32x32, medium=24x24,
6894 small=20x20 and tiny=16x16.
6895
6896 If 'toolbariconsize' is empty, the global default size as determined
6897 by user preferences or the current theme is used.
6898
6899 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6900'ttybuiltin' 'tbi' boolean (default on)
6901 global
6902 {not in Vi}
6903 When on, the builtin termcaps are searched before the external ones.
6904 When off the builtin termcaps are searched after the external ones.
6905 When this option is changed, you should set the 'term' option next for
6906 the change to take effect, for example: >
6907 :set notbi term=$TERM
6908< See also |termcap|.
6909 Rationale: The default for this option is "on", because the builtin
6910 termcap entries are generally better (many systems contain faulty
6911 xterm entries...).
6912
6913 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6914'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6915 sun-cmd, screen, rxvt, dtterm or
6916 iris-ansi; also on when running Vim in
6917 a DOS console)
6918 global
6919 {not in Vi}
6920 Indicates a fast terminal connection. More characters will be sent to
6921 the screen for redrawing, instead of using insert/delete line
6922 commands. Improves smoothness of redrawing when there are multiple
6923 windows and the terminal does not support a scrolling region.
6924 Also enables the extra writing of characters at the end of each screen
6925 line for lines that wrap. This helps when using copy/paste with the
6926 mouse in an xterm and other terminals.
6927
6928 *'ttymouse'* *'ttym'*
6929'ttymouse' 'ttym' string (default depends on 'term')
6930 global
6931 {not in Vi}
6932 {only in Unix and VMS, doesn't work in the GUI; not
6933 available when compiled without |+mouse|}
6934 Name of the terminal type for which mouse codes are to be recognized.
6935 Currently these three strings are valid:
6936 *xterm-mouse*
6937 xterm xterm-like mouse handling. The mouse generates
6938 "<Esc>[Mscr", where "scr" is three bytes:
6939 "s" = button state
6940 "c" = column plus 33
6941 "r" = row plus 33
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006942 This only works up to 223 columns! See "dec" for a
6943 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006944 xterm2 Works like "xterm", but with the xterm reporting the
6945 mouse position while the mouse is dragged. This works
6946 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006947 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00006948 work. See below for how Vim detects this
6949 automatically.
6950 *netterm-mouse*
6951 netterm NetTerm mouse handling. The mouse generates
6952 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6953 for the row and column.
6954 *dec-mouse*
6955 dec DEC terminal mouse handling. The mouse generates a
6956 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006957 This is also available for an Xterm, if it was
6958 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006959 *jsbterm-mouse*
6960 jsbterm JSB term mouse handling.
6961 *pterm-mouse*
6962 pterm QNX pterm mouse handling.
6963
6964 The mouse handling must be enabled at compile time |+mouse_xterm|
6965 |+mouse_dec| |+mouse_netterm|.
6966 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6967 recognized, if enabled at compile time. DEC terminal mouse codes
6968 are recognized if enabled at compile time, and 'ttymouse' is not
6969 "xterm" (because the xterm and dec mouse codes conflict).
6970 This option is automatically set to "xterm", when the 'term' option is
6971 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6972 or "xterm2" already. The main use of this option is to set it to
6973 "xterm", when the terminal name doesn't start with "xterm", but it can
6974 handle xterm mouse codes.
6975 The "xterm2" value will be set if the xterm version is reported to be
6976 95 of higher. This only works when compiled with the |+termresponse|
6977 feature and if |t_RV| is set to the escape sequence to request the
6978 xterm version number. Otherwise "xterm2" must be set explicitly.
6979 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6980 t_RV to an empty string: >
6981 :set t_RV=
6982<
6983 *'ttyscroll'* *'tsl'*
6984'ttyscroll' 'tsl' number (default 999)
6985 global
6986 Maximum number of lines to scroll the screen. If there are more lines
6987 to scroll the window is redrawn. For terminals where scrolling is
6988 very slow and redrawing is not slow this can be set to a small number,
6989 e.g., 3, to speed up displaying.
6990
6991 *'ttytype'* *'tty'*
6992'ttytype' 'tty' string (default from $TERM)
6993 global
6994 Alias for 'term', see above.
6995
6996 *'undolevels'* *'ul'*
6997'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
6998 Win32 and OS/2)
6999 global
7000 {not in Vi}
7001 Maximum number of changes that can be undone. Since undo information
7002 is kept in memory, higher numbers will cause more memory to be used
7003 (nevertheless, a single change can use an unlimited amount of memory).
7004 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7005 itself: >
7006 set ul=0
7007< But you can also get Vi compatibility by including the 'u' flag in
7008 'cpoptions', and still be able to use CTRL-R to repeat undo.
7009 Set to a negative number for no undo at all: >
7010 set ul=-1
7011< This helps when you run out of memory for a single change.
7012 Also see |undo-two-ways|.
7013
7014 *'updatecount'* *'uc'*
7015'updatecount' 'uc' number (default: 200)
7016 global
7017 {not in Vi}
7018 After typing this many characters the swap file will be written to
7019 disk. When zero, no swap file will be created at all (see chapter on
7020 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7021 Vim with the "-n" option, see |startup|. When editing in readonly
7022 mode this option will be initialized to 10000.
7023 The swapfile can be disabled per buffer with |'swapfile'|.
7024 When 'updatecount' is set from zero to non-zero, swap files are
7025 created for all buffers that have 'swapfile' set. When 'updatecount'
7026 is set to zero, existing swap files are not deleted.
7027 Also see |'swapsync'|.
7028 This option has no meaning in buffers where |'buftype'| is "nofile"
7029 or "nowrite".
7030
7031 *'updatetime'* *'ut'*
7032'updatetime' 'ut' number (default 4000)
7033 global
7034 {not in Vi}
7035 If this many milliseconds nothing is typed the swap file will be
7036 written to disk (see |crash-recovery|). Also used for the
7037 |CursorHold| autocommand event.
7038
7039 *'verbose'* *'vbs'*
7040'verbose' 'vbs' number (default 0)
7041 global
7042 {not in Vi, although some versions have a boolean
7043 verbose option}
7044 When bigger than zero, Vim will give messages about what it is doing.
7045 Currently, these messages are given:
7046 >= 1 When the viminfo file is read or written.
7047 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007048 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007049 >= 8 Files for which a group of autocommands is executed.
7050 >= 9 Every executed autocommand.
7051 >= 12 Every executed function.
7052 >= 13 When an exception is thrown, caught, finished, or discarded.
7053 >= 14 Anything pending in a ":finally" clause.
7054 >= 15 Every executed Ex command (truncated at 200 characters).
7055
7056 This option can also be set with the "-V" argument. See |-V|.
7057 This option is also set by the |:verbose| command.
7058
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007059 When the 'verbosefile' option is set then the verbose messages are not
7060 displayed.
7061
7062 *'verbosefile'* *'vfile'*
7063'verbosefile' 'vfile' string (default empty)
7064 global
7065 {not in Vi}
7066 When not empty all messages are written in a file with this name.
7067 When the file exists messages are appended.
7068 Writing to the file ends when Vim exits or when 'verbosefile' is made
7069 empty.
7070 Setting 'verbosefile' to a new value is like making it empty first.
7071 The difference with |:redir| is that verbose messages are not
7072 displayed when 'verbosefile' is set.
7073
Bram Moolenaar071d4272004-06-13 20:20:40 +00007074 *'viewdir'* *'vdir'*
7075'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7076 "$VIM/vimfiles/view",
7077 for Unix: "~/.vim/view",
7078 for Macintosh: "$VIM:vimfiles:view"
7079 for VMS: "sys$login:vimfiles/view"
7080 for RiscOS: "Choices:vimfiles/view")
7081 global
7082 {not in Vi}
7083 {not available when compiled without the +mksession
7084 feature}
7085 Name of the directory where to store files for |:mkview|.
7086 This option cannot be set from a |modeline| or in the |sandbox|, for
7087 security reasons.
7088
7089 *'viewoptions'* *'vop'*
7090'viewoptions' 'vop' string (default: "folds,options,cursor")
7091 global
7092 {not in Vi}
7093 {not available when compiled without the +mksession
7094 feature}
7095 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007096 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007097 word save and restore ~
7098 cursor cursor position in file and in window
7099 folds manually created folds, opened/closed folds and local
7100 fold options
7101 options options and mappings local to a window or buffer (not
7102 global values for local options)
7103 slash backslashes in file names replaced with forward
7104 slashes
7105 unix with Unix end-of-line format (single <NL>), even when
7106 on Windows or DOS
7107
7108 "slash" and "unix" are useful on Windows when sharing view files
7109 with Unix. The Unix version of Vim cannot source dos format scripts,
7110 but the Windows version of Vim can source unix format scripts.
7111
7112 *'viminfo'* *'vi'* *E526* *E527* *E528*
7113'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
7114 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
7115 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
7116 for others: '20,<50,s10,h)
7117 global
7118 {not in Vi}
7119 {not available when compiled without the |+viminfo|
7120 feature}
7121 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007122 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007123 separated list of parameters, each consisting of a single character
7124 identifying the particular parameter, followed by a number or string
7125 which specifies the value of that parameter. If a particular
7126 character is left out, then the default value is used for that
7127 parameter. The following is a list of the identifying characters and
7128 the effect of their value.
7129 CHAR VALUE ~
7130 ! When included, save and restore global variables that start
7131 with an uppercase letter, and don't contain a lowercase
7132 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007133 and "_K_L_M" are not. Only String and Number types are
7134 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007135 " Maximum number of lines saved for each register. Old name of
7136 the '<' item, with the disadvantage that you need to put a
7137 backslash before the ", otherwise it will be recognized as the
7138 start of a comment!
7139 % When included, save and restore the buffer list. If Vim is
7140 started with a file name argument, the buffer list is not
7141 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007142 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007143 without a file name and buffers for help files are not written
7144 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007145 When followed by a number, the number specifies the maximum
7146 number of buffers that are stored. Without a number all
7147 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007148 ' Maximum number of previously edited files for which the marks
7149 are remembered. This parameter must always be included when
7150 'viminfo' is non-empty.
7151 Including this item also means that the |jumplist| and the
7152 |changelist| are stored in the viminfo file.
7153 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007154 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007155 patterns are also saved. When not included, the value of
7156 'history' is used.
7157 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007158 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007159 < Maximum number of lines saved for each register. If zero then
7160 registers are not saved. When not included, all lines are
7161 saved. '"' is the old name for this item.
7162 Also see the 's' item below: limit specified in Kbyte.
7163 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007164 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007165 c When included, convert the text in the viminfo file from the
7166 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007167 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007168 f Whether file marks need to be stored. If zero, file marks ('0
7169 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007170 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007171 cursor position (when exiting or when doing ":wviminfo").
7172 h Disable the effect of 'hlsearch' when loading the viminfo
7173 file. When not included, it depends on whether ":nohlsearch"
7174 has been used since the last search command.
7175 n Name of the viminfo file. The name must immediately follow
7176 the 'n'. Must be the last one! If the "-i" argument was
7177 given when starting Vim, that file name overrides the one
7178 given here with 'viminfo'. Environment variables are expanded
7179 when opening the file, not when setting the option.
7180 r Removable media. The argument is a string (up to the next
7181 ','). This parameter can be given several times. Each
7182 specifies the start of a path for which no marks will be
7183 stored. This is to avoid removable media. For MS-DOS you
7184 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7185 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7186 ignored. Maximum length of each 'r' argument is 50
7187 characters.
7188 s Maximum size of an item in Kbyte. If zero then registers are
7189 not saved. Currently only applies to registers. The default
7190 "s10" will exclude registers with more than 10 Kbyte of text.
7191 Also see the '<' item above: line count limit.
7192
7193 Example: >
7194 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7195<
7196 '50 Marks will be remembered for the last 50 files you
7197 edited.
7198 <1000 Contents of registers (up to 1000 lines each) will be
7199 remembered.
7200 s100 Registers with more than 100 Kbyte text are skipped.
7201 :0 Command-line history will not be saved.
7202 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7203 no / Since '/' is not specified, the default will be used,
7204 that is, save all of the search history, and also the
7205 previous search and substitute patterns.
7206 no % The buffer list will not be saved nor read back.
7207 no h 'hlsearch' highlighting will be restored.
7208
7209 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7210 load the contents of the file, this is not done automatically.
7211
7212 This option cannot be set from a |modeline| or in the |sandbox|, for
7213 security reasons.
7214
7215 *'virtualedit'* *'ve'*
7216'virtualedit' 've' string (default "")
7217 global
7218 {not in Vi}
7219 {not available when compiled without the
7220 |+virtualedit| feature}
7221 A comma separated list of these words:
7222 block Allow virtual editing in Visual block mode.
7223 insert Allow virtual editing in Insert mode.
7224 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007225 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007226
Bram Moolenaar071d4272004-06-13 20:20:40 +00007227 Virtual editing means that the cursor can be positioned where there is
7228 no actual character. This can be halfway into a Tab or beyond the end
7229 of the line. Useful for selecting a rectangle in Visual mode and
7230 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007231 "onemore" is not the same, it will only allow moving the cursor just
7232 after the last character of the line. This makes some commands more
7233 consistent. Previously the cursor was always past the end of the line
7234 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007235 break some plugins or Vim scripts. For example because |l| can move
7236 the cursor after the last character. Use with care!
7237 Using the |$| command will move to the last character in the line, not
7238 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007239 It doesn't make sense to combine "all" with "onemore", but you will
7240 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007241
7242 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7243'visualbell' 'vb' boolean (default off)
7244 global
7245 {not in Vi}
7246 Use visual bell instead of beeping. The terminal code to display the
7247 visual bell is given with 't_vb'. When no beep or flash is wanted,
7248 use ":set vb t_vb=".
7249 Note: When the GUI starts, 't_vb' is reset to its default value. You
7250 might want to set it again in your |gvimrc|.
7251 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7252 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7253 where 40 is the time in msec.
7254 Does not work on the Amiga, you always get a screen flash.
7255 Also see 'errorbells'.
7256
7257 *'warn'* *'nowarn'*
7258'warn' boolean (default on)
7259 global
7260 Give a warning message when a shell command is used while the buffer
7261 has been changed.
7262
7263 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7264'weirdinvert' 'wiv' boolean (default off)
7265 global
7266 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007267 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007268 It is provided for backwards compatibility with version 4.x.
7269 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7270 vice versa. Has no effect when the GUI is running.
7271
7272 *'whichwrap'* *'ww'*
7273'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7274 global
7275 {not in Vi}
7276 Allow specified keys that move the cursor left/right to move to the
7277 previous/next line when the cursor is on the first/last character in
7278 the line. Concatenate characters to allow this for these keys:
7279 char key mode ~
7280 b <BS> Normal and Visual
7281 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007282 h "h" Normal and Visual (not recommended)
7283 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007284 < <Left> Normal and Visual
7285 > <Right> Normal and Visual
7286 ~ "~" Normal
7287 [ <Left> Insert and Replace
7288 ] <Right> Insert and Replace
7289 For example: >
7290 :set ww=<,>,[,]
7291< allows wrap only when cursor keys are used.
7292 When the movement keys are used in combination with a delete or change
7293 operator, the <EOL> also counts for a character. This makes "3h"
7294 different from "3dh" when the cursor crosses the end of a line. This
7295 is also true for "x" and "X", because they do the same as "dl" and
7296 "dh". If you use this, you may also want to use the mapping
7297 ":map <BS> X" to make backspace delete the character in front of the
7298 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007299 When 'l' is included and it is used after an operator at the end of a
7300 line then it will not move to the next line. This makes "dl", "cl",
7301 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007302 NOTE: This option is set to the Vi default value when 'compatible' is
7303 set and to the Vim default value when 'compatible' is reset.
7304
7305 *'wildchar'* *'wc'*
7306'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7307 global
7308 {not in Vi}
7309 Character you have to type to start wildcard expansion in the
7310 command-line, as specified with 'wildmode'.
7311 The character is not recognized when used inside a macro. See
7312 'wildcharm' for that.
7313 Although 'wc' is a number option, you can set it to a special key: >
7314 :set wc=<Esc>
7315< NOTE: This option is set to the Vi default value when 'compatible' is
7316 set and to the Vim default value when 'compatible' is reset.
7317
7318 *'wildcharm'* *'wcm'*
7319'wildcharm' 'wcm' number (default: none (0))
7320 global
7321 {not in Vi}
7322 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007323 recognized when used inside a macro. You can find "spare" command-line
7324 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007325 you'll never actually type 'wildcharm', just use it in mappings that
7326 automatically invoke completion mode, e.g.: >
7327 :set wcm=<C-Z>
7328 :cmap ss so $vim/sessions/*.vim<C-Z>
7329< Then after typing :ss you can use CTRL-P & CTRL-N.
7330
7331 *'wildignore'* *'wig'*
7332'wildignore' 'wig' string (default "")
7333 global
7334 {not in Vi}
7335 {not available when compiled without the |+wildignore|
7336 feature}
7337 A list of file patterns. A file that matches with one of these
7338 patterns is ignored when completing file or directory names.
7339 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7340 Also see 'suffixes'.
7341 Example: >
7342 :set wildignore=*.o,*.obj
7343< The use of |:set+=| and |:set-=| is preferred when adding or removing
7344 a pattern from the list. This avoids problems when a future version
7345 uses another default.
7346
7347 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7348'wildmenu' 'wmnu' boolean (default off)
7349 global
7350 {not in Vi}
7351 {not available if compiled without the |+wildmenu|
7352 feature}
7353 When 'wildmenu' is on, command-line completion operates in an enhanced
7354 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7355 the possible matches are shown just above the command line, with the
7356 first match highlighted (overwriting the status line, if there is
7357 one). Keys that show the previous/next match, such as <Tab> or
7358 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7359 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7360 specified. "longest" and "list" do not start "wildmenu" mode.
7361 If there are more matches than can fit in the line, a ">" is shown on
7362 the right and/or a "<" is shown on the left. The status line scrolls
7363 as needed.
7364 The "wildmenu" mode is abandoned when a key is hit that is not used
7365 for selecting a completion.
7366 While the "wildmenu" is active the following keys have special
7367 meanings:
7368
7369 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7370 <Down> - in filename/menu name completion: move into a
7371 subdirectory or submenu.
7372 <CR> - in menu completion, when the cursor is just after a
7373 dot: move into a submenu.
7374 <Up> - in filename/menu name completion: move up into
7375 parent directory or parent menu.
7376
7377 This makes the menus accessible from the console |console-menus|.
7378
7379 If you prefer the <Left> and <Right> keys to move the cursor instead
7380 of selecting a different match, use this: >
7381 :cnoremap <Left> <Space><BS><Left>
7382 :cnoremap <Right> <Space><BS><Right>
7383<
7384 The "WildMenu" highlighting is used for displaying the current match
7385 |hl-WildMenu|.
7386
7387 *'wildmode'* *'wim'*
7388'wildmode' 'wim' string (Vim default: "full")
7389 global
7390 {not in Vi}
7391 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007392 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00007393 part specifies what to do for each consecutive use of 'wildchar. The
7394 first part specifies the behavior for the first use of 'wildchar',
7395 The second part for the second use, etc.
7396 These are the possible values for each part:
7397 "" Complete only the first match.
7398 "full" Complete the next full match. After the last match,
7399 the original string is used and then the first match
7400 again.
7401 "longest" Complete till longest common string. If this doesn't
7402 result in a longer string, use the next part.
7403 "longest:full" Like "longest", but also start 'wildmenu' if it is
7404 enabled.
7405 "list" When more than one match, list all matches.
7406 "list:full" When more than one match, list all matches and
7407 complete first match.
7408 "list:longest" When more than one match, list all matches and
7409 complete till longest common string.
7410 When there is only a single match, it is fully completed in all cases.
7411
7412 Examples: >
7413 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007414< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007415 :set wildmode=longest,full
7416< Complete longest common string, then each full match >
7417 :set wildmode=list:full
7418< List all matches and complete each full match >
7419 :set wildmode=list,full
7420< List all matches without completing, then each full match >
7421 :set wildmode=longest,list
7422< Complete longest common string, then list alternatives.
7423
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007424 *'wildoptions'* *'wop'*
7425'wildoptions' 'wop' string (default "")
7426 global
7427 {not in Vi}
7428 {not available when compiled without the |+wildignore|
7429 feature}
7430 A list of words that change how command line completion is done.
7431 Currently only one word is allowed:
7432 tagfile When using CTRL-D to list matching tags, the kind of
7433 tag and the file of the tag is listed. Only one match
7434 is displayed per line. Often used tag kinds are:
7435 d #define
7436 f function
7437 Also see |cmdline-completion|.
7438
Bram Moolenaar071d4272004-06-13 20:20:40 +00007439 *'winaltkeys'* *'wak'*
7440'winaltkeys' 'wak' string (default "menu")
7441 global
7442 {not in Vi}
7443 {only used in Win32, Motif, GTK and Photon GUI}
7444 Some GUI versions allow the access to menu entries by using the ALT
7445 key in combination with a character that appears underlined in the
7446 menu. This conflicts with the use of the ALT key for mappings and
7447 entering special characters. This option tells what to do:
7448 no Don't use ALT keys for menus. ALT key combinations can be
7449 mapped, but there is no automatic handling. This can then be
7450 done with the |:simalt| command.
7451 yes ALT key handling is done by the windowing system. ALT key
7452 combinations cannot be mapped.
7453 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007454 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007455 keys can be mapped.
7456 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7457 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007458 This option is not used for <F10>; on Win32 and with GTK <F10> will
7459 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007460
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007461 *'window'* *'wi'*
7462'window' 'wi' number (default screen height - 1)
7463 global
7464 Window height. Do not confuse this with the height of the Vim window,
7465 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007466 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7467 value is smaller than 'lines' minus one. The screen will scroll
7468 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007469 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7470 in a much smarter way, taking care of wrapping lines.
7471 When resizing the Vim window, the value is smaller than 1 or more than
7472 or equal to 'lines' it will be set to 'lines' minus 1.
7473 {Vi also uses the option to specify the number of displayed lines}
7474
Bram Moolenaar071d4272004-06-13 20:20:40 +00007475 *'winheight'* *'wh'* *E591*
7476'winheight' 'wh' number (default 1)
7477 global
7478 {not in Vi}
7479 {not available when compiled without the +windows
7480 feature}
7481 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007482 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007483 current window is smaller, its size is increased, at the cost of the
7484 height of other windows. Set it to 999 to make the current window
7485 always fill the screen (although this has the drawback that ":all"
7486 will create only two windows). Set it to a small number for normal
7487 editing.
7488 Minimum value is 1.
7489 The height is not adjusted after one of the commands to change the
7490 height of the current window.
7491 'winheight' applies to the current window. Use 'winminheight' to set
7492 the minimal height for other windows.
7493
7494 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7495'winfixheight' 'wfh' boolean (default off)
7496 local to window
7497 {not in Vi}
7498 {not available when compiled without the +windows
7499 feature}
7500 Keep the window height when windows are opened or closed and
7501 'equalalways' is set. Set by default for the |preview-window| and
7502 |quickfix-window|.
7503 The height may be changed anyway when running out of room.
7504
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007505 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7506'winfixwidth' 'wfw' boolean (default off)
7507 local to window
7508 {not in Vi}
7509 {not available when compiled without the +windows
7510 feature}
7511 Keep the window width when windows are opened or closed and
7512 'equalalways' is set.
7513 The width may be changed anyway when running out of room.
7514
Bram Moolenaar071d4272004-06-13 20:20:40 +00007515 *'winminheight'* *'wmh'*
7516'winminheight' 'wmh' number (default 1)
7517 global
7518 {not in Vi}
7519 {not available when compiled without the +windows
7520 feature}
7521 The minimal height of a window, when it's not the current window.
7522 This is a hard minimum, windows will never become smaller.
7523 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7524 status bar) if necessary. They will return to at least one line when
7525 they become active (since the cursor has to have somewhere to go.)
7526 Use 'winheight' to set the minimal height of the current window.
7527 This option is only checked when making a window smaller. Don't use a
7528 large number, it will cause errors when opening more than a few
7529 windows. A value of 0 to 3 is reasonable.
7530
7531 *'winminwidth'* *'wmw'*
7532'winminwidth' 'wmw' number (default 1)
7533 global
7534 {not in Vi}
7535 {not available when compiled without the +vertsplit
7536 feature}
7537 The minimal width of a window, when it's not the current window.
7538 This is a hard minimum, windows will never become smaller.
7539 When set to zero, windows may be "squashed" to zero columns (i.e. just
7540 a vertical separator) if necessary. They will return to at least one
7541 line when they become active (since the cursor has to have somewhere
7542 to go.)
7543 Use 'winwidth' to set the minimal width of the current window.
7544 This option is only checked when making a window smaller. Don't use a
7545 large number, it will cause errors when opening more than a few
7546 windows. A value of 0 to 12 is reasonable.
7547
7548 *'winwidth'* *'wiw'* *E592*
7549'winwidth' 'wiw' number (default 20)
7550 global
7551 {not in Vi}
7552 {not available when compiled without the +vertsplit
7553 feature}
7554 Minimal number of columns for the current window. This is not a hard
7555 minimum, Vim will use fewer columns if there is not enough room. If
7556 the current window is smaller, its size is increased, at the cost of
7557 the width of other windows. Set it to 999 to make the current window
7558 always fill the screen. Set it to a small number for normal editing.
7559 The width is not adjusted after one of the commands to change the
7560 width of the current window.
7561 'winwidth' applies to the current window. Use 'winminwidth' to set
7562 the minimal width for other windows.
7563
7564 *'wrap'* *'nowrap'*
7565'wrap' boolean (default on)
7566 local to window
7567 {not in Vi}
7568 This option changes how text is displayed. It doesn't change the text
7569 in the buffer, see 'textwidth' for that.
7570 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007571 displaying continues on the next line. When off lines will not wrap
7572 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007573 moved to a part that is not shown, the screen will scroll
7574 horizontally.
7575 The line will be broken in the middle of a word if necessary. See
7576 'linebreak' to get the break at a word boundary.
7577 To make scrolling horizontally a bit more useful, try this: >
7578 :set sidescroll=5
7579 :set listchars+=precedes:<,extends:>
7580< See 'sidescroll', 'listchars' and |wrap-off|.
7581
7582 *'wrapmargin'* *'wm'*
7583'wrapmargin' 'wm' number (default 0)
7584 local to buffer
7585 Number of characters from the right window border where wrapping
7586 starts. When typing text beyond this limit, an <EOL> will be inserted
7587 and inserting continues on the next line.
7588 Options that add a margin, such as 'number' and 'foldcolumn', cause
7589 the text width to be further reduced. This is Vi compatible.
7590 When 'textwidth' is non-zero, this option is not used.
7591 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7592 and less usefully}
7593
7594 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7595'wrapscan' 'ws' boolean (default on) *E384* *E385*
7596 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007597 Searches wrap around the end of the file. Also applies to |]s| and
7598 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007599
7600 *'write'* *'nowrite'*
7601'write' boolean (default on)
7602 global
7603 {not in Vi}
7604 Allows writing files. When not set, writing a file is not allowed.
7605 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007606 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007607 argument. Filtering text is still possible, even though this requires
7608 writing a temporary file.
7609
7610 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7611'writeany' 'wa' boolean (default off)
7612 global
7613 Allows writing to any file with no need for "!" override.
7614
7615 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7616'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7617 otherwise)
7618 global
7619 {not in Vi}
7620 Make a backup before overwriting a file. The backup is removed after
7621 the file was successfully written, unless the 'backup' option is
7622 also on. Reset this option if your file system is almost full. See
7623 |backup-table| for another explanation.
7624 When the 'backupskip' pattern matches, a backup is not made anyway.
7625 NOTE: This option is set to the default value when 'compatible' is
7626 set.
7627
7628 *'writedelay'* *'wd'*
7629'writedelay' 'wd' number (default 0)
7630 global
7631 {not in Vi}
7632 The number of microseconds to wait for each character sent to the
7633 screen. When non-zero, characters are sent to the terminal one by
7634 one. For MS-DOS pcterm this does not work. For debugging purposes.
7635
7636 vim:tw=78:ts=8:ft=help:norl: