blob: 1b18f804c93b4105c197a9be57500035c22acdd5 [file] [log] [blame]
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001*options.txt* For Vim version 7.0e. Last change: 2006 Apr 18
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 Moolenaarc1e37902006-04-18 21:55:01 +00001654 longest Only insert the longest common text of the matches. If
1655 the menu is displayed you can use CTRL-L to add more
1656 characters. Whether case is ignored depends on the kind
1657 of completion. For buffer text the 'ignorecase' option is
1658 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001659
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001660 preview Show extra information about the currently selected
1661 completion in the preview window.
1662
Bram Moolenaar071d4272004-06-13 20:20:40 +00001663 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1664'confirm' 'cf' boolean (default off)
1665 global
1666 {not in Vi}
1667 When 'confirm' is on, certain operations that would normally
1668 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1669 instead raise a |dialog| asking if you wish to save the current
1670 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1671 If 'confirm' is off you can still activate confirmation for one
1672 command only (this is most useful in mappings) with the |:confirm|
1673 command.
1674 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1675
1676 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1677'conskey' 'consk' boolean (default off)
1678 global
1679 {not in Vi} {only for MS-DOS}
1680 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001681 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001682 three methods of console input are available:
1683 'conskey' 'bioskey' action ~
1684 on on or off direct console input
1685 off on BIOS
1686 off off STDIN
1687
1688 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1689'copyindent' 'ci' boolean (default off)
1690 local to buffer
1691 {not in Vi}
1692 Copy the structure of the existing lines indent when autoindenting a
1693 new line. Normally the new indent is reconstructed by a series of
1694 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1695 in which case only spaces are used). Enabling this option makes the
1696 new line copy whatever characters were used for indenting on the
1697 existing line. If the new indent is greater than on the existing
1698 line, the remaining space is filled in the normal manner.
1699 NOTE: 'copyindent' is reset when 'compatible' is set.
1700 Also see 'preserveindent'.
1701
1702 *'cpoptions'* *'cpo'*
1703'cpoptions' 'cpo' string (Vim default: "aABceFs",
1704 Vi default: all flags)
1705 global
1706 {not in Vi}
1707 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001708 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001709 not being vi-compatible is mostly or sometimes preferred.
1710 'cpoptions' stands for "compatible-options".
1711 Commas can be added for readability.
1712 To avoid problems with flags that are added in the future, use the
1713 "+=" and "-=" feature of ":set" |add-option-flags|.
1714 NOTE: This option is set to the Vi default value when 'compatible' is
1715 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001716 NOTE: This option is set to the POSIX default value at startup when
1717 the Vi default value would be used and the $VIM_POSIX environment
1718 variable exists |posix|. This means tries to behave like the POSIX
1719 specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001720
1721 contains behavior ~
1722 *cpo-a*
1723 a When included, a ":read" command with a file name
1724 argument will set the alternate file name for the
1725 current window.
1726 *cpo-A*
1727 A When included, a ":write" command with a file name
1728 argument will set the alternate file name for the
1729 current window.
1730 *cpo-b*
1731 b "\|" in a ":map" command is recognized as the end of
1732 the map command. The '\' is included in the mapping,
1733 the text after the '|' is interpreted as the next
1734 command. Use a CTRL-V instead of a backslash to
1735 include the '|' in the mapping. Applies to all
1736 mapping, abbreviation, menu and autocmd commands.
1737 See also |map_bar|.
1738 *cpo-B*
1739 B A backslash has no special meaning in mappings,
1740 abbreviations and the "to" part of the menu commands.
1741 Remove this flag to be able to use a backslash like a
1742 CTRL-V. For example, the command ":map X \<Esc>"
1743 results in X being mapped to:
1744 'B' included: "\^[" (^[ is a real <Esc>)
1745 'B' excluded: "<Esc>" (5 characters)
1746 ('<' excluded in both cases)
1747 *cpo-c*
1748 c Searching continues at the end of any match at the
1749 cursor position, but not further than the start of the
1750 next line. When not present searching continues
1751 one character from the cursor position. With 'c'
1752 "abababababab" only gets three matches when repeating
1753 "/abab", without 'c' there are five matches.
1754 *cpo-C*
1755 C Do not concatenate sourced lines that start with a
1756 backslash. See |line-continuation|.
1757 *cpo-d*
1758 d Using "./" in the 'tags' option doesn't mean to use
1759 the tags file relative to the current file, but the
1760 tags file in the current directory.
1761 *cpo-D*
1762 D Can't use CTRL-K to enter a digraph after Normal mode
1763 commands with a character argument, like |r|, |f| and
1764 |t|.
1765 *cpo-e*
1766 e When executing a register with ":@r", always add a
1767 <CR> to the last line, also when the register is not
1768 linewise. If this flag is not present, the register
1769 is not linewise and the last line does not end in a
1770 <CR>, then the last line is put on the command-line
1771 and can be edited before hitting <CR>.
1772 *cpo-E*
1773 E It is an error when using "y", "d", "c", "g~", "gu" or
1774 "gU" on an Empty region. The operators only work when
1775 at least one character is to be operate on. Example:
1776 This makes "y0" fail in the first column.
1777 *cpo-f*
1778 f When included, a ":read" command with a file name
1779 argument will set the file name for the current buffer,
1780 if the current buffer doesn't have a file name yet.
1781 *cpo-F*
1782 F When included, a ":write" command with a file name
1783 argument will set the file name for the current
1784 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001785 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001786 *cpo-g*
1787 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001788 *cpo-H*
1789 H When using "I" on a line with only blanks, insert
1790 before the last blank. Without this flag insert after
1791 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001792 *cpo-i*
1793 i When included, interrupting the reading of a file will
1794 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001795 *cpo-I*
1796 I When moving the cursor up or down just after inserting
1797 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001798 *cpo-j*
1799 j When joining lines, only add two spaces after a '.',
1800 not after '!' or '?'. Also see 'joinspaces'.
1801 *cpo-J*
1802 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001803 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001804 white space.
1805 *cpo-k*
1806 k Disable the recognition of raw key codes in
1807 mappings, abbreviations, and the "to" part of menu
1808 commands. For example, if <Key> sends ^[OA (where ^[
1809 is <Esc>), the command ":map X ^[OA" results in X
1810 being mapped to:
1811 'k' included: "^[OA" (3 characters)
1812 'k' excluded: "<Key>" (one key code)
1813 Also see the '<' flag below.
1814 *cpo-K*
1815 K Don't wait for a key code to complete when it is
1816 halfway a mapping. This breaks mapping <F1><F1> when
1817 only part of the second <F1> has been read. It
1818 enables cancelling the mapping by typing <F1><Esc>.
1819 *cpo-l*
1820 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001821 literally, only "\]", "\^", "\-" and "\\" are special.
1822 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001823 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1824 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001825 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001826 *cpo-L*
1827 L When the 'list' option is set, 'wrapmargin',
1828 'textwidth', 'softtabstop' and Virtual Replace mode
1829 (see |gR|) count a <Tab> as two characters, instead of
1830 the normal behavior of a <Tab>.
1831 *cpo-m*
1832 m When included, a showmatch will always wait half a
1833 second. When not included, a showmatch will wait half
1834 a second or until a character is typed. |'showmatch'|
1835 *cpo-M*
1836 M When excluded, "%" matching will take backslashes into
1837 account. Thus in "( \( )" and "\( ( \)" the outer
1838 parenthesis match. When included "%" ignores
1839 backslashes, which is Vi compatible.
1840 *cpo-n*
1841 n When included, the column used for 'number' will also
1842 be used for text of wrapped lines.
1843 *cpo-o*
1844 o Line offset to search command is not remembered for
1845 next search.
1846 *cpo-O*
1847 O Don't complain if a file is being overwritten, even
1848 when it didn't exist when editing it. This is a
1849 protection against a file unexpectedly created by
1850 someone else. Vi didn't complain about this.
1851 *cpo-p*
1852 p Vi compatible Lisp indenting. When not present, a
1853 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001854 *cpo-P*
1855 P When included, a ":write" command that appends to a
1856 file will set the file name for the current buffer, if
1857 the current buffer doesn't have a file name yet and
1858 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001859 *cpo-q*
1860 q When joining multiple lines leave the cursor at the
1861 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001862 *cpo-r*
1863 r Redo ("." command) uses "/" to repeat a search
1864 command, instead of the actually used search string.
1865 *cpo-R*
1866 R Remove marks from filtered lines. Without this flag
1867 marks are kept like |:keepmarks| was used.
1868 *cpo-s*
1869 s Set buffer options when entering the buffer for the
1870 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001871 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001872 set when the buffer is created.
1873 *cpo-S*
1874 S Set buffer options always when entering a buffer
1875 (except 'readonly', 'fileformat', 'filetype' and
1876 'syntax'). This is the (most) Vi compatible setting.
1877 The options are set to the values in the current
1878 buffer. When you change an option and go to another
1879 buffer, the value is copied. Effectively makes the
1880 buffer options global to all buffers.
1881
1882 's' 'S' copy buffer options
1883 no no when buffer created
1884 yes no when buffer first entered (default)
1885 X yes each time when buffer entered (vi comp.)
1886 *cpo-t*
1887 t Search pattern for the tag command is remembered for
1888 "n" command. Otherwise Vim only puts the pattern in
1889 the history for search pattern, but doesn't change the
1890 last used search pattern.
1891 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001892 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001893 *cpo-v*
1894 v Backspaced characters remain visible on the screen in
1895 Insert mode. Without this flag the characters are
1896 erased from the screen right away. With this flag the
1897 screen newly typed text overwrites backspaced
1898 characters.
1899 *cpo-w*
1900 w When using "cw" on a blank character, only change one
1901 character and not all blanks until the start of the
1902 next word.
1903 *cpo-W*
1904 W Don't overwrite a readonly file. When omitted, ":w!"
1905 overwrites a readonly file, if possible.
1906 *cpo-x*
1907 x <Esc> on the command-line executes the command-line.
1908 The default in Vim is to abandon the command-line,
1909 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001910 *cpo-X*
1911 X When using a count with "R" the replaced text is
1912 deleted only once. Also when repeating "R" with "."
1913 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001914 *cpo-y*
1915 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001916 *cpo-Z*
1917 Z When using "w!" while the 'readonly' option is set,
1918 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001919 *cpo-!*
1920 ! When redoing a filter command, use the last used
1921 external command, whatever it was. Otherwise the last
1922 used -filter- command is used.
1923 *cpo-$*
1924 $ When making a change to one line, don't redisplay the
1925 line, but put a '$' at the end of the changed text.
1926 The changed text will be overwritten when you type the
1927 new text. The line is redisplayed if you type any
1928 command that moves the cursor from the insertion
1929 point.
1930 *cpo-%*
1931 % Vi-compatible matching is done for the "%" command.
1932 Does not recognize "#if", "#endif", etc.
1933 Does not recognize "/*" and "*/".
1934 Parens inside single and double quotes are also
1935 counted, causing a string that contains a paren to
1936 disturb the matching. For example, in a line like
1937 "if (strcmp("foo(", s))" the first paren does not
1938 match the last one. When this flag is not included,
1939 parens inside single and double quotes are treated
1940 specially. When matching a paren outside of quotes,
1941 everything inside quotes is ignored. When matching a
1942 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001943 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001944 This flag is also used for other features, such as
1945 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001946 *cpo--*
1947 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001948 it would go above the first line or below the last
1949 line. Without it the cursor moves to the first or
1950 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001951 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001952 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001953 *cpo-+*
1954 + When included, a ":write file" command will reset the
1955 'modified' flag of the buffer, even though the buffer
1956 itself may still be different from its file.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001957 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001958 * Use ":*" in the same way as ":@". When not included,
1959 ":*" is an alias for ":'<,'>", select the Visual area.
1960 *cpo-<*
1961 < Disable the recognition of special key codes in |<>|
1962 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001963 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001964 ":map X <Tab>" results in X being mapped to:
1965 '<' included: "<Tab>" (5 characters)
1966 '<' excluded: "^I" (^I is a real <Tab>)
1967 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001968 *cpo->*
1969 > When appending to a register, put a line break before
1970 the appended text.
1971
1972 POSIX flags. These are not included in the Vi default value, except
1973 when $VIM_POSIX was set on startup. |posix|
1974
1975 contains behavior ~
1976 *cpo-#*
1977 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001978 *cpo-&*
1979 & When ":preserve" was used keep the swap file when
1980 exiting normally while this buffer is still loaded.
1981 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001982 *cpo-\*
1983 \ Backslash in a [] range in a search pattern is taken
1984 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00001985 '\' included: "/[ \-]" finds <Space>, '\' and '-'
1986 '\' excluded: "/[ \-]" finds <Space> and '-'
1987 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001988 *cpo-/*
1989 / When "%" is used as the replacement string in a |:s|
1990 command, use the previous replacement string. |:s%|
1991 *cpo-{*
1992 { The |{| and |}| commands also stop at a "{" character
1993 at the start of a line.
1994 *cpo-.*
1995 . The ":chdir" and ":cd" commands fail if the current
1996 buffer is modified, unless ! is used. Vim doesn't
1997 need this, since it remembers the full path of an
1998 opened file.
1999 *cpo-bar*
2000 | The value of the $LINES and $COLUMNS environment
2001 variables overrule the terminal size values obtained
2002 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002003
Bram Moolenaar071d4272004-06-13 20:20:40 +00002004
2005 *'cscopepathcomp'* *'cspc'*
2006'cscopepathcomp' 'cspc' number (default 0)
2007 global
2008 {not available when compiled without the |+cscope|
2009 feature}
2010 {not in Vi}
2011 Determines how many components of the path to show in a list of tags.
2012 See |cscopepathcomp|.
2013
2014 *'cscopeprg'* *'csprg'*
2015'cscopeprg' 'csprg' string (default "cscope")
2016 global
2017 {not available when compiled without the |+cscope|
2018 feature}
2019 {not in Vi}
2020 Specifies the command to execute cscope. See |cscopeprg|.
2021 This option cannot be set from a |modeline| or in the |sandbox|, for
2022 security reasons.
2023
2024 *'cscopequickfix'* *'csqf'*
2025'cscopequickfix' 'csqf' string (default "")
2026 global
2027 {not available when compiled without the |+cscope|
2028 or |+quickfix| features}
2029 {not in Vi}
2030 Specifies whether to use quickfix window to show cscope results.
2031 See |cscopequickfix|.
2032
2033 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2034'cscopetag' 'cst' boolean (default off)
2035 global
2036 {not available when compiled without the |+cscope|
2037 feature}
2038 {not in Vi}
2039 Use cscope for tag commands. See |cscope-options|.
2040 NOTE: This option is reset when 'compatible' is set.
2041
2042 *'cscopetagorder'* *'csto'*
2043'cscopetagorder' 'csto' number (default 0)
2044 global
2045 {not available when compiled without the |+cscope|
2046 feature}
2047 {not in Vi}
2048 Determines the order in which ":cstag" performs a search. See
2049 |cscopetagorder|.
2050 NOTE: This option is set to 0 when 'compatible' is set.
2051
2052 *'cscopeverbose'* *'csverb'*
2053 *'nocscopeverbose'* *'nocsverb'*
2054'cscopeverbose' 'csverb' boolean (default off)
2055 global
2056 {not available when compiled without the |+cscope|
2057 feature}
2058 {not in Vi}
2059 Give messages when adding a cscope database. See |cscopeverbose|.
2060 NOTE: This option is reset when 'compatible' is set.
2061
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002062
2063 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2064'cursorcolumn' 'cuc' boolean (default off)
2065 local to window
2066 {not in Vi}
2067 {not available when compiled without the |+syntax|
2068 feature}
2069 Highlight the screen column of the cursor with CursorColumn
2070 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2071 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002072 If you only want the highlighting in the current window you can use
2073 these autocommands: >
2074 au WinLeave * set nocursorline nocursorcolumn
2075 au WinEnter * set cursorline cursorcolumn
2076<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002077
2078 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2079'cursorline' 'cul' boolean (default off)
2080 local to window
2081 {not in Vi}
2082 {not available when compiled without the |+syntax|
2083 feature}
2084 Highlight the screen line of the cursor with CursorLine
2085 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2086 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002087 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002088 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002089
2090
Bram Moolenaar071d4272004-06-13 20:20:40 +00002091 *'debug'*
2092'debug' string (default "")
2093 global
2094 {not in Vi}
2095 When set to "msg", error messages that would otherwise be omitted will
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002096 be given anyway. This is useful when debugging 'foldexpr',
2097 'formatexpr' or 'indentexpr'.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002098 When set to "beep", a message will be given when otherwise only a beep
2099 would be produced.
2100 The values can be combined, separated by a comma.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002101
2102 *'define'* *'def'*
2103'define' 'def' string (default "^\s*#\s*define")
2104 global or local to buffer |global-local|
2105 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002106 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002107 pattern, just like for the "/" command. This option is used for the
2108 commands like "[i" and "[d" |include-search|. The 'isident' option is
2109 used to recognize the defined name after the match:
2110 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2111 See |option-backslash| about inserting backslashes to include a space
2112 or backslash.
2113 The default value is for C programs. For C++ this value would be
2114 useful, to include const type declarations: >
2115 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2116< When using the ":set" command, you need to double the backslashes!
2117
2118 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2119'delcombine' 'deco' boolean (default off)
2120 global
2121 {not in Vi}
2122 {only available when compiled with the |+multi_byte|
2123 feature}
2124 If editing Unicode and this option is set, backspace and Normal mode
2125 "x" delete each combining character on its own. When it is off (the
2126 default) the character along with its combining characters are
2127 deleted.
2128 Note: When 'delcombine' is set "xx" may work different from "2x"!
2129
2130 This is useful for Arabic, Hebrew and many other languages where one
2131 may have combining characters overtop of base characters, and want
2132 to remove only the combining ones.
2133
2134 *'dictionary'* *'dict'*
2135'dictionary' 'dict' string (default "")
2136 global or local to buffer |global-local|
2137 {not in Vi}
2138 List of file names, separated by commas, that are used to lookup words
2139 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2140 contain a list of words. This can be one word per line, or several
2141 words per line, separated by non-keyword characters (white space is
2142 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002143 When this option is empty, or an entry "spell" is present, spell
2144 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002145 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002146 after a comma are ignored, otherwise spaces are included in the file
2147 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002148 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002149 Where to find a list of words?
2150 - On FreeBSD, there is the file "/usr/share/dict/words".
2151 - In the Simtel archive, look in the "msdos/linguist" directory.
2152 - In "miscfiles" of the GNU collection.
2153 The use of |:set+=| and |:set-=| is preferred when adding or removing
2154 directories from the list. This avoids problems when a future version
2155 uses another default.
2156 Backticks cannot be used in this option for security reasons.
2157
2158 *'diff'* *'nodiff'*
2159'diff' boolean (default off)
2160 local to window
2161 {not in Vi}
2162 {not available when compiled without the |+diff|
2163 feature}
2164 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002165 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002166
2167 *'dex'* *'diffexpr'*
2168'diffexpr' 'dex' string (default "")
2169 global
2170 {not in Vi}
2171 {not available when compiled without the |+diff|
2172 feature}
2173 Expression which is evaluated to obtain an ed-style diff file from two
2174 versions of a file. See |diff-diffexpr|.
2175 This option cannot be set from a |modeline| or in the |sandbox|, for
2176 security reasons.
2177
2178 *'dip'* *'diffopt'*
2179'diffopt' 'dip' string (default "filler")
2180 global
2181 {not in Vi}
2182 {not available when compiled without the |+diff|
2183 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002184 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002185 All are optional. Items must be separated by a comma.
2186
2187 filler Show filler lines, to keep the text
2188 synchronized with a window that has inserted
2189 lines at the same position. Mostly useful
2190 when windows are side-by-side and 'scrollbind'
2191 is set.
2192
2193 context:{n} Use a context of {n} lines between a change
2194 and a fold that contains unchanged lines.
2195 When omitted a context of six lines is used.
2196 See |fold-diff|.
2197
2198 icase Ignore changes in case of text. "a" and "A"
2199 are considered the same. Adds the "-i" flag
2200 to the "diff" command if 'diffexpr' is empty.
2201
2202 iwhite Ignore changes in amount of white space. Adds
2203 the "-b" flag to the "diff" command if
2204 'diffexpr' is empty. Check the documentation
2205 of the "diff" command for what this does
2206 exactly. It should ignore adding trailing
2207 white space, but not leading white space.
2208
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002209 horizontal Start diff mode with horizontal splits (unless
2210 explicitly specified otherwise).
2211
2212 vertical Start diff mode with vertical splits (unless
2213 explicitly specified otherwise).
2214
2215 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2216 starting diff mode. Without this 2 is used.
2217
Bram Moolenaar071d4272004-06-13 20:20:40 +00002218 Examples: >
2219
2220 :set diffopt=filler,context:4
2221 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002222 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002223<
2224 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2225'digraph' 'dg' boolean (default off)
2226 global
2227 {not in Vi}
2228 {not available when compiled without the |+digraphs|
2229 feature}
2230 Enable the entering of digraphs in Insert mode with {char1} <BS>
2231 {char2}. See |digraphs|.
2232 NOTE: This option is reset when 'compatible' is set.
2233
2234 *'directory'* *'dir'*
2235'directory' 'dir' string (default for Amiga: ".,t:",
2236 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2237 for Unix: ".,~/tmp,/var/tmp,/tmp")
2238 global
2239 List of directory names for the swap file, separated with commas.
2240 - The swap file will be created in the first directory where this is
2241 possible.
2242 - Empty means that no swap file will be used (recovery is
2243 impossible!).
2244 - A directory "." means to put the swap file in the same directory as
2245 the edited file. On Unix, a dot is prepended to the file name, so
2246 it doesn't show in a directory listing. On MS-Windows the "hidden"
2247 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002248 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002249 put the swap file relative to where the edited file is. The leading
2250 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002251 - For Unix and Win32, if a directory ends in two path separators "//"
2252 or "\\", the swap file name will be built from the complete path to
2253 the file with all path separators substituted to percent '%' signs.
2254 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002255 - Spaces after the comma are ignored, other spaces are considered part
2256 of the directory name. To have a space at the start of a directory
2257 name, precede it with a backslash.
2258 - To include a comma in a directory name precede it with a backslash.
2259 - A directory name may end in an ':' or '/'.
2260 - Environment variables are expanded |:set_env|.
2261 - Careful with '\' characters, type one before a space, type two to
2262 get one in the option (see |option-backslash|), for example: >
2263 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2264< - For backwards compatibility with Vim version 3.0 a '>' at the start
2265 of the option is removed.
2266 Using "." first in the list is recommended. This means that editing
2267 the same file twice will result in a warning. Using "/tmp" on Unix is
2268 discouraged: When the system crashes you lose the swap file.
2269 "/var/tmp" is often not cleared when rebooting, thus is a better
2270 choice than "/tmp". But it can contain a lot of files, your swap
2271 files get lost in the crowd. That is why a "tmp" directory in your
2272 home directory is tried first.
2273 The use of |:set+=| and |:set-=| is preferred when adding or removing
2274 directories from the list. This avoids problems when a future version
2275 uses another default.
2276 This option cannot be set from a |modeline| or in the |sandbox|, for
2277 security reasons.
2278 {Vi: directory to put temp file in, defaults to "/tmp"}
2279
2280 *'display'* *'dy'*
2281'display' 'dy' string (default "")
2282 global
2283 {not in Vi}
2284 Change the way text is displayed. This is comma separated list of
2285 flags:
2286 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002287 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002288 last line that doesn't fit is replaced with "@" lines.
2289 uhex Show unprintable characters hexadecimal as <xx>
2290 instead of using ^C and ~C.
2291
2292 *'eadirection'* *'ead'*
2293'eadirection' 'ead' string (default "both")
2294 global
2295 {not in Vi}
2296 {not available when compiled without the +vertsplit
2297 feature}
2298 Tells when the 'equalalways' option applies:
2299 ver vertically, width of windows is not affected
2300 hor horizontally, height of windows is not affected
2301 both width and height of windows is affected
2302
2303 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2304'edcompatible' 'ed' boolean (default off)
2305 global
2306 Makes the 'g' and 'c' flags of the ":substitute" command to be
2307 toggled each time the flag is given. See |complex-change|. See
2308 also 'gdefault' option.
2309 Switching this option on is discouraged!
2310
2311 *'encoding'* *'enc'* *E543*
2312'encoding' 'enc' string (default: "latin1" or value from $LANG)
2313 global
2314 {only available when compiled with the |+multi_byte|
2315 feature}
2316 {not in Vi}
2317 Sets the character encoding used inside Vim. It applies to text in
2318 the buffers, registers, Strings in expressions, text stored in the
2319 viminfo file, etc. It sets the kind of characters which Vim can work
2320 with. See |encoding-names| for the possible values.
2321
2322 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002323 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002324 It should normally be kept at its default value, or set when Vim
2325 starts up. See |multibyte|.
2326
2327 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2328 "utf-8". Although care has been taken to allow different values of
2329 'encoding', "utf-8" is the natural choice for the environment and
2330 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002331 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002332 versions, and to avoid changing the encoding of newly created files
2333 without your knowledge (in case 'fileencodings' is empty).
2334
2335 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002336 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002337 iconv() or as specified with 'charconvert'.
2338
2339 Normally 'encoding' will be equal to your current locale. This will
2340 be the default if Vim recognizes your environment settings. If
2341 'encoding' is not set to the current locale, 'termencoding' must be
2342 set to convert typed and displayed text. See |encoding-table|.
2343
2344 When you set this option, it fires the |EncodingChanged| autocommand
2345 event so that you can set up fonts if necessary.
2346
2347 When the option is set, the value is converted to lowercase. Thus
2348 you can set it with uppercase values too. Underscores are translated
2349 to '-' signs.
2350 When the encoding is recognized, it is changed to the standard name.
2351 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2352 "iso-8859-2" and "utf8" becomes "utf-8".
2353
2354 Note: "latin1" is also used when the encoding could not be detected.
2355 This only works when editing files in the same encoding! When the
2356 actual character set is not latin1, make sure 'fileencoding' and
2357 'fileencodings' are empty. When conversion is needed, switch to using
2358 utf-8.
2359
2360 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2361 You don't notice this while editing, but it does matter for the
2362 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2363 setting 'encoding' to one of these values instead of utf-8 only has
2364 effect for encoding used for files when 'fileencoding' is empty.
2365
Bram Moolenaar661b1822005-07-28 22:36:45 +00002366 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2367 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002368
2369 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2370'endofline' 'eol' boolean (default on)
2371 local to buffer
2372 {not in Vi}
2373 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002374 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002375 option is automatically set when starting to edit a new file, unless
2376 the file does not have an <EOL> for the last line in the file, in
2377 which case it is reset. Normally you don't have to set or reset this
2378 option. When 'binary' is off the value is not used when writing the
2379 file. When 'binary' is on it is used to remember the presence of a
2380 <EOL> for the last line in the file, so that when you write the file
2381 the situation from the original file can be kept. But you can change
2382 it if you want to.
2383
2384 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2385'equalalways' 'ea' boolean (default on)
2386 global
2387 {not in Vi}
2388 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002389 splitting or closing a window. This also happens the moment the
2390 option is switched on. When off, splitting a window will reduce the
2391 size of the current window and leave the other windows the same. When
2392 closing a window the extra lines are given to the window next to it
2393 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002394 When mixing vertically and horizontally split windows, a minimal size
2395 is computed and some windows may be larger if there is room. The
2396 'eadirection' option tells in which direction the size is affected.
2397 Changing the height of a window can be avoided by setting
2398 'winfixheight'.
2399
2400 *'equalprg'* *'ep'*
2401'equalprg' 'ep' string (default "")
2402 global or local to buffer |global-local|
2403 {not in Vi}
2404 External program to use for "=" command. When this option is empty
2405 the internal formatting functions are used ('lisp', 'cindent' or
2406 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002407 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002408 about including spaces and backslashes.
2409 This option cannot be set from a |modeline| or in the |sandbox|, for
2410 security reasons.
2411
2412 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2413'errorbells' 'eb' boolean (default off)
2414 global
2415 Ring the bell (beep or screen flash) for error messages. This only
2416 makes a difference for error messages, the bell will be used always
2417 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002418 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002419 screen flash or do nothing.
2420
2421 *'errorfile'* *'ef'*
2422'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2423 others: "errors.err")
2424 global
2425 {not in Vi}
2426 {not available when compiled without the |+quickfix|
2427 feature}
2428 Name of the errorfile for the QuickFix mode (see |:cf|).
2429 When the "-q" command-line argument is used, 'errorfile' is set to the
2430 following argument. See |-q|.
2431 NOT used for the ":make" command. See 'makeef' for that.
2432 Environment variables are expanded |:set_env|.
2433 See |option-backslash| about including spaces and backslashes.
2434 This option cannot be set from a |modeline| or in the |sandbox|, for
2435 security reasons.
2436
2437 *'errorformat'* *'efm'*
2438'errorformat' 'efm' string (default is very long)
2439 global or local to buffer |global-local|
2440 {not in Vi}
2441 {not available when compiled without the |+quickfix|
2442 feature}
2443 Scanf-like description of the format for the lines in the error file
2444 (see |errorformat|).
2445
2446 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2447'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2448 global
2449 {not in Vi}
2450 Function keys that start with an <Esc> are recognized in Insert
2451 mode. When this option is off, the cursor and function keys cannot be
2452 used in Insert mode if they start with an <Esc>. The advantage of
2453 this is that the single <Esc> is recognized immediately, instead of
2454 after one second. Instead of resetting this option, you might want to
2455 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2456 when 'esckeys' is off, you can still map anything, but the cursor keys
2457 won't work by default.
2458 NOTE: This option is set to the Vi default value when 'compatible' is
2459 set and to the Vim default value when 'compatible' is reset.
2460
2461 *'eventignore'* *'ei'*
2462'eventignore' 'ei' string (default "")
2463 global
2464 {not in Vi}
2465 {not available when compiled without the |+autocmd|
2466 feature}
2467 A list of autocommand event names, which are to be ignored.
2468 When set to "all", all autocommand events are ignored, autocommands
2469 will not be executed.
2470 Otherwise this is a comma separated list of event names. Example: >
2471 :set ei=WinEnter,WinLeave
2472<
2473 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2474'expandtab' 'et' boolean (default off)
2475 local to buffer
2476 {not in Vi}
2477 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002478 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002479 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2480 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2481 NOTE: This option is reset when 'compatible' is set.
2482
2483 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2484'exrc' 'ex' boolean (default off)
2485 global
2486 {not in Vi}
2487 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2488 directory. If you switch this option on you should also consider
2489 setting the 'secure' option (see |initialization|). Using a local
2490 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2491 also see |.vimrc| and |gui-init|.
2492 This option cannot be set from a |modeline| or in the |sandbox|, for
2493 security reasons.
2494
2495 *'fileencoding'* *'fenc'* *E213*
2496'fileencoding' 'fenc' string (default: "")
2497 local to buffer
2498 {only available when compiled with the |+multi_byte|
2499 feature}
2500 {not in Vi}
2501 Sets the character encoding for the file of this buffer.
2502 When 'fileencoding' is different from 'encoding', conversion will be
2503 done when reading and writing the file.
2504 When 'fileencoding' is empty, the same value as 'encoding' will be
2505 used (no conversion when reading or writing a file).
2506 WARNING: Conversion can cause loss of information! When
2507 'encoding' is "utf-8" conversion is most likely done in a way
2508 that the reverse conversion results in the same text. When
2509 'encoding' is not "utf-8" some characters may be lost!
2510 See 'encoding' for the possible values. Additionally, values may be
2511 specified that can be handled by the converter, see
2512 |mbyte-conversion|.
2513 When reading a file 'fileencoding' will be set from 'fileencodings'.
2514 To read a file in a certain encoding it won't work by setting
2515 'fileencoding', use the |++enc| argument.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002516 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002517 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2518 When the option is set, the value is converted to lowercase. Thus
2519 you can set it with uppercase values too. '_' characters are
2520 replaced with '-'. If a name is recognized from the list for
2521 'encoding', it is replaced by the standard name. For example
2522 "ISO8859-2" becomes "iso-8859-2".
2523 When this option is set, after starting to edit a file, the 'modified'
2524 option is set, because the file would be different when written.
2525 If you do this in a modeline, you might want to set 'nomodified' to
2526 avoid this.
2527 This option can not be changed when 'modifiable' is off.
2528
2529 *'fe'*
2530 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002531 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002532 old short name was 'fe', which is no longer used.
2533
2534 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002535'fileencodings' 'fencs' string (default: "ucs-bom",
2536 "ucs-bom,utf-8,default,latin1" when
2537 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002538 global
2539 {only available when compiled with the |+multi_byte|
2540 feature}
2541 {not in Vi}
2542 This is a list of character encodings considered when starting to edit
2543 an existing file. When a file is read, Vim tries to use the first
2544 mentioned character encoding. If an error is detected, the next one
2545 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002546 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002547 an empty string, which means the value of 'encoding' is used.
2548 WARNING: Conversion can cause loss of information! When
2549 'encoding' is "utf-8" (or one of the other Unicode variants)
2550 conversion is most likely done in a way that the reverse
2551 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002552 "utf-8" some non-ASCII characters may be lost! You can use
2553 the |++bad| argument to specify what is done with characters
2554 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002555 For an empty file or a file with only ASCII characters most encodings
2556 will work and the first entry of 'fileencodings' will be used (except
2557 "ucs-bom", which requires the BOM to be present). If you prefer
2558 another encoding use an BufReadPost autocommand event to test if your
2559 preferred encoding is to be used. Example: >
2560 au BufReadPost * if search('\S', 'w') == 0 |
2561 \ set fenc=iso-2022-jp | endif
2562< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2563 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002564 When the |++enc| argument is used then the value of 'fileencodings' is
2565 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002566 Note that 'fileencodings' is not used for a new file, the global value
2567 of 'fileencoding' is used instead. You can set it with: >
2568 :setglobal fenc=iso-8859-2
2569< This means that a non-existing file may get a different encoding than
2570 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002571 The special value "ucs-bom" can be used to check for a Unicode BOM
2572 (Byte Order Mark) at the start of the file. It must not be preceded
2573 by "utf-8" or another Unicode encoding for this to work properly.
2574 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2575 because Vim cannot detect an error, thus the encoding is always
2576 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002577 The special value "default" can be used for the encoding from the
2578 environment. This is the default value for 'encoding'. It is useful
2579 when 'encoding' is set to "utf-8" and your environment uses a
2580 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002581 When 'encoding' is "utf-8" and a file contains an illegal byte
2582 sequence it won't be recognized as UTF-8. You can use the |8g8|
2583 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002584 WRONG VALUES: WHAT'S WRONG:
2585 latin1,utf-8 "latin1" will always be used
2586 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2587 file
2588 cp1250,latin1 "cp1250" will always be used
2589 If 'fileencodings' is empty, 'fileencoding' is not modified.
2590 See 'fileencoding' for the possible values.
2591 Setting this option does not have an effect until the next time a file
2592 is read.
2593
2594 *'fileformat'* *'ff'*
2595'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2596 Unix default: "unix",
2597 Macintosh default: "mac")
2598 local to buffer
2599 {not in Vi}
2600 This gives the <EOL> of the current buffer, which is used for
2601 reading/writing the buffer from/to a file:
2602 dos <CR> <NL>
2603 unix <NL>
2604 mac <CR>
2605 When "dos" is used, CTRL-Z at the end of a file is ignored.
2606 See |file-formats| and |file-read|.
2607 For the character encoding of the file see 'fileencoding'.
2608 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2609 works like it was set to "unix'.
2610 This option is set automatically when starting to edit a file and
2611 'fileformats' is not empty and 'binary' is off.
2612 When this option is set, after starting to edit a file, the 'modified'
2613 option is set, because the file would be different when written.
2614 This option can not be changed when 'modifiable' is off.
2615 For backwards compatibility: When this option is set to "dos",
2616 'textmode' is set, otherwise 'textmode' is reset.
2617
2618 *'fileformats'* *'ffs'*
2619'fileformats' 'ffs' string (default:
2620 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2621 Vim Unix: "unix,dos",
2622 Vim Mac: "mac,unix,dos",
2623 Vi Cygwin: "unix,dos",
2624 Vi others: "")
2625 global
2626 {not in Vi}
2627 This gives the end-of-line (<EOL>) formats that will be tried when
2628 starting to edit a new buffer and when reading a file into an existing
2629 buffer:
2630 - When empty, the format defined with 'fileformat' will be used
2631 always. It is not set automatically.
2632 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002633 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002634 'fileformats' name will be used when a file is read into an existing
2635 buffer, no matter what 'fileformat' for that buffer is set to.
2636 - When more than one name is present, separated by commas, automatic
2637 <EOL> detection will be done when reading a file. When starting to
2638 edit a file, a check is done for the <EOL>:
2639 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2640 'fileformat' is set to "dos".
2641 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002642 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002643 preceding <CR>, "unix" is preferred over "dos".
2644 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2645 This means that "mac" is only chosen when "unix" is not present,
2646 or when no <NL> is found in the file, and when "dos" is not
2647 present, or no <CR><NL> is present in the file.
2648 Also if "unix" was first chosen, but the first <CR> is before
2649 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2650 the file, then 'fileformat' is set to "mac".
2651 4. If 'fileformat' is still not set, the first name from
2652 'fileformats' is used.
2653 When reading a file into an existing buffer, the same is done, but
2654 this happens like 'fileformat' has been set appropriately for that
2655 file only, the option is not changed.
2656 When 'binary' is set, the value of 'fileformats' is not used.
2657
2658 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2659 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2660 done:
2661 - When 'fileformats' is empty, there is no automatic detection. Dos
2662 format will be used.
2663 - When 'fileformats' is set to one or more names, automatic detection
2664 is done. This is based on the first <NL> in the file: If there is a
2665 <CR> in front of it, Dos format is used, otherwise Unix format is
2666 used.
2667 Also see |file-formats|.
2668 For backwards compatibility: When this option is set to an empty
2669 string or one format (no comma is included), 'textauto' is reset,
2670 otherwise 'textauto' is set.
2671 NOTE: This option is set to the Vi default value when 'compatible' is
2672 set and to the Vim default value when 'compatible' is reset.
2673
2674 *'filetype'* *'ft'*
2675'filetype' 'ft' string (default: "")
2676 local to buffer
2677 {not in Vi}
2678 {not available when compiled without the |+autocmd|
2679 feature}
2680 When this option is set, the FileType autocommand event is triggered.
2681 All autocommands that match with the value of this option will be
2682 executed. Thus the value of 'filetype' is used in place of the file
2683 name.
2684 Otherwise this option does not always reflect the current file type.
2685 This option is normally set when the file type is detected. To enable
2686 this use the ":filetype on" command. |:filetype|
2687 Setting this option to a different value is most useful in a modeline,
2688 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002689 Example, for in an IDL file:
2690 /* vim: set filetype=idl : */ ~
2691 |FileType| |filetypes|
2692 When a dot appears in the value then this separates two filetype
2693 names. Example:
2694 /* vim: set filetype=c.doxygen : */ ~
2695 This will use the "c" filetype first, then the "doxygen" filetype.
2696 This works both for filetype plugins and for syntax files. More than
2697 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002698 Do not confuse this option with 'osfiletype', which is for the file
2699 type that is actually stored with the file.
2700 This option is not copied to another buffer, independent of the 's' or
2701 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002702 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002703
2704 *'fillchars'* *'fcs'*
2705'fillchars' 'fcs' string (default "vert:|,fold:-")
2706 global
2707 {not in Vi}
2708 {not available when compiled without the |+windows|
2709 and |+folding| features}
2710 Characters to fill the statuslines and vertical separators.
2711 It is a comma separated list of items:
2712
2713 item default Used for ~
2714 stl:c ' ' or '^' statusline of the current window
2715 stlnc:c ' ' or '-' statusline of the non-current windows
2716 vert:c '|' vertical separators |:vsplit|
2717 fold:c '-' filling 'foldtext'
2718 diff:c '-' deleted lines of the 'diff' option
2719
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002720 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002721 "stlnc" the space will be used when there is highlighting, '^' or '-'
2722 otherwise.
2723
2724 Example: >
2725 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2726< This is similar to the default, except that these characters will also
2727 be used when there is highlighting.
2728
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002729 for "stl" and "stlnc" only single-byte values are supported.
2730
Bram Moolenaar071d4272004-06-13 20:20:40 +00002731 The highlighting used for these items:
2732 item highlight group ~
2733 stl:c StatusLine |hl-StatusLine|
2734 stlnc:c StatusLineNC |hl-StatusLineNC|
2735 vert:c VertSplit |hl-VertSplit|
2736 fold:c Folded |hl-Folded|
2737 diff:c DiffDelete |hl-DiffDelete|
2738
2739 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2740'fkmap' 'fk' boolean (default off) *E198*
2741 global
2742 {not in Vi}
2743 {only available when compiled with the |+rightleft|
2744 feature}
2745 When on, the keyboard is mapped for the Farsi character set.
2746 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002747 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002748
2749 *'foldclose'* *'fcl'*
2750'foldclose' 'fcl' string (default "")
2751 global
2752 {not in Vi}
2753 {not available when compiled without the |+folding|
2754 feature}
2755 When set to "all", a fold is closed when the cursor isn't in it and
2756 its level is higher than 'foldlevel'. Useful if you want folds to
2757 automatically close when moving out of them.
2758
2759 *'foldcolumn'* *'fdc'*
2760'foldcolumn' 'fdc' number (default 0)
2761 local to window
2762 {not in Vi}
2763 {not available when compiled without the |+folding|
2764 feature}
2765 When non-zero, a column with the specified width is shown at the side
2766 of the window which indicates open and closed folds. The maximum
2767 value is 12.
2768 See |folding|.
2769
2770 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2771'foldenable' 'fen' boolean (default on)
2772 local to window
2773 {not in Vi}
2774 {not available when compiled without the |+folding|
2775 feature}
2776 When off, all folds are open. This option can be used to quickly
2777 switch between showing all text unfolded and viewing the text with
2778 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002779 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002780 'foldenable' is off.
2781 This option is set by commands that create a new fold or close a fold.
2782 See |folding|.
2783
2784 *'foldexpr'* *'fde'*
2785'foldexpr' 'fde' string (default: "0")
2786 local to window
2787 {not in Vi}
2788 {not available when compiled without the |+folding|
2789 or |+eval| feature}
2790 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002791 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002792
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002793 The expression may be evaluated in the |sandbox|, see
2794 |sandbox-option|.
2795
2796 It is not allowed to change text or jump to another window while
2797 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002798
2799 *'foldignore'* *'fdi'*
2800'foldignore' 'fdi' string (default: "#")
2801 local to window
2802 {not in Vi}
2803 {not available when compiled without the |+folding|
2804 feature}
2805 Used only when 'foldmethod' is "indent". Lines starting with
2806 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002807 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002808 The default "#" works well for C programs. See |fold-indent|.
2809
2810 *'foldlevel'* *'fdl'*
2811'foldlevel' 'fdl' number (default: 0)
2812 local to window
2813 {not in Vi}
2814 {not available when compiled without the |+folding|
2815 feature}
2816 Sets the fold level: Folds with a higher level will be closed.
2817 Setting this option to zero will close all folds. Higher numbers will
2818 close fewer folds.
2819 This option is set by commands like |zm|, |zM| and |zR|.
2820 See |fold-foldlevel|.
2821
2822 *'foldlevelstart'* *'fdls'*
2823'foldlevelstart' 'fdls' number (default: -1)
2824 global
2825 {not in Vi}
2826 {not available when compiled without the |+folding|
2827 feature}
2828 Sets 'foldlevel' when starting to edit another buffer in a window.
2829 Useful to always start editing with all folds closed (value zero),
2830 some folds closed (one) or no folds closed (99).
2831 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002832 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002833 ignores this option and closes all folds.
2834 It is also done before BufReadPre autocommands, to allow an autocmd to
2835 overrule the 'foldlevel' value for specific files.
2836 When the value is negative, it is not used.
2837
2838 *'foldmarker'* *'fmr'* *E536*
2839'foldmarker' 'fmr' string (default: "{{{,}}}")
2840 local to window
2841 {not in Vi}
2842 {not available when compiled without the |+folding|
2843 feature}
2844 The start and end marker used when 'foldmethod' is "marker". There
2845 must be one comma, which separates the start and end marker. The
2846 marker is a literal string (a regular expression would be too slow).
2847 See |fold-marker|.
2848
2849 *'foldmethod'* *'fdm'*
2850'foldmethod' 'fdm' string (default: "manual")
2851 local to window
2852 {not in Vi}
2853 {not available when compiled without the |+folding|
2854 feature}
2855 The kind of folding used for the current window. Possible values:
2856 |fold-manual| manual Folds are created manually.
2857 |fold-indent| indent Lines with equal indent form a fold.
2858 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2859 |fold-marker| marker Markers are used to specify folds.
2860 |fold-syntax| syntax Syntax highlighting items specify folds.
2861 |fold-diff| diff Fold text that is not changed.
2862
2863 *'foldminlines'* *'fml'*
2864'foldminlines' 'fml' number (default: 1)
2865 local to window
2866 {not in Vi}
2867 {not available when compiled without the |+folding|
2868 feature}
2869 Sets the minimum number of screen lines for a fold to be displayed
2870 closed. Also for manually closed folds.
2871 Note that this only has an effect of what is displayed. After using
2872 "zc" to close a fold, which is displayed open because it's smaller
2873 than 'foldminlines', a following "zc" may close a containing fold.
2874
2875 *'foldnestmax'* *'fdn'*
2876'foldnestmax' 'fdn' number (default: 20)
2877 local to window
2878 {not in Vi}
2879 {not available when compiled without the |+folding|
2880 feature}
2881 Sets the maximum nesting of folds for the "indent" and "syntax"
2882 methods. This avoids that too many folds will be created. Using more
2883 than 20 doesn't work, because the internal limit is 20.
2884
2885 *'foldopen'* *'fdo'*
2886'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2887 search,tag,undo")
2888 global
2889 {not in Vi}
2890 {not available when compiled without the |+folding|
2891 feature}
2892 Specifies for which type of commands folds will be opened, if the
2893 command moves the cursor into a closed fold. It is a comma separated
2894 list of items.
2895 item commands ~
2896 all any
2897 block "(", "{", "[[", "[{", etc.
2898 hor horizontal movements: "l", "w", "fx", etc.
2899 insert any command in Insert mode
2900 jump far jumps: "G", "gg", etc.
2901 mark jumping to a mark: "'m", CTRL-O, etc.
2902 percent "%"
2903 quickfix ":cn", ":crew", ":make", etc.
2904 search search for a pattern: "/", "n", "*", "gd", etc.
2905 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002906 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002907 tag jumping to a tag: ":ta", CTRL-T, etc.
2908 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002909 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002910 the |zv| command to the mapping to get the same effect.
2911 When a movement command is used for an operator (e.g., "dl" or "y%")
2912 this option is not used. This means the operator will include the
2913 whole closed fold.
2914 Note that vertical movements are not here, because it would make it
2915 very difficult to move onto a closed fold.
2916 In insert mode the folds containing the cursor will always be open
2917 when text is inserted.
2918 To close folds you can re-apply 'foldlevel' with the |zx| command or
2919 set the 'foldclose' option to "all".
2920
2921 *'foldtext'* *'fdt'*
2922'foldtext' 'fdt' string (default: "foldtext()")
2923 local to window
2924 {not in Vi}
2925 {not available when compiled without the |+folding|
2926 feature}
2927 An expression which is used to specify the text displayed for a closed
2928 fold. See |fold-foldtext|.
2929
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002930 The expression may be evaluated in the |sandbox|, see
2931 |sandbox-option|.
2932
2933 It is not allowed to change text or jump to another window while
2934 evaluating 'foldtext' |textlock|.
2935
Bram Moolenaar071d4272004-06-13 20:20:40 +00002936 *'formatoptions'* *'fo'*
2937'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2938 local to buffer
2939 {not in Vi}
2940 This is a sequence of letters which describes how automatic
2941 formatting is to be done. See |fo-table|. When the 'paste' option is
2942 on, no formatting is done (like 'formatoptions' is empty). Commas can
2943 be inserted for readability.
2944 To avoid problems with flags that are added in the future, use the
2945 "+=" and "-=" feature of ":set" |add-option-flags|.
2946 NOTE: This option is set to the Vi default value when 'compatible' is
2947 set and to the Vim default value when 'compatible' is reset.
2948
Bram Moolenaar86b68352004-12-27 21:59:20 +00002949 *'formatlistpat'* *'flp'*
2950'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
2951 local to buffer
2952 {not in Vi}
2953 A pattern that is used to recognize a list header. This is used for
2954 the "n" flag in 'formatoptions'.
2955 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00002956 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00002957 while still checking more characters. There must be a character
2958 following the pattern, when it matches the whole line it is handled
2959 like there is no match.
2960 The default recognizes a number, followed by an optional punctuation
2961 character and white space.
2962
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963 *'formatprg'* *'fp'*
2964'formatprg' 'fp' string (default "")
2965 global
2966 {not in Vi}
2967 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002968 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00002969 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00002970 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002971 If the 'formatexpr' option is not empty it will be used instead.
2972 Otherwise, if 'formatprg' option is an empty string, the internal
2973 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00002974 Environment variables are expanded |:set_env|. See |option-backslash|
2975 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002976 The expression may be evaluated in the |sandbox|, see
2977 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002978
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002979 *'formatexpr'* *'fex'*
2980'formatexpr' 'fex' string (default "")
2981 local to buffer
2982 {not in Vi}
2983 {not available when compiled without the |+eval|
2984 feature}
2985 Expression which is evaluated to format a range of lines for the |gq|
2986 operator. The |v:lnum| variable holds the first line to be formatted,
2987 |v:count| the number of lines to be formatted.
2988 When this option is empty 'formatprg' is used.
2989 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00002990 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002991< This will invoke the mylang#Format() function in the
2992 autoload/mylang.vim file in 'runtimepath'. |autoload|
2993
2994 The expression is also evaluated when 'textwidth' is set and adding
2995 text beyond that limit. This happens under the same conditions as
2996 when internal formatting is used. Make sure the cursor is kept in the
2997 same spot relative to the text then! The |mode()| function will
2998 return "i" or "R" in this situation. When the function returns
2999 non-zero Vim will fall back to using the internal format mechanism.
3000
3001 The expression may be evaluated in the |sandbox|, see
3002 |sandbox-option|.
3003
3004 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003005'fsync' 'fs' boolean (default on)
3006 global
3007 {not in Vi}
3008 When on, the library function fsync() will be called after writing a
3009 file. This will flush a file to disk, ensuring that it is safely
3010 written even on filesystems which do metadata-only journaling. This
3011 will force the harddrive to spin up on Linux systems running in laptop
3012 mode, so it may be undesirable in some situations. Be warned that
3013 turning this off increases the chances of data loss after a crash. On
3014 systems without an fsync() implementation, this variable is always
3015 off.
3016 Also see 'swapsync' for controlling fsync() on swap files.
3017
Bram Moolenaar071d4272004-06-13 20:20:40 +00003018 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3019'gdefault' 'gd' boolean (default off)
3020 global
3021 {not in Vi}
3022 When on, the ":substitute" flag 'g' is default on. This means that
3023 all matches in a line are substituted instead of one. When a 'g' flag
3024 is given to a ":substitute" command, this will toggle the substitution
3025 of all or one match. See |complex-change|.
3026
3027 command 'gdefault' on 'gdefault' off ~
3028 :s/// subst. all subst. one
3029 :s///g subst. one subst. all
3030 :s///gg subst. all subst. one
3031
3032 NOTE: This option is reset when 'compatible' is set.
3033
3034 *'grepformat'* *'gfm'*
3035'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3036 global
3037 {not in Vi}
3038 Format to recognize for the ":grep" command output.
3039 This is a scanf-like string that uses the same format as the
3040 'errorformat' option: see |errorformat|.
3041
3042 *'grepprg'* *'gp'*
3043'grepprg' 'gp' string (default "grep -n ",
3044 Unix: "grep -n $* /dev/null",
3045 Win32: "findstr /n" or "grep -n",
3046 VMS: "SEARCH/NUMBERS ")
3047 global or local to buffer |global-local|
3048 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003049 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003050 and '#' characters, which are expanded like when used in a command-
3051 line. The placeholder "$*" is allowed to specify where the arguments
3052 will be included. Environment variables are expanded |:set_env|. See
3053 |option-backslash| about including spaces and backslashes.
3054 When your "grep" accepts the "-H" argument, use this to make ":grep"
3055 also work well with a single file: >
3056 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003057< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003058 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3059 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003060 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003061 apply equally to 'grepprg'.
3062 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3063 otherwise it's "grep -n".
3064 This option cannot be set from a |modeline| or in the |sandbox|, for
3065 security reasons.
3066
3067 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3068'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3069 ve:ver35-Cursor,
3070 o:hor50-Cursor,
3071 i-ci:ver25-Cursor/lCursor,
3072 r-cr:hor20-Cursor/lCursor,
3073 sm:block-Cursor
3074 -blinkwait175-blinkoff150-blinkon175",
3075 for MS-DOS and Win32 console:
3076 "n-v-c:block,o:hor50,i-ci:hor15,
3077 r-cr:hor30,sm:block")
3078 global
3079 {not in Vi}
3080 {only available when compiled with GUI enabled, and
3081 for MS-DOS and Win32 console}
3082 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003083 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003084 the height of the cursor can be changed. This can be done by
3085 specifying a block cursor, or a percentage for a vertical or
3086 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003087 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003088
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003089 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003090 mode-list and an argument-list:
3091 mode-list:argument-list,mode-list:argument-list,..
3092 The mode-list is a dash separated list of these modes:
3093 n Normal mode
3094 v Visual mode
3095 ve Visual mode with 'selection' "exclusive" (same as 'v',
3096 if not specified)
3097 o Operator-pending mode
3098 i Insert mode
3099 r Replace mode
3100 c Command-line Normal (append) mode
3101 ci Command-line Insert mode
3102 cr Command-line Replace mode
3103 sm showmatch in Insert mode
3104 a all modes
3105 The argument-list is a dash separated list of these arguments:
3106 hor{N} horizontal bar, {N} percent of the character height
3107 ver{N} vertical bar, {N} percent of the character width
3108 block block cursor, fills the whole character
3109 [only one of the above three should be present]
3110 blinkwait{N} *cursor-blinking*
3111 blinkon{N}
3112 blinkoff{N}
3113 blink times for cursor: blinkwait is the delay before
3114 the cursor starts blinking, blinkon is the time that
3115 the cursor is shown and blinkoff is the time that the
3116 cursor is not shown. The times are in msec. When one
3117 of the numbers is zero, there is no blinking. The
3118 default is: "blinkwait700-blinkon400-blinkoff250".
3119 These numbers are used for a missing entry. This
3120 means that blinking is enabled by default. To switch
3121 blinking off you can use "blinkon0". The cursor only
3122 blinks when Vim is waiting for input, not while
3123 executing a command.
3124 To make the cursor blink in an xterm, see
3125 |xterm-blink|.
3126 {group-name}
3127 a highlight group name, that sets the color and font
3128 for the cursor
3129 {group-name}/{group-name}
3130 Two highlight group names, the first is used when
3131 no language mappings are used, the other when they
3132 are. |language-mapping|
3133
3134 Examples of parts:
3135 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3136 block cursor with colors from the "nCursor"
3137 highlight group
3138 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3139 In Insert and Command-line Insert mode, use a
3140 30% vertical bar cursor with colors from the
3141 "iCursor" highlight group. Blink a bit
3142 faster.
3143
3144 The 'a' mode is different. It will set the given argument-list for
3145 all modes. It does not reset anything to defaults. This can be used
3146 to do a common setting for all modes. For example, to switch off
3147 blinking: "a:blinkon0"
3148
3149 Examples of cursor highlighting: >
3150 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3151 :highlight Cursor gui=NONE guifg=bg guibg=fg
3152<
3153 *'guifont'* *'gfn'*
3154 *E235* *E596* *E610* *E611*
3155'guifont' 'gfn' string (default "")
3156 global
3157 {not in Vi}
3158 {only available when compiled with GUI enabled}
3159 This is a list of fonts which will be used for the GUI version of Vim.
3160 In its simplest form the value is just one font name. When
3161 the font cannot be found you will get an error message. To try other
3162 font names a list can be specified, font names separated with commas.
3163 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003164
Bram Moolenaar05159a02005-02-26 23:04:13 +00003165 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3166 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003167
Bram Moolenaar071d4272004-06-13 20:20:40 +00003168 Spaces after a comma are ignored. To include a comma in a font name
3169 precede it with a backslash. Setting an option requires an extra
3170 backslash before a space and a backslash. See also
3171 |option-backslash|. For example: >
3172 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003173< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003174 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003175
3176 If none of the fonts can be loaded, Vim will keep the current setting.
3177 If an empty font list is given, Vim will try using other resource
3178 settings (for X, it will use the Vim.font resource), and finally it
3179 will try some builtin default which should always be there ("7x13" in
3180 the case of X). The font names given should be "normal" fonts. Vim
3181 will try to find the related bold and italic fonts.
3182
Bram Moolenaar05159a02005-02-26 23:04:13 +00003183 For Win32, GTK, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003184 :set guifont=*
3185< will bring up a font requester, where you can pick the font you want.
3186
3187 The font name depends on the GUI used. See |setting-guifont| for a
3188 way to set 'guifont' for various systems.
3189
Bram Moolenaar071d4272004-06-13 20:20:40 +00003190 For the GTK+ 2 GUI the font name looks like this: >
3191 :set guifont=Andale\ Mono\ 11
3192< That's all. XLFDs are no longer accepted.
Bram Moolenaar05159a02005-02-26 23:04:13 +00003193
3194 For Mac OSX you can use something like this: >
3195 :set guifont=Monaco:h10
3196< *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003197 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003198 width). An exception is GTK 2: all fonts are accepted, but
3199 mono-spaced fonts look best.
3200
Bram Moolenaar071d4272004-06-13 20:20:40 +00003201 To preview a font on X11, you might be able to use the "xfontsel"
3202 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003203
Bram Moolenaar071d4272004-06-13 20:20:40 +00003204 For the Win32 GUI *E244* *E245*
3205 - takes these options in the font name:
3206 hXX - height is XX (points, can be floating-point)
3207 wXX - width is XX (points, can be floating-point)
3208 b - bold
3209 i - italic
3210 u - underline
3211 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003212 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003213 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3214 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3215 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003216 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003217
3218 Use a ':' to separate the options.
3219 - A '_' can be used in the place of a space, so you don't need to use
3220 backslashes to escape the spaces.
3221 - Examples: >
3222 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3223 :set guifont=Andale_Mono:h7.5:w4.5
3224< See also |font-sizes|.
3225
3226 *'guifontset'* *'gfs'*
3227 *E250* *E252* *E234* *E597* *E598*
3228'guifontset' 'gfs' string (default "")
3229 global
3230 {not in Vi}
3231 {only available when compiled with GUI enabled and
3232 with the |+xfontset| feature}
3233 {not available in the GTK+ 2 GUI}
3234 When not empty, specifies two (or more) fonts to be used. The first
3235 one for normal English, the second one for your special language. See
3236 |xfontset|.
3237 Setting this option also means that all font names will be handled as
3238 a fontset name. Also the ones used for the "font" argument of the
3239 |:highlight| command.
3240 The fonts must match with the current locale. If fonts for the
3241 character sets that the current locale uses are not included, setting
3242 'guifontset' will fail.
3243 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3244 the comma-separated names are alternative names, one of which will be
3245 used. In 'guifontset' the whole string is one fontset name,
3246 including the commas. It is not possible to specify alternative
3247 fontset names.
3248 This example works on many X11 systems: >
3249 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3250<
3251 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3252'guifontwide' 'gfw' string (default "")
3253 global
3254 {not in Vi}
3255 {only available when compiled with GUI enabled}
3256 When not empty, specifies a comma-separated list of fonts to be used
3257 for double-width characters. The first font that can be loaded is
3258 used.
3259 Note: The size of these fonts must be exactly twice as wide as the one
3260 specified with 'guifont' and the same height.
3261
3262 All GUI versions but GTK+ 2:
3263
3264 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3265 'guifontset' is empty or invalid.
3266 When 'guifont' is set and a valid font is found in it and
3267 'guifontwide' is empty Vim will attempt to find a matching
3268 double-width font and set 'guifontwide' to it.
3269
3270 GTK+ 2 GUI only: *guifontwide_gtk2*
3271
3272 If set and valid, 'guifontwide' is always used for double width
3273 characters, even if 'encoding' is not set to "utf-8".
3274 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003275 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003276 font for characters not available in 'guifont'. Thus you do not need
3277 to set 'guifontwide' at all unless you want to override the choice
3278 made by Pango/Xft.
3279
3280 *'guiheadroom'* *'ghr'*
3281'guiheadroom' 'ghr' number (default 50)
3282 global
3283 {not in Vi} {only for GTK and X11 GUI}
3284 The number of pixels subtracted from the screen height when fitting
3285 the GUI window on the screen. Set this before the GUI is started,
3286 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003287 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003288 lines will be left for window decorations and other items on the
3289 screen. Set it to a negative value to allow windows taller than the
3290 screen.
3291
3292 *'guioptions'* *'go'*
3293'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003294 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295 global
3296 {not in Vi}
3297 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003298 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299 sequence of letters which describes what components and options of the
3300 GUI should be used.
3301 To avoid problems with flags that are added in the future, use the
3302 "+=" and "-=" feature of ":set" |add-option-flags|.
3303
3304 Valid letters are as follows:
3305 *guioptions_a*
3306 'a' Autoselect: If present, then whenever VISUAL mode is started,
3307 or the Visual area extended, Vim tries to become the owner of
3308 the windowing system's global selection. This means that the
3309 Visually highlighted text is available for pasting into other
3310 applications as well as into Vim itself. When the Visual mode
3311 ends, possibly due to an operation on the text, or when an
3312 application wants to paste the selection, the highlighted text
3313 is automatically yanked into the "* selection register.
3314 Thus the selection is still available for pasting into other
3315 applications after the VISUAL mode has ended.
3316 If not present, then Vim won't become the owner of the
3317 windowing system's global selection unless explicitly told to
3318 by a yank or delete operation for the "* register.
3319 The same applies to the modeless selection.
3320
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003321 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003322 applies to the modeless selection.
3323
3324 'guioptions' autoselect Visual autoselect modeless ~
3325 "" - -
3326 "a" yes yes
3327 "A" - yes
3328 "aA" yes yes
3329
3330 'c' Use console dialogs instead of popup dialogs for simple
3331 choices.
3332
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003333 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003334 'guitablabel' can be used to change the text in the labels.
3335 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00003336 The GUI tabs are only supported on some systens, currently
3337 only for GTK.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003338
Bram Moolenaar071d4272004-06-13 20:20:40 +00003339 'f' Foreground: Don't use fork() to detach the GUI from the shell
3340 where it was started. Use this for programs that wait for the
3341 editor to finish (e.g., an e-mail program). Alternatively you
3342 can use "gvim -f" or ":gui -f" to start the GUI in the
3343 foreground. |gui-fork|
3344 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003345 happened already when the |gvimrc| file is read.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003346
3347 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3348 corner of the window. It's black&white on non-GTK, because of
3349 limitations of X11. For a color icon, see |X11-icon|.
3350
3351 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003352 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003353 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003354 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003355 file is sourced the system menu has already been loaded; the
3356 ":syntax on" and ":filetype on" commands load the menu too).
3357 'g' Grey menu items: Make menu items that are not active grey. If
3358 'g' is not included inactive menu items are not shown at all.
3359 Exception: Athena will always use grey menu items.
3360
3361 't' Include tearoff menu items. Currently only works for Win32,
3362 GTK+, and Motif 1.2 GUI.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003363 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
3364 and Athena GUIs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003365
3366 'r' Right-hand scrollbar is always present.
3367 'R' Right-hand scrollbar is present when there is a vertically
3368 split window.
3369 'l' Left-hand scrollbar is always present.
3370 'L' Left-hand scrollbar is present when there is a vertically
3371 split window.
3372 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3373 the longest visible line, or on the cursor line if the 'h'
3374 flag is included. |gui-horiz-scroll|
3375 'h' Limit horizontal scrollbar size to the length of the cursor
3376 line. Reduces computations. |gui-horiz-scroll|
3377
3378 And yes, you may even have scrollbars on the left AND the right if
3379 you really want to :-). See |gui-scrollbars| for more information.
3380
3381 'v' Use a vertical button layout for dialogs. When not included,
3382 a horizontal layout is preferred, but when it doesn't fit a
3383 vertical layout is used anyway.
3384 'p' Use Pointer callbacks for X11 GUI. This is required for some
3385 window managers. If the cursor is not blinking or hollow at
3386 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003387 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003388 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003389 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003390
3391 *'guipty'* *'noguipty'*
3392'guipty' boolean (default on)
3393 global
3394 {not in Vi}
3395 {only available when compiled with GUI enabled}
3396 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3397 I/O to/from shell commands. See |gui-pty|.
3398
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003399 *'guitablabel'* *'gtl'*
3400'guitablabel' 'gtl' string (default empty)
3401 global
3402 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003403 {only available when compiled with GUI enabled and
3404 with the +windows feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003405 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003406 pages line. When empty Vim will use a default label. See
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003407 |setting-guitablabel| for more info.
3408
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003409 The format of this option is like that of 'statusline'.
3410
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003411 Only used when the GUI tab pages line is displayed. 'e' must be
3412 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3413 used.
3414
Bram Moolenaar071d4272004-06-13 20:20:40 +00003415 *'helpfile'* *'hf'*
3416'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3417 (others) "$VIMRUNTIME/doc/help.txt")
3418 global
3419 {not in Vi}
3420 Name of the main help file. All distributed help files should be
3421 placed together in one directory. Additionally, all "doc" directories
3422 in 'runtimepath' will be used.
3423 Environment variables are expanded |:set_env|. For example:
3424 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003425 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003426 spaces and backslashes.
3427 This option cannot be set from a |modeline| or in the |sandbox|, for
3428 security reasons.
3429
3430 *'helpheight'* *'hh'*
3431'helpheight' 'hh' number (default 20)
3432 global
3433 {not in Vi}
3434 {not available when compiled without the +windows
3435 feature}
3436 Minimal initial height of the help window when it is opened with the
3437 ":help" command. The initial height of the help window is half of the
3438 current window, or (when the 'ea' option is on) the same as other
3439 windows. When the height is less than 'helpheight', the height is
3440 set to 'helpheight'. Set to zero to disable.
3441
3442 *'helplang'* *'hlg'*
3443'helplang' 'hlg' string (default: messages language or empty)
3444 global
3445 {only available when compiled with the |+multi_lang|
3446 feature}
3447 {not in Vi}
3448 Comma separated list of languages. Vim will use the first language
3449 for which the desired help can be found. The English help will always
3450 be used as a last resort. You can add "en" to prefer English over
3451 another language, but that will only find tags that exist in that
3452 language and not in the English help.
3453 Example: >
3454 :set helplang=de,it
3455< This will first search German, then Italian and finally English help
3456 files.
3457 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3458 try to find the tag in the current language before using this option.
3459 See |help-translated|.
3460
3461 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3462'hidden' 'hid' boolean (default off)
3463 global
3464 {not in Vi}
3465 When off a buffer is unloaded when it is |abandon|ed. When on a
3466 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3467 displayed in another window, it does not become hidden, of course.
3468 The commands that move through the buffer list sometimes make a buffer
3469 hidden although the 'hidden' option is off: When the buffer is
3470 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003471 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003472 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003473 This option is set for one command with ":hide {command}" |:hide|.
3474 WARNING: It's easy to forget that you have changes in hidden buffers.
3475 Think twice when using ":q!" or ":qa!".
3476
3477 *'highlight'* *'hl'*
3478'highlight' 'hl' string (default (as a single string):
3479 "8:SpecialKey,@:NonText,d:Directory,
3480 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3481 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003482 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003483 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3484 f:Folded,F:FoldColumn,A:DiffAdd,
3485 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003486 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003487 R:SpellRare,L:SpellLocal,
3488 +:Pmenu,=:PmenuSel,
3489 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490 global
3491 {not in Vi}
3492 This option can be used to set highlighting mode for various
3493 occasions. It is a comma separated list of character pairs. The
3494 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003495 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003496 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3497 |hl-NonText| @ '~' and '@' at the end of the window and
3498 characters from 'showbreak'
3499 |hl-Directory| d directories in CTRL-D listing and other special
3500 things in listings
3501 |hl-ErrorMsg| e error messages
3502 h (obsolete, ignored)
3503 |hl-IncSearch| i 'incsearch' highlighting
3504 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3505 |hl-MoreMsg| m |more-prompt|
3506 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3507 |hl-LineNr| n line number for ":number" and ":#" commands
3508 |hl-Question| r |hit-enter| prompt and yes/no questions
3509 |hl-StatusLine| s status line of current window |status-line|
3510 |hl-StatusLineNC| S status lines of not-current windows
3511 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3512 |hl-VertSplit| c column used to separate vertically split windows
3513 |hl-Visual| v Visual mode
3514 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3515 Selection" Only X11 Gui's |gui-x11| and
3516 |xterm-clipboard|.
3517 |hl-WarningMsg| w warning messages
3518 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3519 |hl-Folded| f line used for closed folds
3520 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003521 |hl-DiffAdd| A added line in diff mode
3522 |hl-DiffChange| C changed line in diff mode
3523 |hl-DiffDelete| D deleted line in diff mode
3524 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003525 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003526 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003527 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003528 |hl-SpellRare| R rare word |spell|
3529 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003530 |hl-Pmenu| + popup menu normal line
3531 |hl-PmenuSel| = popup menu normal line
3532 |hl-PmenuSbar| x popup menu scrollbar
3533 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003534
3535 The display modes are:
3536 r reverse (termcap entry "mr" and "me")
3537 i italic (termcap entry "ZH" and "ZR")
3538 b bold (termcap entry "md" and "me")
3539 s standout (termcap entry "so" and "se")
3540 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003541 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542 n no highlighting
3543 - no highlighting
3544 : use a highlight group
3545 The default is used for occasions that are not included.
3546 If you want to change what the display modes do, see |dos-colors|
3547 for an example.
3548 When using the ':' display mode, this must be followed by the name of
3549 a highlight group. A highlight group can be used to define any type
3550 of highlighting, including using color. See |:highlight| on how to
3551 define one. The default uses a different group for each occasion.
3552 See |highlight-default| for the default highlight groups.
3553
3554 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3555'hlsearch' 'hls' boolean (default off)
3556 global
3557 {not in Vi}
3558 {not available when compiled without the
3559 |+extra_search| feature}
3560 When there is a previous search pattern, highlight all its matches.
3561 The type of highlighting used can be set with the 'l' occasion in the
3562 'highlight' option. This uses the "Search" highlight group by
3563 default. Note that only the matching text is highlighted, any offsets
3564 are not applied.
3565 See also: 'incsearch' and |:match|.
3566 When you get bored looking at the highlighted matches, you can turn it
3567 off with |:nohlsearch|. As soon as you use a search command, the
3568 highlighting comes back.
3569 When the search pattern can match an end-of-line, Vim will try to
3570 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003571 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003572 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003573 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003574 NOTE: This option is reset when 'compatible' is set.
3575
3576 *'history'* *'hi'*
3577'history' 'hi' number (Vim default: 20, Vi default: 0)
3578 global
3579 {not in Vi}
3580 A history of ":" commands, and a history of previous search patterns
3581 are remembered. This option decides how many entries may be stored in
3582 each of these histories (see |cmdline-editing|).
3583 NOTE: This option is set to the Vi default value when 'compatible' is
3584 set and to the Vim default value when 'compatible' is reset.
3585
3586 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3587'hkmap' 'hk' boolean (default off)
3588 global
3589 {not in Vi}
3590 {only available when compiled with the |+rightleft|
3591 feature}
3592 When on, the keyboard is mapped for the Hebrew character set.
3593 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3594 toggle this option. See |rileft.txt|.
3595 NOTE: This option is reset when 'compatible' is set.
3596
3597 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3598'hkmapp' 'hkp' boolean (default off)
3599 global
3600 {not in Vi}
3601 {only available when compiled with the |+rightleft|
3602 feature}
3603 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3604 This is useful if you have a non-Hebrew keyboard.
3605 See |rileft.txt|.
3606 NOTE: This option is reset when 'compatible' is set.
3607
3608 *'icon'* *'noicon'*
3609'icon' boolean (default off, on when title can be restored)
3610 global
3611 {not in Vi}
3612 {not available when compiled without the |+title|
3613 feature}
3614 When on, the icon text of the window will be set to the value of
3615 'iconstring' (if it is not empty), or to the name of the file
3616 currently being edited. Only the last part of the name is used.
3617 Overridden by the 'iconstring' option.
3618 Only works if the terminal supports setting window icons (currently
3619 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3620 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3621 builtin termcap).
3622 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003623 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003624 X11.
3625
3626 *'iconstring'*
3627'iconstring' string (default "")
3628 global
3629 {not in Vi}
3630 {not available when compiled without the |+title|
3631 feature}
3632 When this option is not empty, it will be used for the icon text of
3633 the window. This happens only when the 'icon' option is on.
3634 Only works if the terminal supports setting window icon text
3635 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3636 Does not work for MS Windows.
3637 When Vim was compiled with HAVE_X11 defined, the original icon will be
3638 restored if possible |X11|.
3639 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003640 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003641 'titlestring' for example settings.
3642 {not available when compiled without the |+statusline| feature}
3643
3644 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3645'ignorecase' 'ic' boolean (default off)
3646 global
3647 Ignore case in search patterns. Also used when searching in the tags
3648 file.
3649 Also see 'smartcase'.
3650 Can be overruled by using "\c" or "\C" in the pattern, see
3651 |/ignorecase|.
3652
3653 *'imactivatekey'* *'imak'*
3654'imactivatekey' 'imak' string (default "")
3655 global
3656 {not in Vi}
3657 {only available when compiled with |+xim| and
3658 |+GUI_GTK|}
3659 Specifies the key that your Input Method in X-Windows uses for
3660 activation. When this is specified correctly, vim can fully control
3661 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3662 You can't use this option to change the activation key, the option
3663 tells Vim what the key is.
3664 Format:
3665 [MODIFIER_FLAG-]KEY_STRING
3666
3667 These characters can be used for MODIFIER_FLAG (case is ignored):
3668 S Shift key
3669 L Lock key
3670 C Control key
3671 1 Mod1 key
3672 2 Mod2 key
3673 3 Mod3 key
3674 4 Mod4 key
3675 5 Mod5 key
3676 Combinations are allowed, for example "S-C-space" or "SC-space" are
3677 both shift+ctrl+space.
3678 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3679
3680 Example: >
3681 :set imactivatekey=S-space
3682< "S-space" means shift+space. This is the activation key for kinput2 +
3683 canna (Japanese), and ami (Korean).
3684
3685 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3686'imcmdline' 'imc' boolean (default off)
3687 global
3688 {not in Vi}
3689 {only available when compiled with the |+xim|
3690 |+multi_byte_ime| or |global-ime| feature}
3691 When set the Input Method is always on when starting to edit a command
3692 line, unless entering a search pattern (see 'imsearch' for that).
3693 Setting this option is useful when your input method allows entering
3694 English characters directly, e.g., when it's used to type accented
3695 characters with dead keys.
3696
3697 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3698'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3699 global
3700 {not in Vi}
3701 {only available when compiled with the |+xim|
3702 |+multi_byte_ime| or |global-ime| feature}
3703 When set the Input Method is never used. This is useful to disable
3704 the IM when it doesn't work properly.
3705 Currently this option is on by default for SGI/IRIX machines. This
3706 may change in later releases.
3707
3708 *'iminsert'* *'imi'*
3709'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3710 local to buffer
3711 {not in Vi}
3712 Specifies whether :lmap or an Input Method (IM) is to be used in
3713 Insert mode. Valid values:
3714 0 :lmap is off and IM is off
3715 1 :lmap is ON and IM is off
3716 2 :lmap is off and IM is ON
3717 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3718 or |global-ime|.
3719 To always reset the option to zero when leaving Insert mode with <Esc>
3720 this can be used: >
3721 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3722< This makes :lmap and IM turn off automatically when leaving Insert
3723 mode.
3724 Note that this option changes when using CTRL-^ in Insert mode
3725 |i_CTRL-^|.
3726 The value is set to 1 when setting 'keymap' to a valid keymap name.
3727 It is also used for the argument of commands like "r" and "f".
3728 The value 0 may not work correctly with Athena and Motif with some XIM
3729 methods. Use 'imdisable' to disable XIM then.
3730
3731 *'imsearch'* *'ims'*
3732'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3733 local to buffer
3734 {not in Vi}
3735 Specifies whether :lmap or an Input Method (IM) is to be used when
3736 entering a search pattern. Valid values:
3737 -1 the value of 'iminsert' is used, makes it look like
3738 'iminsert' is also used when typing a search pattern
3739 0 :lmap is off and IM is off
3740 1 :lmap is ON and IM is off
3741 2 :lmap is off and IM is ON
3742 Note that this option changes when using CTRL-^ in Command-line mode
3743 |c_CTRL-^|.
3744 The value is set to 1 when it is not -1 and setting the 'keymap'
3745 option to a valid keymap name.
3746 The value 0 may not work correctly with Athena and Motif with some XIM
3747 methods. Use 'imdisable' to disable XIM then.
3748
3749 *'include'* *'inc'*
3750'include' 'inc' string (default "^\s*#\s*include")
3751 global or local to buffer |global-local|
3752 {not in Vi}
3753 {not available when compiled without the
3754 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003755 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003756 pattern, just like for the "/" command (See |pattern|). The default
3757 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003758 "]I", "[d", etc.
3759 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003760 comes after the matched pattern. But if "\zs" appears in the pattern
3761 then the text matched from "\zs" to the end, or until "\ze" if it
3762 appears, is used as the file name. Use this to include characters
3763 that are not in 'isfname', such as a space. You can then use
3764 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003765 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003766
3767 *'includeexpr'* *'inex'*
3768'includeexpr' 'inex' string (default "")
3769 local to buffer
3770 {not in Vi}
3771 {not available when compiled without the
3772 |+find_in_path| or |+eval| feature}
3773 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003774 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003775 :set includeexpr=substitute(v:fname,'\\.','/','g')
3776< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003777
Bram Moolenaar071d4272004-06-13 20:20:40 +00003778 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003779 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003780 Also used for |<cfile>|.
3781
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003782 The expression may be evaluated in the |sandbox|, see
3783 |sandbox-option|.
3784
3785 It is not allowed to change text or jump to another window while
3786 evaluating 'includeexpr' |textlock|.
3787
Bram Moolenaar071d4272004-06-13 20:20:40 +00003788 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3789'incsearch' 'is' boolean (default off)
3790 global
3791 {not in Vi}
3792 {not available when compiled without the
3793 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003794 While typing a search command, show where the pattern, as it was typed
3795 so far, matches. The matched string is highlighted. If the pattern
3796 is invalid or not found, nothing is shown. The screen will be updated
3797 often, this is only useful on fast terminals.
3798 Note that the match will be shown, but the cursor will return to its
3799 original position when no match is found and when pressing <Esc>. You
3800 still need to finish the search command with <Enter> to move the
3801 cursor to the match.
3802 The highlighting can be set with the 'i' flag in 'highlight'.
3803 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00003804 CTRL-L can be used to add one character from after the current match
3805 to the command line.
3806 CTRL-R CTRL-W can be used to add the word at the end of the current
3807 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003808 NOTE: This option is reset when 'compatible' is set.
3809
3810 *'indentexpr'* *'inde'*
3811'indentexpr' 'inde' string (default "")
3812 local to buffer
3813 {not in Vi}
3814 {not available when compiled without the |+cindent|
3815 or |+eval| features}
3816 Expression which is evaluated to obtain the proper indent for a line.
3817 It is used when a new line is created, for the |=| operator and
3818 in Insert mode as specified with the 'indentkeys' option.
3819 When this option is not empty, it overrules the 'cindent' and
3820 'smartindent' indenting.
3821 When 'paste' is set this option is not used for indenting.
3822 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003823 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003824 when the expression is evaluated (but it may be moved around).
3825 The expression must return the number of spaces worth of indent. It
3826 can return "-1" to keep the current indent (this means 'autoindent' is
3827 used for the indent).
3828 Functions useful for computing the indent are |indent()|, |cindent()|
3829 and |lispindent()|.
3830 The evaluation of the expression must not have side effects! It must
3831 not change the text, jump to another window, etc. Afterwards the
3832 cursor position is always restored, thus the cursor may be moved.
3833 Normally this option would be set to call a function: >
3834 :set indentexpr=GetMyIndent()
3835< Error messages will be suppressed, unless the 'debug' option contains
3836 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003837 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003838 NOTE: This option is made empty when 'compatible' is set.
3839
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003840 The expression may be evaluated in the |sandbox|, see
3841 |sandbox-option|.
3842
3843 It is not allowed to change text or jump to another window while
3844 evaluating 'indentexpr' |textlock|.
3845
3846
Bram Moolenaar071d4272004-06-13 20:20:40 +00003847 *'indentkeys'* *'indk'*
3848'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3849 local to buffer
3850 {not in Vi}
3851 {not available when compiled without the |+cindent|
3852 feature}
3853 A list of keys that, when typed in Insert mode, cause reindenting of
3854 the current line. Only happens if 'indentexpr' isn't empty.
3855 The format is identical to 'cinkeys', see |indentkeys-format|.
3856 See |C-indenting| and |indent-expression|.
3857
3858 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3859'infercase' 'inf' boolean (default off)
3860 local to buffer
3861 {not in Vi}
3862 When doing keyword completion in insert mode |ins-completion|, and
3863 'ignorecase' is also on, the case of the match is adjusted. If the
3864 typed text contains a lowercase letter where the match has an upper
3865 case letter, the completed part is made lowercase. If the typed text
3866 has no lowercase letters and the match has a lowercase letter where
3867 the typed text has an uppercase letter, and there is a letter before
3868 it, the completed part is made uppercase.
3869
3870 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3871'insertmode' 'im' boolean (default off)
3872 global
3873 {not in Vi}
3874 Makes Vim work in a way that Insert mode is the default mode. Useful
3875 if you want to use Vim as a modeless editor. Used for |evim|.
3876 These Insert mode commands will be useful:
3877 - Use the cursor keys to move around.
3878 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3879 this is a mapping, it is executed as if 'insertmode' was off.
3880 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003881 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00003882 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
3883 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003884
3885 These items change when 'insertmode' is set:
3886 - when starting to edit of a file, Vim goes to Insert mode.
3887 - <Esc> in Insert mode is a no-op and beeps.
3888 - <Esc> in Normal mode makes Vim go to Insert mode.
3889 - CTRL-L in Insert mode is a command, it is not inserted.
3890 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3891 However, when <Esc> is used inside a mapping, it behaves like
3892 'insertmode' was not set. This was done to be able to use the same
3893 mappings with 'insertmode' set or not set.
3894 When executing commands with |:normal| 'insertmode' is not used.
3895
3896 NOTE: This option is reset when 'compatible' is set.
3897
3898 *'isfname'* *'isf'*
3899'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3900 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3901 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3902 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3903 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3904 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3905 global
3906 {not in Vi}
3907 The characters specified by this option are included in file names and
3908 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003909 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910 Multi-byte characters 256 and above are always included, only the
3911 characters up to 255 are specified with this option.
3912 For UTF-8 the characters 0xa0 to 0xff are included as well.
3913
3914 Note that on systems using a backslash as path separator, Vim tries to
3915 do its best to make it work as you would expect. That is a bit
3916 tricky, since Vi originally used the backslash to escape special
3917 characters. Vim will not remove a backslash in front of a normal file
3918 name character on these systems, but it will on Unix and alikes. The
3919 '&' and '^' are not included by default, because these are special for
3920 cmd.exe.
3921
3922 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003923 Each part can be a single character number or a range. A range is two
3924 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003925 decimal number between 0 and 255 or the ASCII character itself (does
3926 not work for digits). Example:
3927 "_,-,128-140,#-43" (include '_' and '-' and the range
3928 128 to 140 and '#' to 43)
3929 If a part starts with '^', the following character number or range
3930 will be excluded from the option. The option is interpreted from left
3931 to right. Put the excluded character after the range where it is
3932 included. To include '^' itself use it as the last character of the
3933 option or the end of a range. Example:
3934 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3935 If the character is '@', all characters where isalpha() returns TRUE
3936 are included. Normally these are the characters a to z and A to Z,
3937 plus accented characters. To include '@' itself use "@-@". Examples:
3938 "@,^a-z" All alphabetic characters, excluding lower
3939 case letters.
3940 "a-z,A-Z,@-@" All letters plus the '@' character.
3941 A comma can be included by using it where a character number is
3942 expected. Example:
3943 "48-57,,,_" Digits, comma and underscore.
3944 A comma can be excluded by prepending a '^'. Example:
3945 " -~,^,,9" All characters from space to '~', excluding
3946 comma, plus <Tab>.
3947 See |option-backslash| about including spaces and backslashes.
3948
3949 *'isident'* *'isi'*
3950'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3951 "@,48-57,_,128-167,224-235"
3952 otherwise: "@,48-57,_,192-255")
3953 global
3954 {not in Vi}
3955 The characters given by this option are included in identifiers.
3956 Identifiers are used in recognizing environment variables and after a
3957 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00003958 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00003959 option.
3960 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003961 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003962 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3963
3964 *'iskeyword'* *'isk'*
3965'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3966 "@,48-57,_,128-167,224-235"
3967 otherwise: "@,48-57,_,192-255"
3968 Vi default: "@,48-57,_")
3969 local to buffer
3970 {not in Vi}
3971 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003972 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973 'isfname' for a description of the format of this option. For C
3974 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3975 For a help file it is set to all non-blank printable characters except
3976 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3977 command).
3978 When the 'lisp' option is on the '-' character is always included.
3979 NOTE: This option is set to the Vi default value when 'compatible' is
3980 set and to the Vim default value when 'compatible' is reset.
3981
3982 *'isprint'* *'isp'*
3983'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3984 "@,~-255"; otherwise: "@,161-255")
3985 global
3986 {not in Vi}
3987 The characters given by this option are displayed directly on the
3988 screen. It is also used for "\p" in a |pattern|. The characters from
3989 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3990 even when they are not included in 'isprint' or excluded. See
3991 'isfname' for a description of the format of this option.
3992
3993 Non-printable characters are displayed with two characters:
3994 0 - 31 "^@" - "^_"
3995 32 - 126 always single characters
3996 127 "^?"
3997 128 - 159 "~@" - "~_"
3998 160 - 254 "| " - "|~"
3999 255 "~?"
4000 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4001 displayed as <xx>, with the hexadecimal value of the byte.
4002 When 'display' contains "uhex" all unprintable characters are
4003 displayed as <xx>.
4004 The NonText highlighting will be used for unprintable characters.
4005 |hl-NonText|
4006
4007 Multi-byte characters 256 and above are always included, only the
4008 characters up to 255 are specified with this option. When a character
4009 is printable but it is not available in the current font, a
4010 replacement character will be shown.
4011 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4012 There is no option to specify these characters.
4013
4014 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4015'joinspaces' 'js' boolean (default on)
4016 global
4017 {not in Vi}
4018 Insert two spaces after a '.', '?' and '!' with a join command.
4019 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4020 Otherwise only one space is inserted.
4021 NOTE: This option is set when 'compatible' is set.
4022
4023 *'key'*
4024'key' string (default "")
4025 local to buffer
4026 {not in Vi}
4027 The key that is used for encrypting and decrypting the current buffer.
4028 See |encryption|.
4029 Careful: Do not set the key value by hand, someone might see the typed
4030 key. Use the |:X| command. But you can make 'key' empty: >
4031 :set key=
4032< It is not possible to get the value of this option with ":set key" or
4033 "echo &key". This is to avoid showing it to someone who shouldn't
4034 know. It also means you cannot see it yourself once you have set it,
4035 be careful not to make a typing error!
4036
4037 *'keymap'* *'kmp'* *E544*
4038'keymap' 'kmp' string (default "")
4039 local to buffer
4040 {not in Vi}
4041 {only available when compiled with the |+keymap|
4042 feature}
4043 Name of a keyboard mapping. See |mbyte-keymap|.
4044 Setting this option to a valid keymap name has the side effect of
4045 setting 'iminsert' to one, so that the keymap becomes effective.
4046 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004047 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004048
4049 *'keymodel'* *'km'*
4050'keymodel' 'km' string (default "")
4051 global
4052 {not in Vi}
4053 List of comma separated words, which enable special things that keys
4054 can do. These values can be used:
4055 startsel Using a shifted special key starts selection (either
4056 Select mode or Visual mode, depending on "key" being
4057 present in 'selectmode').
4058 stopsel Using a not-shifted special key stops selection.
4059 Special keys in this context are the cursor keys, <End>, <Home>,
4060 <PageUp> and <PageDown>.
4061 The 'keymodel' option is set by the |:behave| command.
4062
4063 *'keywordprg'* *'kp'*
4064'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4065 OS/2: "view /", VMS: "help")
4066 global or local to buffer |global-local|
4067 {not in Vi}
4068 Program to use for the |K| command. Environment variables are
4069 expanded |:set_env|. ":help" may be used to access the Vim internal
4070 help. (Note that previously setting the global option to the empty
4071 value did this, which is now deprecated.)
4072 When "man" is used, Vim will automatically translate a count for the
4073 "K" command to a section number. Also for "man -s", in which case the
4074 "-s" is removed when there is no count.
4075 See |option-backslash| about including spaces and backslashes.
4076 Example: >
4077 :set keywordprg=man\ -s
4078< This option cannot be set from a |modeline| or in the |sandbox|, for
4079 security reasons.
4080
4081 *'langmap'* *'lmap'* *E357* *E358*
4082'langmap' 'lmap' string (default "")
4083 global
4084 {not in Vi}
4085 {only available when compiled with the |+langmap|
4086 feature}
4087 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004088 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004089 inserted directly. When in command mode the 'langmap' option takes
4090 care of translating these special characters to the original meaning
4091 of the key. This means you don't have to change the keyboard mode to
4092 be able to execute Normal mode commands.
4093 This is the opposite of the 'keymap' option, where characters are
4094 mapped in Insert mode.
4095 This only works for 8-bit characters. The value of 'langmap' may be
4096 specified with multi-byte characters (e.g., UTF-8), but only the lower
4097 8 bits of each character will be used.
4098
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004099 Example (for Greek, in UTF-8): *greek* >
4100 :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 +00004101< Example (exchanges meaning of z and y for commands): >
4102 :set langmap=zy,yz,ZY,YZ
4103<
4104 The 'langmap' option is a list of parts, separated with commas. Each
4105 part can be in one of two forms:
4106 1. A list of pairs. Each pair is a "from" character immediately
4107 followed by the "to" character. Examples: "aA", "aAbBcC".
4108 2. A list of "from" characters, a semi-colon and a list of "to"
4109 characters. Example: "abc;ABC"
4110 Example: "aA,fgh;FGH,cCdDeE"
4111 Special characters need to be preceded with a backslash. These are
4112 ";", ',' and backslash itself.
4113
4114 This will allow you to activate vim actions without having to switch
4115 back and forth between the languages. Your language characters will
4116 be understood as normal vim English characters (according to the
4117 langmap mappings) in the following cases:
4118 o Normal/Visual mode (commands, buffer/register names, user mappings)
4119 o Insert/Replace Mode: Register names after CTRL-R
4120 o Insert/Replace Mode: Mappings
4121 Characters entered in Command-line mode will NOT be affected by
4122 this option. Note that this option can be changed at any time
4123 allowing to switch between mappings for different languages/encodings.
4124 Use a mapping to avoid having to type it each time!
4125
4126 *'langmenu'* *'lm'*
4127'langmenu' 'lm' string (default "")
4128 global
4129 {not in Vi}
4130 {only available when compiled with the |+menu| and
4131 |+multi_lang| features}
4132 Language to use for menu translation. Tells which file is loaded
4133 from the "lang" directory in 'runtimepath': >
4134 "lang/menu_" . &langmenu . ".vim"
4135< (without the spaces). For example, to always use the Dutch menus, no
4136 matter what $LANG is set to: >
4137 :set langmenu=nl_NL.ISO_8859-1
4138< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004139 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004140 If your $LANG is set to a non-English language but you do want to use
4141 the English menus: >
4142 :set langmenu=none
4143< This option must be set before loading menus, switching on filetype
4144 detection or syntax highlighting. Once the menus are defined setting
4145 this option has no effect. But you could do this: >
4146 :source $VIMRUNTIME/delmenu.vim
4147 :set langmenu=de_DE.ISO_8859-1
4148 :source $VIMRUNTIME/menu.vim
4149< Warning: This deletes all menus that you defined yourself!
4150
4151 *'laststatus'* *'ls'*
4152'laststatus' 'ls' number (default 1)
4153 global
4154 {not in Vi}
4155 The value of this option influences when the last window will have a
4156 status line:
4157 0: never
4158 1: only if there are at least two windows
4159 2: always
4160 The screen looks nicer with a status line if you have several
4161 windows, but it takes another screen line. |status-line|
4162
4163 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4164'lazyredraw' 'lz' boolean (default off)
4165 global
4166 {not in Vi}
4167 When this option is set, the screen will not be redrawn while
4168 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004169 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004170 update use |:redraw|.
4171
4172 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4173'linebreak' 'lbr' boolean (default off)
4174 local to window
4175 {not in Vi}
4176 {not available when compiled without the |+linebreak|
4177 feature}
4178 If on Vim will wrap long lines at a character in 'breakat' rather
4179 than at the last character that fits on the screen. Unlike
4180 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4181 it only affects the way the file is displayed, not its contents. The
4182 value of 'showbreak' is used to put in front of wrapped lines.
4183 This option is not used when the 'wrap' option is off or 'list' is on.
4184 Note that <Tab> characters after an <EOL> are mostly not displayed
4185 with the right amount of white space.
4186
4187 *'lines'* *E593*
4188'lines' number (default 24 or terminal height)
4189 global
4190 Number of lines of the Vim window.
4191 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004192 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004193 When Vim is running in the GUI or in a resizable window, setting this
4194 option will cause the window size to be changed. When you only want
4195 to use the size for the GUI, put the command in your |gvimrc| file.
4196 Vim limits the number of lines to what fits on the screen. You can
4197 use this command to get the tallest window possible: >
4198 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004199< Minimum value is 2, maximum value is 1000.
4200 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004201 When you set this option and Vim is unable to change the physical
4202 number of lines of the display, the display may be messed up.
4203
4204 *'linespace'* *'lsp'*
4205'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4206 global
4207 {not in Vi}
4208 {only in the GUI}
4209 Number of pixel lines inserted between characters. Useful if the font
4210 uses the full character cell height, making lines touch each other.
4211 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004212 With some fonts there can be too much room between lines (to have
4213 space for ascents and descents). Then it makes sense to set
4214 'linespace' to a negative value. This may cause display problems
4215 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004216
4217 *'lisp'* *'nolisp'*
4218'lisp' boolean (default off)
4219 local to buffer
4220 {not available when compiled without the |+lispindent|
4221 feature}
4222 Lisp mode: When <Enter> is typed in insert mode set the indent for
4223 the next line to Lisp standards (well, sort of). Also happens with
4224 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4225 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4226 better. Also see 'lispwords'.
4227 The '-' character is included in keyword characters. Redefines the
4228 "=" operator to use this same indentation algorithm rather than
4229 calling an external program if 'equalprg' is empty.
4230 This option is not used when 'paste' is set.
4231 {Vi: Does it a little bit differently}
4232
4233 *'lispwords'* *'lw'*
4234'lispwords' 'lw' string (default is very long)
4235 global
4236 {not in Vi}
4237 {not available when compiled without the |+lispindent|
4238 feature}
4239 Comma separated list of words that influence the Lisp indenting.
4240 |'lisp'|
4241
4242 *'list'* *'nolist'*
4243'list' boolean (default off)
4244 local to window
4245 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
4246 see the difference between tabs and spaces and for trailing blanks.
4247 Note that this will also affect formatting (set with 'textwidth' or
4248 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
4249 changing the way tabs are displayed.
4250
4251 *'listchars'* *'lcs'*
4252'listchars' 'lcs' string (default "eol:$")
4253 global
4254 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004255 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004256 settings.
4257 eol:c Character to show at the end of each line. When
4258 omitted, there is no extra character at the end of the
4259 line.
4260 tab:xy Two characters to be used to show a Tab. The first
4261 char is used once. The second char is repeated to
4262 fill the space that the Tab normally occupies.
4263 "tab:>-" will show a Tab that takes four spaces as
4264 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004265 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004266 trailing spaces are blank.
4267 extends:c Character to show in the last column, when 'wrap' is
4268 off and the line continues beyond the right of the
4269 screen.
4270 precedes:c Character to show in the first column, when 'wrap'
4271 is off and there is text preceding the character
4272 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004273 nbsp:c Character to show for a non-breakable space (character
4274 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004275
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004276 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004277 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004278 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004279
4280 Examples: >
4281 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004282 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004283 :set lcs=extends:>,precedes:<
4284< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004285 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004286
4287 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4288'loadplugins' 'lpl' boolean (default on)
4289 global
4290 {not in Vi}
4291 When on the plugin scripts are loaded when starting up |load-plugins|.
4292 This option can be reset in your |vimrc| file to disable the loading
4293 of plugins.
4294 Note that using the "-u NONE" and "--noplugin" command line arguments
4295 reset this option. |-u| |--noplugin|
4296
4297 *'magic'* *'nomagic'*
4298'magic' boolean (default on)
4299 global
4300 Changes the special characters that can be used in search patterns.
4301 See |pattern|.
4302 NOTE: To avoid portability problems with using patterns, always keep
4303 this option at the default "on". Only switch it off when working with
4304 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004305 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004306
4307 *'makeef'* *'mef'*
4308'makeef' 'mef' string (default: "")
4309 global
4310 {not in Vi}
4311 {not available when compiled without the |+quickfix|
4312 feature}
4313 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4314 and the |:grep| command.
4315 When it is empty, an internally generated temp file will be used.
4316 When "##" is included, it is replaced by a number to make the name
4317 unique. This makes sure that the ":make" command doesn't overwrite an
4318 existing file.
4319 NOT used for the ":cf" command. See 'errorfile' for that.
4320 Environment variables are expanded |:set_env|.
4321 See |option-backslash| about including spaces and backslashes.
4322 This option cannot be set from a |modeline| or in the |sandbox|, for
4323 security reasons.
4324
4325 *'makeprg'* *'mp'*
4326'makeprg' 'mp' string (default "make", VMS: "MMS")
4327 global or local to buffer |global-local|
4328 {not in Vi}
4329 Program to use for the ":make" command. See |:make_makeprg|. This
4330 option may contain '%' and '#' characters, which are expanded like
4331 when used in a command-line. Environment variables are expanded
4332 |:set_env|. See |option-backslash| about including spaces and
4333 backslashes. Note that a '|' must be escaped twice: once for ":set"
4334 and once for the interpretation of a command. When you use a filter
4335 called "myfilter" do it like this: >
4336 :set makeprg=gmake\ \\\|\ myfilter
4337< The placeholder "$*" can be given (even multiple times) to specify
4338 where the arguments will be included, for example: >
4339 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4340< This option cannot be set from a |modeline| or in the |sandbox|, for
4341 security reasons.
4342
4343 *'matchpairs'* *'mps'*
4344'matchpairs' 'mps' string (default "(:),{:},[:]")
4345 local to buffer
4346 {not in Vi}
4347 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004348 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00004349 must be different. The characters must be separated by a colon. The
4350 pairs must be separated by a comma. Example for including '<' and '>'
4351 (HTML): >
4352 :set mps+=<:>
4353
4354< A more exotic example, to jump between the '=' and ';' in an
4355 assignment, useful for languages like C and Java: >
4356 :au FileType c,cpp,java set mps+==:;
4357
4358< For a more advanced way of using "%", see the matchit.vim plugin in
4359 the $VIMRUNTIME/macros directory. |add-local-help|
4360
4361 *'matchtime'* *'mat'*
4362'matchtime' 'mat' number (default 5)
4363 global
4364 {not in Vi}{in Nvi}
4365 Tenths of a second to show the matching paren, when 'showmatch' is
4366 set. Note that this is not in milliseconds, like other options that
4367 set a time. This is to be compatible with Nvi.
4368
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004369 *'maxcombine'* *'mco'*
4370'maxcombine' 'mco' number (default 2)
4371 global
4372 {not in Vi}
4373 {only available when compiled with the |+multi_byte|
4374 feature}
4375 The maximum number of combining characters supported for displaying.
4376 Only used when 'encoding' is "utf-8".
4377 The default is OK for most languages. Hebrew may require 4.
4378 Maximum value is 6.
4379 Even when this option is set to 2 you can still edit text with more
4380 combining characters, you just can't see them. Use |g8| or |ga|.
4381 See |mbyte-combining|.
4382
Bram Moolenaar071d4272004-06-13 20:20:40 +00004383 *'maxfuncdepth'* *'mfd'*
4384'maxfuncdepth' 'mfd' number (default 100)
4385 global
4386 {not in Vi}
4387 Maximum depth of function calls for user functions. This normally
4388 catches endless recursion. When using a recursive function with
4389 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4390 more memory, there is the danger of failing when memory is exhausted.
4391 See also |:function|.
4392
4393 *'maxmapdepth'* *'mmd'* *E223*
4394'maxmapdepth' 'mmd' number (default 1000)
4395 global
4396 {not in Vi}
4397 Maximum number of times a mapping is done without resulting in a
4398 character to be used. This normally catches endless mappings, like
4399 ":map x y" with ":map y x". It still does not catch ":map g wg",
4400 because the 'w' is used before the next mapping is done. See also
4401 |key-mapping|.
4402
4403 *'maxmem'* *'mm'*
4404'maxmem' 'mm' number (default between 256 to 5120 (system
4405 dependent) or half the amount of memory
4406 available)
4407 global
4408 {not in Vi}
4409 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4410 limit is reached allocating extra memory for a buffer will cause
4411 other memory to be freed. Maximum value 2000000. Use this to work
4412 without a limit. Also see 'maxmemtot'.
4413
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004414 *'maxmempattern'* *'mmp'*
4415'maxmempattern' 'mmp' number (default 1000)
4416 global
4417 {not in Vi}
4418 Maximum amount of memory (in Kbyte) to use for pattern matching.
4419 Maximum value 2000000. Use this to work without a limit.
4420 *E363*
4421 When Vim runs into the limit it gives an error message mostly behaves
4422 like CTRL-C was typed.
4423 Running into the limit often means that the pattern is very
4424 inefficient or too complex. This may already happen with the pattern
4425 "\(.\)*" on a very long line. ".*" works much better.
4426 Vim may run out of memory before hitting the 'maxmempattern' limit.
4427
Bram Moolenaar071d4272004-06-13 20:20:40 +00004428 *'maxmemtot'* *'mmt'*
4429'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4430 dependent) or half the amount of memory
4431 available)
4432 global
4433 {not in Vi}
4434 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004435 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004436 'maxmem'.
4437
4438 *'menuitems'* *'mis'*
4439'menuitems' 'mis' number (default 25)
4440 global
4441 {not in Vi}
4442 {not available when compiled without the |+menu|
4443 feature}
4444 Maximum number of items to use in a menu. Used for menus that are
4445 generated from a list of items, e.g., the Buffers menu. Changing this
4446 option has no direct effect, the menu must be refreshed first.
4447
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004448 *'mkspellmem'* *'msm'*
4449'mkspellmem' 'msm' string (default "460000,2000,500")
4450 global
4451 {not in Vi}
4452 {not available when compiled without the |+syntax|
4453 feature}
4454 Parameters for |:mkspell|. This tunes when to start compressing the
4455 word tree. Compression can be slow when there are many words, but
4456 it's needed to avoid running out of memory. The amount of memory used
4457 per word depends very much on how similar the words are, that's why
4458 this tuning is complicated.
4459
4460 There are three numbers, separated by commas:
4461 {start},{inc},{added}
4462
4463 For most languages the uncompressed word tree fits in memory. {start}
4464 gives the amount of memory in Kbyte that can be used before any
4465 compression is done. It should be a bit smaller than the amount of
4466 memory that is available to Vim.
4467
4468 When going over the {start} limit the {inc} number specifies the
4469 amount of memory in Kbyte that can be allocated before another
4470 compression is done. A low number means compression is done after
4471 less words are added, which is slow. A high number means more memory
4472 will be allocated.
4473
4474 After doing compression, {added} times 1024 words can be added before
4475 the {inc} limit is ignored and compression is done when any extra
4476 amount of memory is needed. A low number means there is a smaller
4477 chance of hitting the {inc} limit, less memory is used but it's
4478 slower.
4479
4480 The languages for which these numbers are important are Italian and
4481 Hungarian. The default works for when you have about 512 Mbyte. If
4482 you have 1 Gbyte you could use: >
4483 :set mkspellmem=900000,3000,800
4484< If you have less than 512 Mbyte |:mkspell| may fail for some
4485 languages, no matter what you set 'mkspellmem' to.
4486
Bram Moolenaar071d4272004-06-13 20:20:40 +00004487 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4488'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4489 local to buffer
4490 *'modelines'* *'mls'*
4491'modelines' 'mls' number (default 5)
4492 global
4493 {not in Vi}
4494 If 'modeline' is on 'modelines' gives the number of lines that is
4495 checked for set commands. If 'modeline' is off or 'modelines' is zero
4496 no lines are checked. See |modeline|.
4497 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4498 set and to the Vim default value when 'compatible' is reset.
4499
4500 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4501'modifiable' 'ma' boolean (default on)
4502 local to buffer
4503 {not in Vi} *E21*
4504 When off the buffer contents cannot be changed. The 'fileformat' and
4505 'fileencoding' options also can't be changed.
4506 Can be reset with the |-M| command line argument.
4507
4508 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4509'modified' 'mod' boolean (default off)
4510 local to buffer
4511 {not in Vi}
4512 When on, the buffer is considered to be modified. This option is set
4513 when:
4514 1. A change was made to the text since it was last written. Using the
4515 |undo| command to go back to the original text will reset the
4516 option. But undoing changes that were made before writing the
4517 buffer will set the option again, since the text is different from
4518 when it was written.
4519 2. 'fileformat' or 'fileencoding' is different from its original
4520 value. The original value is set when the buffer is read or
4521 written. A ":set nomodified" command also resets the original
4522 values to the current values and the 'modified' option will be
4523 reset.
4524 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4525 will be ignored.
4526
4527 *'more'* *'nomore'*
4528'more' boolean (Vim default: on, Vi default: off)
4529 global
4530 {not in Vi}
4531 When on, listings pause when the whole screen is filled. You will get
4532 the |more-prompt|. When this option is off there are no pauses, the
4533 listing continues until finished.
4534 NOTE: This option is set to the Vi default value when 'compatible' is
4535 set and to the Vim default value when 'compatible' is reset.
4536
4537 *'mouse'* *E538*
4538'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4539 global
4540 {not in Vi}
4541 Enable the use of the mouse. Only works for certain terminals
4542 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4543 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4544 The mouse can be enabled for different modes:
4545 n Normal mode
4546 v Visual mode
4547 i Insert mode
4548 c Command-line mode
4549 h all previous modes when editing a help file
4550 a all previous modes
4551 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004552 Normally you would enable the mouse in all four modes with: >
4553 :set mouse=a
4554< When the mouse is not enabled, the GUI will still use the mouse for
4555 modeless selection. This doesn't move the text cursor.
4556
4557 See |mouse-using|. Also see |'clipboard'|.
4558
4559 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004560 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004561 the mouse buttons can still be used by keeping the shift key pressed.
4562 Also see the 'clipboard' option.
4563
4564 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4565'mousefocus' 'mousef' boolean (default off)
4566 global
4567 {not in Vi}
4568 {only works in the GUI}
4569 The window that the mouse pointer is on is automatically activated.
4570 When changing the window layout or window focus in another way, the
4571 mouse pointer is moved to the window with keyboard focus. Off is the
4572 default because it makes using the pull down menus a little goofy, as
4573 a pointer transit may activate a window unintentionally.
4574
4575 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4576'mousehide' 'mh' boolean (default on)
4577 global
4578 {not in Vi}
4579 {only works in the GUI}
4580 When on, the mouse pointer is hidden when characters are typed.
4581 The mouse pointer is restored when the mouse is moved.
4582
4583 *'mousemodel'* *'mousem'*
4584'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4585 global
4586 {not in Vi}
4587 Sets the model to use for the mouse. The name mostly specifies what
4588 the right mouse button is used for:
4589 extend Right mouse button extends a selection. This works
4590 like in an xterm.
4591 popup Right mouse button pops up a menu. The shifted left
4592 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004593 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004594 popup_setpos Like "popup", but the cursor will be moved to the
4595 position where the mouse was clicked, and thus the
4596 selected operation will act upon the clicked object.
4597 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004598 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004599 course, that right clicking outside a selection will
4600 end Visual mode.
4601 Overview of what button does what for each model:
4602 mouse extend popup(_setpos) ~
4603 left click place cursor place cursor
4604 left drag start selection start selection
4605 shift-left search word extend selection
4606 right click extend selection popup menu (place cursor)
4607 right drag extend selection -
4608 middle click paste paste
4609
4610 In the "popup" model the right mouse button produces a pop-up menu.
4611 You need to define this first, see |popup-menu|.
4612
4613 Note that you can further refine the meaning of buttons with mappings.
4614 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4615 selection (because that's handled in the GUI code directly).
4616
4617 The 'mousemodel' option is set by the |:behave| command.
4618
4619 *'mouseshape'* *'mouses'* *E547*
4620'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004621 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004622 global
4623 {not in Vi}
4624 {only available when compiled with the |+mouseshape|
4625 feature}
4626 This option tells Vim what the mouse pointer should look like in
4627 different modes. The option is a comma separated list of parts, much
4628 like used for 'guicursor'. Each part consist of a mode/location-list
4629 and an argument-list:
4630 mode-list:shape,mode-list:shape,..
4631 The mode-list is a dash separated list of these modes/locations:
4632 In a normal window: ~
4633 n Normal mode
4634 v Visual mode
4635 ve Visual mode with 'selection' "exclusive" (same as 'v',
4636 if not specified)
4637 o Operator-pending mode
4638 i Insert mode
4639 r Replace mode
4640
4641 Others: ~
4642 c appending to the command-line
4643 ci inserting in the command-line
4644 cr replacing in the command-line
4645 m at the 'Hit ENTER' or 'More' prompts
4646 ml idem, but cursor in the last line
4647 e any mode, pointer below last window
4648 s any mode, pointer on a status line
4649 sd any mode, while dragging a status line
4650 vs any mode, pointer on a vertical separator line
4651 vd any mode, while dragging a vertical separator line
4652 a everywhere
4653
4654 The shape is one of the following:
4655 avail name looks like ~
4656 w x arrow Normal mouse pointer
4657 w x blank no pointer at all (use with care!)
4658 w x beam I-beam
4659 w x updown up-down sizing arrows
4660 w x leftright left-right sizing arrows
4661 w x busy The system's usual busy pointer
4662 w x no The system's usual 'no input' pointer
4663 x udsizing indicates up-down resizing
4664 x lrsizing indicates left-right resizing
4665 x crosshair like a big thin +
4666 x hand1 black hand
4667 x hand2 white hand
4668 x pencil what you write with
4669 x question big ?
4670 x rightup-arrow arrow pointing right-up
4671 w x up-arrow arrow pointing up
4672 x <number> any X11 pointer number (see X11/cursorfont.h)
4673
4674 The "avail" column contains a 'w' if the shape is available for Win32,
4675 x for X11.
4676 Any modes not specified or shapes not available use the normal mouse
4677 pointer.
4678
4679 Example: >
4680 :set mouseshape=s:udsizing,m:no
4681< will make the mouse turn to a sizing arrow over the status lines and
4682 indicate no input when the hit-enter prompt is displayed (since
4683 clicking the mouse has no effect in this state.)
4684
4685 *'mousetime'* *'mouset'*
4686'mousetime' 'mouset' number (default 500)
4687 global
4688 {not in Vi}
4689 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4690 time in msec between two mouse clicks for the second click to be
4691 recognized as a multi click.
4692
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004693 *'mzquantum'* *'mzq'*
4694'mzquantum' 'mzq' number (default 100)
4695 global
4696 {not in Vi}
4697 {not available when compiled without the |+mzscheme|
4698 feature}
4699 The number of milliseconds between polls for MzScheme threads.
4700 Negative or zero value means no thread scheduling.
4701
Bram Moolenaar071d4272004-06-13 20:20:40 +00004702 *'nrformats'* *'nf'*
4703'nrformats' 'nf' string (default "octal,hex")
4704 local to buffer
4705 {not in Vi}
4706 This defines what bases Vim will consider for numbers when using the
4707 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4708 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004709 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004710 incremented or decremented. This is useful for a list with a
4711 letter index a), b), etc.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004712 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004713 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004714 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004715 considered to be hexadecimal. Example: Using CTRL-X on
4716 "0x100" results in "0x0ff".
4717 Numbers which simply begin with a digit in the range 1-9 are always
4718 considered decimal. This also happens for numbers that are not
4719 recognized as octal or hex.
4720
4721 *'number'* *'nu'* *'nonumber'* *'nonu'*
4722'number' 'nu' boolean (default off)
4723 local to window
4724 Print the line number in front of each line. When the 'n' option is
4725 excluded from 'cpoptions' a wrapped line will not use the column of
4726 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004727 The 'numberwidth' option can be used to set the room used for the line
4728 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004729 When a long, wrapped line doesn't start with the first character, '-'
4730 characters are put before the number.
4731 See |hl-LineNr| for the highlighting used for the number.
4732
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004733 *'numberwidth'* *'nuw'*
4734'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4735 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004736 {not in Vi}
4737 {only available when compiled with the |+linebreak|
4738 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004739 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00004740 when the 'number' option is set or printing lines with a line number.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004741 Since one space is always between the number and the text, there is
4742 one less character for the number itself.
4743 The value is the minimum width. A bigger width is used when needed to
4744 fit the highest line number in the buffer. Thus with the Vim default
4745 of 4 there is room for a line number up to 999. When the buffer has
4746 1000 lines five columns will be used.
4747 The minimum value is 1, the maximum value is 10.
4748 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4749
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004750 *'omnifunc'* *'ofu'*
4751'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00004752 local to buffer
4753 {not in Vi}
4754 {not available when compiled without the +eval
4755 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00004756 This option specifies a function to be used for Insert mode omni
4757 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00004758 See |complete-functions| for an explanation of how the function is
4759 invoked and what it should return.
Bram Moolenaare344bea2005-09-01 20:46:49 +00004760
4761
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00004762 *'operatorfunc'* *'opfunc'*
4763'operatorfunc' 'opfunc' string (default: empty)
4764 global
4765 {not in Vi}
4766 This option specifies a function to be called by the |g@| operator.
4767 See |:map-operator| for more info and an example.
4768
4769 This option cannot be set from a |modeline| or in the |sandbox|, for
4770 security reasons.
4771
4772
Bram Moolenaar071d4272004-06-13 20:20:40 +00004773 *'osfiletype'* *'oft'* *E366*
4774'osfiletype' 'oft' string (RISC-OS default: "Text",
4775 others default: "")
4776 local to buffer
4777 {not in Vi}
4778 {only available when compiled with the |+osfiletype|
4779 feature}
4780 Some operating systems store extra information about files besides
4781 name, datestamp and permissions. This option contains the extra
4782 information, the nature of which will vary between systems.
4783 The value of this option is usually set when the file is loaded, and
4784 use to set the file type when file is written.
4785 It can affect the pattern matching of the automatic commands.
4786 |autocmd-osfiletypes|
4787
4788 *'paragraphs'* *'para'*
4789'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4790 global
4791 Specifies the nroff macros that separate paragraphs. These are pairs
4792 of two letters (see |object-motions|).
4793
4794 *'paste'* *'nopaste'*
4795'paste' boolean (default off)
4796 global
4797 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004798 Put Vim in Paste mode. This is useful if you want to cut or copy
4799 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004800 unexpected effects.
4801 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004802 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004803 knows about pasting and will mostly do the right thing without 'paste'
4804 being set. The same is true for a terminal where Vim handles the
4805 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004806 This option is reset when starting the GUI. Thus if you set it in
4807 your .vimrc it will work in a terminal, but not in the GUI. Setting
4808 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4809 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004810 When the 'paste' option is switched on (also when it was already on):
4811 - mapping in Insert mode and Command-line mode is disabled
4812 - abbreviations are disabled
4813 - 'textwidth' is set to 0
4814 - 'wrapmargin' is set to 0
4815 - 'autoindent' is reset
4816 - 'smartindent' is reset
4817 - 'softtabstop' is set to 0
4818 - 'revins' is reset
4819 - 'ruler' is reset
4820 - 'showmatch' is reset
4821 - 'formatoptions' is used like it is empty
4822 These options keep their value, but their effect is disabled:
4823 - 'lisp'
4824 - 'indentexpr'
4825 - 'cindent'
4826 NOTE: When you start editing another file while the 'paste' option is
4827 on, settings from the modelines or autocommands may change the
4828 settings again, causing trouble when pasting text. You might want to
4829 set the 'paste' option again.
4830 When the 'paste' option is reset the mentioned options are restored to
4831 the value before the moment 'paste' was switched from off to on.
4832 Resetting 'paste' before ever setting it does not have any effect.
4833 Since mapping doesn't work while 'paste' is active, you need to use
4834 the 'pastetoggle' option to toggle the 'paste' option with some key.
4835
4836 *'pastetoggle'* *'pt'*
4837'pastetoggle' 'pt' string (default "")
4838 global
4839 {not in Vi}
4840 When non-empty, specifies the key sequence that toggles the 'paste'
4841 option. This is like specifying a mapping: >
4842 :map {keys} :set invpaste<CR>
4843< Where {keys} is the value of 'pastetoggle'.
4844 The difference is that it will work even when 'paste' is set.
4845 'pastetoggle' works in Insert mode and Normal mode, but not in
4846 Command-line mode.
4847 Mappings are checked first, thus overrule 'pastetoggle'. However,
4848 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4849 this: >
4850 :map <F10> :set paste<CR>
4851 :map <F11> :set nopaste<CR>
4852 :imap <F10> <C-O>:set paste<CR>
4853 :imap <F11> <nop>
4854 :set pastetoggle=<F11>
4855< This will make <F10> start paste mode and <F11> stop paste mode.
4856 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4857 mode everything is inserted literally, except the 'pastetoggle' key
4858 sequence.
4859
4860 *'pex'* *'patchexpr'*
4861'patchexpr' 'pex' string (default "")
4862 global
4863 {not in Vi}
4864 {not available when compiled without the |+diff|
4865 feature}
4866 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004867 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004868
4869 *'patchmode'* *'pm'* *E206*
4870'patchmode' 'pm' string (default "")
4871 global
4872 {not in Vi}
4873 When non-empty the oldest version of a file is kept. This can be used
4874 to keep the original version of a file if you are changing files in a
4875 source distribution. Only the first time that a file is written a
4876 copy of the original file will be kept. The name of the copy is the
4877 name of the original file with the string in the 'patchmode' option
4878 appended. This option should start with a dot. Use a string like
4879 ".org". 'backupdir' must not be empty for this to work (Detail: The
4880 backup file is renamed to the patchmode file after the new file has
4881 been successfully written, that's why it must be possible to write a
4882 backup file). If there was no file to be backed up, an empty file is
4883 created.
4884 When the 'backupskip' pattern matches, a patchmode file is not made.
4885 Using 'patchmode' for compressed files appends the extension at the
4886 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4887 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004888 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004889
4890 *'path'* *'pa'* *E343* *E345* *E347*
4891'path' 'pa' string (default on Unix: ".,/usr/include,,"
4892 on OS/2: ".,/emx/include,,"
4893 other systems: ".,,")
4894 global or local to buffer |global-local|
4895 {not in Vi}
4896 This is a list of directories which will be searched when using the
4897 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4898 being searched for has a relative path (not starting with '/'). The
4899 directories in the 'path' option may be relative or absolute.
4900 - Use commas to separate directory names: >
4901 :set path=.,/usr/local/include,/usr/include
4902< - Spaces can also be used to separate directory names (for backwards
4903 compatibility with version 3.0). To have a space in a directory
4904 name, precede it with an extra backslash, and escape the space: >
4905 :set path=.,/dir/with\\\ space
4906< - To include a comma in a directory name precede it with an extra
4907 backslash: >
4908 :set path=.,/dir/with\\,comma
4909< - To search relative to the directory of the current file, use: >
4910 :set path=.
4911< - To search in the current directory use an empty string between two
4912 commas: >
4913 :set path=,,
4914< - A directory name may end in a ':' or '/'.
4915 - Environment variables are expanded |:set_env|.
4916 - When using |netrw.vim| URLs can be used. For example, adding
4917 "http://www.vim.org" will make ":find index.html" work.
4918 - Search upwards and downwards in a directory tree:
4919 1) "*" matches a sequence of characters, e.g.: >
4920 :set path=/usr/include/*
4921< means all subdirectories in /usr/include (but not /usr/include
4922 itself). >
4923 :set path=/usr/*c
4924< matches /usr/doc and /usr/src.
4925 2) "**" matches a subtree, up to 100 directories deep. Example: >
4926 :set path=/home/user_x/src/**
4927< means search in the whole subtree under "/home/usr_x/src".
4928 3) If the path ends with a ';', this path is the startpoint
4929 for upward search.
4930 See |file-searching| for more info and exact syntax.
4931 {not available when compiled without the |+path_extra| feature}
4932 - Careful with '\' characters, type two to get one in the option: >
4933 :set path=.,c:\\include
4934< Or just use '/' instead: >
4935 :set path=.,c:/include
4936< Don't forget "." or files won't even be found in the same directory as
4937 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004938 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004939 it is something like 256 or 1024 characters.
4940 You can check if all the include files are found, using the value of
4941 'path', see |:checkpath|.
4942 The use of |:set+=| and |:set-=| is preferred when adding or removing
4943 directories from the list. This avoids problems when a future version
4944 uses another default. To remove the current directory use: >
4945 :set path-=
4946< To add the current directory use: >
4947 :set path+=
4948< To use an environment variable, you probably need to replace the
4949 separator. Here is an example to append $INCL, in which directory
4950 names are separated with a semi-colon: >
4951 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4952< Replace the ';' with a ':' or whatever separator is used. Note that
4953 this doesn't work when $INCL contains a comma or white space.
4954
4955 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4956'preserveindent' 'pi' boolean (default off)
4957 local to buffer
4958 {not in Vi}
4959 When changing the indent of the current line, preserve as much of the
4960 indent structure as possible. Normally the indent is replaced by a
4961 series of tabs followed by spaces as required (unless |'expandtab'| is
4962 enabled, in which case only spaces are used). Enabling this option
4963 means the indent will preserve as many existing characters as possible
4964 for indenting, and only add additional tabs or spaces as required.
4965 NOTE: When using ">>" multiple times the resulting indent is a mix of
4966 tabs and spaces. You might not like this.
4967 NOTE: 'preserveindent' is reset when 'compatible' is set.
4968 Also see 'copyindent'.
4969 Use |:retab| to clean up white space.
4970
4971 *'previewheight'* *'pvh'*
4972'previewheight' 'pvh' number (default 12)
4973 global
4974 {not in Vi}
4975 {not available when compiled without the |+windows| or
4976 |+quickfix| feature}
4977 Default height for a preview window. Used for |:ptag| and associated
4978 commands. Used for |CTRL-W_}| when no count is given.
4979
4980 *'previewwindow'* *'nopreviewwindow'*
4981 *'pvw'* *'nopvw'* *E590*
4982'previewwindow' 'pvw' boolean (default off)
4983 local to window
4984 {not in Vi}
4985 {not available when compiled without the |+windows| or
4986 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004987 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004988 set. It's normally not set directly, but by using one of the commands
4989 |:ptag|, |:pedit|, etc.
4990
4991 *'printdevice'* *'pdev'*
4992'printdevice' 'pdev' string (default empty)
4993 global
4994 {not in Vi}
4995 {only available when compiled with the |+printer|
4996 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004997 The name of the printer to be used for |:hardcopy|.
4998 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004999 This option cannot be set from a |modeline| or in the |sandbox|, for
5000 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005001
Bram Moolenaar8299df92004-07-10 09:47:34 +00005002 *'printencoding'* *'penc'*
5003'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005004 global
5005 {not in Vi}
5006 {only available when compiled with the |+printer|
5007 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005008 Sets the character encoding used when printing.
5009 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005010
5011 *'printexpr'* *'pexpr'*
5012'printexpr' 'pexpr' String (default: see below)
5013 global
5014 {not in Vi}
5015 {only available when compiled with the |+printer|
5016 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005017 Expression used to print the PostScript produced with |:hardcopy|.
5018 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005019
Bram Moolenaar8299df92004-07-10 09:47:34 +00005020 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005021'printfont' 'pfn' string (default "courier")
5022 global
5023 {not in Vi}
5024 {only available when compiled with the |+printer|
5025 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005026 The name of the font that will be used for |:hardcopy|.
5027 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005028
5029 *'printheader'* *'pheader'*
5030'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5031 global
5032 {not in Vi}
5033 {only available when compiled with the |+printer|
5034 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005035 The format of the header produced in |:hardcopy| output.
5036 See |pheader-option|.
5037
5038 *'printmbcharset'* *'pmbcs'*
5039'printmbcharset' 'pmbcs' string (default "")
5040 global
5041 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005042 {only available when compiled with the |+printer|,
5043 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005044 The CJK character set to be used for CJK output from |:hardcopy|.
5045 See |pmbcs-option|.
5046
5047 *'printmbfont'* *'pmbfn'*
5048'printmbfont' 'pmbfn' string (default "")
5049 global
5050 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005051 {only available when compiled with the |+printer|,
5052 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005053 List of font names to be used for CJK output from |:hardcopy|.
5054 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005055
5056 *'printoptions'* *'popt'*
5057'printoptions' 'popt' string (default "")
5058 global
5059 {not in Vi}
5060 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005061 List of items that control the format of the output of |:hardcopy|.
5062 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005063
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005064 *'prompt'* *'noprompt'*
5065'prompt' boolean (default on)
5066 global
5067 When on a ":" prompt is used in Ex mode.
5068
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005069 *'pumheight'* *'ph'*
5070'pumheight' 'ph' number (default 0)
5071 global
5072 {not available when compiled without the
5073 |+insert_expand| feature}
5074 {not in Vi}
5075 Determines the maximum number of items to show in the popup menu.
5076 When zero as much space as available is used.
5077 |ins-completion-menu|.
5078
5079
Bram Moolenaar677ee682005-01-27 14:41:15 +00005080 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005081'quoteescape' 'qe' string (default "\")
5082 local to buffer
5083 {not in Vi}
5084 The characters that are used to escape quotes in a string. Used for
5085 objects like a', a" and a` |a'|.
5086 When one of the characters in this option is found inside a string,
5087 the following character will be skipped. The default value makes the
5088 text "foo\"bar\\" considered to be one string.
5089
Bram Moolenaar071d4272004-06-13 20:20:40 +00005090 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5091'readonly' 'ro' boolean (default off)
5092 local to buffer
5093 If on, writes fail unless you use a '!'. Protects you from
5094 accidentally overwriting a file. Default on when Vim is started
5095 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005096 When using ":w!" the 'readonly' option is reset for the current
5097 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005098 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005099 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005100
5101 *'remap'* *'noremap'*
5102'remap' boolean (default on)
5103 global
5104 Allows for mappings to work recursively. If you do not want this for
5105 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005106 NOTE: To avoid portability problems with Vim scripts, always keep
5107 this option at the default "on". Only switch it off when working with
5108 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005109
5110 *'report'*
5111'report' number (default 2)
5112 global
5113 Threshold for reporting number of lines changed. When the number of
5114 changed lines is more than 'report' a message will be given for most
5115 ":" commands. If you want it always, set 'report' to 0.
5116 For the ":substitute" command the number of substitutions is used
5117 instead of the number of lines.
5118
5119 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5120'restorescreen' 'rs' boolean (default on)
5121 global
5122 {not in Vi} {only in Windows 95/NT console version}
5123 When set, the screen contents is restored when exiting Vim. This also
5124 happens when executing external commands.
5125
5126 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5127 options in your .vimrc. To disable restoring:
5128 set t_ti= t_te=
5129 To enable restoring (for an xterm):
5130 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5131 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5132
5133 *'revins'* *'ri'* *'norevins'* *'nori'*
5134'revins' 'ri' boolean (default off)
5135 global
5136 {not in Vi}
5137 {only available when compiled with the |+rightleft|
5138 feature}
5139 Inserting characters in Insert mode will work backwards. See "typing
5140 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5141 command in Insert mode, when 'allowrevins' is set.
5142 NOTE: This option is reset when 'compatible' or 'paste' is set.
5143
5144 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5145'rightleft' 'rl' boolean (default off)
5146 local to window
5147 {not in Vi}
5148 {only available when compiled with the |+rightleft|
5149 feature}
5150 When on, display orientation becomes right-to-left, i.e., characters
5151 that are stored in the file appear from the right to the left.
5152 Using this option, it is possible to edit files for languages that
5153 are written from the right to the left such as Hebrew and Arabic.
5154 This option is per window, so it is possible to edit mixed files
5155 simultaneously, or to view the same file in both ways (this is
5156 useful whenever you have a mixed text file with both right-to-left
5157 and left-to-right strings so that both sets are displayed properly
5158 in different windows). Also see |rileft.txt|.
5159
5160 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
5161'rightleftcmd' 'rlc' string (default "search")
5162 local to window
5163 {not in Vi}
5164 {only available when compiled with the |+rightleft|
5165 feature}
5166 Each word in this option enables the command line editing to work in
5167 right-to-left mode for a group of commands:
5168
5169 search "/" and "?" commands
5170
5171 This is useful for languages such as Hebrew, Arabic and Farsi.
5172 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5173
5174 *'ruler'* *'ru'* *'noruler'* *'noru'*
5175'ruler' 'ru' boolean (default off)
5176 global
5177 {not in Vi}
5178 {not available when compiled without the
5179 |+cmdline_info| feature}
5180 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005181 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182 text in the file is shown on the far right:
5183 Top first line is visible
5184 Bot last line is visible
5185 All first and last line are visible
5186 45% relative position in the file
5187 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005188 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005189 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005190 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005191 this option takes precedence over 'ruler' and 'rulerformat'
5192 If the number of characters displayed is different from the number of
5193 bytes in the text (e.g., for a TAB or a multi-byte character), both
5194 the text column (byte number) and the screen column are shown,
5195 separated with a dash.
5196 For an empty line "0-1" is shown.
5197 For an empty buffer the line number will also be zero: "0,0-1".
5198 This option is reset when the 'paste' option is set.
5199 If you don't want to see the ruler all the time but want to know where
5200 you are, use "g CTRL-G" |g_CTRL-G|.
5201 NOTE: This option is reset when 'compatible' is set.
5202
5203 *'rulerformat'* *'ruf'*
5204'rulerformat' 'ruf' string (default empty)
5205 global
5206 {not in Vi}
5207 {not available when compiled without the |+statusline|
5208 feature}
5209 When this option is not empty, it determines the content of the ruler
5210 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005211 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005212 The default ruler width is 17 characters. To make the ruler 15
5213 characters wide, put "%15(" at the start and "%)" at the end.
5214 Example: >
5215 :set rulerformat=%15(%c%V\ %p%%%)
5216<
5217 *'runtimepath'* *'rtp'* *vimfiles*
5218'runtimepath' 'rtp' string (default:
5219 Unix: "$HOME/.vim,
5220 $VIM/vimfiles,
5221 $VIMRUNTIME,
5222 $VIM/vimfiles/after,
5223 $HOME/.vim/after"
5224 Amiga: "home:vimfiles,
5225 $VIM/vimfiles,
5226 $VIMRUNTIME,
5227 $VIM/vimfiles/after,
5228 home:vimfiles/after"
5229 PC, OS/2: "$HOME/vimfiles,
5230 $VIM/vimfiles,
5231 $VIMRUNTIME,
5232 $VIM/vimfiles/after,
5233 $HOME/vimfiles/after"
5234 Macintosh: "$VIM:vimfiles,
5235 $VIMRUNTIME,
5236 $VIM:vimfiles:after"
5237 RISC-OS: "Choices:vimfiles,
5238 $VIMRUNTIME,
5239 Choices:vimfiles/after"
5240 VMS: "sys$login:vimfiles,
5241 $VIM/vimfiles,
5242 $VIMRUNTIME,
5243 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005244 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005245 global
5246 {not in Vi}
5247 This is a list of directories which will be searched for runtime
5248 files:
5249 filetype.vim filetypes by file name |new-filetype|
5250 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005251 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005252 colors/ color scheme files |:colorscheme|
5253 compiler/ compiler files |:compiler|
5254 doc/ documentation |write-local-help|
5255 ftplugin/ filetype plugins |write-filetype-plugin|
5256 indent/ indent scripts |indent-expression|
5257 keymap/ key mapping files |mbyte-keymap|
5258 lang/ menu translations |:menutrans|
5259 menu.vim GUI menus |menu.vim|
5260 plugin/ plugin scripts |write-plugin|
5261 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005262 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005263 syntax/ syntax files |mysyntaxfile|
5264 tutor/ files for vimtutor |tutor|
5265
5266 And any other file searched for with the |:runtime| command.
5267
5268 The defaults for most systems are setup to search five locations:
5269 1. In your home directory, for your personal preferences.
5270 2. In a system-wide Vim directory, for preferences from the system
5271 administrator.
5272 3. In $VIMRUNTIME, for files distributed with Vim.
5273 *after-directory*
5274 4. In the "after" directory in the system-wide Vim directory. This is
5275 for the system administrator to overrule or add to the distributed
5276 defaults (rarely needed)
5277 5. In the "after" directory in your home directory. This is for
5278 personal preferences to overrule or add to the distributed defaults
5279 or system-wide settings (rarely needed).
5280
5281 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5282 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005283 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005284 wildcards.
5285 See |:runtime|.
5286 Example: >
5287 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5288< This will use the directory "~/vimruntime" first (containing your
5289 personal Vim runtime files), then "/mygroup/vim" (shared between a
5290 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5291 files).
5292 You probably should always include $VIMRUNTIME somewhere, to use the
5293 distributed runtime files. You can put a directory before $VIMRUNTIME
5294 to find files which replace a distributed runtime files. You can put
5295 a directory after $VIMRUNTIME to find files which add to distributed
5296 runtime files.
5297 This option cannot be set from a |modeline| or in the |sandbox|, for
5298 security reasons.
5299
5300 *'scroll'* *'scr'*
5301'scroll' 'scr' number (default: half the window height)
5302 local to window
5303 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5304 set to half the number of lines in the window when the window size
5305 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005306 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005307 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5308 the number of screen lines instead of file lines, makes a difference
5309 when lines wrap}
5310
5311 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5312'scrollbind' 'scb' boolean (default off)
5313 local to window
5314 {not in Vi}
5315 {not available when compiled without the |+scrollbind|
5316 feature}
5317 See also |scroll-binding|. When this option is set, the current
5318 window scrolls as other scrollbind windows (windows that also have
5319 this option set) scroll. This option is useful for viewing the
5320 differences between two versions of a file, see 'diff'.
5321 See |'scrollopt'| for options that determine how this option should be
5322 interpreted.
5323 This option is mostly reset when splitting a window to edit another
5324 file. This means that ":split | edit file" results in two windows
5325 with scroll-binding, but ":split file" does not.
5326
5327 *'scrolljump'* *'sj'*
5328'scrolljump' 'sj' number (default 1)
5329 global
5330 {not in Vi}
5331 Minimal number of lines to scroll when the cursor gets off the
5332 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5333 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005334 When set to a negative number from -1 to -100 this is used as the
5335 percentage of the window height. Thus -50 scrolls half the window
5336 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005337 NOTE: This option is set to 1 when 'compatible' is set.
5338
5339 *'scrolloff'* *'so'*
5340'scrolloff' 'so' number (default 0)
5341 global
5342 {not in Vi}
5343 Minimal number of screen lines to keep above and below the cursor.
5344 This will make some context visible around where you are working. If
5345 you set it to a very large value (999) the cursor line will always be
5346 in the middle of the window (except at the start or end of the file or
5347 when long lines wrap).
5348 For scrolling horizontally see 'sidescrolloff'.
5349 NOTE: This option is set to 0 when 'compatible' is set.
5350
5351 *'scrollopt'* *'sbo'*
5352'scrollopt' 'sbo' string (default "ver,jump")
5353 global
5354 {not available when compiled without the |+scrollbind|
5355 feature}
5356 {not in Vi}
5357 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005358 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5359 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005360 The following words are available:
5361 ver Bind vertical scrolling for 'scrollbind' windows
5362 hor Bind horizontal scrolling for 'scrollbind' windows
5363 jump Applies to the offset between two windows for vertical
5364 scrolling. This offset is the difference in the first
5365 displayed line of the bound windows. When moving
5366 around in a window, another 'scrollbind' window may
5367 reach a position before the start or after the end of
5368 the buffer. The offset is not changed though, when
5369 moving back the 'scrollbind' window will try to scroll
5370 to the desired position when possible.
5371 When now making that window the current one, two
5372 things can be done with the relative offset:
5373 1. When "jump" is not included, the relative offset is
5374 adjusted for the scroll position in the new current
5375 window. When going back to the other window, the
5376 the new relative offset will be used.
5377 2. When "jump" is included, the other windows are
5378 scrolled to keep the same relative offset. When
5379 going back to the other window, it still uses the
5380 same relative offset.
5381 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005382 When 'diff' mode is active there always is vertical scroll binding,
5383 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005384
5385 *'sections'* *'sect'*
5386'sections' 'sect' string (default "SHNHH HUnhsh")
5387 global
5388 Specifies the nroff macros that separate sections. These are pairs of
5389 two letters (See |object-motions|). The default makes a section start
5390 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5391
5392 *'secure'* *'nosecure'* *E523*
5393'secure' boolean (default off)
5394 global
5395 {not in Vi}
5396 When on, ":autocmd", shell and write commands are not allowed in
5397 ".vimrc" and ".exrc" in the current directory and map commands are
5398 displayed. Switch it off only if you know that you will not run into
5399 problems, or when the 'exrc' option is off. On Unix this option is
5400 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005401 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005402 'secure' at the end of your ~/.vimrc then.
5403 This option cannot be set from a |modeline| or in the |sandbox|, for
5404 security reasons.
5405
5406 *'selection'* *'sel'*
5407'selection' 'sel' string (default "inclusive")
5408 global
5409 {not in Vi}
5410 This option defines the behavior of the selection. It is only used
5411 in Visual and Select mode.
5412 Possible values:
5413 value past line inclusive ~
5414 old no yes
5415 inclusive yes yes
5416 exclusive yes no
5417 "past line" means that the cursor is allowed to be positioned one
5418 character past the line.
5419 "inclusive" means that the last character of the selection is included
5420 in an operation. For example, when "x" is used to delete the
5421 selection.
5422 Note that when "exclusive" is used and selecting from the end
5423 backwards, you cannot include the last character of a line, when
5424 starting in Normal mode and 'virtualedit' empty.
5425
5426 The 'selection' option is set by the |:behave| command.
5427
5428 *'selectmode'* *'slm'*
5429'selectmode' 'slm' string (default "")
5430 global
5431 {not in Vi}
5432 This is a comma separated list of words, which specifies when to start
5433 Select mode instead of Visual mode, when a selection is started.
5434 Possible values:
5435 mouse when using the mouse
5436 key when using shifted special keys
5437 cmd when using "v", "V" or CTRL-V
5438 See |Select-mode|.
5439 The 'selectmode' option is set by the |:behave| command.
5440
5441 *'sessionoptions'* *'ssop'*
5442'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005443 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005444 global
5445 {not in Vi}
5446 {not available when compiled without the +mksession
5447 feature}
5448 Changes the effect of the |:mksession| command. It is a comma
5449 separated list of words. Each word enables saving and restoring
5450 something:
5451 word save and restore ~
5452 blank empty windows
5453 buffers hidden and unloaded buffers, not just those in windows
5454 curdir the current directory
5455 folds manually created folds, opened/closed folds and local
5456 fold options
5457 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005458 and contain at least one lowercase letter. Only
5459 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005460 help the help window
5461 localoptions options and mappings local to a window or buffer (not
5462 global values for local options)
5463 options all options and mappings (also global values for local
5464 options)
5465 resize size of the Vim window: 'lines' and 'columns'
5466 sesdir the directory in which the session file is located
5467 will become the current directory (useful with
5468 projects accessed over a network from different
5469 systems)
5470 slash backslashes in file names replaced with forward
5471 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005472 tabpages all tab pages; without this only the current tab page
5473 is restored, so that you can make a session for each
5474 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005475 unix with Unix end-of-line format (single <NL>), even when
5476 on Windows or DOS
5477 winpos position of the whole Vim window
5478 winsize window sizes
5479
5480 Don't include both "curdir" and "sesdir".
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00005481 There is no option to include tab pages yet, only the current tab page
5482 is stored in the session. |tab-page|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005483 When "curdir" nor "sesdir" is included, file names are stored with
5484 absolute paths.
5485 "slash" and "unix" are useful on Windows when sharing session files
5486 with Unix. The Unix version of Vim cannot source dos format scripts,
5487 but the Windows version of Vim can source unix format scripts.
5488
5489 *'shell'* *'sh'* *E91*
5490'shell' 'sh' string (default $SHELL or "sh",
5491 MS-DOS and Win32: "command.com" or
5492 "cmd.exe", OS/2: "cmd")
5493 global
5494 Name of the shell to use for ! and :! commands. When changing the
5495 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5496 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005497 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005498 See |option-backslash| about including spaces and backslashes.
5499 Environment variables are expanded |:set_env|.
5500 If the name of the shell contains a space, you might need to enclose
5501 it in quotes. Example: >
5502 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5503< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005504 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005505 "-f" is not inside the quotes, because it is not part of the command
5506 name. And Vim automagically recognizes the backslashes that are path
5507 separators.
5508 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5509 variable to change the way external commands are executed. See the
5510 libc.inf file of DJGPP.
5511 Under MS-Windows, when the executable ends in ".com" it must be
5512 included. Thus setting the shell to "command.com" or "4dos.com"
5513 works, but "command" and "4dos" do not work for all commands (e.g.,
5514 filtering).
5515 For unknown reasons, when using "4dos.com" the current directory is
5516 changed to "C:\". To avoid this set 'shell' like this: >
5517 :set shell=command.com\ /c\ 4dos
5518< This option cannot be set from a |modeline| or in the |sandbox|, for
5519 security reasons.
5520
5521 *'shellcmdflag'* *'shcf'*
5522'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5523 does not contain "sh" somewhere: "/c")
5524 global
5525 {not in Vi}
5526 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5527 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5528 systems, the default is set according to the value of 'shell', to
5529 reduce the need to set this option by the user. It's not used for
5530 OS/2 (EMX figures this out itself). See |option-backslash| about
5531 including spaces and backslashes. See |dos-shell|.
5532 This option cannot be set from a |modeline| or in the |sandbox|, for
5533 security reasons.
5534
5535 *'shellpipe'* *'sp'*
5536'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5537 global
5538 {not in Vi}
5539 {not available when compiled without the |+quickfix|
5540 feature}
5541 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005542 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005543 including spaces and backslashes.
5544 The name of the temporary file can be represented by "%s" if necessary
5545 (the file name is appended automatically if no %s appears in the value
5546 of this option).
5547 For the Amiga and MS-DOS the default is ">". The output is directly
5548 saved in a file and not echoed to the screen.
5549 For Unix the default it "| tee". The stdout of the compiler is saved
5550 in a file and echoed to the screen. If the 'shell' option is "csh" or
5551 "tcsh" after initializations, the default becomes "|& tee". If the
5552 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5553 "2>&1| tee". This means that stderr is also included.
5554 The initialization of this option is done after reading the ".vimrc"
5555 and the other initializations, so that when the 'shell' option is set
5556 there, the 'shellpipe' option changes automatically, unless it was
5557 explicitly set before.
5558 When 'shellpipe' is set to an empty string, no redirection of the
5559 ":make" output will be done. This is useful if you use a 'makeprg'
5560 that writes to 'makeef' by itself. If you want no piping, but do
5561 want to include the 'makeef', set 'shellpipe' to a single space.
5562 Don't forget to precede the space with a backslash: ":set sp=\ ".
5563 In the future pipes may be used for filtering and this option will
5564 become obsolete (at least for Unix).
5565 This option cannot be set from a |modeline| or in the |sandbox|, for
5566 security reasons.
5567
5568 *'shellquote'* *'shq'*
5569'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5570 contains "sh" somewhere: "\"")
5571 global
5572 {not in Vi}
5573 Quoting character(s), put around the command passed to the shell, for
5574 the "!" and ":!" commands. The redirection is kept outside of the
5575 quoting. See 'shellxquote' to include the redirection. It's
5576 probably not useful to set both options.
5577 This is an empty string by default. Only known to be useful for
5578 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5579 or bash, where it should be "\"". The default is adjusted according
5580 the value of 'shell', to reduce the need to set this option by the
5581 user. See |dos-shell|.
5582 This option cannot be set from a |modeline| or in the |sandbox|, for
5583 security reasons.
5584
5585 *'shellredir'* *'srr'*
5586'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5587 global
5588 {not in Vi}
5589 String to be used to put the output of a filter command in a temporary
5590 file. See also |:!|. See |option-backslash| about including spaces
5591 and backslashes.
5592 The name of the temporary file can be represented by "%s" if necessary
5593 (the file name is appended automatically if no %s appears in the value
5594 of this option).
5595 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5596 or "zsh" during initializations, the default becomes ">&". If the
5597 'shell' option is "sh", "ksh" or "bash" the default becomes
5598 ">%s 2>&1". This means that stderr is also included.
5599 For Win32, the Unix checks are done and additionally "cmd" is checked
5600 for, which makes the default ">%s 2>&1". Also, the same names with
5601 ".exe" appended are checked for.
5602 The initialization of this option is done after reading the ".vimrc"
5603 and the other initializations, so that when the 'shell' option is set
5604 there, the 'shellredir' option changes automatically unless it was
5605 explicitly set before.
5606 In the future pipes may be used for filtering and this option will
5607 become obsolete (at least for Unix).
5608 This option cannot be set from a |modeline| or in the |sandbox|, for
5609 security reasons.
5610
5611 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5612'shellslash' 'ssl' boolean (default off)
5613 global
5614 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5615 When set, a forward slash is used when expanding file names. This is
5616 useful when a Unix-like shell is used instead of command.com or
5617 cmd.exe. Backward slashes can still be typed, but they are changed to
5618 forward slashes by Vim.
5619 Note that setting or resetting this option has no effect for some
5620 existing file names, thus this option needs to be set before opening
5621 any file for best results. This might change in the future.
5622 'shellslash' only works when a backslash can be used as a path
5623 separator. To test if this is so use: >
5624 if exists('+shellslash')
5625<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005626 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5627'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5628 global
5629 {not in Vi}
5630 When on, use temp files for shell commands. When off use a pipe.
5631 When using a pipe is not possible temp files are used anyway.
5632 Currently a pipe is only supported on Unix. You can check it with: >
5633 :if has("filterpipe")
5634< The advantage of using a pipe is that nobody can read the temp file
5635 and the 'shell' command does not need to support redirection.
5636 The advantage of using a temp file is that the file type and encoding
5637 can be detected.
5638 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5639 |FilterWritePost| autocommands event are not triggered when
5640 'shelltemp' is off.
5641
Bram Moolenaar071d4272004-06-13 20:20:40 +00005642 *'shelltype'* *'st'*
5643'shelltype' 'st' number (default 0)
5644 global
5645 {not in Vi} {only for the Amiga}
5646 On the Amiga this option influences the way how the commands work
5647 which use a shell.
5648 0 and 1: always use the shell
5649 2 and 3: use the shell only to filter lines
5650 4 and 5: use shell only for ':sh' command
5651 When not using the shell, the command is executed directly.
5652
5653 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5654 1 and 3: use "shell cmd" to start external commands
5655
5656 *'shellxquote'* *'sxq'*
5657'shellxquote' 'sxq' string (default: "";
5658 for Win32, when 'shell' contains "sh"
5659 somewhere: "\""
5660 for Unix, when using system(): "\"")
5661 global
5662 {not in Vi}
5663 Quoting character(s), put around the command passed to the shell, for
5664 the "!" and ":!" commands. Includes the redirection. See
5665 'shellquote' to exclude the redirection. It's probably not useful
5666 to set both options.
5667 This is an empty string by default. Known to be useful for
5668 third-party shells when using the Win32 version, such as the MKS Korn
5669 Shell or bash, where it should be "\"". The default is adjusted
5670 according the value of 'shell', to reduce the need to set this option
5671 by the user. See |dos-shell|.
5672 This option cannot be set from a |modeline| or in the |sandbox|, for
5673 security reasons.
5674
5675 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5676'shiftround' 'sr' boolean (default off)
5677 global
5678 {not in Vi}
5679 Round indent to multiple of 'shiftwidth'. Applies to > and <
5680 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5681 a multiple of 'shiftwidth' (this is Vi compatible).
5682 NOTE: This option is reset when 'compatible' is set.
5683
5684 *'shiftwidth'* *'sw'*
5685'shiftwidth' 'sw' number (default 8)
5686 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005687 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005688 |'cindent'|, |>>|, |<<|, etc.
5689
5690 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005691'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5692 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005693 global
5694 {not in Vi}
5695 This option helps to avoid all the |hit-enter| prompts caused by file
5696 messages, for example with CTRL-G, and to avoid some other messages.
5697 It is a list of flags:
5698 flag meaning when present ~
5699 f use "(3 of 5)" instead of "(file 3 of 5)"
5700 i use "[noeol]" instead of "[Incomplete last line]"
5701 l use "999L, 888C" instead of "999 lines, 888 characters"
5702 m use "[+]" instead of "[Modified]"
5703 n use "[New]" instead of "[New File]"
5704 r use "[RO]" instead of "[readonly]"
5705 w use "[w]" instead of "written" for file write message
5706 and "[a]" instead of "appended" for ':w >> file' command
5707 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5708 "[unix format]" and "[mac]" instead of "[mac format]".
5709 a all of the above abbreviations
5710
5711 o overwrite message for writing a file with subsequent message
5712 for reading a file (useful for ":wn" or when 'autowrite' on)
5713 O message for reading a file overwrites any previous message.
5714 Also for quickfix message (e.g., ":cn").
5715 s don't give "search hit BOTTOM, continuing at TOP" or "search
5716 hit TOP, continuing at BOTTOM" messages
5717 t truncate file message at the start if it is too long to fit
5718 on the command-line, "<" will appear in the left most column.
5719 Ignored in Ex mode.
5720 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005721 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005722 Ignored in Ex mode.
5723 W don't give "written" or "[w]" when writing a file
5724 A don't give the "ATTENTION" message when an existing swap file
5725 is found.
5726 I don't give the intro message when starting Vim |:intro|.
5727
5728 This gives you the opportunity to avoid that a change between buffers
5729 requires you to hit <Enter>, but still gives as useful a message as
5730 possible for the space available. To get the whole message that you
5731 would have got with 'shm' empty, use ":file!"
5732 Useful values:
5733 shm= No abbreviation of message.
5734 shm=a Abbreviation, but no loss of information.
5735 shm=at Abbreviation, and truncate message when necessary.
5736
5737 NOTE: This option is set to the Vi default value when 'compatible' is
5738 set and to the Vim default value when 'compatible' is reset.
5739
5740 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5741'shortname' 'sn' boolean (default off)
5742 local to buffer
5743 {not in Vi, not in MS-DOS versions}
5744 Filenames are assumed to be 8 characters plus one extension of 3
5745 characters. Multiple dots in file names are not allowed. When this
5746 option is on, dots in file names are replaced with underscores when
5747 adding an extension (".~" or ".swp"). This option is not available
5748 for MS-DOS, because then it would always be on. This option is useful
5749 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5750 or crossdos. When running the Win32 GUI version under Win32s, this
5751 option is always on by default.
5752
5753 *'showbreak'* *'sbr'* *E595*
5754'showbreak' 'sbr' string (default "")
5755 global
5756 {not in Vi}
5757 {not available when compiled without the |+linebreak|
5758 feature}
5759 String to put at the start of lines that have been wrapped. Useful
5760 values are "> " or "+++ ".
5761 Only printable single-cell characters are allowed, excluding <Tab> and
5762 comma (in a future version the comma might be used to separate the
5763 part that is shown at the end and at the start of a line).
5764 The characters are highlighted according to the '@' flag in
5765 'highlight'.
5766 Note that tabs after the showbreak will be displayed differently.
5767 If you want the 'showbreak' to appear in between line numbers, add the
5768 "n" flag to 'cpoptions'.
5769
5770 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5771'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5772 off)
5773 global
5774 {not in Vi}
5775 {not available when compiled without the
5776 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005777 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005778 terminal is slow.
5779 In Visual mode the size of the selected area is shown:
5780 - When selecting characters within a line, the number of characters.
5781 - When selecting more than one line, the number of lines.
5782 - When selecting a block, the size in screen characters: linesxcolumns.
5783 NOTE: This option is set to the Vi default value when 'compatible' is
5784 set and to the Vim default value when 'compatible' is reset.
5785
5786 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5787'showfulltag' 'sft' boolean (default off)
5788 global
5789 {not in Vi}
5790 When completing a word in insert mode (see |ins-completion|) from the
5791 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005792 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005793 matched a C function, you can see a template for what arguments are
5794 required (coding style permitting).
5795
5796 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5797'showmatch' 'sm' boolean (default off)
5798 global
5799 When a bracket is inserted, briefly jump to the matching one. The
5800 jump is only done if the match can be seen on the screen. The time to
5801 show the match can be set with 'matchtime'.
5802 A Beep is given if there is no match (no matter if the match can be
5803 seen or not). This option is reset when the 'paste' option is set.
5804 When the 'm' flag is not included in 'cpoptions', typing a character
5805 will immediately move the cursor back to where it belongs.
5806 See the "sm" field in 'guicursor' for setting the cursor shape and
5807 blinking when showing the match.
5808 The 'matchpairs' option can be used to specify the characters to show
5809 matches for. 'rightleft' and 'revins' are used to look for opposite
5810 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005811 Also see the matchparen plugin for highlighting the match when moving
5812 around |pi_paren.txt|.
5813 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005814
5815 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5816'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5817 global
5818 If in Insert, Replace or Visual mode put a message on the last line.
5819 Use the 'M' flag in 'highlight' to set the type of highlighting for
5820 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005821 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005822 doesn't mean XIM is really active, especially when 'imactivatekey' is
5823 not set.
5824 NOTE: This option is set to the Vi default value when 'compatible' is
5825 set and to the Vim default value when 'compatible' is reset.
5826
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00005827 *'showtabline'* *'stal'*
5828'showtabline' 'stal' number (default 1)
5829 global
5830 {not in Vi}
5831 {not available when compiled without the +windows
5832 feature}
5833 The value of this option specifies when the line with tab page labels
5834 will be displayed:
5835 0: never
5836 1: only if there are at least two tab pages
5837 2: always
5838 This is both for the GUI and non-GUI implementation of the tab pages
5839 line.
5840 See |tab-page| for more information about tab pages.
5841
Bram Moolenaar071d4272004-06-13 20:20:40 +00005842 *'sidescroll'* *'ss'*
5843'sidescroll' 'ss' number (default 0)
5844 global
5845 {not in Vi}
5846 The minimal number of columns to scroll horizontally. Used only when
5847 the 'wrap' option is off and the cursor is moved off of the screen.
5848 When it is zero the cursor will be put in the middle of the screen.
5849 When using a slow terminal set it to a large number or 0. When using
5850 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5851 commands.
5852
5853 *'sidescrolloff'* *'siso'*
5854'sidescrolloff' 'siso' number (default 0)
5855 global
5856 {not in Vi}
5857 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005858 right of the cursor if 'nowrap' is set. Setting this option to a
5859 value greater than 0 while having |'sidescroll'| also at a non-zero
5860 value makes some context visible in the line you are scrolling in
5861 horizontally (except at beginning of the line). Setting this option
5862 to a large value (like 999) has the effect of keeping the cursor
5863 horizontally centered in the window, as long as one does not come too
5864 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005865 NOTE: This option is set to 0 when 'compatible' is set.
5866
5867 Example: Try this together with 'sidescroll' and 'listchars' as
5868 in the following example to never allow the cursor to move
5869 onto the "extends" character:
5870
5871 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5872 :set sidescrolloff=1
5873
5874
5875 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5876'smartcase' 'scs' boolean (default off)
5877 global
5878 {not in Vi}
5879 Override the 'ignorecase' option if the search pattern contains upper
5880 case characters. Only used when the search pattern is typed and
5881 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005882 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005883 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5884 recalling the search pattern from history and hitting <Enter>.
5885 NOTE: This option is reset when 'compatible' is set.
5886
5887 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5888'smartindent' 'si' boolean (default off)
5889 local to buffer
5890 {not in Vi}
5891 {not available when compiled without the
5892 |+smartindent| feature}
5893 Do smart autoindenting when starting a new line. Works for C-like
5894 programs, but can also be used for other languages. 'cindent' does
5895 something like this, works better in most cases, but is more strict,
5896 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5897 'indentexpr' is a more advanced alternative.
5898 Normally 'autoindent' should also be on when using 'smartindent'.
5899 An indent is automatically inserted:
5900 - After a line ending in '{'.
5901 - After a line starting with a keyword from 'cinwords'.
5902 - Before a line starting with '}' (only with the "O" command).
5903 When typing '}' as the first character in a new line, that line is
5904 given the same indent as the matching '{'.
5905 When typing '#' as the first character in a new line, the indent for
5906 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005907 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005908 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5909 When using the ">>" command, lines starting with '#' are not shifted
5910 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005911 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005912 is set smart indenting is disabled.
5913
5914 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5915'smarttab' 'sta' boolean (default off)
5916 global
5917 {not in Vi}
5918 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00005919 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
5920 <BS> will delete a 'shiftwidth' worth of space at the start of the
5921 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005922 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00005923 'softtabstop'. 'shiftwidth' is only used for shifting text left or
5924 right |shift-left-right|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005925 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5926 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005927 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005928 NOTE: This option is reset when 'compatible' is set.
5929
5930 *'softtabstop'* *'sts'*
5931'softtabstop' 'sts' number (default 0)
5932 local to buffer
5933 {not in Vi}
5934 Number of spaces that a <Tab> counts for while performing editing
5935 operations, like inserting a <Tab> or using <BS>. It "feels" like
5936 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5937 used. This is useful to keep the 'ts' setting at its standard value
5938 of 8, while being able to edit like it is set to 'sts'. However,
5939 commands like "x" still work on the actual characters.
5940 When 'sts' is zero, this feature is off.
5941 'softtabstop' is set to 0 when the 'paste' option is set.
5942 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5943 spaces is minimized by using <Tab>s.
5944 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5945 set.
5946 NOTE: This option is set to 0 when 'compatible' is set.
5947
Bram Moolenaar217ad922005-03-20 22:37:15 +00005948 *'spell'* *'nospell'*
5949'spell' boolean (default off)
5950 local to window
5951 {not in Vi}
5952 {not available when compiled without the |+syntax|
5953 feature}
5954 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005955 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005956
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005957 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005958'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005959 local to buffer
5960 {not in Vi}
5961 {not available when compiled without the |+syntax|
5962 feature}
5963 Pattern to locate the end of a sentence. The following word will be
5964 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005965 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005966 When this check is not wanted make this option empty.
5967 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005968 Be careful with special characters, see |option-backslash| about
5969 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005970 To set this option automatically depending on the language, see
5971 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005972
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005973 *'spellfile'* *'spf'*
5974'spellfile' 'spf' string (default empty)
5975 local to buffer
5976 {not in Vi}
5977 {not available when compiled without the |+syntax|
5978 feature}
5979 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00005980 commands. It must end in ".{encoding}.add". You need to include the
5981 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005982 *E765*
5983 It may also be a comma separated list of names. A count before the
5984 |zg| and |zw| commands can be used to access each. This allows using
5985 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005986 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005987 you: Using the first directory in 'runtimepath' that is writable. If
5988 there is no "spell" directory yet it will be created. For the file
5989 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00005990 ignoring the region.
5991 The resulting ".spl" file will be used for spell checking, it does not
5992 have to appear in 'spelllang'.
5993 Normally one file is used for all regions, but you can add the region
5994 name if you want to. However, it will then only be used when
5995 'spellfile' is set to it, for entries in 'spelllang' only files
5996 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00005997 This option cannot be set from a |modeline| or in the |sandbox|, for
5998 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005999
Bram Moolenaar217ad922005-03-20 22:37:15 +00006000 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006001'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006002 local to buffer
6003 {not in Vi}
6004 {not available when compiled without the |+syntax|
6005 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006006 A comma separated list of word list names. When the 'spell' option is
6007 on spellchecking will be done for these languages. Example: >
6008 set spelllang=en_us,nl,medical
6009< This means US English, Dutch and medical words are recognized. Words
6010 that are not recognized will be highlighted.
6011 The word list name must not include a comma or dot. Using a dash is
6012 recommended to separate the two letter language name from a
6013 specification. Thus "en-rare" is used for rare English words.
6014 A region name must come last and have the form "_xx", where "xx" is
6015 the two-letter, lower case region name. You can use more than one
6016 region by listing them: "en_us,en_ca" supports both US and Canadian
6017 English, but not words specific for Australia, New Zealand or Great
6018 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006019 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006020 As a special case the name of a .spl file can be given as-is. The
6021 first "_xx" in the name is removed and used as the region name
6022 (_xx is an underscore, two letters and followed by a non-letter).
6023 This is mainly for testing purposes. You must make sure the correct
6024 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006025 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006026 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6027 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006028 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006029
Bram Moolenaar98692072006-02-04 00:57:42 +00006030 If the |spellfile.vim| plugin is active and you use a language name
6031 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6032 will ask you if you want to download the file.
6033
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006034 After this option has been set successfully, Vim will source the files
6035 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006036 up to the first comma, dot or underscore.
6037 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006038
6039
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006040 *'spellsuggest'* *'sps'*
6041'spellsuggest' 'sps' string (default "best")
6042 global
6043 {not in Vi}
6044 {not available when compiled without the |+syntax|
6045 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006046 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006047 the |spellsuggest()| function. This is a comma-separated list of
6048 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006049
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006050 best Internal method that works best for English. Finds
6051 changes like "fast" and uses a bit of sound-a-like
6052 scoring to improve the ordering.
6053
6054 double Internal method that uses two methods and mixes the
6055 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006056 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006057 word. That only works when the language specifies
6058 sound folding. Can be slow and doesn't always give
6059 better results.
6060
6061 fast Internal method that only checks for simple changes:
6062 character inserts/deletes/swaps. Works well for
6063 simple typing mistakes.
6064
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006065 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006066 Not used for |spellsuggest()|. The number of
6067 suggestions is never more than the value of 'lines'
6068 minus two.
6069
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006070 file:{filename} Read file {filename}, which must have two columns,
6071 separated by a slash. The first column contains the
6072 bad word, the second column the suggested good word.
6073 Example:
6074 theribal/terrible ~
6075 Use this for common mistakes that do not appear at the
6076 top of the suggestion list with the internal methods.
6077 Lines without a slash are ignored, use this for
6078 comments.
6079 The file is used for all languages.
6080
6081 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6082 trouble with spaces. |v:val| holds the badly spelled
6083 word. The expression must evaluate to a List of
6084 Lists, each with a suggestion and a score.
6085 Example:
6086 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006087 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006088 internal methods use. A lower score is better.
6089 This may invoke |spellsuggest()| if you temporarily
6090 set 'spellsuggest' to exclude the "expr:" part.
6091 Errors are silently ignored, unless you set the
6092 'verbose' option to a non-zero value.
6093
6094 Only one of "best", "double" or "fast" may be used. The others may
6095 appear several times in any order. Example: >
6096 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6097<
6098 This option cannot be set from a |modeline| or in the |sandbox|, for
6099 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006100
6101
Bram Moolenaar071d4272004-06-13 20:20:40 +00006102 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6103'splitbelow' 'sb' boolean (default off)
6104 global
6105 {not in Vi}
6106 {not available when compiled without the +windows
6107 feature}
6108 When on, splitting a window will put the new window below the current
6109 one. |:split|
6110
6111 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6112'splitright' 'spr' boolean (default off)
6113 global
6114 {not in Vi}
6115 {not available when compiled without the +vertsplit
6116 feature}
6117 When on, splitting a window will put the new window right of the
6118 current one. |:vsplit|
6119
6120 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6121'startofline' 'sol' boolean (default on)
6122 global
6123 {not in Vi}
6124 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006125 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006126 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006127 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006128 with a linewise operator, with "%" with a count and to buffer changing
6129 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6130 only has a line number, e.g., ":25" or ":+".
6131 In case of buffer changing commands the cursor is placed at the column
6132 where it was the last time the buffer was edited.
6133 NOTE: This option is set when 'compatible' is set.
6134
6135 *'statusline'* *'stl'* *E540* *E541* *E542*
6136'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006137 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006138 {not in Vi}
6139 {not available when compiled without the |+statusline|
6140 feature}
6141 When nonempty, this option determines the content of the status line.
6142 Also see |status-line|.
6143
6144 The option consists of printf style '%' items interspersed with
6145 normal text. Each status line item is of the form:
6146 %-0{minwid}.{maxwid}{item}
6147 All fields except the {item} is optional. A single percent sign can
6148 be given as "%%". Up to 80 items can be specified.
6149
Bram Moolenaar238a5642006-02-21 22:12:05 +00006150 When the option starts with "%!" then it is used as an expression,
6151 evaluated and the result is used as the option value. Example: >
6152 :set statusline=%!MyStatusLine()
6153< The result can contain %{} items that will be evaluated too.
6154
6155 When there is error while evaluating the option then it will be made
6156 empty to avoid further errors. Otherwise screen updating would loop.
6157
Bram Moolenaar071d4272004-06-13 20:20:40 +00006158 Note that the only effect of 'ruler' when this option is set (and
6159 'laststatus' is 2) is controlling the output of |CTRL-G|.
6160
6161 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006162 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006163 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006164 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006165 minwid Minimum width of the item, padding as set by '-' & '0'.
6166 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006167 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006168 on the left for text items. Numeric items will be
6169 shifted down to maxwid-2 digits followed by '>'number
6170 where number is the amount of missing digits, much like
6171 an exponential notation.
6172 item A one letter code as described below.
6173
6174 Following is a description of the possible statusline items. The
6175 second character in "item" is the type:
6176 N for number
6177 S for string
6178 F for flags as described below
6179 - not applicable
6180
6181 item meaning ~
6182 f S Path to the file in the buffer, relative to current directory.
6183 F S Full path to the file in the buffer.
6184 t S File name (tail) of file in the buffer.
6185 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
6186 M F Modified flag, text is ",+" or ",-".
6187 r F Readonly flag, text is " [RO]".
6188 R F Readonly flag, text is ",RO".
6189 h F Help buffer flag, text is " [help]".
6190 H F Help buffer flag, text is ",HLP".
6191 w F Preview window flag, text is " [Preview]".
6192 W F Preview window flag, text is ",PRV".
6193 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
6194 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6195 {not available when compiled without |+autocmd| feature}
6196 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6197 being used: "<keymap>"
6198 n N Buffer number.
6199 b N Value of byte under cursor.
6200 B N As above, in hexadecimal.
6201 o N Byte number in file of byte under cursor, first byte is 1.
6202 Mnemonic: Offset from start of file (with one added)
6203 {not available when compiled without |+byte_offset| feature}
6204 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006205 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006206 l N Line number.
6207 L N Number of lines in buffer.
6208 c N Column number.
6209 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006210 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006211 p N Percentage through file in lines as in |CTRL-G|.
6212 P S Percentage through file of displayed window. This is like the
6213 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006214 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006215 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006216 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006217 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006218 ( - Start of item group. Can be used for setting the width and
6219 alignment of a section. Must be followed by %) somewhere.
6220 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006221 T N For 'tabline': start of tab page N label. Use %T after the last
6222 label. This information is used for mouse clicks.
6223 X N For 'tabline': start of close tab N label. Use %X after the
6224 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6225 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006226 < - Where to truncate line if too long. Default is at the start.
6227 No width fields allowed.
6228 = - Separation point between left and right aligned items.
6229 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006230 # - Set highlight group. The name must follow and then a # again.
6231 Thus use %#HLname# for highlight group HLname. The same
6232 highlighting is used, also for the statusline of non-current
6233 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006234 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006235 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006236 The difference between User{N} and StatusLine will be applied
6237 to StatusLineNC for the statusline of non-current windows.
6238 The number N must be between 1 and 9. See |hl-User1..9|
6239
6240 Display of flags are controlled by the following heuristic:
6241 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006242 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00006243 with a space it is assumed that it wants to separate itself from
6244 anything but other flags. That is: A leading comma is removed if the
6245 preceding character stems from plaintext. A leading space is removed
Bram Moolenaar582fd852005-03-28 20:58:01 +00006246 if the preceding character stems from another active flag. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006247 make a nice display when flags are used like in the examples below.
6248
Bram Moolenaar582fd852005-03-28 20:58:01 +00006249 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006250 not set) and a minwid is not set for the group, the whole group will
6251 become empty. This will make a group like the following disappear
6252 completely from the statusline when none of the flags are set. >
6253 :set statusline=...%(\ [%M%R%H]%)...
6254<
6255 Beware that an expression is evaluated each and every time the status
6256 line is displayed. The current buffer and current window will be set
6257 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006258 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006259 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006260 real current buffer.
6261
6262 The 'statusline' option may be evaluated in the |sandbox|, see
6263 |sandbox-option|.
6264
6265 It is not allowed to change text or jump to another window while
6266 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006267
6268 If the statusline is not updated when you want it (e.g., after setting
6269 a variable that's used in an expression), you can force an update by
6270 setting an option without changing its value. Example: >
6271 :let &ro = &ro
6272
6273< A result of all digits is regarded a number for display purposes.
6274 Otherwise the result is taken as flag text and applied to the rules
6275 described above.
6276
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006277 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006278 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6279 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6280
6281 Examples:
6282 Emulate standard status line with 'ruler' set >
6283 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6284< Similar, but add ASCII value of char under the cursor (like "ga") >
6285 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6286< Display byte count and byte value, modified flag in red. >
6287 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6288 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6289< Display a ,GZ flag if a compressed file is loaded >
6290 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6291< In the |:autocmd|'s: >
6292 :let b:gzflag = 1
6293< And: >
6294 :unlet b:gzflag
6295< And define this function: >
6296 :function VarExists(var, val)
6297 : if exists(a:var) | return a:val | else | return '' | endif
6298 :endfunction
6299<
6300 *'suffixes'* *'su'*
6301'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6302 global
6303 {not in Vi}
6304 Files with these suffixes get a lower priority when multiple files
6305 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006306 suffixes. Spaces after the comma are ignored. A dot is also seen as
6307 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006308 separator, precede it with a backslash (see |option-backslash| about
6309 including spaces and backslashes).
6310 See 'wildignore' for completely ignoring files.
6311 The use of |:set+=| and |:set-=| is preferred when adding or removing
6312 suffixes from the list. This avoids problems when a future version
6313 uses another default.
6314
6315 *'suffixesadd'* *'sua'*
6316'suffixesadd' 'sua' string (default "")
6317 local to buffer
6318 {not in Vi}
6319 {not available when compiled without the
6320 |+file_in_path| feature}
6321 Comma separated list of suffixes, which are used when searching for a
6322 file for the "gf", "[I", etc. commands. Example: >
6323 :set suffixesadd=.java
6324<
6325 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6326'swapfile' 'swf' boolean (default on)
6327 local to buffer
6328 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006329 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006330 swapfile is not wanted for a specific buffer. For example, with
6331 confidential information that even root must not be able to access.
6332 Careful: All text will be in memory:
6333 - Don't use this for big files.
6334 - Recovery will be impossible!
6335 A swapfile will only be present when |'updatecount'| is non-zero and
6336 'swapfile' is set.
6337 When 'swapfile' is reset, the swap file for the current buffer is
6338 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6339 non-zero, a swap file is immediately created.
6340 Also see |swap-file| and |'swapsync'|.
6341
6342 This option is used together with 'bufhidden' and 'buftype' to
6343 specify special kinds of buffers. See |special-buffers|.
6344
6345 *'swapsync'* *'sws'*
6346'swapsync' 'sws' string (default "fsync")
6347 global
6348 {not in Vi}
6349 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006350 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006351 When this option is empty parts of the swap file may be in memory and
6352 not written to disk. When the system crashes you may lose more work.
6353 On Unix the system does a sync now and then without Vim asking for it,
6354 so the disadvantage of setting this option off is small. On some
6355 systems the swap file will not be written at all. For a unix system
6356 setting it to "sync" will use the sync() call instead of the default
6357 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006358 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006359
6360 *'switchbuf'* *'swb'*
6361'switchbuf' 'swb' string (default "")
6362 global
6363 {not in Vi}
6364 This option controls the behavior when switching between buffers.
6365 Possible values (comma separated list):
6366 useopen If included, jump to the first open window that
6367 contains the specified buffer (if there is one).
6368 Otherwise: Do not examine other windows.
6369 This setting is checked with |quickfix| commands, when
6370 jumping to errors (":cc", ":cn", "cp", etc.). It is
6371 also used in all buffer related split commands, for
6372 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006373 usetab Like "useopen", but also consider windows in other tab
6374 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006375 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006376 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006377 Supported in |quickfix| commands that display errors.
6378
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006379 *'synmaxcol'* *'smc'*
6380'synmaxcol' 'smc' number (default 3000)
6381 local to buffer
6382 {not in Vi}
6383 {not available when compiled without the |+syntax|
6384 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006385 Maximum column in which to search for syntax items. In long lines the
6386 text after this column is not highlighted and following lines may not
6387 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006388 This helps to avoid very slow redrawing for an XML file that is one
6389 long line.
6390 Set to zero to remove the limit.
6391
Bram Moolenaar071d4272004-06-13 20:20:40 +00006392 *'syntax'* *'syn'*
6393'syntax' 'syn' string (default empty)
6394 local to buffer
6395 {not in Vi}
6396 {not available when compiled without the |+syntax|
6397 feature}
6398 When this option is set, the syntax with this name is loaded, unless
6399 syntax highlighting has been switched off with ":syntax off".
6400 Otherwise this option does not always reflect the current syntax (the
6401 b:current_syntax variable does).
6402 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006403 not automatically recognized. Example, in an IDL file:
6404 /* vim: set syntax=idl : */ ~
6405 When a dot appears in the value then this separates two filetype
6406 names. Example:
6407 /* vim: set syntax=c.doxygen : */ ~
6408 This will use the "c" syntax first, then the "doxygen" syntax.
6409 Note that the second one must be prepared to be loaded as an addition,
6410 otherwise it will be skipped. More than one dot may appear.
6411 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006412 :set syntax=OFF
6413< To switch syntax highlighting on according to the current value of the
6414 'filetype' option: >
6415 :set syntax=ON
6416< What actually happens when setting the 'syntax' option is that the
6417 Syntax autocommand event is triggered with the value as argument.
6418 This option is not copied to another buffer, independent of the 's' or
6419 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006420 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006421
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006422 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006423'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006424 global
6425 {not in Vi}
6426 {not available when compiled without the +windows
6427 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006428 When nonempty, this option determines the content of the tab pages
6429 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006430 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006431
6432 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006433 option and only when there is no GUI tab line. When 'e' is in
6434 'guioptions' and the GUI supports a tab line 'guitablabel' is used
6435 instead.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006436
6437 The value is evaluated like with 'statusline'. You can use
6438 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006439 the text to be displayed. Use "%1T" for the first label, "%2T" for
6440 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006441
6442 Keep in mind that only one of the tab pages is the current one, others
6443 are invisible and you can't jump to their windows.
6444
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006445
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006446 *'tabpagemax'* *'tpm'*
6447'tabpagemax' 'tpm' number (default 10)
6448 global
6449 {not in Vi}
6450 {not available when compiled without the +windows
6451 feature}
6452 Maximum number of tab pages to be opened by the |-p| command line
6453 argument or the ":tab all" command. |tabpage|
6454
6455
6456 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006457'tabstop' 'ts' number (default 8)
6458 local to buffer
6459 Number of spaces that a <Tab> in the file counts for. Also see
6460 |:retab| command, and 'softtabstop' option.
6461
6462 Note: Setting 'tabstop' to any other value than 8 can make your file
6463 appear wrong in many places (e.g., when printing it).
6464
6465 There are four main ways to use tabs in Vim:
6466 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6467 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
6468 will use a mix of tabs and spaces, but typing Tab and BS will
6469 behave like a tab appears every 4 (or 3) characters.
6470 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6471 'expandtab'. This way you will always insert spaces. The
6472 formatting will never be messed up when 'tabstop' is changed.
6473 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006474 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006475 works when using Vim to edit the file.
6476 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6477 'noexpandtab'. This should then work (for initial indents only)
6478 for any tabstop setting that people use. It might be nice to have
6479 tabs after the first non-blank inserted as spaces if you do this
6480 though. Otherwise aligned comments will be wrong when 'tabstop' is
6481 changed.
6482
6483 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6484'tagbsearch' 'tbs' boolean (default on)
6485 global
6486 {not in Vi}
6487 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006488 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006489 searching makes searching for a tag a LOT faster, but a linear search
6490 will find more tags if the tags file wasn't properly sorted.
6491 Vim normally assumes that your tags files are sorted, or indicate that
6492 they are not sorted. Only when this is not the case does the
6493 'tagbsearch' option need to be switched off.
6494
6495 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006496 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006497 certain files, or retry all files with a linear search. When
6498 'tagbsearch' is off, only a linear search is done.
6499
6500 Linear searching is done anyway, for one file, when Vim finds a line
6501 at the start of the file indicating that it's not sorted: >
6502 !_TAG_FILE_SORTED 0 /some command/
6503< [The whitespace before and after the '0' must be a single <Tab>]
6504
6505 When a binary search was done and no match was found in any of the
6506 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6507 instead of a normal tag name, a retry is done with a linear search.
6508 Tags in unsorted tags files, and matches with different case will only
6509 be found in the retry.
6510
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006511 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006512 linear search can be avoided for the 'ignorecase' case. Use a value
6513 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6514 case-fold sorted with the -f switch to "sort" in most unices, as in
6515 the command: "sort -f -o tags tags". For "Exuberant ctags" version
6516 5.3 or higher the -f or --fold-case-sort switch can be used for this
6517 as well. Note that case must be folded to uppercase for this to work.
6518
6519 When 'tagbsearch' is off, tags searching is slower when a full match
6520 exists, but faster when no full match exists. Tags in unsorted tags
6521 files may only be found with 'tagbsearch' off.
6522 When the tags file is not sorted, or sorted in a wrong way (not on
6523 ASCII byte value), 'tagbsearch' should be off, or the line given above
6524 must be included in the tags file.
6525 This option doesn't affect commands that find all matching tags (e.g.,
6526 command-line completion and ":help").
6527 {Vi: always uses binary search in some versions}
6528
6529 *'taglength'* *'tl'*
6530'taglength' 'tl' number (default 0)
6531 global
6532 If non-zero, tags are significant up to this number of characters.
6533
6534 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6535'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6536 global
6537 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006538 If on and using a tags file in another directory, file names in that
6539 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006540 NOTE: This option is set to the Vi default value when 'compatible' is
6541 set and to the Vim default value when 'compatible' is reset.
6542
6543 *'tags'* *'tag'* *E433*
6544'tags' 'tag' string (default "./tags,tags", when compiled with
6545 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6546 global or local to buffer |global-local|
6547 Filenames for the tag command, separated by spaces or commas. To
6548 include a space or comma in a file name, precede it with a backslash
6549 (see |option-backslash| about including spaces and backslashes).
6550 When a file name starts with "./", the '.' is replaced with the path
6551 of the current file. But only when the 'd' flag is not included in
6552 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6553 |tags-option|.
6554 "*", "**" and other wildcards can be used to search for tags files in
6555 a directory tree. See |file-searching|. {not available when compiled
6556 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006557 The |tagfiles()| function can be used to get a list of the file names
6558 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006559 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6560 files are also supported. They are automatically recognized. The
6561 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6562 differences are ignored (MS-Windows). |emacs-tags|
6563 The use of |:set+=| and |:set-=| is preferred when adding or removing
6564 file names from the list. This avoids problems when a future version
6565 uses another default.
6566 {Vi: default is "tags /usr/lib/tags"}
6567
6568 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6569'tagstack' 'tgst' boolean (default on)
6570 global
6571 {not in all versions of Vi}
6572 When on, the |tagstack| is used normally. When off, a ":tag" or
6573 ":tselect" command with an argument will not push the tag onto the
6574 tagstack. A following ":tag" without an argument, a ":pop" command or
6575 any other command that uses the tagstack will use the unmodified
6576 tagstack, but does change the pointer to the active entry.
6577 Resetting this option is useful when using a ":tag" command in a
6578 mapping which should not change the tagstack.
6579
6580 *'term'* *E529* *E530* *E531*
6581'term' string (default is $TERM, if that fails:
6582 in the GUI: "builtin_gui"
6583 on Amiga: "amiga"
6584 on BeOS: "beos-ansi"
6585 on Mac: "mac-ansi"
6586 on MiNT: "vt52"
6587 on MS-DOS: "pcterm"
6588 on OS/2: "os2ansi"
6589 on Unix: "ansi"
6590 on VMS: "ansi"
6591 on Win 32: "win32")
6592 global
6593 Name of the terminal. Used for choosing the terminal control
6594 characters. Environment variables are expanded |:set_env|.
6595 For example: >
6596 :set term=$TERM
6597< See |termcap|.
6598
6599 *'termbidi'* *'tbidi'*
6600 *'notermbidi'* *'notbidi'*
6601'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6602 global
6603 {not in Vi}
6604 {only available when compiled with the |+arabic|
6605 feature}
6606 The terminal is in charge of Bi-directionality of text (as specified
6607 by Unicode). The terminal is also expected to do the required shaping
6608 that some languages (such as Arabic) require.
6609 Setting this option implies that 'rightleft' will not be set when
6610 'arabic' is set and the value of 'arabicshape' will be ignored.
6611 Note that setting 'termbidi' has the immediate effect that
6612 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6613 This option is reset when the GUI is started.
6614 For further details see |arabic.txt|.
6615
6616 *'termencoding'* *'tenc'*
6617'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6618 Macintosh GUI: "macroman")
6619 global
6620 {only available when compiled with the |+multi_byte|
6621 feature}
6622 {not in Vi}
6623 Encoding used for the terminal. This specifies what character
6624 encoding the keyboard produces and the display will understand. For
6625 the GUI it only applies to the keyboard ('encoding' is used for the
6626 display).
6627 In the Win32 console version the default value is the console codepage
6628 when it differs from the ANSI codepage.
6629 *E617*
6630 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6631 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6632 Any attempts to set a different value will be rejected, and an error
6633 message is shown.
6634 For the Win32 GUI 'termencoding' is not used for typed characters,
6635 because the Win32 system always passes Unicode characters.
6636 When empty, the same encoding is used as for the 'encoding' option.
6637 This is the normal value.
6638 Not all combinations for 'termencoding' and 'encoding' are valid. See
6639 |encoding-table|.
6640 The value for this option must be supported by internal conversions or
6641 iconv(). When this is not possible no conversion will be done and you
6642 will probably experience problems with non-ASCII characters.
6643 Example: You are working with the locale set to euc-jp (Japanese) and
6644 want to edit a UTF-8 file: >
6645 :let &termencoding = &encoding
6646 :set encoding=utf-8
6647< You need to do this when your system has no locale support for UTF-8.
6648
6649 *'terse'* *'noterse'*
6650'terse' boolean (default off)
6651 global
6652 When set: Add 's' flag to 'shortmess' option (this makes the message
6653 for a search that hits the start or end of the file not being
6654 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6655 shortens a lot of messages}
6656
6657 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6658'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6659 global
6660 {not in Vi}
6661 This option is obsolete. Use 'fileformats'.
6662 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6663 set to the default value for the current system. When 'textauto' is
6664 reset, 'fileformats' is made empty.
6665 NOTE: This option is set to the Vi default value when 'compatible' is
6666 set and to the Vim default value when 'compatible' is reset.
6667
6668 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6669'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6670 others: default off)
6671 local to buffer
6672 {not in Vi}
6673 This option is obsolete. Use 'fileformat'.
6674 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6675 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6676 "unix".
6677
6678 *'textwidth'* *'tw'*
6679'textwidth' 'tw' number (default 0)
6680 local to buffer
6681 {not in Vi}
6682 Maximum width of text that is being inserted. A longer line will be
6683 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006684 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6685 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006686 'formatoptions' and |ins-textwidth|.
6687 NOTE: This option is set to 0 when 'compatible' is set.
6688
6689 *'thesaurus'* *'tsr'*
6690'thesaurus' 'tsr' string (default "")
6691 global or local to buffer |global-local|
6692 {not in Vi}
6693 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006694 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006695 the file should contain words with similar meaning, separated by
6696 non-keyword characters (white space is preferred). Maximum line
6697 length is 510 bytes.
6698 To obtain a file to be used here, check out the wordlist FAQ at
6699 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006700 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006701 after a comma are ignored, otherwise spaces are included in the file
6702 name. See |option-backslash| about using backslashes.
6703 The use of |:set+=| and |:set-=| is preferred when adding or removing
6704 directories from the list. This avoids problems when a future version
6705 uses another default.
6706 Backticks cannot be used in this option for security reasons.
6707
6708 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6709'tildeop' 'top' boolean (default off)
6710 global
6711 {not in Vi}
6712 When on: The tilde command "~" behaves like an operator.
6713 NOTE: This option is reset when 'compatible' is set.
6714
6715 *'timeout'* *'to'* *'notimeout'* *'noto'*
6716'timeout' 'to' boolean (default on)
6717 global
6718 *'ttimeout'* *'nottimeout'*
6719'ttimeout' boolean (default off)
6720 global
6721 {not in Vi}
6722 These two options together determine the behavior when part of a
6723 mapped key sequence or keyboard code has been received:
6724
6725 'timeout' 'ttimeout' action ~
6726 off off do not time out
6727 on on or off time out on :mappings and key codes
6728 off on time out on key codes
6729
6730 If both options are off, Vim will wait until either the complete
6731 mapping or key sequence has been received, or it is clear that there
6732 is no mapping or key sequence for the received characters. For
6733 example: if you have mapped "vl" and Vim has received 'v', the next
6734 character is needed to see if the 'v' is followed by an 'l'.
6735 When one of the options is on, Vim will wait for about 1 second for
6736 the next character to arrive. After that the already received
6737 characters are interpreted as single characters. The waiting time can
6738 be changed with the 'timeoutlen' option.
6739 On slow terminals or very busy systems timing out may cause
6740 malfunctioning cursor keys. If both options are off, Vim waits
6741 forever after an entered <Esc> if there are key codes that start
6742 with <Esc>. You will have to type <Esc> twice. If you do not have
6743 problems with key codes, but would like to have :mapped key
6744 sequences not timing out in 1 second, set the 'ttimeout' option and
6745 reset the 'timeout' option.
6746
6747 NOTE: 'ttimeout' is reset when 'compatible' is set.
6748
6749 *'timeoutlen'* *'tm'*
6750'timeoutlen' 'tm' number (default 1000)
6751 global
6752 {not in all versions of Vi}
6753 *'ttimeoutlen'* *'ttm'*
6754'ttimeoutlen' 'ttm' number (default -1)
6755 global
6756 {not in Vi}
6757 The time in milliseconds that is waited for a key code or mapped key
6758 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6759 when part of a command has been typed.
6760 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6761 different timeout value for key codes is desired set 'ttimeoutlen' to
6762 a non-negative number.
6763
6764 ttimeoutlen mapping delay key code delay ~
6765 < 0 'timeoutlen' 'timeoutlen'
6766 >= 0 'timeoutlen' 'ttimeoutlen'
6767
6768 The timeout only happens when the 'timeout' and 'ttimeout' options
6769 tell so. A useful setting would be >
6770 :set timeout timeoutlen=3000 ttimeoutlen=100
6771< (time out on mapping after three seconds, time out on key codes after
6772 a tenth of a second).
6773
6774 *'title'* *'notitle'*
6775'title' boolean (default off, on when title can be restored)
6776 global
6777 {not in Vi}
6778 {not available when compiled without the |+title|
6779 feature}
6780 When on, the title of the window will be set to the value of
6781 'titlestring' (if it is not empty), or to:
6782 filename [+=-] (path) - VIM
6783 Where:
6784 filename the name of the file being edited
6785 - indicates the file cannot be modified, 'ma' off
6786 + indicates the file was modified
6787 = indicates the file is read-only
6788 =+ indicates the file is read-only and modified
6789 (path) is the path of the file being edited
6790 - VIM the server name |v:servername| or "VIM"
6791 Only works if the terminal supports setting window titles
6792 (currently Amiga console, Win32 console, all GUI versions and
6793 terminals with a non- empty 't_ts' option - these are Unix xterm and
6794 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6795 *X11*
6796 When Vim was compiled with HAVE_X11 defined, the original title will
6797 be restored if possible. The output of ":version" will include "+X11"
6798 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6799 works for the icon name |'icon'|.
6800 But: When Vim was started with the |-X| argument, restoring the title
6801 will not work (except in the GUI).
6802 If the title cannot be restored, it is set to the value of 'titleold'.
6803 You might want to restore the title outside of Vim then.
6804 When using an xterm from a remote machine you can use this command:
6805 rsh machine_name xterm -display $DISPLAY &
6806 then the WINDOWID environment variable should be inherited and the
6807 title of the window should change back to what it should be after
6808 exiting Vim.
6809
6810 *'titlelen'*
6811'titlelen' number (default 85)
6812 global
6813 {not in Vi}
6814 {not available when compiled without the |+title|
6815 feature}
6816 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006817 title. When the title is longer, only the end of the path name is
6818 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006819 Using a percentage makes this adapt to the width of the window. But
6820 it won't work perfectly, because the actual number of characters
6821 available also depends on the font used and other things in the title
6822 bar. When 'titlelen' is zero the full path is used. Otherwise,
6823 values from 1 to 30000 percent can be used.
6824 'titlelen' is also used for the 'titlestring' option.
6825
6826 *'titleold'*
6827'titleold' string (default "Thanks for flying Vim")
6828 global
6829 {not in Vi}
6830 {only available when compiled with the |+title|
6831 feature}
6832 This option will be used for the window title when exiting Vim if the
6833 original title cannot be restored. Only happens if 'title' is on or
6834 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006835 This option cannot be set from a |modeline| or in the |sandbox|, for
6836 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006837 *'titlestring'*
6838'titlestring' string (default "")
6839 global
6840 {not in Vi}
6841 {not available when compiled without the |+title|
6842 feature}
6843 When this option is not empty, it will be used for the title of the
6844 window. This happens only when the 'title' option is on.
6845 Only works if the terminal supports setting window titles (currently
6846 Amiga console, Win32 console, all GUI versions and terminals with a
6847 non-empty 't_ts' option).
6848 When Vim was compiled with HAVE_X11 defined, the original title will
6849 be restored if possible |X11|.
6850 When this option contains printf-style '%' items, they will be
6851 expanded according to the rules used for 'statusline'.
6852 Example: >
6853 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6854 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6855< The value of 'titlelen' is used to align items in the middle or right
6856 of the available space.
6857 Some people prefer to have the file name first: >
6858 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6859< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006860 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006861 separating space only when needed.
6862 NOTE: Use of special characters in 'titlestring' may cause the display
6863 to be garbled (e.g., when it contains a CR or NL character).
6864 {not available when compiled without the |+statusline| feature}
6865
6866 *'toolbar'* *'tb'*
6867'toolbar' 'tb' string (default "icons,tooltips")
6868 global
6869 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6870 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006871 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006872 possible values are:
6873 icons Toolbar buttons are shown with icons.
6874 text Toolbar buttons shown with text.
6875 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006876 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006877 tooltips Tooltips are active for toolbar buttons.
6878 Tooltips refer to the popup help text which appears after the mouse
6879 cursor is placed over a toolbar button for a brief moment.
6880
6881 If you want the toolbar to be shown with icons as well as text, do the
6882 following: >
6883 :set tb=icons,text
6884< Motif and Athena cannot display icons and text at the same time. They
6885 will show icons if both are requested.
6886
6887 If none of the strings specified in 'toolbar' are valid or if
6888 'toolbar' is empty, this option is ignored. If you want to disable
6889 the toolbar, you need to set the 'guioptions' option. For example: >
6890 :set guioptions-=T
6891< Also see |gui-toolbar|.
6892
6893 *'toolbariconsize'* *'tbis'*
6894'toolbariconsize' 'tbis' string (default "small")
6895 global
6896 {not in Vi}
6897 {only in the GTK+ 2 GUI}
6898 Controls the size of toolbar icons. The possible values are:
6899 tiny Use tiny toolbar icons.
6900 small Use small toolbar icons (default).
6901 medium Use medium-sized toolbar icons.
6902 large Use large toolbar icons.
6903 The exact dimensions in pixels of the various icon sizes depend on
6904 the current theme. Common dimensions are large=32x32, medium=24x24,
6905 small=20x20 and tiny=16x16.
6906
6907 If 'toolbariconsize' is empty, the global default size as determined
6908 by user preferences or the current theme is used.
6909
6910 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6911'ttybuiltin' 'tbi' boolean (default on)
6912 global
6913 {not in Vi}
6914 When on, the builtin termcaps are searched before the external ones.
6915 When off the builtin termcaps are searched after the external ones.
6916 When this option is changed, you should set the 'term' option next for
6917 the change to take effect, for example: >
6918 :set notbi term=$TERM
6919< See also |termcap|.
6920 Rationale: The default for this option is "on", because the builtin
6921 termcap entries are generally better (many systems contain faulty
6922 xterm entries...).
6923
6924 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6925'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6926 sun-cmd, screen, rxvt, dtterm or
6927 iris-ansi; also on when running Vim in
6928 a DOS console)
6929 global
6930 {not in Vi}
6931 Indicates a fast terminal connection. More characters will be sent to
6932 the screen for redrawing, instead of using insert/delete line
6933 commands. Improves smoothness of redrawing when there are multiple
6934 windows and the terminal does not support a scrolling region.
6935 Also enables the extra writing of characters at the end of each screen
6936 line for lines that wrap. This helps when using copy/paste with the
6937 mouse in an xterm and other terminals.
6938
6939 *'ttymouse'* *'ttym'*
6940'ttymouse' 'ttym' string (default depends on 'term')
6941 global
6942 {not in Vi}
6943 {only in Unix and VMS, doesn't work in the GUI; not
6944 available when compiled without |+mouse|}
6945 Name of the terminal type for which mouse codes are to be recognized.
6946 Currently these three strings are valid:
6947 *xterm-mouse*
6948 xterm xterm-like mouse handling. The mouse generates
6949 "<Esc>[Mscr", where "scr" is three bytes:
6950 "s" = button state
6951 "c" = column plus 33
6952 "r" = row plus 33
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006953 This only works up to 223 columns! See "dec" for a
6954 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006955 xterm2 Works like "xterm", but with the xterm reporting the
6956 mouse position while the mouse is dragged. This works
6957 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006958 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00006959 work. See below for how Vim detects this
6960 automatically.
6961 *netterm-mouse*
6962 netterm NetTerm mouse handling. The mouse generates
6963 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6964 for the row and column.
6965 *dec-mouse*
6966 dec DEC terminal mouse handling. The mouse generates a
6967 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006968 This is also available for an Xterm, if it was
6969 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006970 *jsbterm-mouse*
6971 jsbterm JSB term mouse handling.
6972 *pterm-mouse*
6973 pterm QNX pterm mouse handling.
6974
6975 The mouse handling must be enabled at compile time |+mouse_xterm|
6976 |+mouse_dec| |+mouse_netterm|.
6977 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6978 recognized, if enabled at compile time. DEC terminal mouse codes
6979 are recognized if enabled at compile time, and 'ttymouse' is not
6980 "xterm" (because the xterm and dec mouse codes conflict).
6981 This option is automatically set to "xterm", when the 'term' option is
6982 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6983 or "xterm2" already. The main use of this option is to set it to
6984 "xterm", when the terminal name doesn't start with "xterm", but it can
6985 handle xterm mouse codes.
6986 The "xterm2" value will be set if the xterm version is reported to be
6987 95 of higher. This only works when compiled with the |+termresponse|
6988 feature and if |t_RV| is set to the escape sequence to request the
6989 xterm version number. Otherwise "xterm2" must be set explicitly.
6990 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6991 t_RV to an empty string: >
6992 :set t_RV=
6993<
6994 *'ttyscroll'* *'tsl'*
6995'ttyscroll' 'tsl' number (default 999)
6996 global
6997 Maximum number of lines to scroll the screen. If there are more lines
6998 to scroll the window is redrawn. For terminals where scrolling is
6999 very slow and redrawing is not slow this can be set to a small number,
7000 e.g., 3, to speed up displaying.
7001
7002 *'ttytype'* *'tty'*
7003'ttytype' 'tty' string (default from $TERM)
7004 global
7005 Alias for 'term', see above.
7006
7007 *'undolevels'* *'ul'*
7008'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7009 Win32 and OS/2)
7010 global
7011 {not in Vi}
7012 Maximum number of changes that can be undone. Since undo information
7013 is kept in memory, higher numbers will cause more memory to be used
7014 (nevertheless, a single change can use an unlimited amount of memory).
7015 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7016 itself: >
7017 set ul=0
7018< But you can also get Vi compatibility by including the 'u' flag in
7019 'cpoptions', and still be able to use CTRL-R to repeat undo.
7020 Set to a negative number for no undo at all: >
7021 set ul=-1
7022< This helps when you run out of memory for a single change.
7023 Also see |undo-two-ways|.
7024
7025 *'updatecount'* *'uc'*
7026'updatecount' 'uc' number (default: 200)
7027 global
7028 {not in Vi}
7029 After typing this many characters the swap file will be written to
7030 disk. When zero, no swap file will be created at all (see chapter on
7031 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7032 Vim with the "-n" option, see |startup|. When editing in readonly
7033 mode this option will be initialized to 10000.
7034 The swapfile can be disabled per buffer with |'swapfile'|.
7035 When 'updatecount' is set from zero to non-zero, swap files are
7036 created for all buffers that have 'swapfile' set. When 'updatecount'
7037 is set to zero, existing swap files are not deleted.
7038 Also see |'swapsync'|.
7039 This option has no meaning in buffers where |'buftype'| is "nofile"
7040 or "nowrite".
7041
7042 *'updatetime'* *'ut'*
7043'updatetime' 'ut' number (default 4000)
7044 global
7045 {not in Vi}
7046 If this many milliseconds nothing is typed the swap file will be
7047 written to disk (see |crash-recovery|). Also used for the
7048 |CursorHold| autocommand event.
7049
7050 *'verbose'* *'vbs'*
7051'verbose' 'vbs' number (default 0)
7052 global
7053 {not in Vi, although some versions have a boolean
7054 verbose option}
7055 When bigger than zero, Vim will give messages about what it is doing.
7056 Currently, these messages are given:
7057 >= 1 When the viminfo file is read or written.
7058 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007059 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007060 >= 8 Files for which a group of autocommands is executed.
7061 >= 9 Every executed autocommand.
7062 >= 12 Every executed function.
7063 >= 13 When an exception is thrown, caught, finished, or discarded.
7064 >= 14 Anything pending in a ":finally" clause.
7065 >= 15 Every executed Ex command (truncated at 200 characters).
7066
7067 This option can also be set with the "-V" argument. See |-V|.
7068 This option is also set by the |:verbose| command.
7069
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007070 When the 'verbosefile' option is set then the verbose messages are not
7071 displayed.
7072
7073 *'verbosefile'* *'vfile'*
7074'verbosefile' 'vfile' string (default empty)
7075 global
7076 {not in Vi}
7077 When not empty all messages are written in a file with this name.
7078 When the file exists messages are appended.
7079 Writing to the file ends when Vim exits or when 'verbosefile' is made
7080 empty.
7081 Setting 'verbosefile' to a new value is like making it empty first.
7082 The difference with |:redir| is that verbose messages are not
7083 displayed when 'verbosefile' is set.
7084
Bram Moolenaar071d4272004-06-13 20:20:40 +00007085 *'viewdir'* *'vdir'*
7086'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7087 "$VIM/vimfiles/view",
7088 for Unix: "~/.vim/view",
7089 for Macintosh: "$VIM:vimfiles:view"
7090 for VMS: "sys$login:vimfiles/view"
7091 for RiscOS: "Choices:vimfiles/view")
7092 global
7093 {not in Vi}
7094 {not available when compiled without the +mksession
7095 feature}
7096 Name of the directory where to store files for |:mkview|.
7097 This option cannot be set from a |modeline| or in the |sandbox|, for
7098 security reasons.
7099
7100 *'viewoptions'* *'vop'*
7101'viewoptions' 'vop' string (default: "folds,options,cursor")
7102 global
7103 {not in Vi}
7104 {not available when compiled without the +mksession
7105 feature}
7106 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007107 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007108 word save and restore ~
7109 cursor cursor position in file and in window
7110 folds manually created folds, opened/closed folds and local
7111 fold options
7112 options options and mappings local to a window or buffer (not
7113 global values for local options)
7114 slash backslashes in file names replaced with forward
7115 slashes
7116 unix with Unix end-of-line format (single <NL>), even when
7117 on Windows or DOS
7118
7119 "slash" and "unix" are useful on Windows when sharing view files
7120 with Unix. The Unix version of Vim cannot source dos format scripts,
7121 but the Windows version of Vim can source unix format scripts.
7122
7123 *'viminfo'* *'vi'* *E526* *E527* *E528*
7124'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
7125 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
7126 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
7127 for others: '20,<50,s10,h)
7128 global
7129 {not in Vi}
7130 {not available when compiled without the |+viminfo|
7131 feature}
7132 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007133 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007134 separated list of parameters, each consisting of a single character
7135 identifying the particular parameter, followed by a number or string
7136 which specifies the value of that parameter. If a particular
7137 character is left out, then the default value is used for that
7138 parameter. The following is a list of the identifying characters and
7139 the effect of their value.
7140 CHAR VALUE ~
7141 ! When included, save and restore global variables that start
7142 with an uppercase letter, and don't contain a lowercase
7143 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007144 and "_K_L_M" are not. Only String and Number types are
7145 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007146 " Maximum number of lines saved for each register. Old name of
7147 the '<' item, with the disadvantage that you need to put a
7148 backslash before the ", otherwise it will be recognized as the
7149 start of a comment!
7150 % When included, save and restore the buffer list. If Vim is
7151 started with a file name argument, the buffer list is not
7152 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007153 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007154 without a file name and buffers for help files are not written
7155 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007156 When followed by a number, the number specifies the maximum
7157 number of buffers that are stored. Without a number all
7158 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007159 ' Maximum number of previously edited files for which the marks
7160 are remembered. This parameter must always be included when
7161 'viminfo' is non-empty.
7162 Including this item also means that the |jumplist| and the
7163 |changelist| are stored in the viminfo file.
7164 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007165 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007166 patterns are also saved. When not included, the value of
7167 'history' is used.
7168 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007169 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007170 < Maximum number of lines saved for each register. If zero then
7171 registers are not saved. When not included, all lines are
7172 saved. '"' is the old name for this item.
7173 Also see the 's' item below: limit specified in Kbyte.
7174 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007175 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007176 c When included, convert the text in the viminfo file from the
7177 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007178 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007179 f Whether file marks need to be stored. If zero, file marks ('0
7180 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007181 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007182 cursor position (when exiting or when doing ":wviminfo").
7183 h Disable the effect of 'hlsearch' when loading the viminfo
7184 file. When not included, it depends on whether ":nohlsearch"
7185 has been used since the last search command.
7186 n Name of the viminfo file. The name must immediately follow
7187 the 'n'. Must be the last one! If the "-i" argument was
7188 given when starting Vim, that file name overrides the one
7189 given here with 'viminfo'. Environment variables are expanded
7190 when opening the file, not when setting the option.
7191 r Removable media. The argument is a string (up to the next
7192 ','). This parameter can be given several times. Each
7193 specifies the start of a path for which no marks will be
7194 stored. This is to avoid removable media. For MS-DOS you
7195 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7196 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7197 ignored. Maximum length of each 'r' argument is 50
7198 characters.
7199 s Maximum size of an item in Kbyte. If zero then registers are
7200 not saved. Currently only applies to registers. The default
7201 "s10" will exclude registers with more than 10 Kbyte of text.
7202 Also see the '<' item above: line count limit.
7203
7204 Example: >
7205 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7206<
7207 '50 Marks will be remembered for the last 50 files you
7208 edited.
7209 <1000 Contents of registers (up to 1000 lines each) will be
7210 remembered.
7211 s100 Registers with more than 100 Kbyte text are skipped.
7212 :0 Command-line history will not be saved.
7213 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7214 no / Since '/' is not specified, the default will be used,
7215 that is, save all of the search history, and also the
7216 previous search and substitute patterns.
7217 no % The buffer list will not be saved nor read back.
7218 no h 'hlsearch' highlighting will be restored.
7219
7220 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7221 load the contents of the file, this is not done automatically.
7222
7223 This option cannot be set from a |modeline| or in the |sandbox|, for
7224 security reasons.
7225
7226 *'virtualedit'* *'ve'*
7227'virtualedit' 've' string (default "")
7228 global
7229 {not in Vi}
7230 {not available when compiled without the
7231 |+virtualedit| feature}
7232 A comma separated list of these words:
7233 block Allow virtual editing in Visual block mode.
7234 insert Allow virtual editing in Insert mode.
7235 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007236 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007237
Bram Moolenaar071d4272004-06-13 20:20:40 +00007238 Virtual editing means that the cursor can be positioned where there is
7239 no actual character. This can be halfway into a Tab or beyond the end
7240 of the line. Useful for selecting a rectangle in Visual mode and
7241 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007242 "onemore" is not the same, it will only allow moving the cursor just
7243 after the last character of the line. This makes some commands more
7244 consistent. Previously the cursor was always past the end of the line
7245 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007246 break some plugins or Vim scripts. For example because |l| can move
7247 the cursor after the last character. Use with care!
7248 Using the |$| command will move to the last character in the line, not
7249 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007250 It doesn't make sense to combine "all" with "onemore", but you will
7251 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007252
7253 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7254'visualbell' 'vb' boolean (default off)
7255 global
7256 {not in Vi}
7257 Use visual bell instead of beeping. The terminal code to display the
7258 visual bell is given with 't_vb'. When no beep or flash is wanted,
7259 use ":set vb t_vb=".
7260 Note: When the GUI starts, 't_vb' is reset to its default value. You
7261 might want to set it again in your |gvimrc|.
7262 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7263 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7264 where 40 is the time in msec.
7265 Does not work on the Amiga, you always get a screen flash.
7266 Also see 'errorbells'.
7267
7268 *'warn'* *'nowarn'*
7269'warn' boolean (default on)
7270 global
7271 Give a warning message when a shell command is used while the buffer
7272 has been changed.
7273
7274 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7275'weirdinvert' 'wiv' boolean (default off)
7276 global
7277 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007278 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007279 It is provided for backwards compatibility with version 4.x.
7280 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7281 vice versa. Has no effect when the GUI is running.
7282
7283 *'whichwrap'* *'ww'*
7284'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7285 global
7286 {not in Vi}
7287 Allow specified keys that move the cursor left/right to move to the
7288 previous/next line when the cursor is on the first/last character in
7289 the line. Concatenate characters to allow this for these keys:
7290 char key mode ~
7291 b <BS> Normal and Visual
7292 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007293 h "h" Normal and Visual (not recommended)
7294 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007295 < <Left> Normal and Visual
7296 > <Right> Normal and Visual
7297 ~ "~" Normal
7298 [ <Left> Insert and Replace
7299 ] <Right> Insert and Replace
7300 For example: >
7301 :set ww=<,>,[,]
7302< allows wrap only when cursor keys are used.
7303 When the movement keys are used in combination with a delete or change
7304 operator, the <EOL> also counts for a character. This makes "3h"
7305 different from "3dh" when the cursor crosses the end of a line. This
7306 is also true for "x" and "X", because they do the same as "dl" and
7307 "dh". If you use this, you may also want to use the mapping
7308 ":map <BS> X" to make backspace delete the character in front of the
7309 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007310 When 'l' is included and it is used after an operator at the end of a
7311 line then it will not move to the next line. This makes "dl", "cl",
7312 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007313 NOTE: This option is set to the Vi default value when 'compatible' is
7314 set and to the Vim default value when 'compatible' is reset.
7315
7316 *'wildchar'* *'wc'*
7317'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7318 global
7319 {not in Vi}
7320 Character you have to type to start wildcard expansion in the
7321 command-line, as specified with 'wildmode'.
7322 The character is not recognized when used inside a macro. See
7323 'wildcharm' for that.
7324 Although 'wc' is a number option, you can set it to a special key: >
7325 :set wc=<Esc>
7326< NOTE: This option is set to the Vi default value when 'compatible' is
7327 set and to the Vim default value when 'compatible' is reset.
7328
7329 *'wildcharm'* *'wcm'*
7330'wildcharm' 'wcm' number (default: none (0))
7331 global
7332 {not in Vi}
7333 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007334 recognized when used inside a macro. You can find "spare" command-line
7335 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007336 you'll never actually type 'wildcharm', just use it in mappings that
7337 automatically invoke completion mode, e.g.: >
7338 :set wcm=<C-Z>
7339 :cmap ss so $vim/sessions/*.vim<C-Z>
7340< Then after typing :ss you can use CTRL-P & CTRL-N.
7341
7342 *'wildignore'* *'wig'*
7343'wildignore' 'wig' string (default "")
7344 global
7345 {not in Vi}
7346 {not available when compiled without the |+wildignore|
7347 feature}
7348 A list of file patterns. A file that matches with one of these
7349 patterns is ignored when completing file or directory names.
7350 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7351 Also see 'suffixes'.
7352 Example: >
7353 :set wildignore=*.o,*.obj
7354< The use of |:set+=| and |:set-=| is preferred when adding or removing
7355 a pattern from the list. This avoids problems when a future version
7356 uses another default.
7357
7358 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7359'wildmenu' 'wmnu' boolean (default off)
7360 global
7361 {not in Vi}
7362 {not available if compiled without the |+wildmenu|
7363 feature}
7364 When 'wildmenu' is on, command-line completion operates in an enhanced
7365 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7366 the possible matches are shown just above the command line, with the
7367 first match highlighted (overwriting the status line, if there is
7368 one). Keys that show the previous/next match, such as <Tab> or
7369 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7370 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7371 specified. "longest" and "list" do not start "wildmenu" mode.
7372 If there are more matches than can fit in the line, a ">" is shown on
7373 the right and/or a "<" is shown on the left. The status line scrolls
7374 as needed.
7375 The "wildmenu" mode is abandoned when a key is hit that is not used
7376 for selecting a completion.
7377 While the "wildmenu" is active the following keys have special
7378 meanings:
7379
7380 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7381 <Down> - in filename/menu name completion: move into a
7382 subdirectory or submenu.
7383 <CR> - in menu completion, when the cursor is just after a
7384 dot: move into a submenu.
7385 <Up> - in filename/menu name completion: move up into
7386 parent directory or parent menu.
7387
7388 This makes the menus accessible from the console |console-menus|.
7389
7390 If you prefer the <Left> and <Right> keys to move the cursor instead
7391 of selecting a different match, use this: >
7392 :cnoremap <Left> <Space><BS><Left>
7393 :cnoremap <Right> <Space><BS><Right>
7394<
7395 The "WildMenu" highlighting is used for displaying the current match
7396 |hl-WildMenu|.
7397
7398 *'wildmode'* *'wim'*
7399'wildmode' 'wim' string (Vim default: "full")
7400 global
7401 {not in Vi}
7402 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007403 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00007404 part specifies what to do for each consecutive use of 'wildchar. The
7405 first part specifies the behavior for the first use of 'wildchar',
7406 The second part for the second use, etc.
7407 These are the possible values for each part:
7408 "" Complete only the first match.
7409 "full" Complete the next full match. After the last match,
7410 the original string is used and then the first match
7411 again.
7412 "longest" Complete till longest common string. If this doesn't
7413 result in a longer string, use the next part.
7414 "longest:full" Like "longest", but also start 'wildmenu' if it is
7415 enabled.
7416 "list" When more than one match, list all matches.
7417 "list:full" When more than one match, list all matches and
7418 complete first match.
7419 "list:longest" When more than one match, list all matches and
7420 complete till longest common string.
7421 When there is only a single match, it is fully completed in all cases.
7422
7423 Examples: >
7424 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007425< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007426 :set wildmode=longest,full
7427< Complete longest common string, then each full match >
7428 :set wildmode=list:full
7429< List all matches and complete each full match >
7430 :set wildmode=list,full
7431< List all matches without completing, then each full match >
7432 :set wildmode=longest,list
7433< Complete longest common string, then list alternatives.
7434
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007435 *'wildoptions'* *'wop'*
7436'wildoptions' 'wop' string (default "")
7437 global
7438 {not in Vi}
7439 {not available when compiled without the |+wildignore|
7440 feature}
7441 A list of words that change how command line completion is done.
7442 Currently only one word is allowed:
7443 tagfile When using CTRL-D to list matching tags, the kind of
7444 tag and the file of the tag is listed. Only one match
7445 is displayed per line. Often used tag kinds are:
7446 d #define
7447 f function
7448 Also see |cmdline-completion|.
7449
Bram Moolenaar071d4272004-06-13 20:20:40 +00007450 *'winaltkeys'* *'wak'*
7451'winaltkeys' 'wak' string (default "menu")
7452 global
7453 {not in Vi}
7454 {only used in Win32, Motif, GTK and Photon GUI}
7455 Some GUI versions allow the access to menu entries by using the ALT
7456 key in combination with a character that appears underlined in the
7457 menu. This conflicts with the use of the ALT key for mappings and
7458 entering special characters. This option tells what to do:
7459 no Don't use ALT keys for menus. ALT key combinations can be
7460 mapped, but there is no automatic handling. This can then be
7461 done with the |:simalt| command.
7462 yes ALT key handling is done by the windowing system. ALT key
7463 combinations cannot be mapped.
7464 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007465 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007466 keys can be mapped.
7467 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7468 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007469 This option is not used for <F10>; on Win32 and with GTK <F10> will
7470 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007471
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007472 *'window'* *'wi'*
7473'window' 'wi' number (default screen height - 1)
7474 global
7475 Window height. Do not confuse this with the height of the Vim window,
7476 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007477 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7478 value is smaller than 'lines' minus one. The screen will scroll
7479 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007480 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7481 in a much smarter way, taking care of wrapping lines.
7482 When resizing the Vim window, the value is smaller than 1 or more than
7483 or equal to 'lines' it will be set to 'lines' minus 1.
7484 {Vi also uses the option to specify the number of displayed lines}
7485
Bram Moolenaar071d4272004-06-13 20:20:40 +00007486 *'winheight'* *'wh'* *E591*
7487'winheight' 'wh' number (default 1)
7488 global
7489 {not in Vi}
7490 {not available when compiled without the +windows
7491 feature}
7492 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007493 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007494 current window is smaller, its size is increased, at the cost of the
7495 height of other windows. Set it to 999 to make the current window
7496 always fill the screen (although this has the drawback that ":all"
7497 will create only two windows). Set it to a small number for normal
7498 editing.
7499 Minimum value is 1.
7500 The height is not adjusted after one of the commands to change the
7501 height of the current window.
7502 'winheight' applies to the current window. Use 'winminheight' to set
7503 the minimal height for other windows.
7504
7505 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7506'winfixheight' 'wfh' boolean (default off)
7507 local to window
7508 {not in Vi}
7509 {not available when compiled without the +windows
7510 feature}
7511 Keep the window height when windows are opened or closed and
7512 'equalalways' is set. Set by default for the |preview-window| and
7513 |quickfix-window|.
7514 The height may be changed anyway when running out of room.
7515
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007516 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7517'winfixwidth' 'wfw' boolean (default off)
7518 local to window
7519 {not in Vi}
7520 {not available when compiled without the +windows
7521 feature}
7522 Keep the window width when windows are opened or closed and
7523 'equalalways' is set.
7524 The width may be changed anyway when running out of room.
7525
Bram Moolenaar071d4272004-06-13 20:20:40 +00007526 *'winminheight'* *'wmh'*
7527'winminheight' 'wmh' number (default 1)
7528 global
7529 {not in Vi}
7530 {not available when compiled without the +windows
7531 feature}
7532 The minimal height of a window, when it's not the current window.
7533 This is a hard minimum, windows will never become smaller.
7534 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7535 status bar) if necessary. They will return to at least one line when
7536 they become active (since the cursor has to have somewhere to go.)
7537 Use 'winheight' to set the minimal height of the current window.
7538 This option is only checked when making a window smaller. Don't use a
7539 large number, it will cause errors when opening more than a few
7540 windows. A value of 0 to 3 is reasonable.
7541
7542 *'winminwidth'* *'wmw'*
7543'winminwidth' 'wmw' number (default 1)
7544 global
7545 {not in Vi}
7546 {not available when compiled without the +vertsplit
7547 feature}
7548 The minimal width of a window, when it's not the current window.
7549 This is a hard minimum, windows will never become smaller.
7550 When set to zero, windows may be "squashed" to zero columns (i.e. just
7551 a vertical separator) if necessary. They will return to at least one
7552 line when they become active (since the cursor has to have somewhere
7553 to go.)
7554 Use 'winwidth' to set the minimal width of the current window.
7555 This option is only checked when making a window smaller. Don't use a
7556 large number, it will cause errors when opening more than a few
7557 windows. A value of 0 to 12 is reasonable.
7558
7559 *'winwidth'* *'wiw'* *E592*
7560'winwidth' 'wiw' number (default 20)
7561 global
7562 {not in Vi}
7563 {not available when compiled without the +vertsplit
7564 feature}
7565 Minimal number of columns for the current window. This is not a hard
7566 minimum, Vim will use fewer columns if there is not enough room. If
7567 the current window is smaller, its size is increased, at the cost of
7568 the width of other windows. Set it to 999 to make the current window
7569 always fill the screen. Set it to a small number for normal editing.
7570 The width is not adjusted after one of the commands to change the
7571 width of the current window.
7572 'winwidth' applies to the current window. Use 'winminwidth' to set
7573 the minimal width for other windows.
7574
7575 *'wrap'* *'nowrap'*
7576'wrap' boolean (default on)
7577 local to window
7578 {not in Vi}
7579 This option changes how text is displayed. It doesn't change the text
7580 in the buffer, see 'textwidth' for that.
7581 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007582 displaying continues on the next line. When off lines will not wrap
7583 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007584 moved to a part that is not shown, the screen will scroll
7585 horizontally.
7586 The line will be broken in the middle of a word if necessary. See
7587 'linebreak' to get the break at a word boundary.
7588 To make scrolling horizontally a bit more useful, try this: >
7589 :set sidescroll=5
7590 :set listchars+=precedes:<,extends:>
7591< See 'sidescroll', 'listchars' and |wrap-off|.
7592
7593 *'wrapmargin'* *'wm'*
7594'wrapmargin' 'wm' number (default 0)
7595 local to buffer
7596 Number of characters from the right window border where wrapping
7597 starts. When typing text beyond this limit, an <EOL> will be inserted
7598 and inserting continues on the next line.
7599 Options that add a margin, such as 'number' and 'foldcolumn', cause
7600 the text width to be further reduced. This is Vi compatible.
7601 When 'textwidth' is non-zero, this option is not used.
7602 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7603 and less usefully}
7604
7605 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7606'wrapscan' 'ws' boolean (default on) *E384* *E385*
7607 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007608 Searches wrap around the end of the file. Also applies to |]s| and
7609 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007610
7611 *'write'* *'nowrite'*
7612'write' boolean (default on)
7613 global
7614 {not in Vi}
7615 Allows writing files. When not set, writing a file is not allowed.
7616 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007617 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007618 argument. Filtering text is still possible, even though this requires
7619 writing a temporary file.
7620
7621 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7622'writeany' 'wa' boolean (default off)
7623 global
7624 Allows writing to any file with no need for "!" override.
7625
7626 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7627'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7628 otherwise)
7629 global
7630 {not in Vi}
7631 Make a backup before overwriting a file. The backup is removed after
7632 the file was successfully written, unless the 'backup' option is
7633 also on. Reset this option if your file system is almost full. See
7634 |backup-table| for another explanation.
7635 When the 'backupskip' pattern matches, a backup is not made anyway.
7636 NOTE: This option is set to the default value when 'compatible' is
7637 set.
7638
7639 *'writedelay'* *'wd'*
7640'writedelay' 'wd' number (default 0)
7641 global
7642 {not in Vi}
7643 The number of microseconds to wait for each character sent to the
7644 screen. When non-zero, characters are sent to the terminal one by
7645 one. For MS-DOS pcterm this does not work. For debugging purposes.
7646
7647 vim:tw=78:ts=8:ft=help:norl: