blob: d7c54406163641281126d1883c9237f838b45d3b [file] [log] [blame]
Bram Moolenaar18144c82006-04-12 21:52:12 +00001*options.txt* For Vim version 7.0d. Last change: 2006 Apr 12
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.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002071 If you only want the highlighting in the current window you can use
2072 these autocommands: >
2073 au WinLeave * set nocursorline nocursorcolumn
2074 au WinEnter * set cursorline cursorcolumn
2075<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002076
2077 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2078'cursorline' 'cul' boolean (default off)
2079 local to window
2080 {not in Vi}
2081 {not available when compiled without the |+syntax|
2082 feature}
2083 Highlight the screen line of the cursor with CursorLine
2084 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2085 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002086 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002087 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002088
2089
Bram Moolenaar071d4272004-06-13 20:20:40 +00002090 *'debug'*
2091'debug' string (default "")
2092 global
2093 {not in Vi}
2094 When set to "msg", error messages that would otherwise be omitted will
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002095 be given anyway. This is useful when debugging 'foldexpr',
2096 'formatexpr' or 'indentexpr'.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002097 When set to "beep", a message will be given when otherwise only a beep
2098 would be produced.
2099 The values can be combined, separated by a comma.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002100
2101 *'define'* *'def'*
2102'define' 'def' string (default "^\s*#\s*define")
2103 global or local to buffer |global-local|
2104 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002105 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002106 pattern, just like for the "/" command. This option is used for the
2107 commands like "[i" and "[d" |include-search|. The 'isident' option is
2108 used to recognize the defined name after the match:
2109 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2110 See |option-backslash| about inserting backslashes to include a space
2111 or backslash.
2112 The default value is for C programs. For C++ this value would be
2113 useful, to include const type declarations: >
2114 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2115< When using the ":set" command, you need to double the backslashes!
2116
2117 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2118'delcombine' 'deco' boolean (default off)
2119 global
2120 {not in Vi}
2121 {only available when compiled with the |+multi_byte|
2122 feature}
2123 If editing Unicode and this option is set, backspace and Normal mode
2124 "x" delete each combining character on its own. When it is off (the
2125 default) the character along with its combining characters are
2126 deleted.
2127 Note: When 'delcombine' is set "xx" may work different from "2x"!
2128
2129 This is useful for Arabic, Hebrew and many other languages where one
2130 may have combining characters overtop of base characters, and want
2131 to remove only the combining ones.
2132
2133 *'dictionary'* *'dict'*
2134'dictionary' 'dict' string (default "")
2135 global or local to buffer |global-local|
2136 {not in Vi}
2137 List of file names, separated by commas, that are used to lookup words
2138 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2139 contain a list of words. This can be one word per line, or several
2140 words per line, separated by non-keyword characters (white space is
2141 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002142 When this option is empty, or an entry "spell" is present, spell
2143 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002144 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002145 after a comma are ignored, otherwise spaces are included in the file
2146 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002147 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002148 Where to find a list of words?
2149 - On FreeBSD, there is the file "/usr/share/dict/words".
2150 - In the Simtel archive, look in the "msdos/linguist" directory.
2151 - In "miscfiles" of the GNU collection.
2152 The use of |:set+=| and |:set-=| is preferred when adding or removing
2153 directories from the list. This avoids problems when a future version
2154 uses another default.
2155 Backticks cannot be used in this option for security reasons.
2156
2157 *'diff'* *'nodiff'*
2158'diff' boolean (default off)
2159 local to window
2160 {not in Vi}
2161 {not available when compiled without the |+diff|
2162 feature}
2163 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002164 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002165
2166 *'dex'* *'diffexpr'*
2167'diffexpr' 'dex' string (default "")
2168 global
2169 {not in Vi}
2170 {not available when compiled without the |+diff|
2171 feature}
2172 Expression which is evaluated to obtain an ed-style diff file from two
2173 versions of a file. See |diff-diffexpr|.
2174 This option cannot be set from a |modeline| or in the |sandbox|, for
2175 security reasons.
2176
2177 *'dip'* *'diffopt'*
2178'diffopt' 'dip' string (default "filler")
2179 global
2180 {not in Vi}
2181 {not available when compiled without the |+diff|
2182 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002183 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002184 All are optional. Items must be separated by a comma.
2185
2186 filler Show filler lines, to keep the text
2187 synchronized with a window that has inserted
2188 lines at the same position. Mostly useful
2189 when windows are side-by-side and 'scrollbind'
2190 is set.
2191
2192 context:{n} Use a context of {n} lines between a change
2193 and a fold that contains unchanged lines.
2194 When omitted a context of six lines is used.
2195 See |fold-diff|.
2196
2197 icase Ignore changes in case of text. "a" and "A"
2198 are considered the same. Adds the "-i" flag
2199 to the "diff" command if 'diffexpr' is empty.
2200
2201 iwhite Ignore changes in amount of white space. Adds
2202 the "-b" flag to the "diff" command if
2203 'diffexpr' is empty. Check the documentation
2204 of the "diff" command for what this does
2205 exactly. It should ignore adding trailing
2206 white space, but not leading white space.
2207
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002208 horizontal Start diff mode with horizontal splits (unless
2209 explicitly specified otherwise).
2210
2211 vertical Start diff mode with vertical splits (unless
2212 explicitly specified otherwise).
2213
2214 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2215 starting diff mode. Without this 2 is used.
2216
Bram Moolenaar071d4272004-06-13 20:20:40 +00002217 Examples: >
2218
2219 :set diffopt=filler,context:4
2220 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002221 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002222<
2223 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2224'digraph' 'dg' boolean (default off)
2225 global
2226 {not in Vi}
2227 {not available when compiled without the |+digraphs|
2228 feature}
2229 Enable the entering of digraphs in Insert mode with {char1} <BS>
2230 {char2}. See |digraphs|.
2231 NOTE: This option is reset when 'compatible' is set.
2232
2233 *'directory'* *'dir'*
2234'directory' 'dir' string (default for Amiga: ".,t:",
2235 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2236 for Unix: ".,~/tmp,/var/tmp,/tmp")
2237 global
2238 List of directory names for the swap file, separated with commas.
2239 - The swap file will be created in the first directory where this is
2240 possible.
2241 - Empty means that no swap file will be used (recovery is
2242 impossible!).
2243 - A directory "." means to put the swap file in the same directory as
2244 the edited file. On Unix, a dot is prepended to the file name, so
2245 it doesn't show in a directory listing. On MS-Windows the "hidden"
2246 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002247 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002248 put the swap file relative to where the edited file is. The leading
2249 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002250 - For Unix and Win32, if a directory ends in two path separators "//"
2251 or "\\", the swap file name will be built from the complete path to
2252 the file with all path separators substituted to percent '%' signs.
2253 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002254 - Spaces after the comma are ignored, other spaces are considered part
2255 of the directory name. To have a space at the start of a directory
2256 name, precede it with a backslash.
2257 - To include a comma in a directory name precede it with a backslash.
2258 - A directory name may end in an ':' or '/'.
2259 - Environment variables are expanded |:set_env|.
2260 - Careful with '\' characters, type one before a space, type two to
2261 get one in the option (see |option-backslash|), for example: >
2262 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2263< - For backwards compatibility with Vim version 3.0 a '>' at the start
2264 of the option is removed.
2265 Using "." first in the list is recommended. This means that editing
2266 the same file twice will result in a warning. Using "/tmp" on Unix is
2267 discouraged: When the system crashes you lose the swap file.
2268 "/var/tmp" is often not cleared when rebooting, thus is a better
2269 choice than "/tmp". But it can contain a lot of files, your swap
2270 files get lost in the crowd. That is why a "tmp" directory in your
2271 home directory is tried first.
2272 The use of |:set+=| and |:set-=| is preferred when adding or removing
2273 directories from the list. This avoids problems when a future version
2274 uses another default.
2275 This option cannot be set from a |modeline| or in the |sandbox|, for
2276 security reasons.
2277 {Vi: directory to put temp file in, defaults to "/tmp"}
2278
2279 *'display'* *'dy'*
2280'display' 'dy' string (default "")
2281 global
2282 {not in Vi}
2283 Change the way text is displayed. This is comma separated list of
2284 flags:
2285 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002286 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002287 last line that doesn't fit is replaced with "@" lines.
2288 uhex Show unprintable characters hexadecimal as <xx>
2289 instead of using ^C and ~C.
2290
2291 *'eadirection'* *'ead'*
2292'eadirection' 'ead' string (default "both")
2293 global
2294 {not in Vi}
2295 {not available when compiled without the +vertsplit
2296 feature}
2297 Tells when the 'equalalways' option applies:
2298 ver vertically, width of windows is not affected
2299 hor horizontally, height of windows is not affected
2300 both width and height of windows is affected
2301
2302 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2303'edcompatible' 'ed' boolean (default off)
2304 global
2305 Makes the 'g' and 'c' flags of the ":substitute" command to be
2306 toggled each time the flag is given. See |complex-change|. See
2307 also 'gdefault' option.
2308 Switching this option on is discouraged!
2309
2310 *'encoding'* *'enc'* *E543*
2311'encoding' 'enc' string (default: "latin1" or value from $LANG)
2312 global
2313 {only available when compiled with the |+multi_byte|
2314 feature}
2315 {not in Vi}
2316 Sets the character encoding used inside Vim. It applies to text in
2317 the buffers, registers, Strings in expressions, text stored in the
2318 viminfo file, etc. It sets the kind of characters which Vim can work
2319 with. See |encoding-names| for the possible values.
2320
2321 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002322 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002323 It should normally be kept at its default value, or set when Vim
2324 starts up. See |multibyte|.
2325
2326 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2327 "utf-8". Although care has been taken to allow different values of
2328 'encoding', "utf-8" is the natural choice for the environment and
2329 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002330 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002331 versions, and to avoid changing the encoding of newly created files
2332 without your knowledge (in case 'fileencodings' is empty).
2333
2334 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002335 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002336 iconv() or as specified with 'charconvert'.
2337
2338 Normally 'encoding' will be equal to your current locale. This will
2339 be the default if Vim recognizes your environment settings. If
2340 'encoding' is not set to the current locale, 'termencoding' must be
2341 set to convert typed and displayed text. See |encoding-table|.
2342
2343 When you set this option, it fires the |EncodingChanged| autocommand
2344 event so that you can set up fonts if necessary.
2345
2346 When the option is set, the value is converted to lowercase. Thus
2347 you can set it with uppercase values too. Underscores are translated
2348 to '-' signs.
2349 When the encoding is recognized, it is changed to the standard name.
2350 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2351 "iso-8859-2" and "utf8" becomes "utf-8".
2352
2353 Note: "latin1" is also used when the encoding could not be detected.
2354 This only works when editing files in the same encoding! When the
2355 actual character set is not latin1, make sure 'fileencoding' and
2356 'fileencodings' are empty. When conversion is needed, switch to using
2357 utf-8.
2358
2359 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2360 You don't notice this while editing, but it does matter for the
2361 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2362 setting 'encoding' to one of these values instead of utf-8 only has
2363 effect for encoding used for files when 'fileencoding' is empty.
2364
Bram Moolenaar661b1822005-07-28 22:36:45 +00002365 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2366 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002367
2368 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2369'endofline' 'eol' boolean (default on)
2370 local to buffer
2371 {not in Vi}
2372 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002373 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002374 option is automatically set when starting to edit a new file, unless
2375 the file does not have an <EOL> for the last line in the file, in
2376 which case it is reset. Normally you don't have to set or reset this
2377 option. When 'binary' is off the value is not used when writing the
2378 file. When 'binary' is on it is used to remember the presence of a
2379 <EOL> for the last line in the file, so that when you write the file
2380 the situation from the original file can be kept. But you can change
2381 it if you want to.
2382
2383 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2384'equalalways' 'ea' boolean (default on)
2385 global
2386 {not in Vi}
2387 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002388 splitting or closing a window. This also happens the moment the
2389 option is switched on. When off, splitting a window will reduce the
2390 size of the current window and leave the other windows the same. When
2391 closing a window the extra lines are given to the window next to it
2392 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002393 When mixing vertically and horizontally split windows, a minimal size
2394 is computed and some windows may be larger if there is room. The
2395 'eadirection' option tells in which direction the size is affected.
2396 Changing the height of a window can be avoided by setting
2397 'winfixheight'.
2398
2399 *'equalprg'* *'ep'*
2400'equalprg' 'ep' string (default "")
2401 global or local to buffer |global-local|
2402 {not in Vi}
2403 External program to use for "=" command. When this option is empty
2404 the internal formatting functions are used ('lisp', 'cindent' or
2405 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002406 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002407 about including spaces and backslashes.
2408 This option cannot be set from a |modeline| or in the |sandbox|, for
2409 security reasons.
2410
2411 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2412'errorbells' 'eb' boolean (default off)
2413 global
2414 Ring the bell (beep or screen flash) for error messages. This only
2415 makes a difference for error messages, the bell will be used always
2416 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002417 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002418 screen flash or do nothing.
2419
2420 *'errorfile'* *'ef'*
2421'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2422 others: "errors.err")
2423 global
2424 {not in Vi}
2425 {not available when compiled without the |+quickfix|
2426 feature}
2427 Name of the errorfile for the QuickFix mode (see |:cf|).
2428 When the "-q" command-line argument is used, 'errorfile' is set to the
2429 following argument. See |-q|.
2430 NOT used for the ":make" command. See 'makeef' for that.
2431 Environment variables are expanded |:set_env|.
2432 See |option-backslash| about including spaces and backslashes.
2433 This option cannot be set from a |modeline| or in the |sandbox|, for
2434 security reasons.
2435
2436 *'errorformat'* *'efm'*
2437'errorformat' 'efm' string (default is very long)
2438 global or local to buffer |global-local|
2439 {not in Vi}
2440 {not available when compiled without the |+quickfix|
2441 feature}
2442 Scanf-like description of the format for the lines in the error file
2443 (see |errorformat|).
2444
2445 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2446'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2447 global
2448 {not in Vi}
2449 Function keys that start with an <Esc> are recognized in Insert
2450 mode. When this option is off, the cursor and function keys cannot be
2451 used in Insert mode if they start with an <Esc>. The advantage of
2452 this is that the single <Esc> is recognized immediately, instead of
2453 after one second. Instead of resetting this option, you might want to
2454 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2455 when 'esckeys' is off, you can still map anything, but the cursor keys
2456 won't work by default.
2457 NOTE: This option is set to the Vi default value when 'compatible' is
2458 set and to the Vim default value when 'compatible' is reset.
2459
2460 *'eventignore'* *'ei'*
2461'eventignore' 'ei' string (default "")
2462 global
2463 {not in Vi}
2464 {not available when compiled without the |+autocmd|
2465 feature}
2466 A list of autocommand event names, which are to be ignored.
2467 When set to "all", all autocommand events are ignored, autocommands
2468 will not be executed.
2469 Otherwise this is a comma separated list of event names. Example: >
2470 :set ei=WinEnter,WinLeave
2471<
2472 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2473'expandtab' 'et' boolean (default off)
2474 local to buffer
2475 {not in Vi}
2476 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002477 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002478 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2479 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2480 NOTE: This option is reset when 'compatible' is set.
2481
2482 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2483'exrc' 'ex' boolean (default off)
2484 global
2485 {not in Vi}
2486 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2487 directory. If you switch this option on you should also consider
2488 setting the 'secure' option (see |initialization|). Using a local
2489 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2490 also see |.vimrc| and |gui-init|.
2491 This option cannot be set from a |modeline| or in the |sandbox|, for
2492 security reasons.
2493
2494 *'fileencoding'* *'fenc'* *E213*
2495'fileencoding' 'fenc' string (default: "")
2496 local to buffer
2497 {only available when compiled with the |+multi_byte|
2498 feature}
2499 {not in Vi}
2500 Sets the character encoding for the file of this buffer.
2501 When 'fileencoding' is different from 'encoding', conversion will be
2502 done when reading and writing the file.
2503 When 'fileencoding' is empty, the same value as 'encoding' will be
2504 used (no conversion when reading or writing a file).
2505 WARNING: Conversion can cause loss of information! When
2506 'encoding' is "utf-8" conversion is most likely done in a way
2507 that the reverse conversion results in the same text. When
2508 'encoding' is not "utf-8" some characters may be lost!
2509 See 'encoding' for the possible values. Additionally, values may be
2510 specified that can be handled by the converter, see
2511 |mbyte-conversion|.
2512 When reading a file 'fileencoding' will be set from 'fileencodings'.
2513 To read a file in a certain encoding it won't work by setting
2514 'fileencoding', use the |++enc| argument.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002515 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002516 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2517 When the option is set, the value is converted to lowercase. Thus
2518 you can set it with uppercase values too. '_' characters are
2519 replaced with '-'. If a name is recognized from the list for
2520 'encoding', it is replaced by the standard name. For example
2521 "ISO8859-2" becomes "iso-8859-2".
2522 When this option is set, after starting to edit a file, the 'modified'
2523 option is set, because the file would be different when written.
2524 If you do this in a modeline, you might want to set 'nomodified' to
2525 avoid this.
2526 This option can not be changed when 'modifiable' is off.
2527
2528 *'fe'*
2529 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002530 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002531 old short name was 'fe', which is no longer used.
2532
2533 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002534'fileencodings' 'fencs' string (default: "ucs-bom",
2535 "ucs-bom,utf-8,default,latin1" when
2536 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002537 global
2538 {only available when compiled with the |+multi_byte|
2539 feature}
2540 {not in Vi}
2541 This is a list of character encodings considered when starting to edit
2542 an existing file. When a file is read, Vim tries to use the first
2543 mentioned character encoding. If an error is detected, the next one
2544 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002545 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002546 an empty string, which means the value of 'encoding' is used.
2547 WARNING: Conversion can cause loss of information! When
2548 'encoding' is "utf-8" (or one of the other Unicode variants)
2549 conversion is most likely done in a way that the reverse
2550 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002551 "utf-8" some non-ASCII characters may be lost! You can use
2552 the |++bad| argument to specify what is done with characters
2553 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002554 For an empty file or a file with only ASCII characters most encodings
2555 will work and the first entry of 'fileencodings' will be used (except
2556 "ucs-bom", which requires the BOM to be present). If you prefer
2557 another encoding use an BufReadPost autocommand event to test if your
2558 preferred encoding is to be used. Example: >
2559 au BufReadPost * if search('\S', 'w') == 0 |
2560 \ set fenc=iso-2022-jp | endif
2561< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2562 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002563 When the |++enc| argument is used then the value of 'fileencodings' is
2564 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002565 Note that 'fileencodings' is not used for a new file, the global value
2566 of 'fileencoding' is used instead. You can set it with: >
2567 :setglobal fenc=iso-8859-2
2568< This means that a non-existing file may get a different encoding than
2569 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002570 The special value "ucs-bom" can be used to check for a Unicode BOM
2571 (Byte Order Mark) at the start of the file. It must not be preceded
2572 by "utf-8" or another Unicode encoding for this to work properly.
2573 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2574 because Vim cannot detect an error, thus the encoding is always
2575 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002576 The special value "default" can be used for the encoding from the
2577 environment. This is the default value for 'encoding'. It is useful
2578 when 'encoding' is set to "utf-8" and your environment uses a
2579 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002580 When 'encoding' is "utf-8" and a file contains an illegal byte
2581 sequence it won't be recognized as UTF-8. You can use the |8g8|
2582 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002583 WRONG VALUES: WHAT'S WRONG:
2584 latin1,utf-8 "latin1" will always be used
2585 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2586 file
2587 cp1250,latin1 "cp1250" will always be used
2588 If 'fileencodings' is empty, 'fileencoding' is not modified.
2589 See 'fileencoding' for the possible values.
2590 Setting this option does not have an effect until the next time a file
2591 is read.
2592
2593 *'fileformat'* *'ff'*
2594'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2595 Unix default: "unix",
2596 Macintosh default: "mac")
2597 local to buffer
2598 {not in Vi}
2599 This gives the <EOL> of the current buffer, which is used for
2600 reading/writing the buffer from/to a file:
2601 dos <CR> <NL>
2602 unix <NL>
2603 mac <CR>
2604 When "dos" is used, CTRL-Z at the end of a file is ignored.
2605 See |file-formats| and |file-read|.
2606 For the character encoding of the file see 'fileencoding'.
2607 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2608 works like it was set to "unix'.
2609 This option is set automatically when starting to edit a file and
2610 'fileformats' is not empty and 'binary' is off.
2611 When this option is set, after starting to edit a file, the 'modified'
2612 option is set, because the file would be different when written.
2613 This option can not be changed when 'modifiable' is off.
2614 For backwards compatibility: When this option is set to "dos",
2615 'textmode' is set, otherwise 'textmode' is reset.
2616
2617 *'fileformats'* *'ffs'*
2618'fileformats' 'ffs' string (default:
2619 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2620 Vim Unix: "unix,dos",
2621 Vim Mac: "mac,unix,dos",
2622 Vi Cygwin: "unix,dos",
2623 Vi others: "")
2624 global
2625 {not in Vi}
2626 This gives the end-of-line (<EOL>) formats that will be tried when
2627 starting to edit a new buffer and when reading a file into an existing
2628 buffer:
2629 - When empty, the format defined with 'fileformat' will be used
2630 always. It is not set automatically.
2631 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002632 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002633 'fileformats' name will be used when a file is read into an existing
2634 buffer, no matter what 'fileformat' for that buffer is set to.
2635 - When more than one name is present, separated by commas, automatic
2636 <EOL> detection will be done when reading a file. When starting to
2637 edit a file, a check is done for the <EOL>:
2638 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2639 'fileformat' is set to "dos".
2640 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002641 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002642 preceding <CR>, "unix" is preferred over "dos".
2643 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2644 This means that "mac" is only chosen when "unix" is not present,
2645 or when no <NL> is found in the file, and when "dos" is not
2646 present, or no <CR><NL> is present in the file.
2647 Also if "unix" was first chosen, but the first <CR> is before
2648 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2649 the file, then 'fileformat' is set to "mac".
2650 4. If 'fileformat' is still not set, the first name from
2651 'fileformats' is used.
2652 When reading a file into an existing buffer, the same is done, but
2653 this happens like 'fileformat' has been set appropriately for that
2654 file only, the option is not changed.
2655 When 'binary' is set, the value of 'fileformats' is not used.
2656
2657 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2658 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2659 done:
2660 - When 'fileformats' is empty, there is no automatic detection. Dos
2661 format will be used.
2662 - When 'fileformats' is set to one or more names, automatic detection
2663 is done. This is based on the first <NL> in the file: If there is a
2664 <CR> in front of it, Dos format is used, otherwise Unix format is
2665 used.
2666 Also see |file-formats|.
2667 For backwards compatibility: When this option is set to an empty
2668 string or one format (no comma is included), 'textauto' is reset,
2669 otherwise 'textauto' is set.
2670 NOTE: This option is set to the Vi default value when 'compatible' is
2671 set and to the Vim default value when 'compatible' is reset.
2672
2673 *'filetype'* *'ft'*
2674'filetype' 'ft' string (default: "")
2675 local to buffer
2676 {not in Vi}
2677 {not available when compiled without the |+autocmd|
2678 feature}
2679 When this option is set, the FileType autocommand event is triggered.
2680 All autocommands that match with the value of this option will be
2681 executed. Thus the value of 'filetype' is used in place of the file
2682 name.
2683 Otherwise this option does not always reflect the current file type.
2684 This option is normally set when the file type is detected. To enable
2685 this use the ":filetype on" command. |:filetype|
2686 Setting this option to a different value is most useful in a modeline,
2687 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002688 Example, for in an IDL file:
2689 /* vim: set filetype=idl : */ ~
2690 |FileType| |filetypes|
2691 When a dot appears in the value then this separates two filetype
2692 names. Example:
2693 /* vim: set filetype=c.doxygen : */ ~
2694 This will use the "c" filetype first, then the "doxygen" filetype.
2695 This works both for filetype plugins and for syntax files. More than
2696 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002697 Do not confuse this option with 'osfiletype', which is for the file
2698 type that is actually stored with the file.
2699 This option is not copied to another buffer, independent of the 's' or
2700 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002701 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002702
2703 *'fillchars'* *'fcs'*
2704'fillchars' 'fcs' string (default "vert:|,fold:-")
2705 global
2706 {not in Vi}
2707 {not available when compiled without the |+windows|
2708 and |+folding| features}
2709 Characters to fill the statuslines and vertical separators.
2710 It is a comma separated list of items:
2711
2712 item default Used for ~
2713 stl:c ' ' or '^' statusline of the current window
2714 stlnc:c ' ' or '-' statusline of the non-current windows
2715 vert:c '|' vertical separators |:vsplit|
2716 fold:c '-' filling 'foldtext'
2717 diff:c '-' deleted lines of the 'diff' option
2718
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002719 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002720 "stlnc" the space will be used when there is highlighting, '^' or '-'
2721 otherwise.
2722
2723 Example: >
2724 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2725< This is similar to the default, except that these characters will also
2726 be used when there is highlighting.
2727
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002728 for "stl" and "stlnc" only single-byte values are supported.
2729
Bram Moolenaar071d4272004-06-13 20:20:40 +00002730 The highlighting used for these items:
2731 item highlight group ~
2732 stl:c StatusLine |hl-StatusLine|
2733 stlnc:c StatusLineNC |hl-StatusLineNC|
2734 vert:c VertSplit |hl-VertSplit|
2735 fold:c Folded |hl-Folded|
2736 diff:c DiffDelete |hl-DiffDelete|
2737
2738 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2739'fkmap' 'fk' boolean (default off) *E198*
2740 global
2741 {not in Vi}
2742 {only available when compiled with the |+rightleft|
2743 feature}
2744 When on, the keyboard is mapped for the Farsi character set.
2745 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002746 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002747
2748 *'foldclose'* *'fcl'*
2749'foldclose' 'fcl' string (default "")
2750 global
2751 {not in Vi}
2752 {not available when compiled without the |+folding|
2753 feature}
2754 When set to "all", a fold is closed when the cursor isn't in it and
2755 its level is higher than 'foldlevel'. Useful if you want folds to
2756 automatically close when moving out of them.
2757
2758 *'foldcolumn'* *'fdc'*
2759'foldcolumn' 'fdc' number (default 0)
2760 local to window
2761 {not in Vi}
2762 {not available when compiled without the |+folding|
2763 feature}
2764 When non-zero, a column with the specified width is shown at the side
2765 of the window which indicates open and closed folds. The maximum
2766 value is 12.
2767 See |folding|.
2768
2769 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2770'foldenable' 'fen' boolean (default on)
2771 local to window
2772 {not in Vi}
2773 {not available when compiled without the |+folding|
2774 feature}
2775 When off, all folds are open. This option can be used to quickly
2776 switch between showing all text unfolded and viewing the text with
2777 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002778 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002779 'foldenable' is off.
2780 This option is set by commands that create a new fold or close a fold.
2781 See |folding|.
2782
2783 *'foldexpr'* *'fde'*
2784'foldexpr' 'fde' string (default: "0")
2785 local to window
2786 {not in Vi}
2787 {not available when compiled without the |+folding|
2788 or |+eval| feature}
2789 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002790 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002791
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002792 The expression may be evaluated in the |sandbox|, see
2793 |sandbox-option|.
2794
2795 It is not allowed to change text or jump to another window while
2796 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002797
2798 *'foldignore'* *'fdi'*
2799'foldignore' 'fdi' string (default: "#")
2800 local to window
2801 {not in Vi}
2802 {not available when compiled without the |+folding|
2803 feature}
2804 Used only when 'foldmethod' is "indent". Lines starting with
2805 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002806 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002807 The default "#" works well for C programs. See |fold-indent|.
2808
2809 *'foldlevel'* *'fdl'*
2810'foldlevel' 'fdl' number (default: 0)
2811 local to window
2812 {not in Vi}
2813 {not available when compiled without the |+folding|
2814 feature}
2815 Sets the fold level: Folds with a higher level will be closed.
2816 Setting this option to zero will close all folds. Higher numbers will
2817 close fewer folds.
2818 This option is set by commands like |zm|, |zM| and |zR|.
2819 See |fold-foldlevel|.
2820
2821 *'foldlevelstart'* *'fdls'*
2822'foldlevelstart' 'fdls' number (default: -1)
2823 global
2824 {not in Vi}
2825 {not available when compiled without the |+folding|
2826 feature}
2827 Sets 'foldlevel' when starting to edit another buffer in a window.
2828 Useful to always start editing with all folds closed (value zero),
2829 some folds closed (one) or no folds closed (99).
2830 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002831 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002832 ignores this option and closes all folds.
2833 It is also done before BufReadPre autocommands, to allow an autocmd to
2834 overrule the 'foldlevel' value for specific files.
2835 When the value is negative, it is not used.
2836
2837 *'foldmarker'* *'fmr'* *E536*
2838'foldmarker' 'fmr' string (default: "{{{,}}}")
2839 local to window
2840 {not in Vi}
2841 {not available when compiled without the |+folding|
2842 feature}
2843 The start and end marker used when 'foldmethod' is "marker". There
2844 must be one comma, which separates the start and end marker. The
2845 marker is a literal string (a regular expression would be too slow).
2846 See |fold-marker|.
2847
2848 *'foldmethod'* *'fdm'*
2849'foldmethod' 'fdm' string (default: "manual")
2850 local to window
2851 {not in Vi}
2852 {not available when compiled without the |+folding|
2853 feature}
2854 The kind of folding used for the current window. Possible values:
2855 |fold-manual| manual Folds are created manually.
2856 |fold-indent| indent Lines with equal indent form a fold.
2857 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2858 |fold-marker| marker Markers are used to specify folds.
2859 |fold-syntax| syntax Syntax highlighting items specify folds.
2860 |fold-diff| diff Fold text that is not changed.
2861
2862 *'foldminlines'* *'fml'*
2863'foldminlines' 'fml' number (default: 1)
2864 local to window
2865 {not in Vi}
2866 {not available when compiled without the |+folding|
2867 feature}
2868 Sets the minimum number of screen lines for a fold to be displayed
2869 closed. Also for manually closed folds.
2870 Note that this only has an effect of what is displayed. After using
2871 "zc" to close a fold, which is displayed open because it's smaller
2872 than 'foldminlines', a following "zc" may close a containing fold.
2873
2874 *'foldnestmax'* *'fdn'*
2875'foldnestmax' 'fdn' number (default: 20)
2876 local to window
2877 {not in Vi}
2878 {not available when compiled without the |+folding|
2879 feature}
2880 Sets the maximum nesting of folds for the "indent" and "syntax"
2881 methods. This avoids that too many folds will be created. Using more
2882 than 20 doesn't work, because the internal limit is 20.
2883
2884 *'foldopen'* *'fdo'*
2885'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2886 search,tag,undo")
2887 global
2888 {not in Vi}
2889 {not available when compiled without the |+folding|
2890 feature}
2891 Specifies for which type of commands folds will be opened, if the
2892 command moves the cursor into a closed fold. It is a comma separated
2893 list of items.
2894 item commands ~
2895 all any
2896 block "(", "{", "[[", "[{", etc.
2897 hor horizontal movements: "l", "w", "fx", etc.
2898 insert any command in Insert mode
2899 jump far jumps: "G", "gg", etc.
2900 mark jumping to a mark: "'m", CTRL-O, etc.
2901 percent "%"
2902 quickfix ":cn", ":crew", ":make", etc.
2903 search search for a pattern: "/", "n", "*", "gd", etc.
2904 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002905 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002906 tag jumping to a tag: ":ta", CTRL-T, etc.
2907 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002908 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002909 the |zv| command to the mapping to get the same effect.
2910 When a movement command is used for an operator (e.g., "dl" or "y%")
2911 this option is not used. This means the operator will include the
2912 whole closed fold.
2913 Note that vertical movements are not here, because it would make it
2914 very difficult to move onto a closed fold.
2915 In insert mode the folds containing the cursor will always be open
2916 when text is inserted.
2917 To close folds you can re-apply 'foldlevel' with the |zx| command or
2918 set the 'foldclose' option to "all".
2919
2920 *'foldtext'* *'fdt'*
2921'foldtext' 'fdt' string (default: "foldtext()")
2922 local to window
2923 {not in Vi}
2924 {not available when compiled without the |+folding|
2925 feature}
2926 An expression which is used to specify the text displayed for a closed
2927 fold. See |fold-foldtext|.
2928
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002929 The expression may be evaluated in the |sandbox|, see
2930 |sandbox-option|.
2931
2932 It is not allowed to change text or jump to another window while
2933 evaluating 'foldtext' |textlock|.
2934
Bram Moolenaar071d4272004-06-13 20:20:40 +00002935 *'formatoptions'* *'fo'*
2936'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2937 local to buffer
2938 {not in Vi}
2939 This is a sequence of letters which describes how automatic
2940 formatting is to be done. See |fo-table|. When the 'paste' option is
2941 on, no formatting is done (like 'formatoptions' is empty). Commas can
2942 be inserted for readability.
2943 To avoid problems with flags that are added in the future, use the
2944 "+=" and "-=" feature of ":set" |add-option-flags|.
2945 NOTE: This option is set to the Vi default value when 'compatible' is
2946 set and to the Vim default value when 'compatible' is reset.
2947
Bram Moolenaar86b68352004-12-27 21:59:20 +00002948 *'formatlistpat'* *'flp'*
2949'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
2950 local to buffer
2951 {not in Vi}
2952 A pattern that is used to recognize a list header. This is used for
2953 the "n" flag in 'formatoptions'.
2954 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00002955 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00002956 while still checking more characters. There must be a character
2957 following the pattern, when it matches the whole line it is handled
2958 like there is no match.
2959 The default recognizes a number, followed by an optional punctuation
2960 character and white space.
2961
Bram Moolenaar071d4272004-06-13 20:20:40 +00002962 *'formatprg'* *'fp'*
2963'formatprg' 'fp' string (default "")
2964 global
2965 {not in Vi}
2966 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002967 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00002968 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00002969 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002970 If the 'formatexpr' option is not empty it will be used instead.
2971 Otherwise, if 'formatprg' option is an empty string, the internal
2972 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00002973 Environment variables are expanded |:set_env|. See |option-backslash|
2974 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002975 The expression may be evaluated in the |sandbox|, see
2976 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002977
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002978 *'formatexpr'* *'fex'*
2979'formatexpr' 'fex' string (default "")
2980 local to buffer
2981 {not in Vi}
2982 {not available when compiled without the |+eval|
2983 feature}
2984 Expression which is evaluated to format a range of lines for the |gq|
2985 operator. The |v:lnum| variable holds the first line to be formatted,
2986 |v:count| the number of lines to be formatted.
2987 When this option is empty 'formatprg' is used.
2988 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00002989 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002990< This will invoke the mylang#Format() function in the
2991 autoload/mylang.vim file in 'runtimepath'. |autoload|
2992
2993 The expression is also evaluated when 'textwidth' is set and adding
2994 text beyond that limit. This happens under the same conditions as
2995 when internal formatting is used. Make sure the cursor is kept in the
2996 same spot relative to the text then! The |mode()| function will
2997 return "i" or "R" in this situation. When the function returns
2998 non-zero Vim will fall back to using the internal format mechanism.
2999
3000 The expression may be evaluated in the |sandbox|, see
3001 |sandbox-option|.
3002
3003 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003004'fsync' 'fs' boolean (default on)
3005 global
3006 {not in Vi}
3007 When on, the library function fsync() will be called after writing a
3008 file. This will flush a file to disk, ensuring that it is safely
3009 written even on filesystems which do metadata-only journaling. This
3010 will force the harddrive to spin up on Linux systems running in laptop
3011 mode, so it may be undesirable in some situations. Be warned that
3012 turning this off increases the chances of data loss after a crash. On
3013 systems without an fsync() implementation, this variable is always
3014 off.
3015 Also see 'swapsync' for controlling fsync() on swap files.
3016
Bram Moolenaar071d4272004-06-13 20:20:40 +00003017 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3018'gdefault' 'gd' boolean (default off)
3019 global
3020 {not in Vi}
3021 When on, the ":substitute" flag 'g' is default on. This means that
3022 all matches in a line are substituted instead of one. When a 'g' flag
3023 is given to a ":substitute" command, this will toggle the substitution
3024 of all or one match. See |complex-change|.
3025
3026 command 'gdefault' on 'gdefault' off ~
3027 :s/// subst. all subst. one
3028 :s///g subst. one subst. all
3029 :s///gg subst. all subst. one
3030
3031 NOTE: This option is reset when 'compatible' is set.
3032
3033 *'grepformat'* *'gfm'*
3034'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3035 global
3036 {not in Vi}
3037 Format to recognize for the ":grep" command output.
3038 This is a scanf-like string that uses the same format as the
3039 'errorformat' option: see |errorformat|.
3040
3041 *'grepprg'* *'gp'*
3042'grepprg' 'gp' string (default "grep -n ",
3043 Unix: "grep -n $* /dev/null",
3044 Win32: "findstr /n" or "grep -n",
3045 VMS: "SEARCH/NUMBERS ")
3046 global or local to buffer |global-local|
3047 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003048 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003049 and '#' characters, which are expanded like when used in a command-
3050 line. The placeholder "$*" is allowed to specify where the arguments
3051 will be included. Environment variables are expanded |:set_env|. See
3052 |option-backslash| about including spaces and backslashes.
3053 When your "grep" accepts the "-H" argument, use this to make ":grep"
3054 also work well with a single file: >
3055 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003056< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003057 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3058 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003059 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003060 apply equally to 'grepprg'.
3061 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3062 otherwise it's "grep -n".
3063 This option cannot be set from a |modeline| or in the |sandbox|, for
3064 security reasons.
3065
3066 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3067'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3068 ve:ver35-Cursor,
3069 o:hor50-Cursor,
3070 i-ci:ver25-Cursor/lCursor,
3071 r-cr:hor20-Cursor/lCursor,
3072 sm:block-Cursor
3073 -blinkwait175-blinkoff150-blinkon175",
3074 for MS-DOS and Win32 console:
3075 "n-v-c:block,o:hor50,i-ci:hor15,
3076 r-cr:hor30,sm:block")
3077 global
3078 {not in Vi}
3079 {only available when compiled with GUI enabled, and
3080 for MS-DOS and Win32 console}
3081 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003082 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003083 the height of the cursor can be changed. This can be done by
3084 specifying a block cursor, or a percentage for a vertical or
3085 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003086 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003087
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003088 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003089 mode-list and an argument-list:
3090 mode-list:argument-list,mode-list:argument-list,..
3091 The mode-list is a dash separated list of these modes:
3092 n Normal mode
3093 v Visual mode
3094 ve Visual mode with 'selection' "exclusive" (same as 'v',
3095 if not specified)
3096 o Operator-pending mode
3097 i Insert mode
3098 r Replace mode
3099 c Command-line Normal (append) mode
3100 ci Command-line Insert mode
3101 cr Command-line Replace mode
3102 sm showmatch in Insert mode
3103 a all modes
3104 The argument-list is a dash separated list of these arguments:
3105 hor{N} horizontal bar, {N} percent of the character height
3106 ver{N} vertical bar, {N} percent of the character width
3107 block block cursor, fills the whole character
3108 [only one of the above three should be present]
3109 blinkwait{N} *cursor-blinking*
3110 blinkon{N}
3111 blinkoff{N}
3112 blink times for cursor: blinkwait is the delay before
3113 the cursor starts blinking, blinkon is the time that
3114 the cursor is shown and blinkoff is the time that the
3115 cursor is not shown. The times are in msec. When one
3116 of the numbers is zero, there is no blinking. The
3117 default is: "blinkwait700-blinkon400-blinkoff250".
3118 These numbers are used for a missing entry. This
3119 means that blinking is enabled by default. To switch
3120 blinking off you can use "blinkon0". The cursor only
3121 blinks when Vim is waiting for input, not while
3122 executing a command.
3123 To make the cursor blink in an xterm, see
3124 |xterm-blink|.
3125 {group-name}
3126 a highlight group name, that sets the color and font
3127 for the cursor
3128 {group-name}/{group-name}
3129 Two highlight group names, the first is used when
3130 no language mappings are used, the other when they
3131 are. |language-mapping|
3132
3133 Examples of parts:
3134 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3135 block cursor with colors from the "nCursor"
3136 highlight group
3137 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3138 In Insert and Command-line Insert mode, use a
3139 30% vertical bar cursor with colors from the
3140 "iCursor" highlight group. Blink a bit
3141 faster.
3142
3143 The 'a' mode is different. It will set the given argument-list for
3144 all modes. It does not reset anything to defaults. This can be used
3145 to do a common setting for all modes. For example, to switch off
3146 blinking: "a:blinkon0"
3147
3148 Examples of cursor highlighting: >
3149 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3150 :highlight Cursor gui=NONE guifg=bg guibg=fg
3151<
3152 *'guifont'* *'gfn'*
3153 *E235* *E596* *E610* *E611*
3154'guifont' 'gfn' string (default "")
3155 global
3156 {not in Vi}
3157 {only available when compiled with GUI enabled}
3158 This is a list of fonts which will be used for the GUI version of Vim.
3159 In its simplest form the value is just one font name. When
3160 the font cannot be found you will get an error message. To try other
3161 font names a list can be specified, font names separated with commas.
3162 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003163
Bram Moolenaar05159a02005-02-26 23:04:13 +00003164 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3165 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003166
Bram Moolenaar071d4272004-06-13 20:20:40 +00003167 Spaces after a comma are ignored. To include a comma in a font name
3168 precede it with a backslash. Setting an option requires an extra
3169 backslash before a space and a backslash. See also
3170 |option-backslash|. For example: >
3171 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003172< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003173 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003174
3175 If none of the fonts can be loaded, Vim will keep the current setting.
3176 If an empty font list is given, Vim will try using other resource
3177 settings (for X, it will use the Vim.font resource), and finally it
3178 will try some builtin default which should always be there ("7x13" in
3179 the case of X). The font names given should be "normal" fonts. Vim
3180 will try to find the related bold and italic fonts.
3181
Bram Moolenaar05159a02005-02-26 23:04:13 +00003182 For Win32, GTK, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003183 :set guifont=*
3184< will bring up a font requester, where you can pick the font you want.
3185
3186 The font name depends on the GUI used. See |setting-guifont| for a
3187 way to set 'guifont' for various systems.
3188
Bram Moolenaar071d4272004-06-13 20:20:40 +00003189 For the GTK+ 2 GUI the font name looks like this: >
3190 :set guifont=Andale\ Mono\ 11
3191< That's all. XLFDs are no longer accepted.
Bram Moolenaar05159a02005-02-26 23:04:13 +00003192
3193 For Mac OSX you can use something like this: >
3194 :set guifont=Monaco:h10
3195< *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003196 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003197 width). An exception is GTK 2: all fonts are accepted, but
3198 mono-spaced fonts look best.
3199
Bram Moolenaar071d4272004-06-13 20:20:40 +00003200 To preview a font on X11, you might be able to use the "xfontsel"
3201 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003202
Bram Moolenaar071d4272004-06-13 20:20:40 +00003203 For the Win32 GUI *E244* *E245*
3204 - takes these options in the font name:
3205 hXX - height is XX (points, can be floating-point)
3206 wXX - width is XX (points, can be floating-point)
3207 b - bold
3208 i - italic
3209 u - underline
3210 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003211 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003212 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3213 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3214 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003215 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003216
3217 Use a ':' to separate the options.
3218 - A '_' can be used in the place of a space, so you don't need to use
3219 backslashes to escape the spaces.
3220 - Examples: >
3221 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3222 :set guifont=Andale_Mono:h7.5:w4.5
3223< See also |font-sizes|.
3224
3225 *'guifontset'* *'gfs'*
3226 *E250* *E252* *E234* *E597* *E598*
3227'guifontset' 'gfs' string (default "")
3228 global
3229 {not in Vi}
3230 {only available when compiled with GUI enabled and
3231 with the |+xfontset| feature}
3232 {not available in the GTK+ 2 GUI}
3233 When not empty, specifies two (or more) fonts to be used. The first
3234 one for normal English, the second one for your special language. See
3235 |xfontset|.
3236 Setting this option also means that all font names will be handled as
3237 a fontset name. Also the ones used for the "font" argument of the
3238 |:highlight| command.
3239 The fonts must match with the current locale. If fonts for the
3240 character sets that the current locale uses are not included, setting
3241 'guifontset' will fail.
3242 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3243 the comma-separated names are alternative names, one of which will be
3244 used. In 'guifontset' the whole string is one fontset name,
3245 including the commas. It is not possible to specify alternative
3246 fontset names.
3247 This example works on many X11 systems: >
3248 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3249<
3250 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3251'guifontwide' 'gfw' string (default "")
3252 global
3253 {not in Vi}
3254 {only available when compiled with GUI enabled}
3255 When not empty, specifies a comma-separated list of fonts to be used
3256 for double-width characters. The first font that can be loaded is
3257 used.
3258 Note: The size of these fonts must be exactly twice as wide as the one
3259 specified with 'guifont' and the same height.
3260
3261 All GUI versions but GTK+ 2:
3262
3263 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3264 'guifontset' is empty or invalid.
3265 When 'guifont' is set and a valid font is found in it and
3266 'guifontwide' is empty Vim will attempt to find a matching
3267 double-width font and set 'guifontwide' to it.
3268
3269 GTK+ 2 GUI only: *guifontwide_gtk2*
3270
3271 If set and valid, 'guifontwide' is always used for double width
3272 characters, even if 'encoding' is not set to "utf-8".
3273 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003274 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003275 font for characters not available in 'guifont'. Thus you do not need
3276 to set 'guifontwide' at all unless you want to override the choice
3277 made by Pango/Xft.
3278
3279 *'guiheadroom'* *'ghr'*
3280'guiheadroom' 'ghr' number (default 50)
3281 global
3282 {not in Vi} {only for GTK and X11 GUI}
3283 The number of pixels subtracted from the screen height when fitting
3284 the GUI window on the screen. Set this before the GUI is started,
3285 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003286 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003287 lines will be left for window decorations and other items on the
3288 screen. Set it to a negative value to allow windows taller than the
3289 screen.
3290
3291 *'guioptions'* *'go'*
3292'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003293 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003294 global
3295 {not in Vi}
3296 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003297 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003298 sequence of letters which describes what components and options of the
3299 GUI should be used.
3300 To avoid problems with flags that are added in the future, use the
3301 "+=" and "-=" feature of ":set" |add-option-flags|.
3302
3303 Valid letters are as follows:
3304 *guioptions_a*
3305 'a' Autoselect: If present, then whenever VISUAL mode is started,
3306 or the Visual area extended, Vim tries to become the owner of
3307 the windowing system's global selection. This means that the
3308 Visually highlighted text is available for pasting into other
3309 applications as well as into Vim itself. When the Visual mode
3310 ends, possibly due to an operation on the text, or when an
3311 application wants to paste the selection, the highlighted text
3312 is automatically yanked into the "* selection register.
3313 Thus the selection is still available for pasting into other
3314 applications after the VISUAL mode has ended.
3315 If not present, then Vim won't become the owner of the
3316 windowing system's global selection unless explicitly told to
3317 by a yank or delete operation for the "* register.
3318 The same applies to the modeless selection.
3319
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003320 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003321 applies to the modeless selection.
3322
3323 'guioptions' autoselect Visual autoselect modeless ~
3324 "" - -
3325 "a" yes yes
3326 "A" - yes
3327 "aA" yes yes
3328
3329 'c' Use console dialogs instead of popup dialogs for simple
3330 choices.
3331
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003332 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003333 'guitablabel' can be used to change the text in the labels.
3334 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00003335 The GUI tabs are only supported on some systens, currently
3336 only for GTK.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003337
Bram Moolenaar071d4272004-06-13 20:20:40 +00003338 'f' Foreground: Don't use fork() to detach the GUI from the shell
3339 where it was started. Use this for programs that wait for the
3340 editor to finish (e.g., an e-mail program). Alternatively you
3341 can use "gvim -f" or ":gui -f" to start the GUI in the
3342 foreground. |gui-fork|
3343 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003344 happened already when the |gvimrc| file is read.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003345
3346 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3347 corner of the window. It's black&white on non-GTK, because of
3348 limitations of X11. For a color icon, see |X11-icon|.
3349
3350 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003351 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003352 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003353 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003354 file is sourced the system menu has already been loaded; the
3355 ":syntax on" and ":filetype on" commands load the menu too).
3356 'g' Grey menu items: Make menu items that are not active grey. If
3357 'g' is not included inactive menu items are not shown at all.
3358 Exception: Athena will always use grey menu items.
3359
3360 't' Include tearoff menu items. Currently only works for Win32,
3361 GTK+, and Motif 1.2 GUI.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003362 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
3363 and Athena GUIs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003364
3365 'r' Right-hand scrollbar is always present.
3366 'R' Right-hand scrollbar is present when there is a vertically
3367 split window.
3368 'l' Left-hand scrollbar is always present.
3369 'L' Left-hand scrollbar is present when there is a vertically
3370 split window.
3371 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3372 the longest visible line, or on the cursor line if the 'h'
3373 flag is included. |gui-horiz-scroll|
3374 'h' Limit horizontal scrollbar size to the length of the cursor
3375 line. Reduces computations. |gui-horiz-scroll|
3376
3377 And yes, you may even have scrollbars on the left AND the right if
3378 you really want to :-). See |gui-scrollbars| for more information.
3379
3380 'v' Use a vertical button layout for dialogs. When not included,
3381 a horizontal layout is preferred, but when it doesn't fit a
3382 vertical layout is used anyway.
3383 'p' Use Pointer callbacks for X11 GUI. This is required for some
3384 window managers. If the cursor is not blinking or hollow at
3385 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003386 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003387 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003388 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003389
3390 *'guipty'* *'noguipty'*
3391'guipty' boolean (default on)
3392 global
3393 {not in Vi}
3394 {only available when compiled with GUI enabled}
3395 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3396 I/O to/from shell commands. See |gui-pty|.
3397
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003398 *'guitablabel'* *'gtl'*
3399'guitablabel' 'gtl' string (default empty)
3400 global
3401 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003402 {only available when compiled with GUI enabled and
3403 with the +windows feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003404 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003405 pages line. When empty Vim will use a default label. See
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003406 |setting-guitablabel| for more info.
3407
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003408 The format of this option is like that of 'statusline'.
3409
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003410 Only used when the GUI tab pages line is displayed. 'e' must be
3411 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3412 used.
3413
Bram Moolenaar071d4272004-06-13 20:20:40 +00003414 *'helpfile'* *'hf'*
3415'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3416 (others) "$VIMRUNTIME/doc/help.txt")
3417 global
3418 {not in Vi}
3419 Name of the main help file. All distributed help files should be
3420 placed together in one directory. Additionally, all "doc" directories
3421 in 'runtimepath' will be used.
3422 Environment variables are expanded |:set_env|. For example:
3423 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003424 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003425 spaces and backslashes.
3426 This option cannot be set from a |modeline| or in the |sandbox|, for
3427 security reasons.
3428
3429 *'helpheight'* *'hh'*
3430'helpheight' 'hh' number (default 20)
3431 global
3432 {not in Vi}
3433 {not available when compiled without the +windows
3434 feature}
3435 Minimal initial height of the help window when it is opened with the
3436 ":help" command. The initial height of the help window is half of the
3437 current window, or (when the 'ea' option is on) the same as other
3438 windows. When the height is less than 'helpheight', the height is
3439 set to 'helpheight'. Set to zero to disable.
3440
3441 *'helplang'* *'hlg'*
3442'helplang' 'hlg' string (default: messages language or empty)
3443 global
3444 {only available when compiled with the |+multi_lang|
3445 feature}
3446 {not in Vi}
3447 Comma separated list of languages. Vim will use the first language
3448 for which the desired help can be found. The English help will always
3449 be used as a last resort. You can add "en" to prefer English over
3450 another language, but that will only find tags that exist in that
3451 language and not in the English help.
3452 Example: >
3453 :set helplang=de,it
3454< This will first search German, then Italian and finally English help
3455 files.
3456 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3457 try to find the tag in the current language before using this option.
3458 See |help-translated|.
3459
3460 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3461'hidden' 'hid' boolean (default off)
3462 global
3463 {not in Vi}
3464 When off a buffer is unloaded when it is |abandon|ed. When on a
3465 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3466 displayed in another window, it does not become hidden, of course.
3467 The commands that move through the buffer list sometimes make a buffer
3468 hidden although the 'hidden' option is off: When the buffer is
3469 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003470 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003471 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003472 This option is set for one command with ":hide {command}" |:hide|.
3473 WARNING: It's easy to forget that you have changes in hidden buffers.
3474 Think twice when using ":q!" or ":qa!".
3475
3476 *'highlight'* *'hl'*
3477'highlight' 'hl' string (default (as a single string):
3478 "8:SpecialKey,@:NonText,d:Directory,
3479 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3480 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003481 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003482 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3483 f:Folded,F:FoldColumn,A:DiffAdd,
3484 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003485 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003486 R:SpellRare,L:SpellLocal,
3487 +:Pmenu,=:PmenuSel,
3488 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003489 global
3490 {not in Vi}
3491 This option can be used to set highlighting mode for various
3492 occasions. It is a comma separated list of character pairs. The
3493 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003494 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003495 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3496 |hl-NonText| @ '~' and '@' at the end of the window and
3497 characters from 'showbreak'
3498 |hl-Directory| d directories in CTRL-D listing and other special
3499 things in listings
3500 |hl-ErrorMsg| e error messages
3501 h (obsolete, ignored)
3502 |hl-IncSearch| i 'incsearch' highlighting
3503 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3504 |hl-MoreMsg| m |more-prompt|
3505 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3506 |hl-LineNr| n line number for ":number" and ":#" commands
3507 |hl-Question| r |hit-enter| prompt and yes/no questions
3508 |hl-StatusLine| s status line of current window |status-line|
3509 |hl-StatusLineNC| S status lines of not-current windows
3510 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3511 |hl-VertSplit| c column used to separate vertically split windows
3512 |hl-Visual| v Visual mode
3513 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3514 Selection" Only X11 Gui's |gui-x11| and
3515 |xterm-clipboard|.
3516 |hl-WarningMsg| w warning messages
3517 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3518 |hl-Folded| f line used for closed folds
3519 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003520 |hl-DiffAdd| A added line in diff mode
3521 |hl-DiffChange| C changed line in diff mode
3522 |hl-DiffDelete| D deleted line in diff mode
3523 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003524 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003525 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003526 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003527 |hl-SpellRare| R rare word |spell|
3528 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003529 |hl-Pmenu| + popup menu normal line
3530 |hl-PmenuSel| = popup menu normal line
3531 |hl-PmenuSbar| x popup menu scrollbar
3532 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003533
3534 The display modes are:
3535 r reverse (termcap entry "mr" and "me")
3536 i italic (termcap entry "ZH" and "ZR")
3537 b bold (termcap entry "md" and "me")
3538 s standout (termcap entry "so" and "se")
3539 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003540 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003541 n no highlighting
3542 - no highlighting
3543 : use a highlight group
3544 The default is used for occasions that are not included.
3545 If you want to change what the display modes do, see |dos-colors|
3546 for an example.
3547 When using the ':' display mode, this must be followed by the name of
3548 a highlight group. A highlight group can be used to define any type
3549 of highlighting, including using color. See |:highlight| on how to
3550 define one. The default uses a different group for each occasion.
3551 See |highlight-default| for the default highlight groups.
3552
3553 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3554'hlsearch' 'hls' boolean (default off)
3555 global
3556 {not in Vi}
3557 {not available when compiled without the
3558 |+extra_search| feature}
3559 When there is a previous search pattern, highlight all its matches.
3560 The type of highlighting used can be set with the 'l' occasion in the
3561 'highlight' option. This uses the "Search" highlight group by
3562 default. Note that only the matching text is highlighted, any offsets
3563 are not applied.
3564 See also: 'incsearch' and |:match|.
3565 When you get bored looking at the highlighted matches, you can turn it
3566 off with |:nohlsearch|. As soon as you use a search command, the
3567 highlighting comes back.
3568 When the search pattern can match an end-of-line, Vim will try to
3569 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003570 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003571 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003572 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003573 NOTE: This option is reset when 'compatible' is set.
3574
3575 *'history'* *'hi'*
3576'history' 'hi' number (Vim default: 20, Vi default: 0)
3577 global
3578 {not in Vi}
3579 A history of ":" commands, and a history of previous search patterns
3580 are remembered. This option decides how many entries may be stored in
3581 each of these histories (see |cmdline-editing|).
3582 NOTE: This option is set to the Vi default value when 'compatible' is
3583 set and to the Vim default value when 'compatible' is reset.
3584
3585 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3586'hkmap' 'hk' boolean (default off)
3587 global
3588 {not in Vi}
3589 {only available when compiled with the |+rightleft|
3590 feature}
3591 When on, the keyboard is mapped for the Hebrew character set.
3592 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3593 toggle this option. See |rileft.txt|.
3594 NOTE: This option is reset when 'compatible' is set.
3595
3596 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3597'hkmapp' 'hkp' boolean (default off)
3598 global
3599 {not in Vi}
3600 {only available when compiled with the |+rightleft|
3601 feature}
3602 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3603 This is useful if you have a non-Hebrew keyboard.
3604 See |rileft.txt|.
3605 NOTE: This option is reset when 'compatible' is set.
3606
3607 *'icon'* *'noicon'*
3608'icon' boolean (default off, on when title can be restored)
3609 global
3610 {not in Vi}
3611 {not available when compiled without the |+title|
3612 feature}
3613 When on, the icon text of the window will be set to the value of
3614 'iconstring' (if it is not empty), or to the name of the file
3615 currently being edited. Only the last part of the name is used.
3616 Overridden by the 'iconstring' option.
3617 Only works if the terminal supports setting window icons (currently
3618 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3619 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3620 builtin termcap).
3621 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003622 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003623 X11.
3624
3625 *'iconstring'*
3626'iconstring' string (default "")
3627 global
3628 {not in Vi}
3629 {not available when compiled without the |+title|
3630 feature}
3631 When this option is not empty, it will be used for the icon text of
3632 the window. This happens only when the 'icon' option is on.
3633 Only works if the terminal supports setting window icon text
3634 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3635 Does not work for MS Windows.
3636 When Vim was compiled with HAVE_X11 defined, the original icon will be
3637 restored if possible |X11|.
3638 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003639 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003640 'titlestring' for example settings.
3641 {not available when compiled without the |+statusline| feature}
3642
3643 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3644'ignorecase' 'ic' boolean (default off)
3645 global
3646 Ignore case in search patterns. Also used when searching in the tags
3647 file.
3648 Also see 'smartcase'.
3649 Can be overruled by using "\c" or "\C" in the pattern, see
3650 |/ignorecase|.
3651
3652 *'imactivatekey'* *'imak'*
3653'imactivatekey' 'imak' string (default "")
3654 global
3655 {not in Vi}
3656 {only available when compiled with |+xim| and
3657 |+GUI_GTK|}
3658 Specifies the key that your Input Method in X-Windows uses for
3659 activation. When this is specified correctly, vim can fully control
3660 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3661 You can't use this option to change the activation key, the option
3662 tells Vim what the key is.
3663 Format:
3664 [MODIFIER_FLAG-]KEY_STRING
3665
3666 These characters can be used for MODIFIER_FLAG (case is ignored):
3667 S Shift key
3668 L Lock key
3669 C Control key
3670 1 Mod1 key
3671 2 Mod2 key
3672 3 Mod3 key
3673 4 Mod4 key
3674 5 Mod5 key
3675 Combinations are allowed, for example "S-C-space" or "SC-space" are
3676 both shift+ctrl+space.
3677 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3678
3679 Example: >
3680 :set imactivatekey=S-space
3681< "S-space" means shift+space. This is the activation key for kinput2 +
3682 canna (Japanese), and ami (Korean).
3683
3684 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3685'imcmdline' 'imc' boolean (default off)
3686 global
3687 {not in Vi}
3688 {only available when compiled with the |+xim|
3689 |+multi_byte_ime| or |global-ime| feature}
3690 When set the Input Method is always on when starting to edit a command
3691 line, unless entering a search pattern (see 'imsearch' for that).
3692 Setting this option is useful when your input method allows entering
3693 English characters directly, e.g., when it's used to type accented
3694 characters with dead keys.
3695
3696 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3697'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3698 global
3699 {not in Vi}
3700 {only available when compiled with the |+xim|
3701 |+multi_byte_ime| or |global-ime| feature}
3702 When set the Input Method is never used. This is useful to disable
3703 the IM when it doesn't work properly.
3704 Currently this option is on by default for SGI/IRIX machines. This
3705 may change in later releases.
3706
3707 *'iminsert'* *'imi'*
3708'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3709 local to buffer
3710 {not in Vi}
3711 Specifies whether :lmap or an Input Method (IM) is to be used in
3712 Insert mode. Valid values:
3713 0 :lmap is off and IM is off
3714 1 :lmap is ON and IM is off
3715 2 :lmap is off and IM is ON
3716 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3717 or |global-ime|.
3718 To always reset the option to zero when leaving Insert mode with <Esc>
3719 this can be used: >
3720 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3721< This makes :lmap and IM turn off automatically when leaving Insert
3722 mode.
3723 Note that this option changes when using CTRL-^ in Insert mode
3724 |i_CTRL-^|.
3725 The value is set to 1 when setting 'keymap' to a valid keymap name.
3726 It is also used for the argument of commands like "r" and "f".
3727 The value 0 may not work correctly with Athena and Motif with some XIM
3728 methods. Use 'imdisable' to disable XIM then.
3729
3730 *'imsearch'* *'ims'*
3731'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3732 local to buffer
3733 {not in Vi}
3734 Specifies whether :lmap or an Input Method (IM) is to be used when
3735 entering a search pattern. Valid values:
3736 -1 the value of 'iminsert' is used, makes it look like
3737 'iminsert' is also used when typing a search pattern
3738 0 :lmap is off and IM is off
3739 1 :lmap is ON and IM is off
3740 2 :lmap is off and IM is ON
3741 Note that this option changes when using CTRL-^ in Command-line mode
3742 |c_CTRL-^|.
3743 The value is set to 1 when it is not -1 and setting the 'keymap'
3744 option to a valid keymap name.
3745 The value 0 may not work correctly with Athena and Motif with some XIM
3746 methods. Use 'imdisable' to disable XIM then.
3747
3748 *'include'* *'inc'*
3749'include' 'inc' string (default "^\s*#\s*include")
3750 global or local to buffer |global-local|
3751 {not in Vi}
3752 {not available when compiled without the
3753 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003754 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003755 pattern, just like for the "/" command (See |pattern|). The default
3756 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003757 "]I", "[d", etc.
3758 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003759 comes after the matched pattern. But if "\zs" appears in the pattern
3760 then the text matched from "\zs" to the end, or until "\ze" if it
3761 appears, is used as the file name. Use this to include characters
3762 that are not in 'isfname', such as a space. You can then use
3763 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003764 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003765
3766 *'includeexpr'* *'inex'*
3767'includeexpr' 'inex' string (default "")
3768 local to buffer
3769 {not in Vi}
3770 {not available when compiled without the
3771 |+find_in_path| or |+eval| feature}
3772 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003773 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003774 :set includeexpr=substitute(v:fname,'\\.','/','g')
3775< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003776
Bram Moolenaar071d4272004-06-13 20:20:40 +00003777 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003778 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003779 Also used for |<cfile>|.
3780
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003781 The expression may be evaluated in the |sandbox|, see
3782 |sandbox-option|.
3783
3784 It is not allowed to change text or jump to another window while
3785 evaluating 'includeexpr' |textlock|.
3786
Bram Moolenaar071d4272004-06-13 20:20:40 +00003787 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3788'incsearch' 'is' boolean (default off)
3789 global
3790 {not in Vi}
3791 {not available when compiled without the
3792 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003793 While typing a search command, show where the pattern, as it was typed
3794 so far, matches. The matched string is highlighted. If the pattern
3795 is invalid or not found, nothing is shown. The screen will be updated
3796 often, this is only useful on fast terminals.
3797 Note that the match will be shown, but the cursor will return to its
3798 original position when no match is found and when pressing <Esc>. You
3799 still need to finish the search command with <Enter> to move the
3800 cursor to the match.
3801 The highlighting can be set with the 'i' flag in 'highlight'.
3802 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00003803 CTRL-L can be used to add one character from after the current match
3804 to the command line.
3805 CTRL-R CTRL-W can be used to add the word at the end of the current
3806 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003807 NOTE: This option is reset when 'compatible' is set.
3808
3809 *'indentexpr'* *'inde'*
3810'indentexpr' 'inde' string (default "")
3811 local to buffer
3812 {not in Vi}
3813 {not available when compiled without the |+cindent|
3814 or |+eval| features}
3815 Expression which is evaluated to obtain the proper indent for a line.
3816 It is used when a new line is created, for the |=| operator and
3817 in Insert mode as specified with the 'indentkeys' option.
3818 When this option is not empty, it overrules the 'cindent' and
3819 'smartindent' indenting.
3820 When 'paste' is set this option is not used for indenting.
3821 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003822 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003823 when the expression is evaluated (but it may be moved around).
3824 The expression must return the number of spaces worth of indent. It
3825 can return "-1" to keep the current indent (this means 'autoindent' is
3826 used for the indent).
3827 Functions useful for computing the indent are |indent()|, |cindent()|
3828 and |lispindent()|.
3829 The evaluation of the expression must not have side effects! It must
3830 not change the text, jump to another window, etc. Afterwards the
3831 cursor position is always restored, thus the cursor may be moved.
3832 Normally this option would be set to call a function: >
3833 :set indentexpr=GetMyIndent()
3834< Error messages will be suppressed, unless the 'debug' option contains
3835 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003836 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003837 NOTE: This option is made empty when 'compatible' is set.
3838
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003839 The expression may be evaluated in the |sandbox|, see
3840 |sandbox-option|.
3841
3842 It is not allowed to change text or jump to another window while
3843 evaluating 'indentexpr' |textlock|.
3844
3845
Bram Moolenaar071d4272004-06-13 20:20:40 +00003846 *'indentkeys'* *'indk'*
3847'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3848 local to buffer
3849 {not in Vi}
3850 {not available when compiled without the |+cindent|
3851 feature}
3852 A list of keys that, when typed in Insert mode, cause reindenting of
3853 the current line. Only happens if 'indentexpr' isn't empty.
3854 The format is identical to 'cinkeys', see |indentkeys-format|.
3855 See |C-indenting| and |indent-expression|.
3856
3857 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3858'infercase' 'inf' boolean (default off)
3859 local to buffer
3860 {not in Vi}
3861 When doing keyword completion in insert mode |ins-completion|, and
3862 'ignorecase' is also on, the case of the match is adjusted. If the
3863 typed text contains a lowercase letter where the match has an upper
3864 case letter, the completed part is made lowercase. If the typed text
3865 has no lowercase letters and the match has a lowercase letter where
3866 the typed text has an uppercase letter, and there is a letter before
3867 it, the completed part is made uppercase.
3868
3869 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3870'insertmode' 'im' boolean (default off)
3871 global
3872 {not in Vi}
3873 Makes Vim work in a way that Insert mode is the default mode. Useful
3874 if you want to use Vim as a modeless editor. Used for |evim|.
3875 These Insert mode commands will be useful:
3876 - Use the cursor keys to move around.
3877 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3878 this is a mapping, it is executed as if 'insertmode' was off.
3879 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003880 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00003881 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
3882 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003883
3884 These items change when 'insertmode' is set:
3885 - when starting to edit of a file, Vim goes to Insert mode.
3886 - <Esc> in Insert mode is a no-op and beeps.
3887 - <Esc> in Normal mode makes Vim go to Insert mode.
3888 - CTRL-L in Insert mode is a command, it is not inserted.
3889 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3890 However, when <Esc> is used inside a mapping, it behaves like
3891 'insertmode' was not set. This was done to be able to use the same
3892 mappings with 'insertmode' set or not set.
3893 When executing commands with |:normal| 'insertmode' is not used.
3894
3895 NOTE: This option is reset when 'compatible' is set.
3896
3897 *'isfname'* *'isf'*
3898'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3899 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3900 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3901 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3902 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3903 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3904 global
3905 {not in Vi}
3906 The characters specified by this option are included in file names and
3907 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003908 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003909 Multi-byte characters 256 and above are always included, only the
3910 characters up to 255 are specified with this option.
3911 For UTF-8 the characters 0xa0 to 0xff are included as well.
3912
3913 Note that on systems using a backslash as path separator, Vim tries to
3914 do its best to make it work as you would expect. That is a bit
3915 tricky, since Vi originally used the backslash to escape special
3916 characters. Vim will not remove a backslash in front of a normal file
3917 name character on these systems, but it will on Unix and alikes. The
3918 '&' and '^' are not included by default, because these are special for
3919 cmd.exe.
3920
3921 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003922 Each part can be a single character number or a range. A range is two
3923 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003924 decimal number between 0 and 255 or the ASCII character itself (does
3925 not work for digits). Example:
3926 "_,-,128-140,#-43" (include '_' and '-' and the range
3927 128 to 140 and '#' to 43)
3928 If a part starts with '^', the following character number or range
3929 will be excluded from the option. The option is interpreted from left
3930 to right. Put the excluded character after the range where it is
3931 included. To include '^' itself use it as the last character of the
3932 option or the end of a range. Example:
3933 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3934 If the character is '@', all characters where isalpha() returns TRUE
3935 are included. Normally these are the characters a to z and A to Z,
3936 plus accented characters. To include '@' itself use "@-@". Examples:
3937 "@,^a-z" All alphabetic characters, excluding lower
3938 case letters.
3939 "a-z,A-Z,@-@" All letters plus the '@' character.
3940 A comma can be included by using it where a character number is
3941 expected. Example:
3942 "48-57,,,_" Digits, comma and underscore.
3943 A comma can be excluded by prepending a '^'. Example:
3944 " -~,^,,9" All characters from space to '~', excluding
3945 comma, plus <Tab>.
3946 See |option-backslash| about including spaces and backslashes.
3947
3948 *'isident'* *'isi'*
3949'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3950 "@,48-57,_,128-167,224-235"
3951 otherwise: "@,48-57,_,192-255")
3952 global
3953 {not in Vi}
3954 The characters given by this option are included in identifiers.
3955 Identifiers are used in recognizing environment variables and after a
3956 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00003957 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00003958 option.
3959 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003960 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003961 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3962
3963 *'iskeyword'* *'isk'*
3964'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3965 "@,48-57,_,128-167,224-235"
3966 otherwise: "@,48-57,_,192-255"
3967 Vi default: "@,48-57,_")
3968 local to buffer
3969 {not in Vi}
3970 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003971 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003972 'isfname' for a description of the format of this option. For C
3973 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3974 For a help file it is set to all non-blank printable characters except
3975 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3976 command).
3977 When the 'lisp' option is on the '-' character is always included.
3978 NOTE: This option is set to the Vi default value when 'compatible' is
3979 set and to the Vim default value when 'compatible' is reset.
3980
3981 *'isprint'* *'isp'*
3982'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3983 "@,~-255"; otherwise: "@,161-255")
3984 global
3985 {not in Vi}
3986 The characters given by this option are displayed directly on the
3987 screen. It is also used for "\p" in a |pattern|. The characters from
3988 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3989 even when they are not included in 'isprint' or excluded. See
3990 'isfname' for a description of the format of this option.
3991
3992 Non-printable characters are displayed with two characters:
3993 0 - 31 "^@" - "^_"
3994 32 - 126 always single characters
3995 127 "^?"
3996 128 - 159 "~@" - "~_"
3997 160 - 254 "| " - "|~"
3998 255 "~?"
3999 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4000 displayed as <xx>, with the hexadecimal value of the byte.
4001 When 'display' contains "uhex" all unprintable characters are
4002 displayed as <xx>.
4003 The NonText highlighting will be used for unprintable characters.
4004 |hl-NonText|
4005
4006 Multi-byte characters 256 and above are always included, only the
4007 characters up to 255 are specified with this option. When a character
4008 is printable but it is not available in the current font, a
4009 replacement character will be shown.
4010 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4011 There is no option to specify these characters.
4012
4013 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4014'joinspaces' 'js' boolean (default on)
4015 global
4016 {not in Vi}
4017 Insert two spaces after a '.', '?' and '!' with a join command.
4018 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4019 Otherwise only one space is inserted.
4020 NOTE: This option is set when 'compatible' is set.
4021
4022 *'key'*
4023'key' string (default "")
4024 local to buffer
4025 {not in Vi}
4026 The key that is used for encrypting and decrypting the current buffer.
4027 See |encryption|.
4028 Careful: Do not set the key value by hand, someone might see the typed
4029 key. Use the |:X| command. But you can make 'key' empty: >
4030 :set key=
4031< It is not possible to get the value of this option with ":set key" or
4032 "echo &key". This is to avoid showing it to someone who shouldn't
4033 know. It also means you cannot see it yourself once you have set it,
4034 be careful not to make a typing error!
4035
4036 *'keymap'* *'kmp'* *E544*
4037'keymap' 'kmp' string (default "")
4038 local to buffer
4039 {not in Vi}
4040 {only available when compiled with the |+keymap|
4041 feature}
4042 Name of a keyboard mapping. See |mbyte-keymap|.
4043 Setting this option to a valid keymap name has the side effect of
4044 setting 'iminsert' to one, so that the keymap becomes effective.
4045 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004046 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004047
4048 *'keymodel'* *'km'*
4049'keymodel' 'km' string (default "")
4050 global
4051 {not in Vi}
4052 List of comma separated words, which enable special things that keys
4053 can do. These values can be used:
4054 startsel Using a shifted special key starts selection (either
4055 Select mode or Visual mode, depending on "key" being
4056 present in 'selectmode').
4057 stopsel Using a not-shifted special key stops selection.
4058 Special keys in this context are the cursor keys, <End>, <Home>,
4059 <PageUp> and <PageDown>.
4060 The 'keymodel' option is set by the |:behave| command.
4061
4062 *'keywordprg'* *'kp'*
4063'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4064 OS/2: "view /", VMS: "help")
4065 global or local to buffer |global-local|
4066 {not in Vi}
4067 Program to use for the |K| command. Environment variables are
4068 expanded |:set_env|. ":help" may be used to access the Vim internal
4069 help. (Note that previously setting the global option to the empty
4070 value did this, which is now deprecated.)
4071 When "man" is used, Vim will automatically translate a count for the
4072 "K" command to a section number. Also for "man -s", in which case the
4073 "-s" is removed when there is no count.
4074 See |option-backslash| about including spaces and backslashes.
4075 Example: >
4076 :set keywordprg=man\ -s
4077< This option cannot be set from a |modeline| or in the |sandbox|, for
4078 security reasons.
4079
4080 *'langmap'* *'lmap'* *E357* *E358*
4081'langmap' 'lmap' string (default "")
4082 global
4083 {not in Vi}
4084 {only available when compiled with the |+langmap|
4085 feature}
4086 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004087 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004088 inserted directly. When in command mode the 'langmap' option takes
4089 care of translating these special characters to the original meaning
4090 of the key. This means you don't have to change the keyboard mode to
4091 be able to execute Normal mode commands.
4092 This is the opposite of the 'keymap' option, where characters are
4093 mapped in Insert mode.
4094 This only works for 8-bit characters. The value of 'langmap' may be
4095 specified with multi-byte characters (e.g., UTF-8), but only the lower
4096 8 bits of each character will be used.
4097
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004098 Example (for Greek, in UTF-8): *greek* >
4099 :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 +00004100< Example (exchanges meaning of z and y for commands): >
4101 :set langmap=zy,yz,ZY,YZ
4102<
4103 The 'langmap' option is a list of parts, separated with commas. Each
4104 part can be in one of two forms:
4105 1. A list of pairs. Each pair is a "from" character immediately
4106 followed by the "to" character. Examples: "aA", "aAbBcC".
4107 2. A list of "from" characters, a semi-colon and a list of "to"
4108 characters. Example: "abc;ABC"
4109 Example: "aA,fgh;FGH,cCdDeE"
4110 Special characters need to be preceded with a backslash. These are
4111 ";", ',' and backslash itself.
4112
4113 This will allow you to activate vim actions without having to switch
4114 back and forth between the languages. Your language characters will
4115 be understood as normal vim English characters (according to the
4116 langmap mappings) in the following cases:
4117 o Normal/Visual mode (commands, buffer/register names, user mappings)
4118 o Insert/Replace Mode: Register names after CTRL-R
4119 o Insert/Replace Mode: Mappings
4120 Characters entered in Command-line mode will NOT be affected by
4121 this option. Note that this option can be changed at any time
4122 allowing to switch between mappings for different languages/encodings.
4123 Use a mapping to avoid having to type it each time!
4124
4125 *'langmenu'* *'lm'*
4126'langmenu' 'lm' string (default "")
4127 global
4128 {not in Vi}
4129 {only available when compiled with the |+menu| and
4130 |+multi_lang| features}
4131 Language to use for menu translation. Tells which file is loaded
4132 from the "lang" directory in 'runtimepath': >
4133 "lang/menu_" . &langmenu . ".vim"
4134< (without the spaces). For example, to always use the Dutch menus, no
4135 matter what $LANG is set to: >
4136 :set langmenu=nl_NL.ISO_8859-1
4137< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004138 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004139 If your $LANG is set to a non-English language but you do want to use
4140 the English menus: >
4141 :set langmenu=none
4142< This option must be set before loading menus, switching on filetype
4143 detection or syntax highlighting. Once the menus are defined setting
4144 this option has no effect. But you could do this: >
4145 :source $VIMRUNTIME/delmenu.vim
4146 :set langmenu=de_DE.ISO_8859-1
4147 :source $VIMRUNTIME/menu.vim
4148< Warning: This deletes all menus that you defined yourself!
4149
4150 *'laststatus'* *'ls'*
4151'laststatus' 'ls' number (default 1)
4152 global
4153 {not in Vi}
4154 The value of this option influences when the last window will have a
4155 status line:
4156 0: never
4157 1: only if there are at least two windows
4158 2: always
4159 The screen looks nicer with a status line if you have several
4160 windows, but it takes another screen line. |status-line|
4161
4162 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4163'lazyredraw' 'lz' boolean (default off)
4164 global
4165 {not in Vi}
4166 When this option is set, the screen will not be redrawn while
4167 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004168 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004169 update use |:redraw|.
4170
4171 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4172'linebreak' 'lbr' boolean (default off)
4173 local to window
4174 {not in Vi}
4175 {not available when compiled without the |+linebreak|
4176 feature}
4177 If on Vim will wrap long lines at a character in 'breakat' rather
4178 than at the last character that fits on the screen. Unlike
4179 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4180 it only affects the way the file is displayed, not its contents. The
4181 value of 'showbreak' is used to put in front of wrapped lines.
4182 This option is not used when the 'wrap' option is off or 'list' is on.
4183 Note that <Tab> characters after an <EOL> are mostly not displayed
4184 with the right amount of white space.
4185
4186 *'lines'* *E593*
4187'lines' number (default 24 or terminal height)
4188 global
4189 Number of lines of the Vim window.
4190 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004191 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004192 When Vim is running in the GUI or in a resizable window, setting this
4193 option will cause the window size to be changed. When you only want
4194 to use the size for the GUI, put the command in your |gvimrc| file.
4195 Vim limits the number of lines to what fits on the screen. You can
4196 use this command to get the tallest window possible: >
4197 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004198< Minimum value is 2, maximum value is 1000.
4199 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004200 When you set this option and Vim is unable to change the physical
4201 number of lines of the display, the display may be messed up.
4202
4203 *'linespace'* *'lsp'*
4204'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4205 global
4206 {not in Vi}
4207 {only in the GUI}
4208 Number of pixel lines inserted between characters. Useful if the font
4209 uses the full character cell height, making lines touch each other.
4210 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004211 With some fonts there can be too much room between lines (to have
4212 space for ascents and descents). Then it makes sense to set
4213 'linespace' to a negative value. This may cause display problems
4214 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004215
4216 *'lisp'* *'nolisp'*
4217'lisp' boolean (default off)
4218 local to buffer
4219 {not available when compiled without the |+lispindent|
4220 feature}
4221 Lisp mode: When <Enter> is typed in insert mode set the indent for
4222 the next line to Lisp standards (well, sort of). Also happens with
4223 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4224 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4225 better. Also see 'lispwords'.
4226 The '-' character is included in keyword characters. Redefines the
4227 "=" operator to use this same indentation algorithm rather than
4228 calling an external program if 'equalprg' is empty.
4229 This option is not used when 'paste' is set.
4230 {Vi: Does it a little bit differently}
4231
4232 *'lispwords'* *'lw'*
4233'lispwords' 'lw' string (default is very long)
4234 global
4235 {not in Vi}
4236 {not available when compiled without the |+lispindent|
4237 feature}
4238 Comma separated list of words that influence the Lisp indenting.
4239 |'lisp'|
4240
4241 *'list'* *'nolist'*
4242'list' boolean (default off)
4243 local to window
4244 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
4245 see the difference between tabs and spaces and for trailing blanks.
4246 Note that this will also affect formatting (set with 'textwidth' or
4247 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
4248 changing the way tabs are displayed.
4249
4250 *'listchars'* *'lcs'*
4251'listchars' 'lcs' string (default "eol:$")
4252 global
4253 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004254 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004255 settings.
4256 eol:c Character to show at the end of each line. When
4257 omitted, there is no extra character at the end of the
4258 line.
4259 tab:xy Two characters to be used to show a Tab. The first
4260 char is used once. The second char is repeated to
4261 fill the space that the Tab normally occupies.
4262 "tab:>-" will show a Tab that takes four spaces as
4263 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004264 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004265 trailing spaces are blank.
4266 extends:c Character to show in the last column, when 'wrap' is
4267 off and the line continues beyond the right of the
4268 screen.
4269 precedes:c Character to show in the first column, when 'wrap'
4270 is off and there is text preceding the character
4271 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004272 nbsp:c Character to show for a non-breakable space (character
4273 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004274
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004275 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004276 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004277 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004278
4279 Examples: >
4280 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004281 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004282 :set lcs=extends:>,precedes:<
4283< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004284 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004285
4286 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4287'loadplugins' 'lpl' boolean (default on)
4288 global
4289 {not in Vi}
4290 When on the plugin scripts are loaded when starting up |load-plugins|.
4291 This option can be reset in your |vimrc| file to disable the loading
4292 of plugins.
4293 Note that using the "-u NONE" and "--noplugin" command line arguments
4294 reset this option. |-u| |--noplugin|
4295
4296 *'magic'* *'nomagic'*
4297'magic' boolean (default on)
4298 global
4299 Changes the special characters that can be used in search patterns.
4300 See |pattern|.
4301 NOTE: To avoid portability problems with using patterns, always keep
4302 this option at the default "on". Only switch it off when working with
4303 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004304 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004305
4306 *'makeef'* *'mef'*
4307'makeef' 'mef' string (default: "")
4308 global
4309 {not in Vi}
4310 {not available when compiled without the |+quickfix|
4311 feature}
4312 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4313 and the |:grep| command.
4314 When it is empty, an internally generated temp file will be used.
4315 When "##" is included, it is replaced by a number to make the name
4316 unique. This makes sure that the ":make" command doesn't overwrite an
4317 existing file.
4318 NOT used for the ":cf" command. See 'errorfile' for that.
4319 Environment variables are expanded |:set_env|.
4320 See |option-backslash| about including spaces and backslashes.
4321 This option cannot be set from a |modeline| or in the |sandbox|, for
4322 security reasons.
4323
4324 *'makeprg'* *'mp'*
4325'makeprg' 'mp' string (default "make", VMS: "MMS")
4326 global or local to buffer |global-local|
4327 {not in Vi}
4328 Program to use for the ":make" command. See |:make_makeprg|. This
4329 option may contain '%' and '#' characters, which are expanded like
4330 when used in a command-line. Environment variables are expanded
4331 |:set_env|. See |option-backslash| about including spaces and
4332 backslashes. Note that a '|' must be escaped twice: once for ":set"
4333 and once for the interpretation of a command. When you use a filter
4334 called "myfilter" do it like this: >
4335 :set makeprg=gmake\ \\\|\ myfilter
4336< The placeholder "$*" can be given (even multiple times) to specify
4337 where the arguments will be included, for example: >
4338 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4339< This option cannot be set from a |modeline| or in the |sandbox|, for
4340 security reasons.
4341
4342 *'matchpairs'* *'mps'*
4343'matchpairs' 'mps' string (default "(:),{:},[:]")
4344 local to buffer
4345 {not in Vi}
4346 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004347 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00004348 must be different. The characters must be separated by a colon. The
4349 pairs must be separated by a comma. Example for including '<' and '>'
4350 (HTML): >
4351 :set mps+=<:>
4352
4353< A more exotic example, to jump between the '=' and ';' in an
4354 assignment, useful for languages like C and Java: >
4355 :au FileType c,cpp,java set mps+==:;
4356
4357< For a more advanced way of using "%", see the matchit.vim plugin in
4358 the $VIMRUNTIME/macros directory. |add-local-help|
4359
4360 *'matchtime'* *'mat'*
4361'matchtime' 'mat' number (default 5)
4362 global
4363 {not in Vi}{in Nvi}
4364 Tenths of a second to show the matching paren, when 'showmatch' is
4365 set. Note that this is not in milliseconds, like other options that
4366 set a time. This is to be compatible with Nvi.
4367
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004368 *'maxcombine'* *'mco'*
4369'maxcombine' 'mco' number (default 2)
4370 global
4371 {not in Vi}
4372 {only available when compiled with the |+multi_byte|
4373 feature}
4374 The maximum number of combining characters supported for displaying.
4375 Only used when 'encoding' is "utf-8".
4376 The default is OK for most languages. Hebrew may require 4.
4377 Maximum value is 6.
4378 Even when this option is set to 2 you can still edit text with more
4379 combining characters, you just can't see them. Use |g8| or |ga|.
4380 See |mbyte-combining|.
4381
Bram Moolenaar071d4272004-06-13 20:20:40 +00004382 *'maxfuncdepth'* *'mfd'*
4383'maxfuncdepth' 'mfd' number (default 100)
4384 global
4385 {not in Vi}
4386 Maximum depth of function calls for user functions. This normally
4387 catches endless recursion. When using a recursive function with
4388 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4389 more memory, there is the danger of failing when memory is exhausted.
4390 See also |:function|.
4391
4392 *'maxmapdepth'* *'mmd'* *E223*
4393'maxmapdepth' 'mmd' number (default 1000)
4394 global
4395 {not in Vi}
4396 Maximum number of times a mapping is done without resulting in a
4397 character to be used. This normally catches endless mappings, like
4398 ":map x y" with ":map y x". It still does not catch ":map g wg",
4399 because the 'w' is used before the next mapping is done. See also
4400 |key-mapping|.
4401
4402 *'maxmem'* *'mm'*
4403'maxmem' 'mm' number (default between 256 to 5120 (system
4404 dependent) or half the amount of memory
4405 available)
4406 global
4407 {not in Vi}
4408 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4409 limit is reached allocating extra memory for a buffer will cause
4410 other memory to be freed. Maximum value 2000000. Use this to work
4411 without a limit. Also see 'maxmemtot'.
4412
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004413 *'maxmempattern'* *'mmp'*
4414'maxmempattern' 'mmp' number (default 1000)
4415 global
4416 {not in Vi}
4417 Maximum amount of memory (in Kbyte) to use for pattern matching.
4418 Maximum value 2000000. Use this to work without a limit.
4419 *E363*
4420 When Vim runs into the limit it gives an error message mostly behaves
4421 like CTRL-C was typed.
4422 Running into the limit often means that the pattern is very
4423 inefficient or too complex. This may already happen with the pattern
4424 "\(.\)*" on a very long line. ".*" works much better.
4425 Vim may run out of memory before hitting the 'maxmempattern' limit.
4426
Bram Moolenaar071d4272004-06-13 20:20:40 +00004427 *'maxmemtot'* *'mmt'*
4428'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4429 dependent) or half the amount of memory
4430 available)
4431 global
4432 {not in Vi}
4433 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004434 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004435 'maxmem'.
4436
4437 *'menuitems'* *'mis'*
4438'menuitems' 'mis' number (default 25)
4439 global
4440 {not in Vi}
4441 {not available when compiled without the |+menu|
4442 feature}
4443 Maximum number of items to use in a menu. Used for menus that are
4444 generated from a list of items, e.g., the Buffers menu. Changing this
4445 option has no direct effect, the menu must be refreshed first.
4446
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004447 *'mkspellmem'* *'msm'*
4448'mkspellmem' 'msm' string (default "460000,2000,500")
4449 global
4450 {not in Vi}
4451 {not available when compiled without the |+syntax|
4452 feature}
4453 Parameters for |:mkspell|. This tunes when to start compressing the
4454 word tree. Compression can be slow when there are many words, but
4455 it's needed to avoid running out of memory. The amount of memory used
4456 per word depends very much on how similar the words are, that's why
4457 this tuning is complicated.
4458
4459 There are three numbers, separated by commas:
4460 {start},{inc},{added}
4461
4462 For most languages the uncompressed word tree fits in memory. {start}
4463 gives the amount of memory in Kbyte that can be used before any
4464 compression is done. It should be a bit smaller than the amount of
4465 memory that is available to Vim.
4466
4467 When going over the {start} limit the {inc} number specifies the
4468 amount of memory in Kbyte that can be allocated before another
4469 compression is done. A low number means compression is done after
4470 less words are added, which is slow. A high number means more memory
4471 will be allocated.
4472
4473 After doing compression, {added} times 1024 words can be added before
4474 the {inc} limit is ignored and compression is done when any extra
4475 amount of memory is needed. A low number means there is a smaller
4476 chance of hitting the {inc} limit, less memory is used but it's
4477 slower.
4478
4479 The languages for which these numbers are important are Italian and
4480 Hungarian. The default works for when you have about 512 Mbyte. If
4481 you have 1 Gbyte you could use: >
4482 :set mkspellmem=900000,3000,800
4483< If you have less than 512 Mbyte |:mkspell| may fail for some
4484 languages, no matter what you set 'mkspellmem' to.
4485
Bram Moolenaar071d4272004-06-13 20:20:40 +00004486 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4487'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4488 local to buffer
4489 *'modelines'* *'mls'*
4490'modelines' 'mls' number (default 5)
4491 global
4492 {not in Vi}
4493 If 'modeline' is on 'modelines' gives the number of lines that is
4494 checked for set commands. If 'modeline' is off or 'modelines' is zero
4495 no lines are checked. See |modeline|.
4496 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4497 set and to the Vim default value when 'compatible' is reset.
4498
4499 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4500'modifiable' 'ma' boolean (default on)
4501 local to buffer
4502 {not in Vi} *E21*
4503 When off the buffer contents cannot be changed. The 'fileformat' and
4504 'fileencoding' options also can't be changed.
4505 Can be reset with the |-M| command line argument.
4506
4507 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4508'modified' 'mod' boolean (default off)
4509 local to buffer
4510 {not in Vi}
4511 When on, the buffer is considered to be modified. This option is set
4512 when:
4513 1. A change was made to the text since it was last written. Using the
4514 |undo| command to go back to the original text will reset the
4515 option. But undoing changes that were made before writing the
4516 buffer will set the option again, since the text is different from
4517 when it was written.
4518 2. 'fileformat' or 'fileencoding' is different from its original
4519 value. The original value is set when the buffer is read or
4520 written. A ":set nomodified" command also resets the original
4521 values to the current values and the 'modified' option will be
4522 reset.
4523 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4524 will be ignored.
4525
4526 *'more'* *'nomore'*
4527'more' boolean (Vim default: on, Vi default: off)
4528 global
4529 {not in Vi}
4530 When on, listings pause when the whole screen is filled. You will get
4531 the |more-prompt|. When this option is off there are no pauses, the
4532 listing continues until finished.
4533 NOTE: This option is set to the Vi default value when 'compatible' is
4534 set and to the Vim default value when 'compatible' is reset.
4535
4536 *'mouse'* *E538*
4537'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4538 global
4539 {not in Vi}
4540 Enable the use of the mouse. Only works for certain terminals
4541 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4542 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4543 The mouse can be enabled for different modes:
4544 n Normal mode
4545 v Visual mode
4546 i Insert mode
4547 c Command-line mode
4548 h all previous modes when editing a help file
4549 a all previous modes
4550 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004551 Normally you would enable the mouse in all four modes with: >
4552 :set mouse=a
4553< When the mouse is not enabled, the GUI will still use the mouse for
4554 modeless selection. This doesn't move the text cursor.
4555
4556 See |mouse-using|. Also see |'clipboard'|.
4557
4558 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004559 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004560 the mouse buttons can still be used by keeping the shift key pressed.
4561 Also see the 'clipboard' option.
4562
4563 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4564'mousefocus' 'mousef' boolean (default off)
4565 global
4566 {not in Vi}
4567 {only works in the GUI}
4568 The window that the mouse pointer is on is automatically activated.
4569 When changing the window layout or window focus in another way, the
4570 mouse pointer is moved to the window with keyboard focus. Off is the
4571 default because it makes using the pull down menus a little goofy, as
4572 a pointer transit may activate a window unintentionally.
4573
4574 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4575'mousehide' 'mh' boolean (default on)
4576 global
4577 {not in Vi}
4578 {only works in the GUI}
4579 When on, the mouse pointer is hidden when characters are typed.
4580 The mouse pointer is restored when the mouse is moved.
4581
4582 *'mousemodel'* *'mousem'*
4583'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4584 global
4585 {not in Vi}
4586 Sets the model to use for the mouse. The name mostly specifies what
4587 the right mouse button is used for:
4588 extend Right mouse button extends a selection. This works
4589 like in an xterm.
4590 popup Right mouse button pops up a menu. The shifted left
4591 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004592 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004593 popup_setpos Like "popup", but the cursor will be moved to the
4594 position where the mouse was clicked, and thus the
4595 selected operation will act upon the clicked object.
4596 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004597 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004598 course, that right clicking outside a selection will
4599 end Visual mode.
4600 Overview of what button does what for each model:
4601 mouse extend popup(_setpos) ~
4602 left click place cursor place cursor
4603 left drag start selection start selection
4604 shift-left search word extend selection
4605 right click extend selection popup menu (place cursor)
4606 right drag extend selection -
4607 middle click paste paste
4608
4609 In the "popup" model the right mouse button produces a pop-up menu.
4610 You need to define this first, see |popup-menu|.
4611
4612 Note that you can further refine the meaning of buttons with mappings.
4613 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4614 selection (because that's handled in the GUI code directly).
4615
4616 The 'mousemodel' option is set by the |:behave| command.
4617
4618 *'mouseshape'* *'mouses'* *E547*
4619'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004620 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004621 global
4622 {not in Vi}
4623 {only available when compiled with the |+mouseshape|
4624 feature}
4625 This option tells Vim what the mouse pointer should look like in
4626 different modes. The option is a comma separated list of parts, much
4627 like used for 'guicursor'. Each part consist of a mode/location-list
4628 and an argument-list:
4629 mode-list:shape,mode-list:shape,..
4630 The mode-list is a dash separated list of these modes/locations:
4631 In a normal window: ~
4632 n Normal mode
4633 v Visual mode
4634 ve Visual mode with 'selection' "exclusive" (same as 'v',
4635 if not specified)
4636 o Operator-pending mode
4637 i Insert mode
4638 r Replace mode
4639
4640 Others: ~
4641 c appending to the command-line
4642 ci inserting in the command-line
4643 cr replacing in the command-line
4644 m at the 'Hit ENTER' or 'More' prompts
4645 ml idem, but cursor in the last line
4646 e any mode, pointer below last window
4647 s any mode, pointer on a status line
4648 sd any mode, while dragging a status line
4649 vs any mode, pointer on a vertical separator line
4650 vd any mode, while dragging a vertical separator line
4651 a everywhere
4652
4653 The shape is one of the following:
4654 avail name looks like ~
4655 w x arrow Normal mouse pointer
4656 w x blank no pointer at all (use with care!)
4657 w x beam I-beam
4658 w x updown up-down sizing arrows
4659 w x leftright left-right sizing arrows
4660 w x busy The system's usual busy pointer
4661 w x no The system's usual 'no input' pointer
4662 x udsizing indicates up-down resizing
4663 x lrsizing indicates left-right resizing
4664 x crosshair like a big thin +
4665 x hand1 black hand
4666 x hand2 white hand
4667 x pencil what you write with
4668 x question big ?
4669 x rightup-arrow arrow pointing right-up
4670 w x up-arrow arrow pointing up
4671 x <number> any X11 pointer number (see X11/cursorfont.h)
4672
4673 The "avail" column contains a 'w' if the shape is available for Win32,
4674 x for X11.
4675 Any modes not specified or shapes not available use the normal mouse
4676 pointer.
4677
4678 Example: >
4679 :set mouseshape=s:udsizing,m:no
4680< will make the mouse turn to a sizing arrow over the status lines and
4681 indicate no input when the hit-enter prompt is displayed (since
4682 clicking the mouse has no effect in this state.)
4683
4684 *'mousetime'* *'mouset'*
4685'mousetime' 'mouset' number (default 500)
4686 global
4687 {not in Vi}
4688 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4689 time in msec between two mouse clicks for the second click to be
4690 recognized as a multi click.
4691
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004692 *'mzquantum'* *'mzq'*
4693'mzquantum' 'mzq' number (default 100)
4694 global
4695 {not in Vi}
4696 {not available when compiled without the |+mzscheme|
4697 feature}
4698 The number of milliseconds between polls for MzScheme threads.
4699 Negative or zero value means no thread scheduling.
4700
Bram Moolenaar071d4272004-06-13 20:20:40 +00004701 *'nrformats'* *'nf'*
4702'nrformats' 'nf' string (default "octal,hex")
4703 local to buffer
4704 {not in Vi}
4705 This defines what bases Vim will consider for numbers when using the
4706 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4707 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004708 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004709 incremented or decremented. This is useful for a list with a
4710 letter index a), b), etc.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004711 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004712 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004713 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004714 considered to be hexadecimal. Example: Using CTRL-X on
4715 "0x100" results in "0x0ff".
4716 Numbers which simply begin with a digit in the range 1-9 are always
4717 considered decimal. This also happens for numbers that are not
4718 recognized as octal or hex.
4719
4720 *'number'* *'nu'* *'nonumber'* *'nonu'*
4721'number' 'nu' boolean (default off)
4722 local to window
4723 Print the line number in front of each line. When the 'n' option is
4724 excluded from 'cpoptions' a wrapped line will not use the column of
4725 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004726 The 'numberwidth' option can be used to set the room used for the line
4727 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004728 When a long, wrapped line doesn't start with the first character, '-'
4729 characters are put before the number.
4730 See |hl-LineNr| for the highlighting used for the number.
4731
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004732 *'numberwidth'* *'nuw'*
4733'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4734 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004735 {not in Vi}
4736 {only available when compiled with the |+linebreak|
4737 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004738 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00004739 when the 'number' option is set or printing lines with a line number.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004740 Since one space is always between the number and the text, there is
4741 one less character for the number itself.
4742 The value is the minimum width. A bigger width is used when needed to
4743 fit the highest line number in the buffer. Thus with the Vim default
4744 of 4 there is room for a line number up to 999. When the buffer has
4745 1000 lines five columns will be used.
4746 The minimum value is 1, the maximum value is 10.
4747 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4748
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004749 *'omnifunc'* *'ofu'*
4750'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00004751 local to buffer
4752 {not in Vi}
4753 {not available when compiled without the +eval
4754 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00004755 This option specifies a function to be used for Insert mode omni
4756 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00004757 See |complete-functions| for an explanation of how the function is
4758 invoked and what it should return.
Bram Moolenaare344bea2005-09-01 20:46:49 +00004759
4760
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00004761 *'operatorfunc'* *'opfunc'*
4762'operatorfunc' 'opfunc' string (default: empty)
4763 global
4764 {not in Vi}
4765 This option specifies a function to be called by the |g@| operator.
4766 See |:map-operator| for more info and an example.
4767
4768 This option cannot be set from a |modeline| or in the |sandbox|, for
4769 security reasons.
4770
4771
Bram Moolenaar071d4272004-06-13 20:20:40 +00004772 *'osfiletype'* *'oft'* *E366*
4773'osfiletype' 'oft' string (RISC-OS default: "Text",
4774 others default: "")
4775 local to buffer
4776 {not in Vi}
4777 {only available when compiled with the |+osfiletype|
4778 feature}
4779 Some operating systems store extra information about files besides
4780 name, datestamp and permissions. This option contains the extra
4781 information, the nature of which will vary between systems.
4782 The value of this option is usually set when the file is loaded, and
4783 use to set the file type when file is written.
4784 It can affect the pattern matching of the automatic commands.
4785 |autocmd-osfiletypes|
4786
4787 *'paragraphs'* *'para'*
4788'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4789 global
4790 Specifies the nroff macros that separate paragraphs. These are pairs
4791 of two letters (see |object-motions|).
4792
4793 *'paste'* *'nopaste'*
4794'paste' boolean (default off)
4795 global
4796 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004797 Put Vim in Paste mode. This is useful if you want to cut or copy
4798 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004799 unexpected effects.
4800 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004801 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004802 knows about pasting and will mostly do the right thing without 'paste'
4803 being set. The same is true for a terminal where Vim handles the
4804 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004805 This option is reset when starting the GUI. Thus if you set it in
4806 your .vimrc it will work in a terminal, but not in the GUI. Setting
4807 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4808 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004809 When the 'paste' option is switched on (also when it was already on):
4810 - mapping in Insert mode and Command-line mode is disabled
4811 - abbreviations are disabled
4812 - 'textwidth' is set to 0
4813 - 'wrapmargin' is set to 0
4814 - 'autoindent' is reset
4815 - 'smartindent' is reset
4816 - 'softtabstop' is set to 0
4817 - 'revins' is reset
4818 - 'ruler' is reset
4819 - 'showmatch' is reset
4820 - 'formatoptions' is used like it is empty
4821 These options keep their value, but their effect is disabled:
4822 - 'lisp'
4823 - 'indentexpr'
4824 - 'cindent'
4825 NOTE: When you start editing another file while the 'paste' option is
4826 on, settings from the modelines or autocommands may change the
4827 settings again, causing trouble when pasting text. You might want to
4828 set the 'paste' option again.
4829 When the 'paste' option is reset the mentioned options are restored to
4830 the value before the moment 'paste' was switched from off to on.
4831 Resetting 'paste' before ever setting it does not have any effect.
4832 Since mapping doesn't work while 'paste' is active, you need to use
4833 the 'pastetoggle' option to toggle the 'paste' option with some key.
4834
4835 *'pastetoggle'* *'pt'*
4836'pastetoggle' 'pt' string (default "")
4837 global
4838 {not in Vi}
4839 When non-empty, specifies the key sequence that toggles the 'paste'
4840 option. This is like specifying a mapping: >
4841 :map {keys} :set invpaste<CR>
4842< Where {keys} is the value of 'pastetoggle'.
4843 The difference is that it will work even when 'paste' is set.
4844 'pastetoggle' works in Insert mode and Normal mode, but not in
4845 Command-line mode.
4846 Mappings are checked first, thus overrule 'pastetoggle'. However,
4847 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4848 this: >
4849 :map <F10> :set paste<CR>
4850 :map <F11> :set nopaste<CR>
4851 :imap <F10> <C-O>:set paste<CR>
4852 :imap <F11> <nop>
4853 :set pastetoggle=<F11>
4854< This will make <F10> start paste mode and <F11> stop paste mode.
4855 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4856 mode everything is inserted literally, except the 'pastetoggle' key
4857 sequence.
4858
4859 *'pex'* *'patchexpr'*
4860'patchexpr' 'pex' string (default "")
4861 global
4862 {not in Vi}
4863 {not available when compiled without the |+diff|
4864 feature}
4865 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004866 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004867
4868 *'patchmode'* *'pm'* *E206*
4869'patchmode' 'pm' string (default "")
4870 global
4871 {not in Vi}
4872 When non-empty the oldest version of a file is kept. This can be used
4873 to keep the original version of a file if you are changing files in a
4874 source distribution. Only the first time that a file is written a
4875 copy of the original file will be kept. The name of the copy is the
4876 name of the original file with the string in the 'patchmode' option
4877 appended. This option should start with a dot. Use a string like
4878 ".org". 'backupdir' must not be empty for this to work (Detail: The
4879 backup file is renamed to the patchmode file after the new file has
4880 been successfully written, that's why it must be possible to write a
4881 backup file). If there was no file to be backed up, an empty file is
4882 created.
4883 When the 'backupskip' pattern matches, a patchmode file is not made.
4884 Using 'patchmode' for compressed files appends the extension at the
4885 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4886 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004887 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004888
4889 *'path'* *'pa'* *E343* *E345* *E347*
4890'path' 'pa' string (default on Unix: ".,/usr/include,,"
4891 on OS/2: ".,/emx/include,,"
4892 other systems: ".,,")
4893 global or local to buffer |global-local|
4894 {not in Vi}
4895 This is a list of directories which will be searched when using the
4896 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4897 being searched for has a relative path (not starting with '/'). The
4898 directories in the 'path' option may be relative or absolute.
4899 - Use commas to separate directory names: >
4900 :set path=.,/usr/local/include,/usr/include
4901< - Spaces can also be used to separate directory names (for backwards
4902 compatibility with version 3.0). To have a space in a directory
4903 name, precede it with an extra backslash, and escape the space: >
4904 :set path=.,/dir/with\\\ space
4905< - To include a comma in a directory name precede it with an extra
4906 backslash: >
4907 :set path=.,/dir/with\\,comma
4908< - To search relative to the directory of the current file, use: >
4909 :set path=.
4910< - To search in the current directory use an empty string between two
4911 commas: >
4912 :set path=,,
4913< - A directory name may end in a ':' or '/'.
4914 - Environment variables are expanded |:set_env|.
4915 - When using |netrw.vim| URLs can be used. For example, adding
4916 "http://www.vim.org" will make ":find index.html" work.
4917 - Search upwards and downwards in a directory tree:
4918 1) "*" matches a sequence of characters, e.g.: >
4919 :set path=/usr/include/*
4920< means all subdirectories in /usr/include (but not /usr/include
4921 itself). >
4922 :set path=/usr/*c
4923< matches /usr/doc and /usr/src.
4924 2) "**" matches a subtree, up to 100 directories deep. Example: >
4925 :set path=/home/user_x/src/**
4926< means search in the whole subtree under "/home/usr_x/src".
4927 3) If the path ends with a ';', this path is the startpoint
4928 for upward search.
4929 See |file-searching| for more info and exact syntax.
4930 {not available when compiled without the |+path_extra| feature}
4931 - Careful with '\' characters, type two to get one in the option: >
4932 :set path=.,c:\\include
4933< Or just use '/' instead: >
4934 :set path=.,c:/include
4935< Don't forget "." or files won't even be found in the same directory as
4936 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004937 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004938 it is something like 256 or 1024 characters.
4939 You can check if all the include files are found, using the value of
4940 'path', see |:checkpath|.
4941 The use of |:set+=| and |:set-=| is preferred when adding or removing
4942 directories from the list. This avoids problems when a future version
4943 uses another default. To remove the current directory use: >
4944 :set path-=
4945< To add the current directory use: >
4946 :set path+=
4947< To use an environment variable, you probably need to replace the
4948 separator. Here is an example to append $INCL, in which directory
4949 names are separated with a semi-colon: >
4950 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4951< Replace the ';' with a ':' or whatever separator is used. Note that
4952 this doesn't work when $INCL contains a comma or white space.
4953
4954 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4955'preserveindent' 'pi' boolean (default off)
4956 local to buffer
4957 {not in Vi}
4958 When changing the indent of the current line, preserve as much of the
4959 indent structure as possible. Normally the indent is replaced by a
4960 series of tabs followed by spaces as required (unless |'expandtab'| is
4961 enabled, in which case only spaces are used). Enabling this option
4962 means the indent will preserve as many existing characters as possible
4963 for indenting, and only add additional tabs or spaces as required.
4964 NOTE: When using ">>" multiple times the resulting indent is a mix of
4965 tabs and spaces. You might not like this.
4966 NOTE: 'preserveindent' is reset when 'compatible' is set.
4967 Also see 'copyindent'.
4968 Use |:retab| to clean up white space.
4969
4970 *'previewheight'* *'pvh'*
4971'previewheight' 'pvh' number (default 12)
4972 global
4973 {not in Vi}
4974 {not available when compiled without the |+windows| or
4975 |+quickfix| feature}
4976 Default height for a preview window. Used for |:ptag| and associated
4977 commands. Used for |CTRL-W_}| when no count is given.
4978
4979 *'previewwindow'* *'nopreviewwindow'*
4980 *'pvw'* *'nopvw'* *E590*
4981'previewwindow' 'pvw' boolean (default off)
4982 local to window
4983 {not in Vi}
4984 {not available when compiled without the |+windows| or
4985 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004986 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004987 set. It's normally not set directly, but by using one of the commands
4988 |:ptag|, |:pedit|, etc.
4989
4990 *'printdevice'* *'pdev'*
4991'printdevice' 'pdev' string (default empty)
4992 global
4993 {not in Vi}
4994 {only available when compiled with the |+printer|
4995 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004996 The name of the printer to be used for |:hardcopy|.
4997 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004998 This option cannot be set from a |modeline| or in the |sandbox|, for
4999 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005000
Bram Moolenaar8299df92004-07-10 09:47:34 +00005001 *'printencoding'* *'penc'*
5002'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005003 global
5004 {not in Vi}
5005 {only available when compiled with the |+printer|
5006 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005007 Sets the character encoding used when printing.
5008 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005009
5010 *'printexpr'* *'pexpr'*
5011'printexpr' 'pexpr' String (default: see below)
5012 global
5013 {not in Vi}
5014 {only available when compiled with the |+printer|
5015 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005016 Expression used to print the PostScript produced with |:hardcopy|.
5017 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005018
Bram Moolenaar8299df92004-07-10 09:47:34 +00005019 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005020'printfont' 'pfn' string (default "courier")
5021 global
5022 {not in Vi}
5023 {only available when compiled with the |+printer|
5024 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005025 The name of the font that will be used for |:hardcopy|.
5026 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005027
5028 *'printheader'* *'pheader'*
5029'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5030 global
5031 {not in Vi}
5032 {only available when compiled with the |+printer|
5033 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005034 The format of the header produced in |:hardcopy| output.
5035 See |pheader-option|.
5036
5037 *'printmbcharset'* *'pmbcs'*
5038'printmbcharset' 'pmbcs' string (default "")
5039 global
5040 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005041 {only available when compiled with the |+printer|,
5042 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005043 The CJK character set to be used for CJK output from |:hardcopy|.
5044 See |pmbcs-option|.
5045
5046 *'printmbfont'* *'pmbfn'*
5047'printmbfont' 'pmbfn' string (default "")
5048 global
5049 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005050 {only available when compiled with the |+printer|,
5051 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005052 List of font names to be used for CJK output from |:hardcopy|.
5053 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005054
5055 *'printoptions'* *'popt'*
5056'printoptions' 'popt' string (default "")
5057 global
5058 {not in Vi}
5059 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005060 List of items that control the format of the output of |:hardcopy|.
5061 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005062
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005063 *'prompt'* *'noprompt'*
5064'prompt' boolean (default on)
5065 global
5066 When on a ":" prompt is used in Ex mode.
5067
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005068 *'pumheight'* *'ph'*
5069'pumheight' 'ph' number (default 0)
5070 global
5071 {not available when compiled without the
5072 |+insert_expand| feature}
5073 {not in Vi}
5074 Determines the maximum number of items to show in the popup menu.
5075 When zero as much space as available is used.
5076 |ins-completion-menu|.
5077
5078
Bram Moolenaar677ee682005-01-27 14:41:15 +00005079 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005080'quoteescape' 'qe' string (default "\")
5081 local to buffer
5082 {not in Vi}
5083 The characters that are used to escape quotes in a string. Used for
5084 objects like a', a" and a` |a'|.
5085 When one of the characters in this option is found inside a string,
5086 the following character will be skipped. The default value makes the
5087 text "foo\"bar\\" considered to be one string.
5088
Bram Moolenaar071d4272004-06-13 20:20:40 +00005089 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5090'readonly' 'ro' boolean (default off)
5091 local to buffer
5092 If on, writes fail unless you use a '!'. Protects you from
5093 accidentally overwriting a file. Default on when Vim is started
5094 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005095 When using ":w!" the 'readonly' option is reset for the current
5096 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005097 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005098 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005099
5100 *'remap'* *'noremap'*
5101'remap' boolean (default on)
5102 global
5103 Allows for mappings to work recursively. If you do not want this for
5104 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005105 NOTE: To avoid portability problems with Vim scripts, always keep
5106 this option at the default "on". Only switch it off when working with
5107 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005108
5109 *'report'*
5110'report' number (default 2)
5111 global
5112 Threshold for reporting number of lines changed. When the number of
5113 changed lines is more than 'report' a message will be given for most
5114 ":" commands. If you want it always, set 'report' to 0.
5115 For the ":substitute" command the number of substitutions is used
5116 instead of the number of lines.
5117
5118 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5119'restorescreen' 'rs' boolean (default on)
5120 global
5121 {not in Vi} {only in Windows 95/NT console version}
5122 When set, the screen contents is restored when exiting Vim. This also
5123 happens when executing external commands.
5124
5125 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5126 options in your .vimrc. To disable restoring:
5127 set t_ti= t_te=
5128 To enable restoring (for an xterm):
5129 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5130 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5131
5132 *'revins'* *'ri'* *'norevins'* *'nori'*
5133'revins' 'ri' boolean (default off)
5134 global
5135 {not in Vi}
5136 {only available when compiled with the |+rightleft|
5137 feature}
5138 Inserting characters in Insert mode will work backwards. See "typing
5139 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5140 command in Insert mode, when 'allowrevins' is set.
5141 NOTE: This option is reset when 'compatible' or 'paste' is set.
5142
5143 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5144'rightleft' 'rl' boolean (default off)
5145 local to window
5146 {not in Vi}
5147 {only available when compiled with the |+rightleft|
5148 feature}
5149 When on, display orientation becomes right-to-left, i.e., characters
5150 that are stored in the file appear from the right to the left.
5151 Using this option, it is possible to edit files for languages that
5152 are written from the right to the left such as Hebrew and Arabic.
5153 This option is per window, so it is possible to edit mixed files
5154 simultaneously, or to view the same file in both ways (this is
5155 useful whenever you have a mixed text file with both right-to-left
5156 and left-to-right strings so that both sets are displayed properly
5157 in different windows). Also see |rileft.txt|.
5158
5159 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
5160'rightleftcmd' 'rlc' string (default "search")
5161 local to window
5162 {not in Vi}
5163 {only available when compiled with the |+rightleft|
5164 feature}
5165 Each word in this option enables the command line editing to work in
5166 right-to-left mode for a group of commands:
5167
5168 search "/" and "?" commands
5169
5170 This is useful for languages such as Hebrew, Arabic and Farsi.
5171 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5172
5173 *'ruler'* *'ru'* *'noruler'* *'noru'*
5174'ruler' 'ru' boolean (default off)
5175 global
5176 {not in Vi}
5177 {not available when compiled without the
5178 |+cmdline_info| feature}
5179 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005180 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005181 text in the file is shown on the far right:
5182 Top first line is visible
5183 Bot last line is visible
5184 All first and last line are visible
5185 45% relative position in the file
5186 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005187 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005188 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005189 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005190 this option takes precedence over 'ruler' and 'rulerformat'
5191 If the number of characters displayed is different from the number of
5192 bytes in the text (e.g., for a TAB or a multi-byte character), both
5193 the text column (byte number) and the screen column are shown,
5194 separated with a dash.
5195 For an empty line "0-1" is shown.
5196 For an empty buffer the line number will also be zero: "0,0-1".
5197 This option is reset when the 'paste' option is set.
5198 If you don't want to see the ruler all the time but want to know where
5199 you are, use "g CTRL-G" |g_CTRL-G|.
5200 NOTE: This option is reset when 'compatible' is set.
5201
5202 *'rulerformat'* *'ruf'*
5203'rulerformat' 'ruf' string (default empty)
5204 global
5205 {not in Vi}
5206 {not available when compiled without the |+statusline|
5207 feature}
5208 When this option is not empty, it determines the content of the ruler
5209 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005210 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005211 The default ruler width is 17 characters. To make the ruler 15
5212 characters wide, put "%15(" at the start and "%)" at the end.
5213 Example: >
5214 :set rulerformat=%15(%c%V\ %p%%%)
5215<
5216 *'runtimepath'* *'rtp'* *vimfiles*
5217'runtimepath' 'rtp' string (default:
5218 Unix: "$HOME/.vim,
5219 $VIM/vimfiles,
5220 $VIMRUNTIME,
5221 $VIM/vimfiles/after,
5222 $HOME/.vim/after"
5223 Amiga: "home:vimfiles,
5224 $VIM/vimfiles,
5225 $VIMRUNTIME,
5226 $VIM/vimfiles/after,
5227 home:vimfiles/after"
5228 PC, OS/2: "$HOME/vimfiles,
5229 $VIM/vimfiles,
5230 $VIMRUNTIME,
5231 $VIM/vimfiles/after,
5232 $HOME/vimfiles/after"
5233 Macintosh: "$VIM:vimfiles,
5234 $VIMRUNTIME,
5235 $VIM:vimfiles:after"
5236 RISC-OS: "Choices:vimfiles,
5237 $VIMRUNTIME,
5238 Choices:vimfiles/after"
5239 VMS: "sys$login:vimfiles,
5240 $VIM/vimfiles,
5241 $VIMRUNTIME,
5242 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005243 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005244 global
5245 {not in Vi}
5246 This is a list of directories which will be searched for runtime
5247 files:
5248 filetype.vim filetypes by file name |new-filetype|
5249 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005250 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005251 colors/ color scheme files |:colorscheme|
5252 compiler/ compiler files |:compiler|
5253 doc/ documentation |write-local-help|
5254 ftplugin/ filetype plugins |write-filetype-plugin|
5255 indent/ indent scripts |indent-expression|
5256 keymap/ key mapping files |mbyte-keymap|
5257 lang/ menu translations |:menutrans|
5258 menu.vim GUI menus |menu.vim|
5259 plugin/ plugin scripts |write-plugin|
5260 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005261 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005262 syntax/ syntax files |mysyntaxfile|
5263 tutor/ files for vimtutor |tutor|
5264
5265 And any other file searched for with the |:runtime| command.
5266
5267 The defaults for most systems are setup to search five locations:
5268 1. In your home directory, for your personal preferences.
5269 2. In a system-wide Vim directory, for preferences from the system
5270 administrator.
5271 3. In $VIMRUNTIME, for files distributed with Vim.
5272 *after-directory*
5273 4. In the "after" directory in the system-wide Vim directory. This is
5274 for the system administrator to overrule or add to the distributed
5275 defaults (rarely needed)
5276 5. In the "after" directory in your home directory. This is for
5277 personal preferences to overrule or add to the distributed defaults
5278 or system-wide settings (rarely needed).
5279
5280 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5281 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005282 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005283 wildcards.
5284 See |:runtime|.
5285 Example: >
5286 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5287< This will use the directory "~/vimruntime" first (containing your
5288 personal Vim runtime files), then "/mygroup/vim" (shared between a
5289 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5290 files).
5291 You probably should always include $VIMRUNTIME somewhere, to use the
5292 distributed runtime files. You can put a directory before $VIMRUNTIME
5293 to find files which replace a distributed runtime files. You can put
5294 a directory after $VIMRUNTIME to find files which add to distributed
5295 runtime files.
5296 This option cannot be set from a |modeline| or in the |sandbox|, for
5297 security reasons.
5298
5299 *'scroll'* *'scr'*
5300'scroll' 'scr' number (default: half the window height)
5301 local to window
5302 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5303 set to half the number of lines in the window when the window size
5304 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005305 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005306 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5307 the number of screen lines instead of file lines, makes a difference
5308 when lines wrap}
5309
5310 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5311'scrollbind' 'scb' boolean (default off)
5312 local to window
5313 {not in Vi}
5314 {not available when compiled without the |+scrollbind|
5315 feature}
5316 See also |scroll-binding|. When this option is set, the current
5317 window scrolls as other scrollbind windows (windows that also have
5318 this option set) scroll. This option is useful for viewing the
5319 differences between two versions of a file, see 'diff'.
5320 See |'scrollopt'| for options that determine how this option should be
5321 interpreted.
5322 This option is mostly reset when splitting a window to edit another
5323 file. This means that ":split | edit file" results in two windows
5324 with scroll-binding, but ":split file" does not.
5325
5326 *'scrolljump'* *'sj'*
5327'scrolljump' 'sj' number (default 1)
5328 global
5329 {not in Vi}
5330 Minimal number of lines to scroll when the cursor gets off the
5331 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5332 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005333 When set to a negative number from -1 to -100 this is used as the
5334 percentage of the window height. Thus -50 scrolls half the window
5335 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005336 NOTE: This option is set to 1 when 'compatible' is set.
5337
5338 *'scrolloff'* *'so'*
5339'scrolloff' 'so' number (default 0)
5340 global
5341 {not in Vi}
5342 Minimal number of screen lines to keep above and below the cursor.
5343 This will make some context visible around where you are working. If
5344 you set it to a very large value (999) the cursor line will always be
5345 in the middle of the window (except at the start or end of the file or
5346 when long lines wrap).
5347 For scrolling horizontally see 'sidescrolloff'.
5348 NOTE: This option is set to 0 when 'compatible' is set.
5349
5350 *'scrollopt'* *'sbo'*
5351'scrollopt' 'sbo' string (default "ver,jump")
5352 global
5353 {not available when compiled without the |+scrollbind|
5354 feature}
5355 {not in Vi}
5356 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005357 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5358 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005359 The following words are available:
5360 ver Bind vertical scrolling for 'scrollbind' windows
5361 hor Bind horizontal scrolling for 'scrollbind' windows
5362 jump Applies to the offset between two windows for vertical
5363 scrolling. This offset is the difference in the first
5364 displayed line of the bound windows. When moving
5365 around in a window, another 'scrollbind' window may
5366 reach a position before the start or after the end of
5367 the buffer. The offset is not changed though, when
5368 moving back the 'scrollbind' window will try to scroll
5369 to the desired position when possible.
5370 When now making that window the current one, two
5371 things can be done with the relative offset:
5372 1. When "jump" is not included, the relative offset is
5373 adjusted for the scroll position in the new current
5374 window. When going back to the other window, the
5375 the new relative offset will be used.
5376 2. When "jump" is included, the other windows are
5377 scrolled to keep the same relative offset. When
5378 going back to the other window, it still uses the
5379 same relative offset.
5380 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005381 When 'diff' mode is active there always is vertical scroll binding,
5382 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005383
5384 *'sections'* *'sect'*
5385'sections' 'sect' string (default "SHNHH HUnhsh")
5386 global
5387 Specifies the nroff macros that separate sections. These are pairs of
5388 two letters (See |object-motions|). The default makes a section start
5389 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5390
5391 *'secure'* *'nosecure'* *E523*
5392'secure' boolean (default off)
5393 global
5394 {not in Vi}
5395 When on, ":autocmd", shell and write commands are not allowed in
5396 ".vimrc" and ".exrc" in the current directory and map commands are
5397 displayed. Switch it off only if you know that you will not run into
5398 problems, or when the 'exrc' option is off. On Unix this option is
5399 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005400 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005401 'secure' at the end of your ~/.vimrc then.
5402 This option cannot be set from a |modeline| or in the |sandbox|, for
5403 security reasons.
5404
5405 *'selection'* *'sel'*
5406'selection' 'sel' string (default "inclusive")
5407 global
5408 {not in Vi}
5409 This option defines the behavior of the selection. It is only used
5410 in Visual and Select mode.
5411 Possible values:
5412 value past line inclusive ~
5413 old no yes
5414 inclusive yes yes
5415 exclusive yes no
5416 "past line" means that the cursor is allowed to be positioned one
5417 character past the line.
5418 "inclusive" means that the last character of the selection is included
5419 in an operation. For example, when "x" is used to delete the
5420 selection.
5421 Note that when "exclusive" is used and selecting from the end
5422 backwards, you cannot include the last character of a line, when
5423 starting in Normal mode and 'virtualedit' empty.
5424
5425 The 'selection' option is set by the |:behave| command.
5426
5427 *'selectmode'* *'slm'*
5428'selectmode' 'slm' string (default "")
5429 global
5430 {not in Vi}
5431 This is a comma separated list of words, which specifies when to start
5432 Select mode instead of Visual mode, when a selection is started.
5433 Possible values:
5434 mouse when using the mouse
5435 key when using shifted special keys
5436 cmd when using "v", "V" or CTRL-V
5437 See |Select-mode|.
5438 The 'selectmode' option is set by the |:behave| command.
5439
5440 *'sessionoptions'* *'ssop'*
5441'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005442 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005443 global
5444 {not in Vi}
5445 {not available when compiled without the +mksession
5446 feature}
5447 Changes the effect of the |:mksession| command. It is a comma
5448 separated list of words. Each word enables saving and restoring
5449 something:
5450 word save and restore ~
5451 blank empty windows
5452 buffers hidden and unloaded buffers, not just those in windows
5453 curdir the current directory
5454 folds manually created folds, opened/closed folds and local
5455 fold options
5456 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005457 and contain at least one lowercase letter. Only
5458 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005459 help the help window
5460 localoptions options and mappings local to a window or buffer (not
5461 global values for local options)
5462 options all options and mappings (also global values for local
5463 options)
5464 resize size of the Vim window: 'lines' and 'columns'
5465 sesdir the directory in which the session file is located
5466 will become the current directory (useful with
5467 projects accessed over a network from different
5468 systems)
5469 slash backslashes in file names replaced with forward
5470 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005471 tabpages all tab pages; without this only the current tab page
5472 is restored, so that you can make a session for each
5473 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005474 unix with Unix end-of-line format (single <NL>), even when
5475 on Windows or DOS
5476 winpos position of the whole Vim window
5477 winsize window sizes
5478
5479 Don't include both "curdir" and "sesdir".
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00005480 There is no option to include tab pages yet, only the current tab page
5481 is stored in the session. |tab-page|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005482 When "curdir" nor "sesdir" is included, file names are stored with
5483 absolute paths.
5484 "slash" and "unix" are useful on Windows when sharing session files
5485 with Unix. The Unix version of Vim cannot source dos format scripts,
5486 but the Windows version of Vim can source unix format scripts.
5487
5488 *'shell'* *'sh'* *E91*
5489'shell' 'sh' string (default $SHELL or "sh",
5490 MS-DOS and Win32: "command.com" or
5491 "cmd.exe", OS/2: "cmd")
5492 global
5493 Name of the shell to use for ! and :! commands. When changing the
5494 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5495 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005496 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005497 See |option-backslash| about including spaces and backslashes.
5498 Environment variables are expanded |:set_env|.
5499 If the name of the shell contains a space, you might need to enclose
5500 it in quotes. Example: >
5501 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5502< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005503 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005504 "-f" is not inside the quotes, because it is not part of the command
5505 name. And Vim automagically recognizes the backslashes that are path
5506 separators.
5507 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5508 variable to change the way external commands are executed. See the
5509 libc.inf file of DJGPP.
5510 Under MS-Windows, when the executable ends in ".com" it must be
5511 included. Thus setting the shell to "command.com" or "4dos.com"
5512 works, but "command" and "4dos" do not work for all commands (e.g.,
5513 filtering).
5514 For unknown reasons, when using "4dos.com" the current directory is
5515 changed to "C:\". To avoid this set 'shell' like this: >
5516 :set shell=command.com\ /c\ 4dos
5517< This option cannot be set from a |modeline| or in the |sandbox|, for
5518 security reasons.
5519
5520 *'shellcmdflag'* *'shcf'*
5521'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5522 does not contain "sh" somewhere: "/c")
5523 global
5524 {not in Vi}
5525 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5526 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5527 systems, the default is set according to the value of 'shell', to
5528 reduce the need to set this option by the user. It's not used for
5529 OS/2 (EMX figures this out itself). See |option-backslash| about
5530 including spaces and backslashes. See |dos-shell|.
5531 This option cannot be set from a |modeline| or in the |sandbox|, for
5532 security reasons.
5533
5534 *'shellpipe'* *'sp'*
5535'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5536 global
5537 {not in Vi}
5538 {not available when compiled without the |+quickfix|
5539 feature}
5540 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005541 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005542 including spaces and backslashes.
5543 The name of the temporary file can be represented by "%s" if necessary
5544 (the file name is appended automatically if no %s appears in the value
5545 of this option).
5546 For the Amiga and MS-DOS the default is ">". The output is directly
5547 saved in a file and not echoed to the screen.
5548 For Unix the default it "| tee". The stdout of the compiler is saved
5549 in a file and echoed to the screen. If the 'shell' option is "csh" or
5550 "tcsh" after initializations, the default becomes "|& tee". If the
5551 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5552 "2>&1| tee". This means that stderr is also included.
5553 The initialization of this option is done after reading the ".vimrc"
5554 and the other initializations, so that when the 'shell' option is set
5555 there, the 'shellpipe' option changes automatically, unless it was
5556 explicitly set before.
5557 When 'shellpipe' is set to an empty string, no redirection of the
5558 ":make" output will be done. This is useful if you use a 'makeprg'
5559 that writes to 'makeef' by itself. If you want no piping, but do
5560 want to include the 'makeef', set 'shellpipe' to a single space.
5561 Don't forget to precede the space with a backslash: ":set sp=\ ".
5562 In the future pipes may be used for filtering and this option will
5563 become obsolete (at least for Unix).
5564 This option cannot be set from a |modeline| or in the |sandbox|, for
5565 security reasons.
5566
5567 *'shellquote'* *'shq'*
5568'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5569 contains "sh" somewhere: "\"")
5570 global
5571 {not in Vi}
5572 Quoting character(s), put around the command passed to the shell, for
5573 the "!" and ":!" commands. The redirection is kept outside of the
5574 quoting. See 'shellxquote' to include the redirection. It's
5575 probably not useful to set both options.
5576 This is an empty string by default. Only known to be useful for
5577 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5578 or bash, where it should be "\"". The default is adjusted according
5579 the value of 'shell', to reduce the need to set this option by the
5580 user. See |dos-shell|.
5581 This option cannot be set from a |modeline| or in the |sandbox|, for
5582 security reasons.
5583
5584 *'shellredir'* *'srr'*
5585'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5586 global
5587 {not in Vi}
5588 String to be used to put the output of a filter command in a temporary
5589 file. See also |:!|. See |option-backslash| about including spaces
5590 and backslashes.
5591 The name of the temporary file can be represented by "%s" if necessary
5592 (the file name is appended automatically if no %s appears in the value
5593 of this option).
5594 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5595 or "zsh" during initializations, the default becomes ">&". If the
5596 'shell' option is "sh", "ksh" or "bash" the default becomes
5597 ">%s 2>&1". This means that stderr is also included.
5598 For Win32, the Unix checks are done and additionally "cmd" is checked
5599 for, which makes the default ">%s 2>&1". Also, the same names with
5600 ".exe" appended are checked for.
5601 The initialization of this option is done after reading the ".vimrc"
5602 and the other initializations, so that when the 'shell' option is set
5603 there, the 'shellredir' option changes automatically unless it was
5604 explicitly set before.
5605 In the future pipes may be used for filtering and this option will
5606 become obsolete (at least for Unix).
5607 This option cannot be set from a |modeline| or in the |sandbox|, for
5608 security reasons.
5609
5610 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5611'shellslash' 'ssl' boolean (default off)
5612 global
5613 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5614 When set, a forward slash is used when expanding file names. This is
5615 useful when a Unix-like shell is used instead of command.com or
5616 cmd.exe. Backward slashes can still be typed, but they are changed to
5617 forward slashes by Vim.
5618 Note that setting or resetting this option has no effect for some
5619 existing file names, thus this option needs to be set before opening
5620 any file for best results. This might change in the future.
5621 'shellslash' only works when a backslash can be used as a path
5622 separator. To test if this is so use: >
5623 if exists('+shellslash')
5624<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005625 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5626'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5627 global
5628 {not in Vi}
5629 When on, use temp files for shell commands. When off use a pipe.
5630 When using a pipe is not possible temp files are used anyway.
5631 Currently a pipe is only supported on Unix. You can check it with: >
5632 :if has("filterpipe")
5633< The advantage of using a pipe is that nobody can read the temp file
5634 and the 'shell' command does not need to support redirection.
5635 The advantage of using a temp file is that the file type and encoding
5636 can be detected.
5637 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5638 |FilterWritePost| autocommands event are not triggered when
5639 'shelltemp' is off.
5640
Bram Moolenaar071d4272004-06-13 20:20:40 +00005641 *'shelltype'* *'st'*
5642'shelltype' 'st' number (default 0)
5643 global
5644 {not in Vi} {only for the Amiga}
5645 On the Amiga this option influences the way how the commands work
5646 which use a shell.
5647 0 and 1: always use the shell
5648 2 and 3: use the shell only to filter lines
5649 4 and 5: use shell only for ':sh' command
5650 When not using the shell, the command is executed directly.
5651
5652 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5653 1 and 3: use "shell cmd" to start external commands
5654
5655 *'shellxquote'* *'sxq'*
5656'shellxquote' 'sxq' string (default: "";
5657 for Win32, when 'shell' contains "sh"
5658 somewhere: "\""
5659 for Unix, when using system(): "\"")
5660 global
5661 {not in Vi}
5662 Quoting character(s), put around the command passed to the shell, for
5663 the "!" and ":!" commands. Includes the redirection. See
5664 'shellquote' to exclude the redirection. It's probably not useful
5665 to set both options.
5666 This is an empty string by default. Known to be useful for
5667 third-party shells when using the Win32 version, such as the MKS Korn
5668 Shell or bash, where it should be "\"". The default is adjusted
5669 according the value of 'shell', to reduce the need to set this option
5670 by the user. See |dos-shell|.
5671 This option cannot be set from a |modeline| or in the |sandbox|, for
5672 security reasons.
5673
5674 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5675'shiftround' 'sr' boolean (default off)
5676 global
5677 {not in Vi}
5678 Round indent to multiple of 'shiftwidth'. Applies to > and <
5679 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5680 a multiple of 'shiftwidth' (this is Vi compatible).
5681 NOTE: This option is reset when 'compatible' is set.
5682
5683 *'shiftwidth'* *'sw'*
5684'shiftwidth' 'sw' number (default 8)
5685 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005686 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005687 |'cindent'|, |>>|, |<<|, etc.
5688
5689 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005690'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5691 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005692 global
5693 {not in Vi}
5694 This option helps to avoid all the |hit-enter| prompts caused by file
5695 messages, for example with CTRL-G, and to avoid some other messages.
5696 It is a list of flags:
5697 flag meaning when present ~
5698 f use "(3 of 5)" instead of "(file 3 of 5)"
5699 i use "[noeol]" instead of "[Incomplete last line]"
5700 l use "999L, 888C" instead of "999 lines, 888 characters"
5701 m use "[+]" instead of "[Modified]"
5702 n use "[New]" instead of "[New File]"
5703 r use "[RO]" instead of "[readonly]"
5704 w use "[w]" instead of "written" for file write message
5705 and "[a]" instead of "appended" for ':w >> file' command
5706 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5707 "[unix format]" and "[mac]" instead of "[mac format]".
5708 a all of the above abbreviations
5709
5710 o overwrite message for writing a file with subsequent message
5711 for reading a file (useful for ":wn" or when 'autowrite' on)
5712 O message for reading a file overwrites any previous message.
5713 Also for quickfix message (e.g., ":cn").
5714 s don't give "search hit BOTTOM, continuing at TOP" or "search
5715 hit TOP, continuing at BOTTOM" messages
5716 t truncate file message at the start if it is too long to fit
5717 on the command-line, "<" will appear in the left most column.
5718 Ignored in Ex mode.
5719 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005720 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005721 Ignored in Ex mode.
5722 W don't give "written" or "[w]" when writing a file
5723 A don't give the "ATTENTION" message when an existing swap file
5724 is found.
5725 I don't give the intro message when starting Vim |:intro|.
5726
5727 This gives you the opportunity to avoid that a change between buffers
5728 requires you to hit <Enter>, but still gives as useful a message as
5729 possible for the space available. To get the whole message that you
5730 would have got with 'shm' empty, use ":file!"
5731 Useful values:
5732 shm= No abbreviation of message.
5733 shm=a Abbreviation, but no loss of information.
5734 shm=at Abbreviation, and truncate message when necessary.
5735
5736 NOTE: This option is set to the Vi default value when 'compatible' is
5737 set and to the Vim default value when 'compatible' is reset.
5738
5739 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5740'shortname' 'sn' boolean (default off)
5741 local to buffer
5742 {not in Vi, not in MS-DOS versions}
5743 Filenames are assumed to be 8 characters plus one extension of 3
5744 characters. Multiple dots in file names are not allowed. When this
5745 option is on, dots in file names are replaced with underscores when
5746 adding an extension (".~" or ".swp"). This option is not available
5747 for MS-DOS, because then it would always be on. This option is useful
5748 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5749 or crossdos. When running the Win32 GUI version under Win32s, this
5750 option is always on by default.
5751
5752 *'showbreak'* *'sbr'* *E595*
5753'showbreak' 'sbr' string (default "")
5754 global
5755 {not in Vi}
5756 {not available when compiled without the |+linebreak|
5757 feature}
5758 String to put at the start of lines that have been wrapped. Useful
5759 values are "> " or "+++ ".
5760 Only printable single-cell characters are allowed, excluding <Tab> and
5761 comma (in a future version the comma might be used to separate the
5762 part that is shown at the end and at the start of a line).
5763 The characters are highlighted according to the '@' flag in
5764 'highlight'.
5765 Note that tabs after the showbreak will be displayed differently.
5766 If you want the 'showbreak' to appear in between line numbers, add the
5767 "n" flag to 'cpoptions'.
5768
5769 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5770'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5771 off)
5772 global
5773 {not in Vi}
5774 {not available when compiled without the
5775 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005776 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005777 terminal is slow.
5778 In Visual mode the size of the selected area is shown:
5779 - When selecting characters within a line, the number of characters.
5780 - When selecting more than one line, the number of lines.
5781 - When selecting a block, the size in screen characters: linesxcolumns.
5782 NOTE: This option is set to the Vi default value when 'compatible' is
5783 set and to the Vim default value when 'compatible' is reset.
5784
5785 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5786'showfulltag' 'sft' boolean (default off)
5787 global
5788 {not in Vi}
5789 When completing a word in insert mode (see |ins-completion|) from the
5790 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005791 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005792 matched a C function, you can see a template for what arguments are
5793 required (coding style permitting).
5794
5795 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5796'showmatch' 'sm' boolean (default off)
5797 global
5798 When a bracket is inserted, briefly jump to the matching one. The
5799 jump is only done if the match can be seen on the screen. The time to
5800 show the match can be set with 'matchtime'.
5801 A Beep is given if there is no match (no matter if the match can be
5802 seen or not). This option is reset when the 'paste' option is set.
5803 When the 'm' flag is not included in 'cpoptions', typing a character
5804 will immediately move the cursor back to where it belongs.
5805 See the "sm" field in 'guicursor' for setting the cursor shape and
5806 blinking when showing the match.
5807 The 'matchpairs' option can be used to specify the characters to show
5808 matches for. 'rightleft' and 'revins' are used to look for opposite
5809 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005810 Also see the matchparen plugin for highlighting the match when moving
5811 around |pi_paren.txt|.
5812 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005813
5814 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5815'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5816 global
5817 If in Insert, Replace or Visual mode put a message on the last line.
5818 Use the 'M' flag in 'highlight' to set the type of highlighting for
5819 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005820 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005821 doesn't mean XIM is really active, especially when 'imactivatekey' is
5822 not set.
5823 NOTE: This option is set to the Vi default value when 'compatible' is
5824 set and to the Vim default value when 'compatible' is reset.
5825
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00005826 *'showtabline'* *'stal'*
5827'showtabline' 'stal' number (default 1)
5828 global
5829 {not in Vi}
5830 {not available when compiled without the +windows
5831 feature}
5832 The value of this option specifies when the line with tab page labels
5833 will be displayed:
5834 0: never
5835 1: only if there are at least two tab pages
5836 2: always
5837 This is both for the GUI and non-GUI implementation of the tab pages
5838 line.
5839 See |tab-page| for more information about tab pages.
5840
Bram Moolenaar071d4272004-06-13 20:20:40 +00005841 *'sidescroll'* *'ss'*
5842'sidescroll' 'ss' number (default 0)
5843 global
5844 {not in Vi}
5845 The minimal number of columns to scroll horizontally. Used only when
5846 the 'wrap' option is off and the cursor is moved off of the screen.
5847 When it is zero the cursor will be put in the middle of the screen.
5848 When using a slow terminal set it to a large number or 0. When using
5849 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5850 commands.
5851
5852 *'sidescrolloff'* *'siso'*
5853'sidescrolloff' 'siso' number (default 0)
5854 global
5855 {not in Vi}
5856 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005857 right of the cursor if 'nowrap' is set. Setting this option to a
5858 value greater than 0 while having |'sidescroll'| also at a non-zero
5859 value makes some context visible in the line you are scrolling in
5860 horizontally (except at beginning of the line). Setting this option
5861 to a large value (like 999) has the effect of keeping the cursor
5862 horizontally centered in the window, as long as one does not come too
5863 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005864 NOTE: This option is set to 0 when 'compatible' is set.
5865
5866 Example: Try this together with 'sidescroll' and 'listchars' as
5867 in the following example to never allow the cursor to move
5868 onto the "extends" character:
5869
5870 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5871 :set sidescrolloff=1
5872
5873
5874 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5875'smartcase' 'scs' boolean (default off)
5876 global
5877 {not in Vi}
5878 Override the 'ignorecase' option if the search pattern contains upper
5879 case characters. Only used when the search pattern is typed and
5880 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005881 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005882 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5883 recalling the search pattern from history and hitting <Enter>.
5884 NOTE: This option is reset when 'compatible' is set.
5885
5886 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5887'smartindent' 'si' boolean (default off)
5888 local to buffer
5889 {not in Vi}
5890 {not available when compiled without the
5891 |+smartindent| feature}
5892 Do smart autoindenting when starting a new line. Works for C-like
5893 programs, but can also be used for other languages. 'cindent' does
5894 something like this, works better in most cases, but is more strict,
5895 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5896 'indentexpr' is a more advanced alternative.
5897 Normally 'autoindent' should also be on when using 'smartindent'.
5898 An indent is automatically inserted:
5899 - After a line ending in '{'.
5900 - After a line starting with a keyword from 'cinwords'.
5901 - Before a line starting with '}' (only with the "O" command).
5902 When typing '}' as the first character in a new line, that line is
5903 given the same indent as the matching '{'.
5904 When typing '#' as the first character in a new line, the indent for
5905 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005906 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005907 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5908 When using the ">>" command, lines starting with '#' are not shifted
5909 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005910 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005911 is set smart indenting is disabled.
5912
5913 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5914'smarttab' 'sta' boolean (default off)
5915 global
5916 {not in Vi}
5917 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00005918 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
5919 <BS> will delete a 'shiftwidth' worth of space at the start of the
5920 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005921 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00005922 'softtabstop'. 'shiftwidth' is only used for shifting text left or
5923 right |shift-left-right|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005924 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5925 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005926 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005927 NOTE: This option is reset when 'compatible' is set.
5928
5929 *'softtabstop'* *'sts'*
5930'softtabstop' 'sts' number (default 0)
5931 local to buffer
5932 {not in Vi}
5933 Number of spaces that a <Tab> counts for while performing editing
5934 operations, like inserting a <Tab> or using <BS>. It "feels" like
5935 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5936 used. This is useful to keep the 'ts' setting at its standard value
5937 of 8, while being able to edit like it is set to 'sts'. However,
5938 commands like "x" still work on the actual characters.
5939 When 'sts' is zero, this feature is off.
5940 'softtabstop' is set to 0 when the 'paste' option is set.
5941 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5942 spaces is minimized by using <Tab>s.
5943 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5944 set.
5945 NOTE: This option is set to 0 when 'compatible' is set.
5946
Bram Moolenaar217ad922005-03-20 22:37:15 +00005947 *'spell'* *'nospell'*
5948'spell' boolean (default off)
5949 local to window
5950 {not in Vi}
5951 {not available when compiled without the |+syntax|
5952 feature}
5953 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005954 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005955
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005956 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005957'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005958 local to buffer
5959 {not in Vi}
5960 {not available when compiled without the |+syntax|
5961 feature}
5962 Pattern to locate the end of a sentence. The following word will be
5963 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005964 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005965 When this check is not wanted make this option empty.
5966 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005967 Be careful with special characters, see |option-backslash| about
5968 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005969 To set this option automatically depending on the language, see
5970 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005971
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005972 *'spellfile'* *'spf'*
5973'spellfile' 'spf' string (default empty)
5974 local to buffer
5975 {not in Vi}
5976 {not available when compiled without the |+syntax|
5977 feature}
5978 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00005979 commands. It must end in ".{encoding}.add". You need to include the
5980 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005981 *E765*
5982 It may also be a comma separated list of names. A count before the
5983 |zg| and |zw| commands can be used to access each. This allows using
5984 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005985 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005986 you: Using the first directory in 'runtimepath' that is writable. If
5987 there is no "spell" directory yet it will be created. For the file
5988 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00005989 ignoring the region.
5990 The resulting ".spl" file will be used for spell checking, it does not
5991 have to appear in 'spelllang'.
5992 Normally one file is used for all regions, but you can add the region
5993 name if you want to. However, it will then only be used when
5994 'spellfile' is set to it, for entries in 'spelllang' only files
5995 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00005996 This option cannot be set from a |modeline| or in the |sandbox|, for
5997 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005998
Bram Moolenaar217ad922005-03-20 22:37:15 +00005999 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006000'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006001 local to buffer
6002 {not in Vi}
6003 {not available when compiled without the |+syntax|
6004 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006005 A comma separated list of word list names. When the 'spell' option is
6006 on spellchecking will be done for these languages. Example: >
6007 set spelllang=en_us,nl,medical
6008< This means US English, Dutch and medical words are recognized. Words
6009 that are not recognized will be highlighted.
6010 The word list name must not include a comma or dot. Using a dash is
6011 recommended to separate the two letter language name from a
6012 specification. Thus "en-rare" is used for rare English words.
6013 A region name must come last and have the form "_xx", where "xx" is
6014 the two-letter, lower case region name. You can use more than one
6015 region by listing them: "en_us,en_ca" supports both US and Canadian
6016 English, but not words specific for Australia, New Zealand or Great
6017 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006018 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006019 As a special case the name of a .spl file can be given as-is. The
6020 first "_xx" in the name is removed and used as the region name
6021 (_xx is an underscore, two letters and followed by a non-letter).
6022 This is mainly for testing purposes. You must make sure the correct
6023 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006024 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006025 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6026 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006027 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006028
Bram Moolenaar98692072006-02-04 00:57:42 +00006029 If the |spellfile.vim| plugin is active and you use a language name
6030 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6031 will ask you if you want to download the file.
6032
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006033 After this option has been set successfully, Vim will source the files
6034 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006035 up to the first comma, dot or underscore.
6036 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006037
6038
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006039 *'spellsuggest'* *'sps'*
6040'spellsuggest' 'sps' string (default "best")
6041 global
6042 {not in Vi}
6043 {not available when compiled without the |+syntax|
6044 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006045 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006046 the |spellsuggest()| function. This is a comma-separated list of
6047 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006048
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006049 best Internal method that works best for English. Finds
6050 changes like "fast" and uses a bit of sound-a-like
6051 scoring to improve the ordering.
6052
6053 double Internal method that uses two methods and mixes the
6054 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006055 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006056 word. That only works when the language specifies
6057 sound folding. Can be slow and doesn't always give
6058 better results.
6059
6060 fast Internal method that only checks for simple changes:
6061 character inserts/deletes/swaps. Works well for
6062 simple typing mistakes.
6063
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006064 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006065 Not used for |spellsuggest()|. The number of
6066 suggestions is never more than the value of 'lines'
6067 minus two.
6068
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006069 file:{filename} Read file {filename}, which must have two columns,
6070 separated by a slash. The first column contains the
6071 bad word, the second column the suggested good word.
6072 Example:
6073 theribal/terrible ~
6074 Use this for common mistakes that do not appear at the
6075 top of the suggestion list with the internal methods.
6076 Lines without a slash are ignored, use this for
6077 comments.
6078 The file is used for all languages.
6079
6080 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6081 trouble with spaces. |v:val| holds the badly spelled
6082 word. The expression must evaluate to a List of
6083 Lists, each with a suggestion and a score.
6084 Example:
6085 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006086 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006087 internal methods use. A lower score is better.
6088 This may invoke |spellsuggest()| if you temporarily
6089 set 'spellsuggest' to exclude the "expr:" part.
6090 Errors are silently ignored, unless you set the
6091 'verbose' option to a non-zero value.
6092
6093 Only one of "best", "double" or "fast" may be used. The others may
6094 appear several times in any order. Example: >
6095 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6096<
6097 This option cannot be set from a |modeline| or in the |sandbox|, for
6098 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006099
6100
Bram Moolenaar071d4272004-06-13 20:20:40 +00006101 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6102'splitbelow' 'sb' boolean (default off)
6103 global
6104 {not in Vi}
6105 {not available when compiled without the +windows
6106 feature}
6107 When on, splitting a window will put the new window below the current
6108 one. |:split|
6109
6110 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6111'splitright' 'spr' boolean (default off)
6112 global
6113 {not in Vi}
6114 {not available when compiled without the +vertsplit
6115 feature}
6116 When on, splitting a window will put the new window right of the
6117 current one. |:vsplit|
6118
6119 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6120'startofline' 'sol' boolean (default on)
6121 global
6122 {not in Vi}
6123 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006124 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006125 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006126 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006127 with a linewise operator, with "%" with a count and to buffer changing
6128 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6129 only has a line number, e.g., ":25" or ":+".
6130 In case of buffer changing commands the cursor is placed at the column
6131 where it was the last time the buffer was edited.
6132 NOTE: This option is set when 'compatible' is set.
6133
6134 *'statusline'* *'stl'* *E540* *E541* *E542*
6135'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006136 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006137 {not in Vi}
6138 {not available when compiled without the |+statusline|
6139 feature}
6140 When nonempty, this option determines the content of the status line.
6141 Also see |status-line|.
6142
6143 The option consists of printf style '%' items interspersed with
6144 normal text. Each status line item is of the form:
6145 %-0{minwid}.{maxwid}{item}
6146 All fields except the {item} is optional. A single percent sign can
6147 be given as "%%". Up to 80 items can be specified.
6148
Bram Moolenaar238a5642006-02-21 22:12:05 +00006149 When the option starts with "%!" then it is used as an expression,
6150 evaluated and the result is used as the option value. Example: >
6151 :set statusline=%!MyStatusLine()
6152< The result can contain %{} items that will be evaluated too.
6153
6154 When there is error while evaluating the option then it will be made
6155 empty to avoid further errors. Otherwise screen updating would loop.
6156
Bram Moolenaar071d4272004-06-13 20:20:40 +00006157 Note that the only effect of 'ruler' when this option is set (and
6158 'laststatus' is 2) is controlling the output of |CTRL-G|.
6159
6160 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006161 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006162 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006163 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006164 minwid Minimum width of the item, padding as set by '-' & '0'.
6165 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006166 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006167 on the left for text items. Numeric items will be
6168 shifted down to maxwid-2 digits followed by '>'number
6169 where number is the amount of missing digits, much like
6170 an exponential notation.
6171 item A one letter code as described below.
6172
6173 Following is a description of the possible statusline items. The
6174 second character in "item" is the type:
6175 N for number
6176 S for string
6177 F for flags as described below
6178 - not applicable
6179
6180 item meaning ~
6181 f S Path to the file in the buffer, relative to current directory.
6182 F S Full path to the file in the buffer.
6183 t S File name (tail) of file in the buffer.
6184 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
6185 M F Modified flag, text is ",+" or ",-".
6186 r F Readonly flag, text is " [RO]".
6187 R F Readonly flag, text is ",RO".
6188 h F Help buffer flag, text is " [help]".
6189 H F Help buffer flag, text is ",HLP".
6190 w F Preview window flag, text is " [Preview]".
6191 W F Preview window flag, text is ",PRV".
6192 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
6193 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6194 {not available when compiled without |+autocmd| feature}
6195 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6196 being used: "<keymap>"
6197 n N Buffer number.
6198 b N Value of byte under cursor.
6199 B N As above, in hexadecimal.
6200 o N Byte number in file of byte under cursor, first byte is 1.
6201 Mnemonic: Offset from start of file (with one added)
6202 {not available when compiled without |+byte_offset| feature}
6203 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006204 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006205 l N Line number.
6206 L N Number of lines in buffer.
6207 c N Column number.
6208 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006209 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006210 p N Percentage through file in lines as in |CTRL-G|.
6211 P S Percentage through file of displayed window. This is like the
6212 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006213 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006214 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006215 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006216 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006217 ( - Start of item group. Can be used for setting the width and
6218 alignment of a section. Must be followed by %) somewhere.
6219 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006220 T N For 'tabline': start of tab page N label. Use %T after the last
6221 label. This information is used for mouse clicks.
6222 X N For 'tabline': start of close tab N label. Use %X after the
6223 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6224 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006225 < - Where to truncate line if too long. Default is at the start.
6226 No width fields allowed.
6227 = - Separation point between left and right aligned items.
6228 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006229 # - Set highlight group. The name must follow and then a # again.
6230 Thus use %#HLname# for highlight group HLname. The same
6231 highlighting is used, also for the statusline of non-current
6232 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006233 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006234 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006235 The difference between User{N} and StatusLine will be applied
6236 to StatusLineNC for the statusline of non-current windows.
6237 The number N must be between 1 and 9. See |hl-User1..9|
6238
6239 Display of flags are controlled by the following heuristic:
6240 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006241 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00006242 with a space it is assumed that it wants to separate itself from
6243 anything but other flags. That is: A leading comma is removed if the
6244 preceding character stems from plaintext. A leading space is removed
Bram Moolenaar582fd852005-03-28 20:58:01 +00006245 if the preceding character stems from another active flag. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006246 make a nice display when flags are used like in the examples below.
6247
Bram Moolenaar582fd852005-03-28 20:58:01 +00006248 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006249 not set) and a minwid is not set for the group, the whole group will
6250 become empty. This will make a group like the following disappear
6251 completely from the statusline when none of the flags are set. >
6252 :set statusline=...%(\ [%M%R%H]%)...
6253<
6254 Beware that an expression is evaluated each and every time the status
6255 line is displayed. The current buffer and current window will be set
6256 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006257 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006258 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006259 real current buffer.
6260
6261 The 'statusline' option may be evaluated in the |sandbox|, see
6262 |sandbox-option|.
6263
6264 It is not allowed to change text or jump to another window while
6265 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006266
6267 If the statusline is not updated when you want it (e.g., after setting
6268 a variable that's used in an expression), you can force an update by
6269 setting an option without changing its value. Example: >
6270 :let &ro = &ro
6271
6272< A result of all digits is regarded a number for display purposes.
6273 Otherwise the result is taken as flag text and applied to the rules
6274 described above.
6275
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006276 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006277 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6278 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6279
6280 Examples:
6281 Emulate standard status line with 'ruler' set >
6282 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6283< Similar, but add ASCII value of char under the cursor (like "ga") >
6284 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6285< Display byte count and byte value, modified flag in red. >
6286 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6287 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6288< Display a ,GZ flag if a compressed file is loaded >
6289 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6290< In the |:autocmd|'s: >
6291 :let b:gzflag = 1
6292< And: >
6293 :unlet b:gzflag
6294< And define this function: >
6295 :function VarExists(var, val)
6296 : if exists(a:var) | return a:val | else | return '' | endif
6297 :endfunction
6298<
6299 *'suffixes'* *'su'*
6300'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6301 global
6302 {not in Vi}
6303 Files with these suffixes get a lower priority when multiple files
6304 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006305 suffixes. Spaces after the comma are ignored. A dot is also seen as
6306 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006307 separator, precede it with a backslash (see |option-backslash| about
6308 including spaces and backslashes).
6309 See 'wildignore' for completely ignoring files.
6310 The use of |:set+=| and |:set-=| is preferred when adding or removing
6311 suffixes from the list. This avoids problems when a future version
6312 uses another default.
6313
6314 *'suffixesadd'* *'sua'*
6315'suffixesadd' 'sua' string (default "")
6316 local to buffer
6317 {not in Vi}
6318 {not available when compiled without the
6319 |+file_in_path| feature}
6320 Comma separated list of suffixes, which are used when searching for a
6321 file for the "gf", "[I", etc. commands. Example: >
6322 :set suffixesadd=.java
6323<
6324 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6325'swapfile' 'swf' boolean (default on)
6326 local to buffer
6327 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006328 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006329 swapfile is not wanted for a specific buffer. For example, with
6330 confidential information that even root must not be able to access.
6331 Careful: All text will be in memory:
6332 - Don't use this for big files.
6333 - Recovery will be impossible!
6334 A swapfile will only be present when |'updatecount'| is non-zero and
6335 'swapfile' is set.
6336 When 'swapfile' is reset, the swap file for the current buffer is
6337 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6338 non-zero, a swap file is immediately created.
6339 Also see |swap-file| and |'swapsync'|.
6340
6341 This option is used together with 'bufhidden' and 'buftype' to
6342 specify special kinds of buffers. See |special-buffers|.
6343
6344 *'swapsync'* *'sws'*
6345'swapsync' 'sws' string (default "fsync")
6346 global
6347 {not in Vi}
6348 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006349 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006350 When this option is empty parts of the swap file may be in memory and
6351 not written to disk. When the system crashes you may lose more work.
6352 On Unix the system does a sync now and then without Vim asking for it,
6353 so the disadvantage of setting this option off is small. On some
6354 systems the swap file will not be written at all. For a unix system
6355 setting it to "sync" will use the sync() call instead of the default
6356 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006357 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006358
6359 *'switchbuf'* *'swb'*
6360'switchbuf' 'swb' string (default "")
6361 global
6362 {not in Vi}
6363 This option controls the behavior when switching between buffers.
6364 Possible values (comma separated list):
6365 useopen If included, jump to the first open window that
6366 contains the specified buffer (if there is one).
6367 Otherwise: Do not examine other windows.
6368 This setting is checked with |quickfix| commands, when
6369 jumping to errors (":cc", ":cn", "cp", etc.). It is
6370 also used in all buffer related split commands, for
6371 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006372 usetab Like "useopen", but also consider windows in other tab
6373 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006374 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006375 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006376 Supported in |quickfix| commands that display errors.
6377
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006378 *'synmaxcol'* *'smc'*
6379'synmaxcol' 'smc' number (default 3000)
6380 local to buffer
6381 {not in Vi}
6382 {not available when compiled without the |+syntax|
6383 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006384 Maximum column in which to search for syntax items. In long lines the
6385 text after this column is not highlighted and following lines may not
6386 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006387 This helps to avoid very slow redrawing for an XML file that is one
6388 long line.
6389 Set to zero to remove the limit.
6390
Bram Moolenaar071d4272004-06-13 20:20:40 +00006391 *'syntax'* *'syn'*
6392'syntax' 'syn' string (default empty)
6393 local to buffer
6394 {not in Vi}
6395 {not available when compiled without the |+syntax|
6396 feature}
6397 When this option is set, the syntax with this name is loaded, unless
6398 syntax highlighting has been switched off with ":syntax off".
6399 Otherwise this option does not always reflect the current syntax (the
6400 b:current_syntax variable does).
6401 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006402 not automatically recognized. Example, in an IDL file:
6403 /* vim: set syntax=idl : */ ~
6404 When a dot appears in the value then this separates two filetype
6405 names. Example:
6406 /* vim: set syntax=c.doxygen : */ ~
6407 This will use the "c" syntax first, then the "doxygen" syntax.
6408 Note that the second one must be prepared to be loaded as an addition,
6409 otherwise it will be skipped. More than one dot may appear.
6410 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006411 :set syntax=OFF
6412< To switch syntax highlighting on according to the current value of the
6413 'filetype' option: >
6414 :set syntax=ON
6415< What actually happens when setting the 'syntax' option is that the
6416 Syntax autocommand event is triggered with the value as argument.
6417 This option is not copied to another buffer, independent of the 's' or
6418 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006419 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006420
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006421 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006422'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006423 global
6424 {not in Vi}
6425 {not available when compiled without the +windows
6426 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006427 When nonempty, this option determines the content of the tab pages
6428 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006429 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006430
6431 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006432 option and only when there is no GUI tab line. When 'e' is in
6433 'guioptions' and the GUI supports a tab line 'guitablabel' is used
6434 instead.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006435
6436 The value is evaluated like with 'statusline'. You can use
6437 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006438 the text to be displayed. Use "%1T" for the first label, "%2T" for
6439 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006440
6441 Keep in mind that only one of the tab pages is the current one, others
6442 are invisible and you can't jump to their windows.
6443
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006444
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006445 *'tabpagemax'* *'tpm'*
6446'tabpagemax' 'tpm' number (default 10)
6447 global
6448 {not in Vi}
6449 {not available when compiled without the +windows
6450 feature}
6451 Maximum number of tab pages to be opened by the |-p| command line
6452 argument or the ":tab all" command. |tabpage|
6453
6454
6455 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006456'tabstop' 'ts' number (default 8)
6457 local to buffer
6458 Number of spaces that a <Tab> in the file counts for. Also see
6459 |:retab| command, and 'softtabstop' option.
6460
6461 Note: Setting 'tabstop' to any other value than 8 can make your file
6462 appear wrong in many places (e.g., when printing it).
6463
6464 There are four main ways to use tabs in Vim:
6465 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6466 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
6467 will use a mix of tabs and spaces, but typing Tab and BS will
6468 behave like a tab appears every 4 (or 3) characters.
6469 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6470 'expandtab'. This way you will always insert spaces. The
6471 formatting will never be messed up when 'tabstop' is changed.
6472 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006473 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006474 works when using Vim to edit the file.
6475 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6476 'noexpandtab'. This should then work (for initial indents only)
6477 for any tabstop setting that people use. It might be nice to have
6478 tabs after the first non-blank inserted as spaces if you do this
6479 though. Otherwise aligned comments will be wrong when 'tabstop' is
6480 changed.
6481
6482 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6483'tagbsearch' 'tbs' boolean (default on)
6484 global
6485 {not in Vi}
6486 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006487 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006488 searching makes searching for a tag a LOT faster, but a linear search
6489 will find more tags if the tags file wasn't properly sorted.
6490 Vim normally assumes that your tags files are sorted, or indicate that
6491 they are not sorted. Only when this is not the case does the
6492 'tagbsearch' option need to be switched off.
6493
6494 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006495 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006496 certain files, or retry all files with a linear search. When
6497 'tagbsearch' is off, only a linear search is done.
6498
6499 Linear searching is done anyway, for one file, when Vim finds a line
6500 at the start of the file indicating that it's not sorted: >
6501 !_TAG_FILE_SORTED 0 /some command/
6502< [The whitespace before and after the '0' must be a single <Tab>]
6503
6504 When a binary search was done and no match was found in any of the
6505 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6506 instead of a normal tag name, a retry is done with a linear search.
6507 Tags in unsorted tags files, and matches with different case will only
6508 be found in the retry.
6509
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006510 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006511 linear search can be avoided for the 'ignorecase' case. Use a value
6512 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6513 case-fold sorted with the -f switch to "sort" in most unices, as in
6514 the command: "sort -f -o tags tags". For "Exuberant ctags" version
6515 5.3 or higher the -f or --fold-case-sort switch can be used for this
6516 as well. Note that case must be folded to uppercase for this to work.
6517
6518 When 'tagbsearch' is off, tags searching is slower when a full match
6519 exists, but faster when no full match exists. Tags in unsorted tags
6520 files may only be found with 'tagbsearch' off.
6521 When the tags file is not sorted, or sorted in a wrong way (not on
6522 ASCII byte value), 'tagbsearch' should be off, or the line given above
6523 must be included in the tags file.
6524 This option doesn't affect commands that find all matching tags (e.g.,
6525 command-line completion and ":help").
6526 {Vi: always uses binary search in some versions}
6527
6528 *'taglength'* *'tl'*
6529'taglength' 'tl' number (default 0)
6530 global
6531 If non-zero, tags are significant up to this number of characters.
6532
6533 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6534'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6535 global
6536 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006537 If on and using a tags file in another directory, file names in that
6538 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006539 NOTE: This option is set to the Vi default value when 'compatible' is
6540 set and to the Vim default value when 'compatible' is reset.
6541
6542 *'tags'* *'tag'* *E433*
6543'tags' 'tag' string (default "./tags,tags", when compiled with
6544 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6545 global or local to buffer |global-local|
6546 Filenames for the tag command, separated by spaces or commas. To
6547 include a space or comma in a file name, precede it with a backslash
6548 (see |option-backslash| about including spaces and backslashes).
6549 When a file name starts with "./", the '.' is replaced with the path
6550 of the current file. But only when the 'd' flag is not included in
6551 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6552 |tags-option|.
6553 "*", "**" and other wildcards can be used to search for tags files in
6554 a directory tree. See |file-searching|. {not available when compiled
6555 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006556 The |tagfiles()| function can be used to get a list of the file names
6557 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006558 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6559 files are also supported. They are automatically recognized. The
6560 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6561 differences are ignored (MS-Windows). |emacs-tags|
6562 The use of |:set+=| and |:set-=| is preferred when adding or removing
6563 file names from the list. This avoids problems when a future version
6564 uses another default.
6565 {Vi: default is "tags /usr/lib/tags"}
6566
6567 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6568'tagstack' 'tgst' boolean (default on)
6569 global
6570 {not in all versions of Vi}
6571 When on, the |tagstack| is used normally. When off, a ":tag" or
6572 ":tselect" command with an argument will not push the tag onto the
6573 tagstack. A following ":tag" without an argument, a ":pop" command or
6574 any other command that uses the tagstack will use the unmodified
6575 tagstack, but does change the pointer to the active entry.
6576 Resetting this option is useful when using a ":tag" command in a
6577 mapping which should not change the tagstack.
6578
6579 *'term'* *E529* *E530* *E531*
6580'term' string (default is $TERM, if that fails:
6581 in the GUI: "builtin_gui"
6582 on Amiga: "amiga"
6583 on BeOS: "beos-ansi"
6584 on Mac: "mac-ansi"
6585 on MiNT: "vt52"
6586 on MS-DOS: "pcterm"
6587 on OS/2: "os2ansi"
6588 on Unix: "ansi"
6589 on VMS: "ansi"
6590 on Win 32: "win32")
6591 global
6592 Name of the terminal. Used for choosing the terminal control
6593 characters. Environment variables are expanded |:set_env|.
6594 For example: >
6595 :set term=$TERM
6596< See |termcap|.
6597
6598 *'termbidi'* *'tbidi'*
6599 *'notermbidi'* *'notbidi'*
6600'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6601 global
6602 {not in Vi}
6603 {only available when compiled with the |+arabic|
6604 feature}
6605 The terminal is in charge of Bi-directionality of text (as specified
6606 by Unicode). The terminal is also expected to do the required shaping
6607 that some languages (such as Arabic) require.
6608 Setting this option implies that 'rightleft' will not be set when
6609 'arabic' is set and the value of 'arabicshape' will be ignored.
6610 Note that setting 'termbidi' has the immediate effect that
6611 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6612 This option is reset when the GUI is started.
6613 For further details see |arabic.txt|.
6614
6615 *'termencoding'* *'tenc'*
6616'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6617 Macintosh GUI: "macroman")
6618 global
6619 {only available when compiled with the |+multi_byte|
6620 feature}
6621 {not in Vi}
6622 Encoding used for the terminal. This specifies what character
6623 encoding the keyboard produces and the display will understand. For
6624 the GUI it only applies to the keyboard ('encoding' is used for the
6625 display).
6626 In the Win32 console version the default value is the console codepage
6627 when it differs from the ANSI codepage.
6628 *E617*
6629 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6630 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6631 Any attempts to set a different value will be rejected, and an error
6632 message is shown.
6633 For the Win32 GUI 'termencoding' is not used for typed characters,
6634 because the Win32 system always passes Unicode characters.
6635 When empty, the same encoding is used as for the 'encoding' option.
6636 This is the normal value.
6637 Not all combinations for 'termencoding' and 'encoding' are valid. See
6638 |encoding-table|.
6639 The value for this option must be supported by internal conversions or
6640 iconv(). When this is not possible no conversion will be done and you
6641 will probably experience problems with non-ASCII characters.
6642 Example: You are working with the locale set to euc-jp (Japanese) and
6643 want to edit a UTF-8 file: >
6644 :let &termencoding = &encoding
6645 :set encoding=utf-8
6646< You need to do this when your system has no locale support for UTF-8.
6647
6648 *'terse'* *'noterse'*
6649'terse' boolean (default off)
6650 global
6651 When set: Add 's' flag to 'shortmess' option (this makes the message
6652 for a search that hits the start or end of the file not being
6653 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6654 shortens a lot of messages}
6655
6656 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6657'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6658 global
6659 {not in Vi}
6660 This option is obsolete. Use 'fileformats'.
6661 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6662 set to the default value for the current system. When 'textauto' is
6663 reset, 'fileformats' is made empty.
6664 NOTE: This option is set to the Vi default value when 'compatible' is
6665 set and to the Vim default value when 'compatible' is reset.
6666
6667 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6668'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6669 others: default off)
6670 local to buffer
6671 {not in Vi}
6672 This option is obsolete. Use 'fileformat'.
6673 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6674 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6675 "unix".
6676
6677 *'textwidth'* *'tw'*
6678'textwidth' 'tw' number (default 0)
6679 local to buffer
6680 {not in Vi}
6681 Maximum width of text that is being inserted. A longer line will be
6682 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006683 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6684 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006685 'formatoptions' and |ins-textwidth|.
6686 NOTE: This option is set to 0 when 'compatible' is set.
6687
6688 *'thesaurus'* *'tsr'*
6689'thesaurus' 'tsr' string (default "")
6690 global or local to buffer |global-local|
6691 {not in Vi}
6692 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006693 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006694 the file should contain words with similar meaning, separated by
6695 non-keyword characters (white space is preferred). Maximum line
6696 length is 510 bytes.
6697 To obtain a file to be used here, check out the wordlist FAQ at
6698 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006699 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006700 after a comma are ignored, otherwise spaces are included in the file
6701 name. See |option-backslash| about using backslashes.
6702 The use of |:set+=| and |:set-=| is preferred when adding or removing
6703 directories from the list. This avoids problems when a future version
6704 uses another default.
6705 Backticks cannot be used in this option for security reasons.
6706
6707 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6708'tildeop' 'top' boolean (default off)
6709 global
6710 {not in Vi}
6711 When on: The tilde command "~" behaves like an operator.
6712 NOTE: This option is reset when 'compatible' is set.
6713
6714 *'timeout'* *'to'* *'notimeout'* *'noto'*
6715'timeout' 'to' boolean (default on)
6716 global
6717 *'ttimeout'* *'nottimeout'*
6718'ttimeout' boolean (default off)
6719 global
6720 {not in Vi}
6721 These two options together determine the behavior when part of a
6722 mapped key sequence or keyboard code has been received:
6723
6724 'timeout' 'ttimeout' action ~
6725 off off do not time out
6726 on on or off time out on :mappings and key codes
6727 off on time out on key codes
6728
6729 If both options are off, Vim will wait until either the complete
6730 mapping or key sequence has been received, or it is clear that there
6731 is no mapping or key sequence for the received characters. For
6732 example: if you have mapped "vl" and Vim has received 'v', the next
6733 character is needed to see if the 'v' is followed by an 'l'.
6734 When one of the options is on, Vim will wait for about 1 second for
6735 the next character to arrive. After that the already received
6736 characters are interpreted as single characters. The waiting time can
6737 be changed with the 'timeoutlen' option.
6738 On slow terminals or very busy systems timing out may cause
6739 malfunctioning cursor keys. If both options are off, Vim waits
6740 forever after an entered <Esc> if there are key codes that start
6741 with <Esc>. You will have to type <Esc> twice. If you do not have
6742 problems with key codes, but would like to have :mapped key
6743 sequences not timing out in 1 second, set the 'ttimeout' option and
6744 reset the 'timeout' option.
6745
6746 NOTE: 'ttimeout' is reset when 'compatible' is set.
6747
6748 *'timeoutlen'* *'tm'*
6749'timeoutlen' 'tm' number (default 1000)
6750 global
6751 {not in all versions of Vi}
6752 *'ttimeoutlen'* *'ttm'*
6753'ttimeoutlen' 'ttm' number (default -1)
6754 global
6755 {not in Vi}
6756 The time in milliseconds that is waited for a key code or mapped key
6757 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6758 when part of a command has been typed.
6759 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6760 different timeout value for key codes is desired set 'ttimeoutlen' to
6761 a non-negative number.
6762
6763 ttimeoutlen mapping delay key code delay ~
6764 < 0 'timeoutlen' 'timeoutlen'
6765 >= 0 'timeoutlen' 'ttimeoutlen'
6766
6767 The timeout only happens when the 'timeout' and 'ttimeout' options
6768 tell so. A useful setting would be >
6769 :set timeout timeoutlen=3000 ttimeoutlen=100
6770< (time out on mapping after three seconds, time out on key codes after
6771 a tenth of a second).
6772
6773 *'title'* *'notitle'*
6774'title' boolean (default off, on when title can be restored)
6775 global
6776 {not in Vi}
6777 {not available when compiled without the |+title|
6778 feature}
6779 When on, the title of the window will be set to the value of
6780 'titlestring' (if it is not empty), or to:
6781 filename [+=-] (path) - VIM
6782 Where:
6783 filename the name of the file being edited
6784 - indicates the file cannot be modified, 'ma' off
6785 + indicates the file was modified
6786 = indicates the file is read-only
6787 =+ indicates the file is read-only and modified
6788 (path) is the path of the file being edited
6789 - VIM the server name |v:servername| or "VIM"
6790 Only works if the terminal supports setting window titles
6791 (currently Amiga console, Win32 console, all GUI versions and
6792 terminals with a non- empty 't_ts' option - these are Unix xterm and
6793 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6794 *X11*
6795 When Vim was compiled with HAVE_X11 defined, the original title will
6796 be restored if possible. The output of ":version" will include "+X11"
6797 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6798 works for the icon name |'icon'|.
6799 But: When Vim was started with the |-X| argument, restoring the title
6800 will not work (except in the GUI).
6801 If the title cannot be restored, it is set to the value of 'titleold'.
6802 You might want to restore the title outside of Vim then.
6803 When using an xterm from a remote machine you can use this command:
6804 rsh machine_name xterm -display $DISPLAY &
6805 then the WINDOWID environment variable should be inherited and the
6806 title of the window should change back to what it should be after
6807 exiting Vim.
6808
6809 *'titlelen'*
6810'titlelen' number (default 85)
6811 global
6812 {not in Vi}
6813 {not available when compiled without the |+title|
6814 feature}
6815 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006816 title. When the title is longer, only the end of the path name is
6817 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006818 Using a percentage makes this adapt to the width of the window. But
6819 it won't work perfectly, because the actual number of characters
6820 available also depends on the font used and other things in the title
6821 bar. When 'titlelen' is zero the full path is used. Otherwise,
6822 values from 1 to 30000 percent can be used.
6823 'titlelen' is also used for the 'titlestring' option.
6824
6825 *'titleold'*
6826'titleold' string (default "Thanks for flying Vim")
6827 global
6828 {not in Vi}
6829 {only available when compiled with the |+title|
6830 feature}
6831 This option will be used for the window title when exiting Vim if the
6832 original title cannot be restored. Only happens if 'title' is on or
6833 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006834 This option cannot be set from a |modeline| or in the |sandbox|, for
6835 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006836 *'titlestring'*
6837'titlestring' string (default "")
6838 global
6839 {not in Vi}
6840 {not available when compiled without the |+title|
6841 feature}
6842 When this option is not empty, it will be used for the title of the
6843 window. This happens only when the 'title' option is on.
6844 Only works if the terminal supports setting window titles (currently
6845 Amiga console, Win32 console, all GUI versions and terminals with a
6846 non-empty 't_ts' option).
6847 When Vim was compiled with HAVE_X11 defined, the original title will
6848 be restored if possible |X11|.
6849 When this option contains printf-style '%' items, they will be
6850 expanded according to the rules used for 'statusline'.
6851 Example: >
6852 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6853 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6854< The value of 'titlelen' is used to align items in the middle or right
6855 of the available space.
6856 Some people prefer to have the file name first: >
6857 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6858< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006859 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006860 separating space only when needed.
6861 NOTE: Use of special characters in 'titlestring' may cause the display
6862 to be garbled (e.g., when it contains a CR or NL character).
6863 {not available when compiled without the |+statusline| feature}
6864
6865 *'toolbar'* *'tb'*
6866'toolbar' 'tb' string (default "icons,tooltips")
6867 global
6868 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6869 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006870 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006871 possible values are:
6872 icons Toolbar buttons are shown with icons.
6873 text Toolbar buttons shown with text.
6874 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006875 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006876 tooltips Tooltips are active for toolbar buttons.
6877 Tooltips refer to the popup help text which appears after the mouse
6878 cursor is placed over a toolbar button for a brief moment.
6879
6880 If you want the toolbar to be shown with icons as well as text, do the
6881 following: >
6882 :set tb=icons,text
6883< Motif and Athena cannot display icons and text at the same time. They
6884 will show icons if both are requested.
6885
6886 If none of the strings specified in 'toolbar' are valid or if
6887 'toolbar' is empty, this option is ignored. If you want to disable
6888 the toolbar, you need to set the 'guioptions' option. For example: >
6889 :set guioptions-=T
6890< Also see |gui-toolbar|.
6891
6892 *'toolbariconsize'* *'tbis'*
6893'toolbariconsize' 'tbis' string (default "small")
6894 global
6895 {not in Vi}
6896 {only in the GTK+ 2 GUI}
6897 Controls the size of toolbar icons. The possible values are:
6898 tiny Use tiny toolbar icons.
6899 small Use small toolbar icons (default).
6900 medium Use medium-sized toolbar icons.
6901 large Use large toolbar icons.
6902 The exact dimensions in pixels of the various icon sizes depend on
6903 the current theme. Common dimensions are large=32x32, medium=24x24,
6904 small=20x20 and tiny=16x16.
6905
6906 If 'toolbariconsize' is empty, the global default size as determined
6907 by user preferences or the current theme is used.
6908
6909 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6910'ttybuiltin' 'tbi' boolean (default on)
6911 global
6912 {not in Vi}
6913 When on, the builtin termcaps are searched before the external ones.
6914 When off the builtin termcaps are searched after the external ones.
6915 When this option is changed, you should set the 'term' option next for
6916 the change to take effect, for example: >
6917 :set notbi term=$TERM
6918< See also |termcap|.
6919 Rationale: The default for this option is "on", because the builtin
6920 termcap entries are generally better (many systems contain faulty
6921 xterm entries...).
6922
6923 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6924'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6925 sun-cmd, screen, rxvt, dtterm or
6926 iris-ansi; also on when running Vim in
6927 a DOS console)
6928 global
6929 {not in Vi}
6930 Indicates a fast terminal connection. More characters will be sent to
6931 the screen for redrawing, instead of using insert/delete line
6932 commands. Improves smoothness of redrawing when there are multiple
6933 windows and the terminal does not support a scrolling region.
6934 Also enables the extra writing of characters at the end of each screen
6935 line for lines that wrap. This helps when using copy/paste with the
6936 mouse in an xterm and other terminals.
6937
6938 *'ttymouse'* *'ttym'*
6939'ttymouse' 'ttym' string (default depends on 'term')
6940 global
6941 {not in Vi}
6942 {only in Unix and VMS, doesn't work in the GUI; not
6943 available when compiled without |+mouse|}
6944 Name of the terminal type for which mouse codes are to be recognized.
6945 Currently these three strings are valid:
6946 *xterm-mouse*
6947 xterm xterm-like mouse handling. The mouse generates
6948 "<Esc>[Mscr", where "scr" is three bytes:
6949 "s" = button state
6950 "c" = column plus 33
6951 "r" = row plus 33
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006952 This only works up to 223 columns! See "dec" for a
6953 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006954 xterm2 Works like "xterm", but with the xterm reporting the
6955 mouse position while the mouse is dragged. This works
6956 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006957 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00006958 work. See below for how Vim detects this
6959 automatically.
6960 *netterm-mouse*
6961 netterm NetTerm mouse handling. The mouse generates
6962 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6963 for the row and column.
6964 *dec-mouse*
6965 dec DEC terminal mouse handling. The mouse generates a
6966 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006967 This is also available for an Xterm, if it was
6968 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006969 *jsbterm-mouse*
6970 jsbterm JSB term mouse handling.
6971 *pterm-mouse*
6972 pterm QNX pterm mouse handling.
6973
6974 The mouse handling must be enabled at compile time |+mouse_xterm|
6975 |+mouse_dec| |+mouse_netterm|.
6976 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6977 recognized, if enabled at compile time. DEC terminal mouse codes
6978 are recognized if enabled at compile time, and 'ttymouse' is not
6979 "xterm" (because the xterm and dec mouse codes conflict).
6980 This option is automatically set to "xterm", when the 'term' option is
6981 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6982 or "xterm2" already. The main use of this option is to set it to
6983 "xterm", when the terminal name doesn't start with "xterm", but it can
6984 handle xterm mouse codes.
6985 The "xterm2" value will be set if the xterm version is reported to be
6986 95 of higher. This only works when compiled with the |+termresponse|
6987 feature and if |t_RV| is set to the escape sequence to request the
6988 xterm version number. Otherwise "xterm2" must be set explicitly.
6989 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6990 t_RV to an empty string: >
6991 :set t_RV=
6992<
6993 *'ttyscroll'* *'tsl'*
6994'ttyscroll' 'tsl' number (default 999)
6995 global
6996 Maximum number of lines to scroll the screen. If there are more lines
6997 to scroll the window is redrawn. For terminals where scrolling is
6998 very slow and redrawing is not slow this can be set to a small number,
6999 e.g., 3, to speed up displaying.
7000
7001 *'ttytype'* *'tty'*
7002'ttytype' 'tty' string (default from $TERM)
7003 global
7004 Alias for 'term', see above.
7005
7006 *'undolevels'* *'ul'*
7007'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7008 Win32 and OS/2)
7009 global
7010 {not in Vi}
7011 Maximum number of changes that can be undone. Since undo information
7012 is kept in memory, higher numbers will cause more memory to be used
7013 (nevertheless, a single change can use an unlimited amount of memory).
7014 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7015 itself: >
7016 set ul=0
7017< But you can also get Vi compatibility by including the 'u' flag in
7018 'cpoptions', and still be able to use CTRL-R to repeat undo.
7019 Set to a negative number for no undo at all: >
7020 set ul=-1
7021< This helps when you run out of memory for a single change.
7022 Also see |undo-two-ways|.
7023
7024 *'updatecount'* *'uc'*
7025'updatecount' 'uc' number (default: 200)
7026 global
7027 {not in Vi}
7028 After typing this many characters the swap file will be written to
7029 disk. When zero, no swap file will be created at all (see chapter on
7030 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7031 Vim with the "-n" option, see |startup|. When editing in readonly
7032 mode this option will be initialized to 10000.
7033 The swapfile can be disabled per buffer with |'swapfile'|.
7034 When 'updatecount' is set from zero to non-zero, swap files are
7035 created for all buffers that have 'swapfile' set. When 'updatecount'
7036 is set to zero, existing swap files are not deleted.
7037 Also see |'swapsync'|.
7038 This option has no meaning in buffers where |'buftype'| is "nofile"
7039 or "nowrite".
7040
7041 *'updatetime'* *'ut'*
7042'updatetime' 'ut' number (default 4000)
7043 global
7044 {not in Vi}
7045 If this many milliseconds nothing is typed the swap file will be
7046 written to disk (see |crash-recovery|). Also used for the
7047 |CursorHold| autocommand event.
7048
7049 *'verbose'* *'vbs'*
7050'verbose' 'vbs' number (default 0)
7051 global
7052 {not in Vi, although some versions have a boolean
7053 verbose option}
7054 When bigger than zero, Vim will give messages about what it is doing.
7055 Currently, these messages are given:
7056 >= 1 When the viminfo file is read or written.
7057 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007058 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007059 >= 8 Files for which a group of autocommands is executed.
7060 >= 9 Every executed autocommand.
7061 >= 12 Every executed function.
7062 >= 13 When an exception is thrown, caught, finished, or discarded.
7063 >= 14 Anything pending in a ":finally" clause.
7064 >= 15 Every executed Ex command (truncated at 200 characters).
7065
7066 This option can also be set with the "-V" argument. See |-V|.
7067 This option is also set by the |:verbose| command.
7068
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007069 When the 'verbosefile' option is set then the verbose messages are not
7070 displayed.
7071
7072 *'verbosefile'* *'vfile'*
7073'verbosefile' 'vfile' string (default empty)
7074 global
7075 {not in Vi}
7076 When not empty all messages are written in a file with this name.
7077 When the file exists messages are appended.
7078 Writing to the file ends when Vim exits or when 'verbosefile' is made
7079 empty.
7080 Setting 'verbosefile' to a new value is like making it empty first.
7081 The difference with |:redir| is that verbose messages are not
7082 displayed when 'verbosefile' is set.
7083
Bram Moolenaar071d4272004-06-13 20:20:40 +00007084 *'viewdir'* *'vdir'*
7085'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7086 "$VIM/vimfiles/view",
7087 for Unix: "~/.vim/view",
7088 for Macintosh: "$VIM:vimfiles:view"
7089 for VMS: "sys$login:vimfiles/view"
7090 for RiscOS: "Choices:vimfiles/view")
7091 global
7092 {not in Vi}
7093 {not available when compiled without the +mksession
7094 feature}
7095 Name of the directory where to store files for |:mkview|.
7096 This option cannot be set from a |modeline| or in the |sandbox|, for
7097 security reasons.
7098
7099 *'viewoptions'* *'vop'*
7100'viewoptions' 'vop' string (default: "folds,options,cursor")
7101 global
7102 {not in Vi}
7103 {not available when compiled without the +mksession
7104 feature}
7105 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007106 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007107 word save and restore ~
7108 cursor cursor position in file and in window
7109 folds manually created folds, opened/closed folds and local
7110 fold options
7111 options options and mappings local to a window or buffer (not
7112 global values for local options)
7113 slash backslashes in file names replaced with forward
7114 slashes
7115 unix with Unix end-of-line format (single <NL>), even when
7116 on Windows or DOS
7117
7118 "slash" and "unix" are useful on Windows when sharing view files
7119 with Unix. The Unix version of Vim cannot source dos format scripts,
7120 but the Windows version of Vim can source unix format scripts.
7121
7122 *'viminfo'* *'vi'* *E526* *E527* *E528*
7123'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
7124 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
7125 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
7126 for others: '20,<50,s10,h)
7127 global
7128 {not in Vi}
7129 {not available when compiled without the |+viminfo|
7130 feature}
7131 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007132 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007133 separated list of parameters, each consisting of a single character
7134 identifying the particular parameter, followed by a number or string
7135 which specifies the value of that parameter. If a particular
7136 character is left out, then the default value is used for that
7137 parameter. The following is a list of the identifying characters and
7138 the effect of their value.
7139 CHAR VALUE ~
7140 ! When included, save and restore global variables that start
7141 with an uppercase letter, and don't contain a lowercase
7142 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007143 and "_K_L_M" are not. Only String and Number types are
7144 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007145 " Maximum number of lines saved for each register. Old name of
7146 the '<' item, with the disadvantage that you need to put a
7147 backslash before the ", otherwise it will be recognized as the
7148 start of a comment!
7149 % When included, save and restore the buffer list. If Vim is
7150 started with a file name argument, the buffer list is not
7151 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007152 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007153 without a file name and buffers for help files are not written
7154 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007155 When followed by a number, the number specifies the maximum
7156 number of buffers that are stored. Without a number all
7157 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007158 ' Maximum number of previously edited files for which the marks
7159 are remembered. This parameter must always be included when
7160 'viminfo' is non-empty.
7161 Including this item also means that the |jumplist| and the
7162 |changelist| are stored in the viminfo file.
7163 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007164 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007165 patterns are also saved. When not included, the value of
7166 'history' is used.
7167 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007168 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007169 < Maximum number of lines saved for each register. If zero then
7170 registers are not saved. When not included, all lines are
7171 saved. '"' is the old name for this item.
7172 Also see the 's' item below: limit specified in Kbyte.
7173 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007174 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007175 c When included, convert the text in the viminfo file from the
7176 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007177 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007178 f Whether file marks need to be stored. If zero, file marks ('0
7179 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007180 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007181 cursor position (when exiting or when doing ":wviminfo").
7182 h Disable the effect of 'hlsearch' when loading the viminfo
7183 file. When not included, it depends on whether ":nohlsearch"
7184 has been used since the last search command.
7185 n Name of the viminfo file. The name must immediately follow
7186 the 'n'. Must be the last one! If the "-i" argument was
7187 given when starting Vim, that file name overrides the one
7188 given here with 'viminfo'. Environment variables are expanded
7189 when opening the file, not when setting the option.
7190 r Removable media. The argument is a string (up to the next
7191 ','). This parameter can be given several times. Each
7192 specifies the start of a path for which no marks will be
7193 stored. This is to avoid removable media. For MS-DOS you
7194 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7195 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7196 ignored. Maximum length of each 'r' argument is 50
7197 characters.
7198 s Maximum size of an item in Kbyte. If zero then registers are
7199 not saved. Currently only applies to registers. The default
7200 "s10" will exclude registers with more than 10 Kbyte of text.
7201 Also see the '<' item above: line count limit.
7202
7203 Example: >
7204 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7205<
7206 '50 Marks will be remembered for the last 50 files you
7207 edited.
7208 <1000 Contents of registers (up to 1000 lines each) will be
7209 remembered.
7210 s100 Registers with more than 100 Kbyte text are skipped.
7211 :0 Command-line history will not be saved.
7212 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7213 no / Since '/' is not specified, the default will be used,
7214 that is, save all of the search history, and also the
7215 previous search and substitute patterns.
7216 no % The buffer list will not be saved nor read back.
7217 no h 'hlsearch' highlighting will be restored.
7218
7219 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7220 load the contents of the file, this is not done automatically.
7221
7222 This option cannot be set from a |modeline| or in the |sandbox|, for
7223 security reasons.
7224
7225 *'virtualedit'* *'ve'*
7226'virtualedit' 've' string (default "")
7227 global
7228 {not in Vi}
7229 {not available when compiled without the
7230 |+virtualedit| feature}
7231 A comma separated list of these words:
7232 block Allow virtual editing in Visual block mode.
7233 insert Allow virtual editing in Insert mode.
7234 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007235 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007236
Bram Moolenaar071d4272004-06-13 20:20:40 +00007237 Virtual editing means that the cursor can be positioned where there is
7238 no actual character. This can be halfway into a Tab or beyond the end
7239 of the line. Useful for selecting a rectangle in Visual mode and
7240 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007241 "onemore" is not the same, it will only allow moving the cursor just
7242 after the last character of the line. This makes some commands more
7243 consistent. Previously the cursor was always past the end of the line
7244 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007245 break some plugins or Vim scripts. For example because |l| can move
7246 the cursor after the last character. Use with care!
7247 Using the |$| command will move to the last character in the line, not
7248 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007249 It doesn't make sense to combine "all" with "onemore", but you will
7250 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007251
7252 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7253'visualbell' 'vb' boolean (default off)
7254 global
7255 {not in Vi}
7256 Use visual bell instead of beeping. The terminal code to display the
7257 visual bell is given with 't_vb'. When no beep or flash is wanted,
7258 use ":set vb t_vb=".
7259 Note: When the GUI starts, 't_vb' is reset to its default value. You
7260 might want to set it again in your |gvimrc|.
7261 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7262 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7263 where 40 is the time in msec.
7264 Does not work on the Amiga, you always get a screen flash.
7265 Also see 'errorbells'.
7266
7267 *'warn'* *'nowarn'*
7268'warn' boolean (default on)
7269 global
7270 Give a warning message when a shell command is used while the buffer
7271 has been changed.
7272
7273 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7274'weirdinvert' 'wiv' boolean (default off)
7275 global
7276 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007277 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007278 It is provided for backwards compatibility with version 4.x.
7279 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7280 vice versa. Has no effect when the GUI is running.
7281
7282 *'whichwrap'* *'ww'*
7283'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7284 global
7285 {not in Vi}
7286 Allow specified keys that move the cursor left/right to move to the
7287 previous/next line when the cursor is on the first/last character in
7288 the line. Concatenate characters to allow this for these keys:
7289 char key mode ~
7290 b <BS> Normal and Visual
7291 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007292 h "h" Normal and Visual (not recommended)
7293 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007294 < <Left> Normal and Visual
7295 > <Right> Normal and Visual
7296 ~ "~" Normal
7297 [ <Left> Insert and Replace
7298 ] <Right> Insert and Replace
7299 For example: >
7300 :set ww=<,>,[,]
7301< allows wrap only when cursor keys are used.
7302 When the movement keys are used in combination with a delete or change
7303 operator, the <EOL> also counts for a character. This makes "3h"
7304 different from "3dh" when the cursor crosses the end of a line. This
7305 is also true for "x" and "X", because they do the same as "dl" and
7306 "dh". If you use this, you may also want to use the mapping
7307 ":map <BS> X" to make backspace delete the character in front of the
7308 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007309 When 'l' is included and it is used after an operator at the end of a
7310 line then it will not move to the next line. This makes "dl", "cl",
7311 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007312 NOTE: This option is set to the Vi default value when 'compatible' is
7313 set and to the Vim default value when 'compatible' is reset.
7314
7315 *'wildchar'* *'wc'*
7316'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7317 global
7318 {not in Vi}
7319 Character you have to type to start wildcard expansion in the
7320 command-line, as specified with 'wildmode'.
7321 The character is not recognized when used inside a macro. See
7322 'wildcharm' for that.
7323 Although 'wc' is a number option, you can set it to a special key: >
7324 :set wc=<Esc>
7325< NOTE: This option is set to the Vi default value when 'compatible' is
7326 set and to the Vim default value when 'compatible' is reset.
7327
7328 *'wildcharm'* *'wcm'*
7329'wildcharm' 'wcm' number (default: none (0))
7330 global
7331 {not in Vi}
7332 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007333 recognized when used inside a macro. You can find "spare" command-line
7334 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007335 you'll never actually type 'wildcharm', just use it in mappings that
7336 automatically invoke completion mode, e.g.: >
7337 :set wcm=<C-Z>
7338 :cmap ss so $vim/sessions/*.vim<C-Z>
7339< Then after typing :ss you can use CTRL-P & CTRL-N.
7340
7341 *'wildignore'* *'wig'*
7342'wildignore' 'wig' string (default "")
7343 global
7344 {not in Vi}
7345 {not available when compiled without the |+wildignore|
7346 feature}
7347 A list of file patterns. A file that matches with one of these
7348 patterns is ignored when completing file or directory names.
7349 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7350 Also see 'suffixes'.
7351 Example: >
7352 :set wildignore=*.o,*.obj
7353< The use of |:set+=| and |:set-=| is preferred when adding or removing
7354 a pattern from the list. This avoids problems when a future version
7355 uses another default.
7356
7357 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7358'wildmenu' 'wmnu' boolean (default off)
7359 global
7360 {not in Vi}
7361 {not available if compiled without the |+wildmenu|
7362 feature}
7363 When 'wildmenu' is on, command-line completion operates in an enhanced
7364 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7365 the possible matches are shown just above the command line, with the
7366 first match highlighted (overwriting the status line, if there is
7367 one). Keys that show the previous/next match, such as <Tab> or
7368 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7369 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7370 specified. "longest" and "list" do not start "wildmenu" mode.
7371 If there are more matches than can fit in the line, a ">" is shown on
7372 the right and/or a "<" is shown on the left. The status line scrolls
7373 as needed.
7374 The "wildmenu" mode is abandoned when a key is hit that is not used
7375 for selecting a completion.
7376 While the "wildmenu" is active the following keys have special
7377 meanings:
7378
7379 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7380 <Down> - in filename/menu name completion: move into a
7381 subdirectory or submenu.
7382 <CR> - in menu completion, when the cursor is just after a
7383 dot: move into a submenu.
7384 <Up> - in filename/menu name completion: move up into
7385 parent directory or parent menu.
7386
7387 This makes the menus accessible from the console |console-menus|.
7388
7389 If you prefer the <Left> and <Right> keys to move the cursor instead
7390 of selecting a different match, use this: >
7391 :cnoremap <Left> <Space><BS><Left>
7392 :cnoremap <Right> <Space><BS><Right>
7393<
7394 The "WildMenu" highlighting is used for displaying the current match
7395 |hl-WildMenu|.
7396
7397 *'wildmode'* *'wim'*
7398'wildmode' 'wim' string (Vim default: "full")
7399 global
7400 {not in Vi}
7401 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007402 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00007403 part specifies what to do for each consecutive use of 'wildchar. The
7404 first part specifies the behavior for the first use of 'wildchar',
7405 The second part for the second use, etc.
7406 These are the possible values for each part:
7407 "" Complete only the first match.
7408 "full" Complete the next full match. After the last match,
7409 the original string is used and then the first match
7410 again.
7411 "longest" Complete till longest common string. If this doesn't
7412 result in a longer string, use the next part.
7413 "longest:full" Like "longest", but also start 'wildmenu' if it is
7414 enabled.
7415 "list" When more than one match, list all matches.
7416 "list:full" When more than one match, list all matches and
7417 complete first match.
7418 "list:longest" When more than one match, list all matches and
7419 complete till longest common string.
7420 When there is only a single match, it is fully completed in all cases.
7421
7422 Examples: >
7423 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007424< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007425 :set wildmode=longest,full
7426< Complete longest common string, then each full match >
7427 :set wildmode=list:full
7428< List all matches and complete each full match >
7429 :set wildmode=list,full
7430< List all matches without completing, then each full match >
7431 :set wildmode=longest,list
7432< Complete longest common string, then list alternatives.
7433
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007434 *'wildoptions'* *'wop'*
7435'wildoptions' 'wop' string (default "")
7436 global
7437 {not in Vi}
7438 {not available when compiled without the |+wildignore|
7439 feature}
7440 A list of words that change how command line completion is done.
7441 Currently only one word is allowed:
7442 tagfile When using CTRL-D to list matching tags, the kind of
7443 tag and the file of the tag is listed. Only one match
7444 is displayed per line. Often used tag kinds are:
7445 d #define
7446 f function
7447 Also see |cmdline-completion|.
7448
Bram Moolenaar071d4272004-06-13 20:20:40 +00007449 *'winaltkeys'* *'wak'*
7450'winaltkeys' 'wak' string (default "menu")
7451 global
7452 {not in Vi}
7453 {only used in Win32, Motif, GTK and Photon GUI}
7454 Some GUI versions allow the access to menu entries by using the ALT
7455 key in combination with a character that appears underlined in the
7456 menu. This conflicts with the use of the ALT key for mappings and
7457 entering special characters. This option tells what to do:
7458 no Don't use ALT keys for menus. ALT key combinations can be
7459 mapped, but there is no automatic handling. This can then be
7460 done with the |:simalt| command.
7461 yes ALT key handling is done by the windowing system. ALT key
7462 combinations cannot be mapped.
7463 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007464 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007465 keys can be mapped.
7466 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7467 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007468 This option is not used for <F10>; on Win32 and with GTK <F10> will
7469 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007470
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007471 *'window'* *'wi'*
7472'window' 'wi' number (default screen height - 1)
7473 global
7474 Window height. Do not confuse this with the height of the Vim window,
7475 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007476 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7477 value is smaller than 'lines' minus one. The screen will scroll
7478 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007479 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7480 in a much smarter way, taking care of wrapping lines.
7481 When resizing the Vim window, the value is smaller than 1 or more than
7482 or equal to 'lines' it will be set to 'lines' minus 1.
7483 {Vi also uses the option to specify the number of displayed lines}
7484
Bram Moolenaar071d4272004-06-13 20:20:40 +00007485 *'winheight'* *'wh'* *E591*
7486'winheight' 'wh' number (default 1)
7487 global
7488 {not in Vi}
7489 {not available when compiled without the +windows
7490 feature}
7491 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007492 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007493 current window is smaller, its size is increased, at the cost of the
7494 height of other windows. Set it to 999 to make the current window
7495 always fill the screen (although this has the drawback that ":all"
7496 will create only two windows). Set it to a small number for normal
7497 editing.
7498 Minimum value is 1.
7499 The height is not adjusted after one of the commands to change the
7500 height of the current window.
7501 'winheight' applies to the current window. Use 'winminheight' to set
7502 the minimal height for other windows.
7503
7504 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7505'winfixheight' 'wfh' boolean (default off)
7506 local to window
7507 {not in Vi}
7508 {not available when compiled without the +windows
7509 feature}
7510 Keep the window height when windows are opened or closed and
7511 'equalalways' is set. Set by default for the |preview-window| and
7512 |quickfix-window|.
7513 The height may be changed anyway when running out of room.
7514
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007515 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7516'winfixwidth' 'wfw' boolean (default off)
7517 local to window
7518 {not in Vi}
7519 {not available when compiled without the +windows
7520 feature}
7521 Keep the window width when windows are opened or closed and
7522 'equalalways' is set.
7523 The width may be changed anyway when running out of room.
7524
Bram Moolenaar071d4272004-06-13 20:20:40 +00007525 *'winminheight'* *'wmh'*
7526'winminheight' 'wmh' number (default 1)
7527 global
7528 {not in Vi}
7529 {not available when compiled without the +windows
7530 feature}
7531 The minimal height of a window, when it's not the current window.
7532 This is a hard minimum, windows will never become smaller.
7533 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7534 status bar) if necessary. They will return to at least one line when
7535 they become active (since the cursor has to have somewhere to go.)
7536 Use 'winheight' to set the minimal height of the current window.
7537 This option is only checked when making a window smaller. Don't use a
7538 large number, it will cause errors when opening more than a few
7539 windows. A value of 0 to 3 is reasonable.
7540
7541 *'winminwidth'* *'wmw'*
7542'winminwidth' 'wmw' number (default 1)
7543 global
7544 {not in Vi}
7545 {not available when compiled without the +vertsplit
7546 feature}
7547 The minimal width of a window, when it's not the current window.
7548 This is a hard minimum, windows will never become smaller.
7549 When set to zero, windows may be "squashed" to zero columns (i.e. just
7550 a vertical separator) if necessary. They will return to at least one
7551 line when they become active (since the cursor has to have somewhere
7552 to go.)
7553 Use 'winwidth' to set the minimal width of the current window.
7554 This option is only checked when making a window smaller. Don't use a
7555 large number, it will cause errors when opening more than a few
7556 windows. A value of 0 to 12 is reasonable.
7557
7558 *'winwidth'* *'wiw'* *E592*
7559'winwidth' 'wiw' number (default 20)
7560 global
7561 {not in Vi}
7562 {not available when compiled without the +vertsplit
7563 feature}
7564 Minimal number of columns for the current window. This is not a hard
7565 minimum, Vim will use fewer columns if there is not enough room. If
7566 the current window is smaller, its size is increased, at the cost of
7567 the width of other windows. Set it to 999 to make the current window
7568 always fill the screen. Set it to a small number for normal editing.
7569 The width is not adjusted after one of the commands to change the
7570 width of the current window.
7571 'winwidth' applies to the current window. Use 'winminwidth' to set
7572 the minimal width for other windows.
7573
7574 *'wrap'* *'nowrap'*
7575'wrap' boolean (default on)
7576 local to window
7577 {not in Vi}
7578 This option changes how text is displayed. It doesn't change the text
7579 in the buffer, see 'textwidth' for that.
7580 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007581 displaying continues on the next line. When off lines will not wrap
7582 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007583 moved to a part that is not shown, the screen will scroll
7584 horizontally.
7585 The line will be broken in the middle of a word if necessary. See
7586 'linebreak' to get the break at a word boundary.
7587 To make scrolling horizontally a bit more useful, try this: >
7588 :set sidescroll=5
7589 :set listchars+=precedes:<,extends:>
7590< See 'sidescroll', 'listchars' and |wrap-off|.
7591
7592 *'wrapmargin'* *'wm'*
7593'wrapmargin' 'wm' number (default 0)
7594 local to buffer
7595 Number of characters from the right window border where wrapping
7596 starts. When typing text beyond this limit, an <EOL> will be inserted
7597 and inserting continues on the next line.
7598 Options that add a margin, such as 'number' and 'foldcolumn', cause
7599 the text width to be further reduced. This is Vi compatible.
7600 When 'textwidth' is non-zero, this option is not used.
7601 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7602 and less usefully}
7603
7604 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7605'wrapscan' 'ws' boolean (default on) *E384* *E385*
7606 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007607 Searches wrap around the end of the file. Also applies to |]s| and
7608 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007609
7610 *'write'* *'nowrite'*
7611'write' boolean (default on)
7612 global
7613 {not in Vi}
7614 Allows writing files. When not set, writing a file is not allowed.
7615 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007616 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007617 argument. Filtering text is still possible, even though this requires
7618 writing a temporary file.
7619
7620 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7621'writeany' 'wa' boolean (default off)
7622 global
7623 Allows writing to any file with no need for "!" override.
7624
7625 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7626'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7627 otherwise)
7628 global
7629 {not in Vi}
7630 Make a backup before overwriting a file. The backup is removed after
7631 the file was successfully written, unless the 'backup' option is
7632 also on. Reset this option if your file system is almost full. See
7633 |backup-table| for another explanation.
7634 When the 'backupskip' pattern matches, a backup is not made anyway.
7635 NOTE: This option is set to the default value when 'compatible' is
7636 set.
7637
7638 *'writedelay'* *'wd'*
7639'writedelay' 'wd' number (default 0)
7640 global
7641 {not in Vi}
7642 The number of microseconds to wait for each character sent to the
7643 screen. When non-zero, characters are sent to the terminal one by
7644 one. For MS-DOS pcterm this does not work. For debugging purposes.
7645
7646 vim:tw=78:ts=8:ft=help:norl: