blob: 22c04196ac8648717ab994b47f21e1d75dcc4b66 [file] [log] [blame]
Bram Moolenaarc236c162008-07-13 17:41:49 +00001*options.txt* For Vim version 7.2b. Last change: 2008 Jul 05
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
13For an overview of options see help.txt |option-list|.
14
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
25:se[t] Show all options that differ from their default value.
26
27:se[t] all Show all but terminal options.
28
29:se[t] termcap Show all terminal options. Note that in the GUI the
30 key codes are not shown, because they are generated
31 internally and can't be changed. Changing the terminal
32 codes in the GUI is not useful either...
33
34 *E518* *E519*
35:se[t] {option}? Show value of {option}.
36
37:se[t] {option} Toggle option: set, switch it on.
38 Number option: show value.
39 String option: show value.
40
41:se[t] no{option} Toggle option: Reset, switch it off.
42
43:se[t] {option}! or
44:se[t] inv{option} Toggle option: Invert value. {not in Vi}
45
46 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
47:se[t] {option}& Reset option to its default value. May depend on the
48 current value of 'compatible'. {not in Vi}
49:se[t] {option}&vi Reset option to its Vi default value. {not in Vi}
50:se[t] {option}&vim Reset option to its Vim default value. {not in Vi}
51
52:se[t] all& Set all options, except terminal options, to their
Bram Moolenaarf4b8e572004-06-24 15:53:16 +000053 default value. The values of 'term', 'lines' and
Bram Moolenaar071d4272004-06-13 20:20:40 +000054 'columns' are not changed. {not in Vi}
55
56 *:set-args* *E487* *E521*
57:se[t] {option}={value} or
58:se[t] {option}:{value}
59 Set string or number option to {value}.
60 For numeric options the value can be given in decimal,
61 hex (preceded with 0x) or octal (preceded with '0')
62 (hex and octal are only available for machines which
63 have the strtol() function).
64 The old value can be inserted by typing 'wildchar' (by
65 default this is a <Tab> or CTRL-E if 'compatible' is
66 set). See |cmdline-completion|.
67 White space between {option} and '=' is allowed and
68 will be ignored. White space between '=' and {value}
69 is not allowed.
70 See |option-backslash| for using white space and
71 backslashes in {value}.
72
73:se[t] {option}+={value} *:set+=*
74 Add the {value} to a number option, or append the
75 {value} to a string option. When the option is a
76 comma separated list, a comma is added, unless the
77 value was empty.
78 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000079 are removed. When adding a flag that was already
80 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000081 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000082 {not in Vi}
83
84:se[t] {option}^={value} *:set^=*
85 Multiply the {value} to a number option, or prepend
86 the {value} to a string option. When the option is a
87 comma separated list, a comma is added, unless the
88 value was empty.
89 Also see |:set-args| above.
90 {not in Vi}
91
92:se[t] {option}-={value} *:set-=*
93 Subtract the {value} from a number option, or remove
94 the {value} from a string option, if it is there.
95 If the {value} is not found in a string option, there
96 is no error or warning. When the option is a comma
97 separated list, a comma is deleted, unless the option
98 becomes empty.
99 When the option is a list of flags, {value} must be
100 exactly as they appear in the option. Remove flags
101 one by one to avoid problems.
102 Also see |:set-args| above.
103 {not in Vi}
104
105The {option} arguments to ":set" may be repeated. For example: >
106 :set ai nosi sw=3 ts=3
107If you make an error in one of the arguments, an error message will be given
108and the following arguments will be ignored.
109
110 *:set-verbose*
111When 'verbose' is non-zero, displaying an option value will also tell where it
112was last set. Example: >
113 :verbose set shiftwidth cindent?
Bram Moolenaar446cb832008-06-24 21:56:24 +0000114< 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 ":verbose
119set all" or ":verbose set" without an argument.
120When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000121When the option was set while executing a function, user command or
122autocommand, the script in which it was defined is reported.
123Note that an option may also have been set as a side effect of setting
124'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000125A few special texts:
126 Last set from modeline ~
127 Option was set in a |modeline|.
128 Last set from --cmd argument ~
129 Option was set with command line argument |--cmd| or +.
130 Last set from -c argument ~
131 Option was set with command line argument |-c|, +, |-S| or
132 |-q|.
133 Last set from environment variable ~
134 Option was set from an environment variable, $VIMINIT,
135 $GVIMINIT or $EXINIT.
136 Last set from error handler ~
137 Option was cleared when evaluating it resulted in an error.
138
Bram Moolenaar071d4272004-06-13 20:20:40 +0000139{not available when compiled without the +eval feature}
140
141 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000142For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000143override the value from the termcap. You can then use it in a mapping. If
144the "xx" part contains special characters, use the <t_xx> form: >
145 :set <t_#4>=^[Ot
146This can also be used to translate a special code for a normal key. For
147example, if Alt-b produces <Esc>b, use this: >
148 :set <M-b>=^[b
149(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
150The advantage over a mapping is that it works in all situations.
151
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000152The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
153security reasons.
154
Bram Moolenaar071d4272004-06-13 20:20:40 +0000155The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000156at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000157"set all" probably does not fit on the screen, causing Vim to give the
158|more-prompt|.
159
160 *option-backslash*
161To include white space in a string option value it has to be preceded with a
162backslash. To include a backslash you have to use two. Effectively this
163means that the number of backslashes in an option value is halved (rounded
164down).
165A few examples: >
166 :set tags=tags\ /usr/tags results in "tags /usr/tags"
167 :set tags=tags\\,file results in "tags\,file"
168 :set tags=tags\\\ file results in "tags\ file"
169
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000170The "|" character separates a ":set" command from a following command. To
171include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000172'titlestring' option to "hi|there": >
173 :set titlestring=hi\|there
174This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
175 :set titlestring=hi|set iconstring=there
176
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000177Similarly, the double quote character starts a comment. To include the '"' in
178the option value, use '\"' instead. This example sets the 'titlestring'
179option to 'hi "there"': >
180 :set titlestring=hi\ \"there\"
181
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000182For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000183precise: For options that expect a file name (those where environment
184variables are expanded) a backslash before a normal file name character is not
185removed. But a backslash before a special character (space, backslash, comma,
186etc.) is used like explained above.
187There is one special situation, when the value starts with "\\": >
188 :set dir=\\machine\path results in "\\machine\path"
189 :set dir=\\\\machine\\path results in "\\machine\path"
190 :set dir=\\path\\file results in "\\path\file" (wrong!)
191For the first one the start is kept, but for the second one the backslashes
192are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000193halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000194result which is probably not what you want. Avoid it.
195
196 *add-option-flags* *remove-option-flags*
197 *E539* *E550* *E551* *E552*
198Some options are a list of flags. When you want to add a flag to such an
199option, without changing the existing ones, you can do it like this: >
200 :set guioptions+=a
201Remove a flag from an option like this: >
202 :set guioptions-=a
203This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000204Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000205the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
206doesn't appear.
207
208 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000209Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000210environment variable exists the '$' and the following environment variable
211name is replaced with its value. If it does not exist the '$' and the name
212are not modified. Any non-id character (not a letter, digit or '_') may
213follow the environment variable name. That character and what follows is
214appended to the value of the environment variable. Examples: >
215 :set term=$TERM.new
216 :set path=/usr/$INCLUDE,$HOME/include,.
217When adding or removing a string from an option with ":set opt-=val" or ":set
218opt+=val" the expansion is done before the adding or removing.
219
220
221Handling of local options *local-options*
222
223Some of the options only apply to a window or buffer. Each window or buffer
224has its own copy of this option, thus can each have their own value. This
225allows you to set 'list' in one window but not in another. And set
226'shiftwidth' to 3 in one buffer and 4 in another.
227
228The following explains what happens to these local options in specific
229situations. You don't really need to know all of this, since Vim mostly uses
230the option values you would expect. Unfortunately, doing what the user
231expects is a bit complicated...
232
233When splitting a window, the local options are copied to the new window. Thus
234right after the split the contents of the two windows look the same.
235
236When editing a new buffer, its local option values must be initialized. Since
237the local options of the current buffer might be specifically for that buffer,
238these are not used. Instead, for each buffer-local option there also is a
239global value, which is used for new buffers. With ":set" both the local and
240global value is changed. With "setlocal" only the local value is changed,
241thus this value is not used when editing a new buffer.
242
243When editing a buffer that has been edited before, the last used window
244options are used again. If this buffer has been edited in this window, the
245values from back then are used. Otherwise the values from the window where
246the buffer was edited last are used.
247
248It's possible to set a local window option specifically for a type of buffer.
249When you edit another buffer in the same window, you don't want to keep
250using these local window options. Therefore Vim keeps a global value of the
251local window options, which is used when editing another buffer. Each window
252has its own copy of these values. Thus these are local to the window, but
253global to all buffers in the window. With this you can do: >
254 :e one
255 :set list
256 :e two
257Now the 'list' option will also be set in "two", since with the ":set list"
258command you have also set the global value. >
259 :set nolist
260 :e one
261 :setlocal list
262 :e two
263Now the 'list' option is not set, because ":set nolist" resets the global
264value, ":setlocal list" only changes the local value and ":e two" gets the
265global value. Note that if you do this next: >
266 :e one
267You will not get back the 'list' value as it was the last time you edited
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000268"one". The options local to a window are not remembered for each buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000269
270 *:setl* *:setlocal*
271:setl[ocal] ... Like ":set" but set only the value local to the
272 current buffer or window. Not all options have a
273 local value. If the option does not have a local
274 value the global value is set.
275 With the "all" argument: display all local option's
276 local values.
277 Without argument: Display all local option's local
278 values which are different from the default.
279 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000280 local value. For a global/local boolean option, when
281 the global value is being used, "--" is displayed
282 before the option name.
283 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000284 shown (but that might change in the future).
285 {not in Vi}
286
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000287:setl[ocal] {option}< Set the local value of {option} to its global value by
288 copying the value.
289 {not in Vi}
290
291:se[t] {option}< Set the local value of {option} to its global value by
292 making it empty. Only makes sense for |global-local|
293 options.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000294 {not in Vi}
295
296 *:setg* *:setglobal*
297:setg[lobal] ... Like ":set" but set only the global value for a local
298 option without changing the local value.
299 When displaying an option, the global value is shown.
300 With the "all" argument: display all local option's
301 global values.
302 Without argument: display all local option's global
303 values which are different from the default.
304 {not in Vi}
305
306For buffer-local and window-local options:
307 Command global value local value ~
308 :set option=value set set
309 :setlocal option=value - set
310:setglobal option=value set -
311 :set option? - display
312 :setlocal option? - display
313:setglobal option? display -
314
315
316Global options with a local value *global-local*
317
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000318Options are global when you mostly use one value for all buffers and windows.
319For some global options it's useful to sometimes have a different local value.
320You can set the local value with ":setlocal". That buffer or window will then
321use the local value, while other buffers and windows continue using the global
322value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000323
324For example, you have two windows, both on C source code. They use the global
325'makeprg' option. If you do this in one of the two windows: >
326 :set makeprg=gmake
327then the other window will switch to the same value. There is no need to set
328the 'makeprg' option in the other C source window too.
329However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000330another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000331files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000332 :setlocal makeprg=perlmake
333You can switch back to using the global value by making the local value empty: >
334 :setlocal makeprg=
335This only works for a string option. For a boolean option you need to use the
336"<" flag, like this: >
337 :setlocal autoread<
338Note that for non-boolean options using "<" copies the global value to the
339local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000340when the global value changes later). You can also use: >
341 :set path<
342This will make the local value of 'path' empty, so that the global value is
343used. Thus it does the same as: >
344 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000345Note: In the future more global options can be made global-local. Using
346":setlocal" on a global option might work differently then.
347
348
349Setting the filetype
350
351:setf[iletype] {filetype} *:setf* *:setfiletype*
352 Set the 'filetype' option to {filetype}, but only if
353 not done yet in a sequence of (nested) autocommands.
354 This is short for: >
355 :if !did_filetype()
356 : setlocal filetype={filetype}
357 :endif
358< This command is used in a filetype.vim file to avoid
359 setting the 'filetype' option twice, causing different
360 settings and syntax files to be loaded.
361 {not in Vi}
362
363:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
364:opt[ions] Open a window for viewing and setting all options.
365 Options are grouped by function.
366 Offers short help for each option. Hit <CR> on the
367 short help to open a help window with more help for
368 the option.
369 Modify the value of the option and hit <CR> on the
370 "set" line to set the new value. For window and
371 buffer specific options, the last accessed window is
372 used to set the option value in, unless this is a help
373 window, in which case the window below help window is
374 used (skipping the option-window).
375 {not available when compiled without the |+eval| or
376 |+autocmd| features}
377
378 *$HOME*
379Using "~" is like using "$HOME", but it is only recognized at the start of an
380option and after a space or comma.
381
382On Unix systems "~user" can be used too. It is replaced by the home directory
383of user "user". Example: >
384 :set path=~mool/include,/usr/include,.
385
386On Unix systems the form "${HOME}" can be used too. The name between {} can
387contain non-id characters then. Note that if you want to use this for the
388"gf" command, you need to add the '{' and '}' characters to 'isfname'.
389
390NOTE: expanding environment variables and "~/" is only done with the ":set"
391command, not when assigning a value to an option with ":let".
392
393
394Note the maximum length of an expanded option is limited. How much depends on
395the system, mostly it is something like 256 or 1024 characters.
396
397 *:fix* *:fixdel*
398:fix[del] Set the value of 't_kD':
399 't_kb' is 't_kD' becomes ~
400 CTRL-? CTRL-H
401 not CTRL-? CTRL-?
402
403 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
404
405 If your delete key terminal code is wrong, but the
406 code for backspace is alright, you can put this in
407 your .vimrc: >
408 :fixdel
409< This works no matter what the actual code for
410 backspace is.
411
412 If the backspace key terminal code is wrong you can
413 use this: >
414 :if &term == "termname"
415 : set t_kb=^V<BS>
416 : fixdel
417 :endif
418< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000419 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000420 with your terminal name.
421
422 If your <Delete> key sends a strange key sequence (not
423 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
424 :if &term == "termname"
425 : set t_kD=^V<Delete>
426 :endif
427< Where "^V" is CTRL-V and "<Delete>" is the delete key
428 (don't type eight characters!). Replace "termname"
429 with your terminal name.
430
431 *Linux-backspace*
432 Note about Linux: By default the backspace key
433 produces CTRL-?, which is wrong. You can fix it by
434 putting this line in your rc.local: >
435 echo "keycode 14 = BackSpace" | loadkeys
436<
437 *NetBSD-backspace*
438 Note about NetBSD: If your backspace doesn't produce
439 the right code, try this: >
440 xmodmap -e "keycode 22 = BackSpace"
441< If this works, add this in your .Xmodmap file: >
442 keysym 22 = BackSpace
443< You need to restart for this to take effect.
444
445==============================================================================
4462. Automatically setting options *auto-setting*
447
448Besides changing options with the ":set" command, there are three alternatives
449to set options automatically for one or more files:
450
4511. When starting Vim initializations are read from various places. See
452 |initialization|. Most of them are performed for all editing sessions,
453 and some of them depend on the directory where Vim is started.
454 You can create an initialization file with |:mkvimrc|, |:mkview| and
455 |:mksession|.
4562. If you start editing a new file, the automatic commands are executed.
457 This can be used to set options for files matching a particular pattern and
458 many other things. See |autocommand|.
4593. If you start editing a new file, and the 'modeline' option is on, a
460 number of lines at the beginning and end of the file are checked for
461 modelines. This is explained here.
462
463 *modeline* *vim:* *vi:* *ex:* *E520*
464There are two forms of modelines. The first form:
465 [text]{white}{vi:|vim:|ex:}[white]{options}
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
471{options} a list of option settings, separated with white space or ':',
472 where each part between ':' is the argument for a ":set"
Bram Moolenaar02467872007-05-06 13:22:01 +0000473 command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000474
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000475Example:
476 vi:noai:sw=3 ts=6 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000477
478The second form (this is compatible with some versions of Vi):
479
480 [text]{white}{vi:|vim:|ex:}[white]se[t] {options}:[text]
481
482[text] any text or empty
483{white} at least one blank character (<Space> or <Tab>)
484{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
485[white] optional white space
486se[t] the string "set " or "se " (note the space)
487{options} a list of options, separated with white space, which is the
488 argument for a ":set" command
489: a colon
490[text] any text or empty
491
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000492Example:
493 /* vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000494
495The white space before {vi:|vim:|ex:} is required. This minimizes the chance
496that a normal word like "lex:" is caught. There is one exception: "vi:" and
497"vim:" can also be at the start of the line (for compatibility with version
4983.0). Using "ex:" at the start of the line will be ignored (this could be
499short for "example:").
500
501 *modeline-local*
502The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000503buffer and window that contain the file. Although it's possible to set global
504options from a modeline, this is unusual. If you have two windows open and
505the files in it set the same global option to a different value, the result
506depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000507
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000508When editing a file that was already loaded, only the window-local options
509from the modeline are used. Thus if you manually changed a buffer-local
510option after opening the file, it won't be changed if you edit the same buffer
511in another window. But window-local options will be set.
512
Bram Moolenaar071d4272004-06-13 20:20:40 +0000513 *modeline-version*
514If the modeline is only to be used for some versions of Vim, the version
515number can be specified where "vim:" is used:
516 vim{vers}: version {vers} or later
517 vim<{vers}: version before {vers}
518 vim={vers}: version {vers}
519 vim>{vers}: version after {vers}
520{vers} is 600 for Vim 6.0 (hundred times the major version plus minor).
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000521For example, to use a modeline only for Vim 6.0 and later:
522 /* vim600: set foldmethod=marker: */ ~
523To use a modeline for Vim before version 5.7:
524 /* vim<570: set sw=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000525There can be no blanks between "vim" and the ":".
526
527
528The number of lines that are checked can be set with the 'modelines' option.
529If 'modeline' is off or 'modelines' is 0 no lines are checked.
530
531Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000532like:
533 /* vi:ts=4: */ ~
534will give an error message for the trailing "*/". This line is OK:
535 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000536
537If an error is detected the rest of the line is skipped.
538
539If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000540backslash in front of the ':' will be removed. Example:
541 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000542This sets the 'dir' option to "c:\tmp". Only a single backslash before the
543':' is removed. Thus to include "\:" you have to specify "\\:".
544
545No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000546might create a Trojan horse text file with modelines). And not all options
547can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000548|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000549causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
550are wrapped unexpectedly. So disable modelines before editing untrusted text.
551The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000552
553Hint: If you would like to do something else than setting an option, you could
554define an autocommand that checks the file for a specific string. For
555example: >
556 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
557And define a function SetVar() that does something with the line containing
558"VAR".
559
560==============================================================================
5613. Options summary *option-summary*
562
563In the list below all the options are mentioned with their full name and with
564an abbreviation if there is one. Both forms may be used.
565
566In this document when a boolean option is "set" that means that ":set option"
567is entered. When an option is "reset", ":set nooption" is used.
568
569For some options there are two default values: The "Vim default", which is
570used when 'compatible' is not set, and the "Vi default", which is used when
571'compatible' is set.
572
573Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000574are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000575different value in each window. For example the 'list' option can be set in
576one window and reset in another for the same text, giving both types of view
577at the same time. There are a few options that are specific to a certain
578file. These can have a different value for each file or buffer. For example
579the 'textwidth' option can be 78 for a normal text file and 0 for a C
580program.
581
582 global one option for all buffers and windows
583 local to window each window has its own copy of this option
584 local to buffer each buffer has its own copy of this option
585
586When creating a new window the option values from the currently active window
587are used as a default value for the window-specific options. For the
588buffer-specific options this depends on the 's' and 'S' flags in the
589'cpoptions' option. If 's' is included (which is the default) the values for
590buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000591first entered. If 'S' is present the options are copied each time the buffer
592is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000593present, the options are copied from the currently active buffer when the
594buffer is created.
595
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000596Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000597
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000598Not all options are supported in all versions. This depends on the supported
599features and sometimes on the system. A remark about this is in curly braces
600below. When an option is not supported it may still be set without getting an
601error, this is called a hidden option. You can't get the value of a hidden
602option though, it is not stored.
603
604To test if option "foo" can be used with ":set" use something like this: >
605 if exists('&foo')
606This also returns true for a hidden option. To test if option "foo" is really
607supported use something like this: >
608 if exists('+foo')
609<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000610 *E355*
611A jump table for the options with a short description can be found at |Q_op|.
612
613 *'aleph'* *'al'* *aleph* *Aleph*
614'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
615 global
616 {not in Vi}
617 {only available when compiled with the |+rightleft|
618 feature}
619 The ASCII code for the first letter of the Hebrew alphabet. The
620 routine that maps the keyboard in Hebrew mode, both in Insert mode
621 (when hkmap is set) and on the command-line (when hitting CTRL-_)
622 outputs the Hebrew characters in the range [aleph..aleph+26].
623 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
624 See |rileft.txt|.
625
626 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
627'allowrevins' 'ari' boolean (default off)
628 global
629 {not in Vi}
630 {only available when compiled with the |+rightleft|
631 feature}
632 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
633 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
634 into reverse Insert mode, and don't know how to get out. See
635 'revins'.
636 NOTE: This option is reset when 'compatible' is set.
637
638 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
639'altkeymap' 'akm' boolean (default off)
640 global
641 {not in Vi}
642 {only available when compiled with the |+farsi|
643 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000644 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000645 the keyboard map between Farsi and English, when 'allowrevins' set.
646
Bram Moolenaar582fd852005-03-28 20:58:01 +0000647 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000648 is useful to start the Vim in native mode i.e. English (left-to-right
649 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000650 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000651
652 *'ambiwidth'* *'ambw'*
653'ambiwidth' 'ambw' string (default: "single")
654 global
655 {not in Vi}
656 {only available when compiled with the |+multi_byte|
657 feature}
658 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
659 Tells Vim what to do with characters with East Asian Width Class
660 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
661 letters, Cyrillic letters).
662
663 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000664 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000665 expected by most users.
666 "double": Use twice the width of ASCII characters.
667
668 There are a number of CJK fonts for which the width of glyphs for
669 those characters are solely based on how many octets they take in
670 legacy/traditional CJK encodings. In those encodings, Euro,
671 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000672 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000673 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000674 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000675 Vim is running inside a terminal (emulators) that uses a CJK font
676 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
677 this option should be set to "double" to match the width perceived
678 by Vim with the width of glyphs in the font. Perhaps it also has
679 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
680 when the system locale is set to one of CJK locales. See Unicode
681 Standard Annex #11 (http://www.unicode.org/reports/tr11).
682
683 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
684'antialias' 'anti' boolean (default: off)
685 global
686 {not in Vi}
687 {only available when compiled with GUI enabled
688 on Mac OS X}
689 This option only has an effect in the GUI version of Vim on Mac OS X
690 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
691 which can be easier to read at certain sizes on certain displays.
692 Setting this option can sometimes cause problems if 'guifont' is set
693 to its default (empty string).
694
695 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
696'autochdir' 'acd' boolean (default off)
697 global
698 {not in Vi}
699 {only available when compiled with the
700 |+netbeans_intg| or |+sun_workshop| feature}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000701 When on, Vim will change the current working directory whenever you
702 open a file, switch buffers, delete a buffer or open/close a window.
703 It will change to the directory containing the file which was opened
704 or selected.
705 This option is provided for backward compatibility with the Vim
706 released with Sun ONE Studio 4 Enterprise Edition.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000707 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000708
709 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
710'arabic' 'arab' boolean (default off)
711 local to window
712 {not in Vi}
713 {only available when compiled with the |+arabic|
714 feature}
715 This option can be set to start editing Arabic text.
716 Setting this option will:
717 - Set the 'rightleft' option, unless 'termbidi' is set.
718 - Set the 'arabicshape' option, unless 'termbidi' is set.
719 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
720 between typing English and Arabic key mapping.
721 - Set the 'delcombine' option
722 Note that 'encoding' must be "utf-8" for working with Arabic text.
723
724 Resetting this option will:
725 - Reset the 'rightleft' option.
726 - Disable the use of 'keymap' (without changing its value).
727 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
728 option.
729 Also see |arabic.txt|.
730
731 *'arabicshape'* *'arshape'*
732 *'noarabicshape'* *'noarshape'*
733'arabicshape' 'arshape' boolean (default on)
734 global
735 {not in Vi}
736 {only available when compiled with the |+arabic|
737 feature}
738 When on and 'termbidi' is off, the required visual character
739 corrections that need to take place for displaying the Arabic language
740 take affect. Shaping, in essence, gets enabled; the term is a broad
741 one which encompasses:
742 a) the changing/morphing of characters based on their location
743 within a word (initial, medial, final and stand-alone).
744 b) the enabling of the ability to compose characters
745 c) the enabling of the required combining of some characters
746 When disabled the character display reverts back to each character's
747 true stand-alone form.
748 Arabic is a complex language which requires other settings, for
749 further details see |arabic.txt|.
750
751 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
752'autoindent' 'ai' boolean (default off)
753 local to buffer
754 Copy indent from current line when starting a new line (typing <CR>
755 in Insert mode or when using the "o" or "O" command). If you do not
756 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000757 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
758 to another line has the same effect, unless the 'I' flag is included
759 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000760 When autoindent is on, formatting (with the "gq" command or when you
761 reach 'textwidth' in Insert mode) uses the indentation of the first
762 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000763 When 'smartindent' or 'cindent' is on the indent is changed in
764 a different way.
765 The 'autoindent' option is reset when the 'paste' option is set.
766 {small difference from Vi: After the indent is deleted when typing
767 <Esc> or <CR>, the cursor position when moving up or down is after the
768 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
769
770 *'autoread'* *'ar'* *'noautoread'* *'noar'*
771'autoread' 'ar' boolean (default off)
772 global or local to buffer |global-local|
773 {not in Vi}
774 When a file has been detected to have been changed outside of Vim and
775 it has not been changed inside of Vim, automatically read it again.
776 When the file has been deleted this is not done. |timestamp|
777 If this option has a local value, use this command to switch back to
778 using the global value: >
779 :set autoread<
780<
781 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
782'autowrite' 'aw' boolean (default off)
783 global
784 Write the contents of the file, if it has been modified, on each
785 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000786 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000787 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
788 Note that for some commands the 'autowrite' option is not used, see
789 'autowriteall' for that.
790
791 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
792'autowriteall' 'awa' boolean (default off)
793 global
794 {not in Vi}
795 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
796 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
797 Setting this option also implies that Vim behaves like 'autowrite' has
798 been set.
799
800 *'background'* *'bg'*
801'background' 'bg' string (default "dark" or "light")
802 global
803 {not in Vi}
804 When set to "dark", Vim will try to use colors that look good on a
805 dark background. When set to "light", Vim will try to use colors that
806 look good on a light background. Any other value is illegal.
807 Vim tries to set the default value according to the terminal used.
808 This will not always be correct.
809 Setting this option does not change the background color, it tells Vim
810 what the background color looks like. For changing the background
811 color, see |:hi-normal|.
812
813 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000814 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000815 change. *g:colors_name*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000816 When a color scheme is loaded (the "colors_name" variable is set)
817 setting 'background' will cause the color scheme to be reloaded. If
818 the color scheme adjusts to the value of 'background' this will work.
819 However, if the color scheme sets 'background' itself the effect may
820 be undone. First delete the "colors_name" variable when needed.
821
822 When setting 'background' to the default value with: >
823 :set background&
824< Vim will guess the value. In the GUI this should work correctly,
825 in other cases Vim might not be able to guess the right value.
826
827 When starting the GUI, the default value for 'background' will be
828 "light". When the value is not set in the .gvimrc, and Vim detects
829 that the background is actually quite dark, 'background' is set to
830 "dark". But this happens only AFTER the .gvimrc file has been read
831 (because the window needs to be opened to find the actual background
832 color). To get around this, force the GUI window to be opened by
833 putting a ":gui" command in the .gvimrc file, before where the value
834 of 'background' is used (e.g., before ":syntax on").
835 Normally this option would be set in the .vimrc file. Possibly
836 depending on the terminal name. Example: >
837 :if &term == "pcterm"
838 : set background=dark
839 :endif
840< When this option is set, the default settings for the highlight groups
841 will change. To use other settings, place ":highlight" commands AFTER
842 the setting of the 'background' option.
843 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
844 to select the colors for syntax highlighting. After changing this
845 option, you must load syntax.vim again to see the result. This can be
846 done with ":syntax on".
847
848 *'backspace'* *'bs'*
849'backspace' 'bs' string (default "")
850 global
851 {not in Vi}
852 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
853 mode. This is a list of items, separated by commas. Each item allows
854 a way to backspace over something:
855 value effect ~
856 indent allow backspacing over autoindent
857 eol allow backspacing over line breaks (join lines)
858 start allow backspacing over the start of insert; CTRL-W and CTRL-U
859 stop once at the start of insert.
860
861 When the value is empty, Vi compatible backspacing is used.
862
863 For backwards compatibility with version 5.4 and earlier:
864 value effect ~
865 0 same as ":set backspace=" (Vi compatible)
866 1 same as ":set backspace=indent,eol"
867 2 same as ":set backspace=indent,eol,start"
868
869 See |:fixdel| if your <BS> or <Del> key does not do what you want.
870 NOTE: This option is set to "" when 'compatible' is set.
871
872 *'backup'* *'bk'* *'nobackup'* *'nobk'*
873'backup' 'bk' boolean (default off)
874 global
875 {not in Vi}
876 Make a backup before overwriting a file. Leave it around after the
877 file has been successfully written. If you do not want to keep the
878 backup file, but you do want a backup while the file is being
879 written, reset this option and set the 'writebackup' option (this is
880 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000881 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000882 |backup-table| for more explanations.
883 When the 'backupskip' pattern matches, a backup is not made anyway.
884 When 'patchmode' is set, the backup may be renamed to become the
885 oldest version of a file.
886 NOTE: This option is reset when 'compatible' is set.
887
888 *'backupcopy'* *'bkc'*
889'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
890 global
891 {not in Vi}
892 When writing a file and a backup is made, this option tells how it's
893 done. This is a comma separated list of words.
894
895 The main values are:
896 "yes" make a copy of the file and overwrite the original one
897 "no" rename the file and write a new one
898 "auto" one of the previous, what works best
899
900 Extra values that can be combined with the ones above are:
901 "breaksymlink" always break symlinks when writing
902 "breakhardlink" always break hardlinks when writing
903
904 Making a copy and overwriting the original file:
905 - Takes extra time to copy the file.
906 + When the file has special attributes, is a (hard/symbolic) link or
907 has a resource fork, all this is preserved.
908 - When the file is a link the backup will have the name of the link,
909 not of the real file.
910
911 Renaming the file and writing a new one:
912 + It's fast.
913 - Sometimes not all attributes of the file can be copied to the new
914 file.
915 - When the file is a link the new file will not be a link.
916
917 The "auto" value is the middle way: When Vim sees that renaming file
918 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000919 the file is not a link) that is used. When problems are expected, a
920 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000921
922 The "breaksymlink" and "breakhardlink" values can be used in
923 combination with any of "yes", "no" and "auto". When included, they
924 force Vim to always break either symbolic or hard links by doing
925 exactly what the "no" option does, renaming the original file to
926 become the backup and writing a new file in its place. This can be
927 useful for example in source trees where all the files are symbolic or
928 hard links and any changes should stay in the local source tree, not
929 be propagated back to the original source.
930 *crontab*
931 One situation where "no" and "auto" will cause problems: A program
932 that opens a file, invokes Vim to edit that file, and then tests if
933 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000934 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000935 example.
936
937 When a copy is made, the original file is truncated and then filled
938 with the new text. This means that protection bits, owner and
939 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000940 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000941 group of the backup is set to the group of the original file. If this
942 fails, the protection bits for the group are made the same as for
943 others.
944
945 When the file is renamed this is the other way around: The backup has
946 the same attributes of the original file, and the newly written file
947 is owned by the current user. When the file was a (hard/symbolic)
948 link, the new file will not! That's why the "auto" value doesn't
949 rename when the file is a link. The owner and group of the newly
950 written file will be set to the same ones as the original file, but
951 the system may refuse to do this. In that case the "auto" value will
952 again not rename the file.
953
954 *'backupdir'* *'bdir'*
955'backupdir' 'bdir' string (default for Amiga: ".,t:",
956 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
957 for Unix: ".,~/tmp,~/")
958 global
959 {not in Vi}
960 List of directories for the backup file, separated with commas.
961 - The backup file will be created in the first directory in the list
962 where this is possible.
963 - Empty means that no backup file will be created ('patchmode' is
964 impossible!). Writing may fail because of this.
965 - A directory "." means to put the backup file in the same directory
966 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000967 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000968 put the backup file relative to where the edited file is. The
969 leading "." is replaced with the path name of the edited file.
970 ("." inside a directory name has no special meaning).
971 - Spaces after the comma are ignored, other spaces are considered part
972 of the directory name. To have a space at the start of a directory
973 name, precede it with a backslash.
974 - To include a comma in a directory name precede it with a backslash.
975 - A directory name may end in an '/'.
976 - Environment variables are expanded |:set_env|.
977 - Careful with '\' characters, type one before a space, type two to
978 get one in the option (see |option-backslash|), for example: >
979 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
980< - For backwards compatibility with Vim version 3.0 a '>' at the start
981 of the option is removed.
982 See also 'backup' and 'writebackup' options.
983 If you want to hide your backup files on Unix, consider this value: >
984 :set backupdir=./.backup,~/.backup,.,/tmp
985< You must create a ".backup" directory in each directory and in your
986 home directory for this to work properly.
987 The use of |:set+=| and |:set-=| is preferred when adding or removing
988 directories from the list. This avoids problems when a future version
989 uses another default.
990 This option cannot be set from a |modeline| or in the |sandbox|, for
991 security reasons.
992
993 *'backupext'* *'bex'* *E589*
994'backupext' 'bex' string (default "~", for VMS: "_")
995 global
996 {not in Vi}
997 String which is appended to a file name to make the name of the
998 backup file. The default is quite unusual, because this avoids
999 accidentally overwriting existing files with a backup file. You might
1000 prefer using ".bak", but make sure that you don't have files with
1001 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001002 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001003
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001004 If you like to keep a lot of backups, you could use a BufWritePre
1005 autocommand to change 'backupext' just before writing the file to
1006 include a timestamp. >
1007 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1008< Use 'backupdir' to put the backup in a different directory.
1009
Bram Moolenaar071d4272004-06-13 20:20:40 +00001010 *'backupskip'* *'bsk'*
1011'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1012 global
1013 {not in Vi}
1014 {not available when compiled without the |+wildignore|
1015 feature}
1016 A list of file patterns. When one of the patterns matches with the
1017 name of the file which is written, no backup file is created. Both
1018 the specified file name and the full path name of the file are used.
1019 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1020 Watch out for special characters, see |option-backslash|.
1021 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001022 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001023
1024 Note that environment variables are not expanded. If you want to use
1025 $HOME you must expand it explicitly, e.g.: >
1026 :let backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
1027
1028< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001029 backup would be made by renaming the original file crontab won't see
1030 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001031
1032 *'balloondelay'* *'bdlay'*
1033'balloondelay' 'bdlay' number (default: 600)
1034 global
1035 {not in Vi}
1036 {only available when compiled with the |+balloon_eval|
1037 feature}
1038 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1039
1040 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1041'ballooneval' 'beval' boolean (default off)
1042 global
1043 {not in Vi}
1044 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001045 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001046 Switch on the |balloon-eval| functionality.
1047
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001048 *'balloonexpr'* *'bexpr'*
1049'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001050 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001051 {not in Vi}
1052 {only available when compiled with the |+balloon_eval|
1053 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001054 Expression for text to show in evaluation balloon. It is only used
1055 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001056
1057 v:beval_bufnr number of the buffer in which balloon is going to show
1058 v:beval_winnr number of the window
1059 v:beval_lnum line number
1060 v:beval_col column number (byte index)
1061 v:beval_text word under or after the mouse pointer
1062
1063 The evaluation of the expression must not have side effects!
1064 Example: >
1065 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001066 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001067 \', column ' . v:beval_col .
1068 \ ' of file ' . bufname(v:beval_bufnr) .
1069 \ ' on word "' . v:beval_text . '"'
1070 endfunction
1071 set bexpr=MyBalloonExpr()
1072 set ballooneval
1073<
1074 NOTE: The balloon is displayed only if the cursor is on a text
1075 character. If the result of evaluating 'balloonexpr' is not empty,
1076 Vim does not try to send a message to an external debugger (Netbeans
1077 or Sun Workshop).
1078
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001079 The expression may be evaluated in the |sandbox|, see
1080 |sandbox-option|.
1081
1082 It is not allowed to change text or jump to another window while
1083 evaluating 'balloonexpr' |textlock|.
1084
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001085 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001086 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001087< When they are supported "\n" characters will start a new line. If the
1088 expression evaluates to a |List| this is equal to using each List item
1089 as a string and putting "\n" in between them.
1090
Bram Moolenaar071d4272004-06-13 20:20:40 +00001091 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1092'binary' 'bin' boolean (default off)
1093 local to buffer
1094 {not in Vi}
1095 This option should be set before editing a binary file. You can also
1096 use the |-b| Vim argument. When this option is switched on a few
1097 options will be changed (also when it already was on):
1098 'textwidth' will be set to 0
1099 'wrapmargin' will be set to 0
1100 'modeline' will be off
1101 'expandtab' will be off
1102 Also, 'fileformat' and 'fileformats' options will not be used, the
1103 file is read and written like 'fileformat' was "unix" (a single <NL>
1104 separates lines).
1105 The 'fileencoding' and 'fileencodings' options will not be used, the
1106 file is read without conversion.
1107 NOTE: When you start editing a(nother) file while the 'bin' option is
1108 on, settings from autocommands may change the settings again (e.g.,
1109 'textwidth'), causing trouble when editing. You might want to set
1110 'bin' again when the file has been loaded.
1111 The previous values of these options are remembered and restored when
1112 'bin' is switched from on to off. Each buffer has its own set of
1113 saved option values.
1114 To edit a file with 'binary' set you can use the |++bin| argument.
1115 This avoids you have to do ":set bin", which would have effect for all
1116 files you edit.
1117 When writing a file the <EOL> for the last line is only written if
1118 there was one in the original file (normally Vim appends an <EOL> to
1119 the last line if there is none; this would make the file longer). See
1120 the 'endofline' option.
1121
1122 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1123'bioskey' 'biosk' boolean (default on)
1124 global
1125 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001126 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001127 better to detect CTRL-C, but only works for the console. When using a
1128 terminal over a serial port reset this option.
1129 Also see |'conskey'|.
1130
1131 *'bomb'* *'nobomb'*
1132'bomb' boolean (default off)
1133 local to buffer
1134 {not in Vi}
1135 {only available when compiled with the |+multi_byte|
1136 feature}
1137 When writing a file and the following conditions are met, a BOM (Byte
1138 Order Mark) is prepended to the file:
1139 - this option is on
1140 - the 'binary' option is off
1141 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1142 endian variants.
1143 Some applications use the BOM to recognize the encoding of the file.
1144 Often used for UCS-2 files on MS-Windows. For other applications it
1145 causes trouble, for example: "cat file1 file2" makes the BOM of file2
1146 appear halfway the resulting file.
1147 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1148 check for the presence of the BOM is done and 'bomb' set accordingly.
1149 Unless 'binary' is set, it is removed from the first line, so that you
1150 don't see it when editing. When you don't change the options, the BOM
1151 will be restored when writing the file.
1152
1153 *'breakat'* *'brk'*
1154'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1155 global
1156 {not in Vi}
1157 {not available when compiled without the |+linebreak|
1158 feature}
1159 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001160 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1161 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001162
1163 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001164'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001165 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001166 {not in Vi} {only for Motif, Athena, GTK, Mac and
1167 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001168 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001169 last Use same directory as with last file browser, where a
1170 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001171 buffer Use the directory of the related buffer.
1172 current Use the current directory.
1173 {path} Use the specified directory
1174
1175 *'bufhidden'* *'bh'*
1176'bufhidden' 'bh' string (default: "")
1177 local to buffer
1178 {not in Vi}
1179 {not available when compiled without the |+quickfix|
1180 feature}
1181 This option specifies what happens when a buffer is no longer
1182 displayed in a window:
1183 <empty> follow the global 'hidden' option
1184 hide hide the buffer (don't unload it), also when 'hidden'
1185 is not set
1186 unload unload the buffer, also when 'hidden' is set or using
1187 |:hide|
1188 delete delete the buffer from the buffer list, also when
1189 'hidden' is set or using |:hide|, like using
1190 |:bdelete|
1191 wipe wipe out the buffer from the buffer list, also when
1192 'hidden' is set or using |:hide|, like using
1193 |:bwipeout|
1194
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001195 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1196 are lost without a warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001197 This option is used together with 'buftype' and 'swapfile' to specify
1198 special kinds of buffers. See |special-buffers|.
1199
1200 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1201'buflisted' 'bl' boolean (default: on)
1202 local to buffer
1203 {not in Vi}
1204 When this option is set, the buffer shows up in the buffer list. If
1205 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1206 This option is reset by Vim for buffers that are only used to remember
1207 a file name or marks. Vim sets it when starting to edit a buffer.
1208 But not when moving to a buffer with ":buffer".
1209
1210 *'buftype'* *'bt'* *E382*
1211'buftype' 'bt' string (default: "")
1212 local to buffer
1213 {not in Vi}
1214 {not available when compiled without the |+quickfix|
1215 feature}
1216 The value of this option specifies the type of a buffer:
1217 <empty> normal buffer
1218 nofile buffer which is not related to a file and will not be
1219 written
1220 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001221 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001222 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001223 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001224 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001225 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001226 help help buffer (you are not supposed to set this
1227 manually)
1228
1229 This option is used together with 'bufhidden' and 'swapfile' to
1230 specify special kinds of buffers. See |special-buffers|.
1231
1232 Be careful with changing this option, it can have many side effects!
1233
Bram Moolenaar280f1262006-01-30 00:14:18 +00001234 A "quickfix" buffer is only used for the error list and the location
1235 list. This value is set by the |:cwindow| and |:lwindow| commands and
1236 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001237
1238 "nofile" and "nowrite" buffers are similar:
1239 both: The buffer is not to be written to disk, ":w" doesn't
1240 work (":w filename" does work though).
1241 both: The buffer is never considered to be |'modified'|.
1242 There is no warning when the changes will be lost, for
1243 example when you quit Vim.
1244 both: A swap file is only created when using too much memory
1245 (when 'swapfile' has been reset there is never a swap
1246 file).
1247 nofile only: The buffer name is fixed, it is not handled like a
1248 file name. It is not modified in response to a |:cd|
1249 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001250 *E676*
1251 "acwrite" implies that the buffer name is not related to a file, like
1252 "nofile", but it will be written. Thus, in contrast to "nofile" and
1253 "nowrite", ":w" does work and a modified buffer can't be abandoned
1254 without saving. For writing there must be matching |BufWriteCmd|,
1255 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001256
1257 *'casemap'* *'cmp'*
1258'casemap' 'cmp' string (default: "internal,keepascii")
1259 global
1260 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001261 {only available when compiled with the |+multi_byte|
1262 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001263 Specifies details about changing the case of letters. It may contain
1264 these words, separated by a comma:
1265 internal Use internal case mapping functions, the current
1266 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001267 matters when 'encoding' is a Unicode encoding,
1268 "latin1" or "iso-8859-15". When "internal" is
1269 omitted, the towupper() and towlower() system library
1270 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001271 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1272 case mapping, the current locale is not effective.
1273 This probably only matters for Turkish.
1274
1275 *'cdpath'* *'cd'* *E344* *E346*
1276'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1277 global
1278 {not in Vi}
1279 {not available when compiled without the
1280 |+file_in_path| feature}
1281 This is a list of directories which will be searched when using the
1282 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001283 for has a relative path, not an absolute part starting with "/", "./"
1284 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001285 The 'cdpath' option's value has the same form and semantics as
1286 |'path'|. Also see |file-searching|.
1287 The default value is taken from $CDPATH, with a "," prepended to look
1288 in the current directory first.
1289 If the default value taken from $CDPATH is not what you want, include
1290 a modified version of the following command in your vimrc file to
1291 override it: >
1292 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1293< This option cannot be set from a |modeline| or in the |sandbox|, for
1294 security reasons.
1295 (parts of 'cdpath' can be passed to the shell to expand file names).
1296
1297 *'cedit'*
1298'cedit' string (Vi default: "", Vim default: CTRL-F)
1299 global
1300 {not in Vi}
1301 {not available when compiled without the |+vertsplit|
1302 feature}
1303 The key used in Command-line Mode to open the command-line window.
1304 The default is CTRL-F when 'compatible' is off.
1305 Only non-printable keys are allowed.
1306 The key can be specified as a single character, but it is difficult to
1307 type. The preferred way is to use the <> notation. Examples: >
1308 :set cedit=<C-Y>
1309 :set cedit=<Esc>
1310< |Nvi| also has this option, but it only uses the first character.
1311 See |cmdwin|.
1312
1313 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1314'charconvert' 'ccv' string (default "")
1315 global
1316 {only available when compiled with the |+multi_byte|
1317 feature and the |+eval| feature}
1318 {not in Vi}
1319 An expression that is used for character encoding conversion. It is
1320 evaluated when a file that is to be read or has been written has a
1321 different encoding from what is desired.
1322 'charconvert' is not used when the internal iconv() function is
1323 supported and is able to do the conversion. Using iconv() is
1324 preferred, because it is much faster.
1325 'charconvert' is not used when reading stdin |--|, because there is no
1326 file to convert from. You will have to save the text in a file first.
1327 The expression must return zero or an empty string for success,
1328 non-zero for failure.
1329 The possible encoding names encountered are in 'encoding'.
1330 Additionally, names given in 'fileencodings' and 'fileencoding' are
1331 used.
1332 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1333 is done internally by Vim, 'charconvert' is not used for this.
1334 'charconvert' is also used to convert the viminfo file, if the 'c'
1335 flag is present in 'viminfo'. Also used for Unicode conversion.
1336 Example: >
1337 set charconvert=CharConvert()
1338 fun CharConvert()
1339 system("recode "
1340 \ . v:charconvert_from . ".." . v:charconvert_to
1341 \ . " <" . v:fname_in . " >" v:fname_out)
1342 return v:shell_error
1343 endfun
1344< The related Vim variables are:
1345 v:charconvert_from name of the current encoding
1346 v:charconvert_to name of the desired encoding
1347 v:fname_in name of the input file
1348 v:fname_out name of the output file
1349 Note that v:fname_in and v:fname_out will never be the same.
1350 Note that v:charconvert_from and v:charconvert_to may be different
1351 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1352 Encryption is not done by Vim when using 'charconvert'. If you want
1353 to encrypt the file after conversion, 'charconvert' should take care
1354 of this.
1355 This option cannot be set from a |modeline| or in the |sandbox|, for
1356 security reasons.
1357
1358 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1359'cindent' 'cin' boolean (default off)
1360 local to buffer
1361 {not in Vi}
1362 {not available when compiled without the |+cindent|
1363 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001364 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001365 that trigger reindenting in insert mode and 'cinoptions' to set your
1366 preferred indent style.
1367 If 'indentexpr' is not empty, it overrules 'cindent'.
1368 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1369 the "=" operator indents using this algorithm rather than calling an
1370 external program.
1371 See |C-indenting|.
1372 When you don't like the way 'cindent' works, try the 'smartindent'
1373 option or 'indentexpr'.
1374 This option is not used when 'paste' is set.
1375 NOTE: This option is reset when 'compatible' is set.
1376
1377 *'cinkeys'* *'cink'*
1378'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1379 local to buffer
1380 {not in Vi}
1381 {not available when compiled without the |+cindent|
1382 feature}
1383 A list of keys that, when typed in Insert mode, cause reindenting of
1384 the current line. Only used if 'cindent' is on and 'indentexpr' is
1385 empty.
1386 For the format of this option see |cinkeys-format|.
1387 See |C-indenting|.
1388
1389 *'cinoptions'* *'cino'*
1390'cinoptions' 'cino' string (default "")
1391 local to buffer
1392 {not in Vi}
1393 {not available when compiled without the |+cindent|
1394 feature}
1395 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1396 program. See |cinoptions-values| for the values of this option, and
1397 |C-indenting| for info on C indenting in general.
1398
1399
1400 *'cinwords'* *'cinw'*
1401'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1402 local to buffer
1403 {not in Vi}
1404 {not available when compiled without both the
1405 |+cindent| and the |+smartindent| features}
1406 These keywords start an extra indent in the next line when
1407 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1408 an appropriate place (inside {}).
1409 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1410 matter, include the keyword both the uppercase and lowercase:
1411 "if,If,IF".
1412
1413 *'clipboard'* *'cb'*
1414'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1415 for X-windows, "" otherwise)
1416 global
1417 {not in Vi}
1418 {only in GUI versions or when the |+xterm_clipboard|
1419 feature is included}
1420 This option is a list of comma separated names.
1421 These names are recognized:
1422
1423 unnamed When included, Vim will use the clipboard register '*'
1424 for all yank, delete, change and put operations which
1425 would normally go to the unnamed register. When a
1426 register is explicitly specified, it will always be
1427 used regardless of whether "unnamed" is in 'clipboard'
1428 or not. The clipboard register can always be
1429 explicitly accessed using the "* notation. Also see
1430 |gui-clipboard|.
1431
1432 autoselect Works like the 'a' flag in 'guioptions': If present,
1433 then whenever Visual mode is started, or the Visual
1434 area extended, Vim tries to become the owner of the
1435 windowing system's global selection or put the
1436 selected text on the clipboard used by the selection
1437 register "*. See |guioptions_a| and |quotestar| for
1438 details. When the GUI is active, the 'a' flag in
1439 'guioptions' is used, when the GUI is not active, this
1440 "autoselect" flag is used.
1441 Also applies to the modeless selection.
1442
1443 autoselectml Like "autoselect", but for the modeless selection
1444 only. Compare to the 'A' flag in 'guioptions'.
1445
1446 exclude:{pattern}
1447 Defines a pattern that is matched against the name of
1448 the terminal 'term'. If there is a match, no
1449 connection will be made to the X server. This is
1450 useful in this situation:
1451 - Running Vim in a console.
1452 - $DISPLAY is set to start applications on another
1453 display.
1454 - You do not want to connect to the X server in the
1455 console, but do want this in a terminal emulator.
1456 To never connect to the X server use: >
1457 exclude:.*
1458< This has the same effect as using the |-X| argument.
1459 Note that when there is no connection to the X server
1460 the window title won't be restored and the clipboard
1461 cannot be accessed.
1462 The value of 'magic' is ignored, {pattern} is
1463 interpreted as if 'magic' was on.
1464 The rest of the option value will be used for
1465 {pattern}, this must be the last entry.
1466
1467 *'cmdheight'* *'ch'*
1468'cmdheight' 'ch' number (default 1)
1469 global
1470 {not in Vi}
1471 Number of screen lines to use for the command-line. Helps avoiding
1472 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001473 The value of this option is stored with the tab page, so that each tab
1474 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001475
1476 *'cmdwinheight'* *'cwh'*
1477'cmdwinheight' 'cwh' number (default 7)
1478 global
1479 {not in Vi}
1480 {not available when compiled without the |+vertsplit|
1481 feature}
1482 Number of screen lines to use for the command-line window. |cmdwin|
1483
1484 *'columns'* *'co'* *E594*
1485'columns' 'co' number (default 80 or terminal width)
1486 global
1487 {not in Vi}
1488 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001489 initialization and does not have to be set by hand. Also see
1490 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001491 When Vim is running in the GUI or in a resizable window, setting this
1492 option will cause the window size to be changed. When you only want
1493 to use the size for the GUI, put the command in your |gvimrc| file.
1494 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001495 number of columns of the display, the display may be messed up. For
1496 the GUI it is always possible and Vim limits the number of columns to
1497 what fits on the screen. You can use this command to get the widest
1498 window possible: >
1499 :set columns=9999
1500< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001501
1502 *'comments'* *'com'* *E524* *E525*
1503'comments' 'com' string (default
1504 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1505 local to buffer
1506 {not in Vi}
1507 {not available when compiled without the |+comments|
1508 feature}
1509 A comma separated list of strings that can start a comment line. See
1510 |format-comments|. See |option-backslash| about using backslashes to
1511 insert a space.
1512
1513 *'commentstring'* *'cms'* *E537*
1514'commentstring' 'cms' string (default "/*%s*/")
1515 local to buffer
1516 {not in Vi}
1517 {not available when compiled without the |+folding|
1518 feature}
1519 A template for a comment. The "%s" in the value is replaced with the
1520 comment text. Currently only used to add markers for folding, see
1521 |fold-marker|.
1522
1523 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001524'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1525 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001526 global
1527 {not in Vi}
1528 This option has the effect of making Vim either more Vi-compatible, or
1529 make Vim behave in a more useful way.
1530 This is a special kind of option, because when it's set or reset,
1531 other options are also changed as a side effect. CAREFUL: Setting or
1532 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001533 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001534 set this option in your vimrc file, you should probably put it at the
1535 very start.
1536 By default this option is on and the Vi defaults are used for the
1537 options. This default was chosen for those people who want to use Vim
1538 just like Vi, and don't even (want to) know about the 'compatible'
1539 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001540 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001541 this option is switched off, and all options that have not been
1542 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001543 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001544 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001545 happen for the system-wide vimrc or gvimrc file, nor for a file given
1546 with the |-u| argument). Also see |compatible-default| and
1547 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001548 You can also set this option with the "-C" argument, and reset it with
1549 "-N". See |-C| and |-N|.
1550 Switching this option off makes the Vim defaults be used for options
1551 that have a different Vi and Vim default value. See the options
1552 marked with a '+' below. Other options are not modified.
1553 At the moment this option is set, several other options will be set
1554 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001555 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001556 editing.
1557 See also 'cpoptions'.
1558
1559 option + set value effect ~
1560
1561 'allowrevins' off no CTRL-_ command
1562 'backupcopy' Unix: "yes" backup file is a copy
1563 others: "auto" copy or rename backup file
1564 'backspace' "" normal backspace
1565 'backup' off no backup file
1566 'cindent' off no C code indentation
1567 'cedit' + "" no key to open the |cmdwin|
1568 'cpoptions' + (all flags) Vi-compatible flags
1569 'cscopetag' off don't use cscope for ":tag"
1570 'cscopetagorder' 0 see |cscopetagorder|
1571 'cscopeverbose' off see |cscopeverbose|
1572 'digraph' off no digraphs
1573 'esckeys' + off no <Esc>-keys in Insert mode
1574 'expandtab' off tabs not expanded to spaces
1575 'fileformats' + "" no automatic file format detection,
1576 "dos,unix" except for DOS, Windows and OS/2
1577 'formatoptions' + "vt" Vi compatible formatting
1578 'gdefault' off no default 'g' flag for ":s"
1579 'history' + 0 no commandline history
1580 'hkmap' off no Hebrew keyboard mapping
1581 'hkmapp' off no phonetic Hebrew keyboard mapping
1582 'hlsearch' off no highlighting of search matches
1583 'incsearch' off no incremental searching
1584 'indentexpr' "" no indenting by expression
1585 'insertmode' off do not start in Insert mode
1586 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1587 characters and '_'
1588 'joinspaces' on insert 2 spaces after period
1589 'modeline' + off no modelines
1590 'more' + off no pauses in listings
1591 'revins' off no reverse insert
1592 'ruler' off no ruler
1593 'scrolljump' 1 no jump scroll
1594 'scrolloff' 0 no scroll offset
1595 'shiftround' off indent not rounded to shiftwidth
1596 'shortmess' + "" no shortening of messages
1597 'showcmd' + off command characters not shown
1598 'showmode' + off current mode not shown
1599 'smartcase' off no automatic ignore case switch
1600 'smartindent' off no smart indentation
1601 'smarttab' off no smart tab size
1602 'softtabstop' 0 tabs are always 'tabstop' positions
1603 'startofline' on goto startofline with some commands
1604 'tagrelative' + off tag file names are not relative
1605 'textauto' + off no automatic textmode detection
1606 'textwidth' 0 no automatic line wrap
1607 'tildeop' off tilde is not an operator
1608 'ttimeout' off no terminal timeout
1609 'whichwrap' + "" left-right movements don't wrap
1610 'wildchar' + CTRL-E only when the current value is <Tab>
1611 use CTRL-E for cmdline completion
1612 'writebackup' on or off depends on +writebackup feature
1613
1614 *'complete'* *'cpt'* *E535*
1615'complete' 'cpt' string (default: ".,w,b,u,t,i")
1616 local to buffer
1617 {not in Vi}
1618 This option specifies how keyword completion |ins-completion| works
1619 when CTRL-P or CTRL-N are used. It is also used for whole-line
1620 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1621 and the places to scan. It is a comma separated list of flags:
1622 . scan the current buffer ('wrapscan' is ignored)
1623 w scan buffers from other windows
1624 b scan other loaded buffers that are in the buffer list
1625 u scan the unloaded buffers that are in the buffer list
1626 U scan the buffers that are not in the buffer list
1627 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001628 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001629 k{dict} scan the file {dict}. Several "k" flags can be given,
1630 patterns are valid too. For example: >
1631 :set cpt=k/usr/dict/*,k~/spanish
1632< s scan the files given with the 'thesaurus' option
1633 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1634 are valid too.
1635 i scan current and included files
1636 d scan current and included files for defined name or macro
1637 |i_CTRL-X_CTRL-D|
1638 ] tag completion
1639 t same as "]"
1640
1641 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1642 not executed, this may lead to unexpected completions from some files
1643 (gzipped files for example). Unloaded buffers are not scanned for
1644 whole-line completion.
1645
1646 The default is ".,w,b,u,t,i", which means to scan:
1647 1. the current buffer
1648 2. buffers in other windows
1649 3. other loaded buffers
1650 4. unloaded buffers
1651 5. tags
1652 6. included files
1653
1654 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001655 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1656 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001657
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001658 *'completefunc'* *'cfu'*
1659'completefunc' 'cfu' string (default: empty)
1660 local to buffer
1661 {not in Vi}
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001662 {not available when compiled without the +eval
1663 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001664 This option specifies a function to be used for Insert mode completion
1665 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001666 See |complete-functions| for an explanation of how the function is
1667 invoked and what it should return.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001668
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001669
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001670 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001671'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001672 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001673 {not available when compiled without the
1674 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001675 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001676 A comma separated list of options for Insert mode completion
1677 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001678
1679 menu Use a popup menu to show the possible completions. The
1680 menu is only shown when there is more than one match and
1681 sufficient colors are available. |ins-completion-menu|
1682
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001683 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001684 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001685 match, e.g., what file it comes from.
1686
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001687 longest Only insert the longest common text of the matches. If
1688 the menu is displayed you can use CTRL-L to add more
1689 characters. Whether case is ignored depends on the kind
1690 of completion. For buffer text the 'ignorecase' option is
1691 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001692
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001693 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001694 completion in the preview window. Only works in
1695 combination with "menu" or "menuone".
1696
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001697
Bram Moolenaar071d4272004-06-13 20:20:40 +00001698 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1699'confirm' 'cf' boolean (default off)
1700 global
1701 {not in Vi}
1702 When 'confirm' is on, certain operations that would normally
1703 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1704 instead raise a |dialog| asking if you wish to save the current
1705 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1706 If 'confirm' is off you can still activate confirmation for one
1707 command only (this is most useful in mappings) with the |:confirm|
1708 command.
1709 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1710
1711 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1712'conskey' 'consk' boolean (default off)
1713 global
1714 {not in Vi} {only for MS-DOS}
1715 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001716 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001717 three methods of console input are available:
1718 'conskey' 'bioskey' action ~
1719 on on or off direct console input
1720 off on BIOS
1721 off off STDIN
1722
1723 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1724'copyindent' 'ci' boolean (default off)
1725 local to buffer
1726 {not in Vi}
1727 Copy the structure of the existing lines indent when autoindenting a
1728 new line. Normally the new indent is reconstructed by a series of
1729 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1730 in which case only spaces are used). Enabling this option makes the
1731 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001732 existing line. 'expandtab' has no effect on these characters, a Tab
1733 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001734 line, the remaining space is filled in the normal manner.
1735 NOTE: 'copyindent' is reset when 'compatible' is set.
1736 Also see 'preserveindent'.
1737
1738 *'cpoptions'* *'cpo'*
1739'cpoptions' 'cpo' string (Vim default: "aABceFs",
1740 Vi default: all flags)
1741 global
1742 {not in Vi}
1743 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001744 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001745 not being vi-compatible is mostly or sometimes preferred.
1746 'cpoptions' stands for "compatible-options".
1747 Commas can be added for readability.
1748 To avoid problems with flags that are added in the future, use the
1749 "+=" and "-=" feature of ":set" |add-option-flags|.
1750 NOTE: This option is set to the Vi default value when 'compatible' is
1751 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001752 NOTE: This option is set to the POSIX default value at startup when
1753 the Vi default value would be used and the $VIM_POSIX environment
1754 variable exists |posix|. This means tries to behave like the POSIX
1755 specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001756
1757 contains behavior ~
1758 *cpo-a*
1759 a When included, a ":read" command with a file name
1760 argument will set the alternate file name for the
1761 current window.
1762 *cpo-A*
1763 A When included, a ":write" command with a file name
1764 argument will set the alternate file name for the
1765 current window.
1766 *cpo-b*
1767 b "\|" in a ":map" command is recognized as the end of
1768 the map command. The '\' is included in the mapping,
1769 the text after the '|' is interpreted as the next
1770 command. Use a CTRL-V instead of a backslash to
1771 include the '|' in the mapping. Applies to all
1772 mapping, abbreviation, menu and autocmd commands.
1773 See also |map_bar|.
1774 *cpo-B*
1775 B A backslash has no special meaning in mappings,
1776 abbreviations and the "to" part of the menu commands.
1777 Remove this flag to be able to use a backslash like a
1778 CTRL-V. For example, the command ":map X \<Esc>"
1779 results in X being mapped to:
1780 'B' included: "\^[" (^[ is a real <Esc>)
1781 'B' excluded: "<Esc>" (5 characters)
1782 ('<' excluded in both cases)
1783 *cpo-c*
1784 c Searching continues at the end of any match at the
1785 cursor position, but not further than the start of the
1786 next line. When not present searching continues
1787 one character from the cursor position. With 'c'
1788 "abababababab" only gets three matches when repeating
1789 "/abab", without 'c' there are five matches.
1790 *cpo-C*
1791 C Do not concatenate sourced lines that start with a
1792 backslash. See |line-continuation|.
1793 *cpo-d*
1794 d Using "./" in the 'tags' option doesn't mean to use
1795 the tags file relative to the current file, but the
1796 tags file in the current directory.
1797 *cpo-D*
1798 D Can't use CTRL-K to enter a digraph after Normal mode
1799 commands with a character argument, like |r|, |f| and
1800 |t|.
1801 *cpo-e*
1802 e When executing a register with ":@r", always add a
1803 <CR> to the last line, also when the register is not
1804 linewise. If this flag is not present, the register
1805 is not linewise and the last line does not end in a
1806 <CR>, then the last line is put on the command-line
1807 and can be edited before hitting <CR>.
1808 *cpo-E*
1809 E It is an error when using "y", "d", "c", "g~", "gu" or
1810 "gU" on an Empty region. The operators only work when
1811 at least one character is to be operate on. Example:
1812 This makes "y0" fail in the first column.
1813 *cpo-f*
1814 f When included, a ":read" command with a file name
1815 argument will set the file name for the current buffer,
1816 if the current buffer doesn't have a file name yet.
1817 *cpo-F*
1818 F When included, a ":write" command with a file name
1819 argument will set the file name for the current
1820 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001821 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001822 *cpo-g*
1823 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001824 *cpo-H*
1825 H When using "I" on a line with only blanks, insert
1826 before the last blank. Without this flag insert after
1827 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001828 *cpo-i*
1829 i When included, interrupting the reading of a file will
1830 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001831 *cpo-I*
1832 I When moving the cursor up or down just after inserting
1833 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001834 *cpo-j*
1835 j When joining lines, only add two spaces after a '.',
1836 not after '!' or '?'. Also see 'joinspaces'.
1837 *cpo-J*
1838 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001839 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001840 white space.
1841 *cpo-k*
1842 k Disable the recognition of raw key codes in
1843 mappings, abbreviations, and the "to" part of menu
1844 commands. For example, if <Key> sends ^[OA (where ^[
1845 is <Esc>), the command ":map X ^[OA" results in X
1846 being mapped to:
1847 'k' included: "^[OA" (3 characters)
1848 'k' excluded: "<Key>" (one key code)
1849 Also see the '<' flag below.
1850 *cpo-K*
1851 K Don't wait for a key code to complete when it is
1852 halfway a mapping. This breaks mapping <F1><F1> when
1853 only part of the second <F1> has been read. It
1854 enables cancelling the mapping by typing <F1><Esc>.
1855 *cpo-l*
1856 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001857 literally, only "\]", "\^", "\-" and "\\" are special.
1858 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001859 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1860 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001861 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001862 *cpo-L*
1863 L When the 'list' option is set, 'wrapmargin',
1864 'textwidth', 'softtabstop' and Virtual Replace mode
1865 (see |gR|) count a <Tab> as two characters, instead of
1866 the normal behavior of a <Tab>.
1867 *cpo-m*
1868 m When included, a showmatch will always wait half a
1869 second. When not included, a showmatch will wait half
1870 a second or until a character is typed. |'showmatch'|
1871 *cpo-M*
1872 M When excluded, "%" matching will take backslashes into
1873 account. Thus in "( \( )" and "\( ( \)" the outer
1874 parenthesis match. When included "%" ignores
1875 backslashes, which is Vi compatible.
1876 *cpo-n*
1877 n When included, the column used for 'number' will also
1878 be used for text of wrapped lines.
1879 *cpo-o*
1880 o Line offset to search command is not remembered for
1881 next search.
1882 *cpo-O*
1883 O Don't complain if a file is being overwritten, even
1884 when it didn't exist when editing it. This is a
1885 protection against a file unexpectedly created by
1886 someone else. Vi didn't complain about this.
1887 *cpo-p*
1888 p Vi compatible Lisp indenting. When not present, a
1889 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001890 *cpo-P*
1891 P When included, a ":write" command that appends to a
1892 file will set the file name for the current buffer, if
1893 the current buffer doesn't have a file name yet and
1894 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001895 *cpo-q*
1896 q When joining multiple lines leave the cursor at the
1897 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001898 *cpo-r*
1899 r Redo ("." command) uses "/" to repeat a search
1900 command, instead of the actually used search string.
1901 *cpo-R*
1902 R Remove marks from filtered lines. Without this flag
1903 marks are kept like |:keepmarks| was used.
1904 *cpo-s*
1905 s Set buffer options when entering the buffer for the
1906 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001907 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001908 set when the buffer is created.
1909 *cpo-S*
1910 S Set buffer options always when entering a buffer
1911 (except 'readonly', 'fileformat', 'filetype' and
1912 'syntax'). This is the (most) Vi compatible setting.
1913 The options are set to the values in the current
1914 buffer. When you change an option and go to another
1915 buffer, the value is copied. Effectively makes the
1916 buffer options global to all buffers.
1917
1918 's' 'S' copy buffer options
1919 no no when buffer created
1920 yes no when buffer first entered (default)
1921 X yes each time when buffer entered (vi comp.)
1922 *cpo-t*
1923 t Search pattern for the tag command is remembered for
1924 "n" command. Otherwise Vim only puts the pattern in
1925 the history for search pattern, but doesn't change the
1926 last used search pattern.
1927 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001928 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001929 *cpo-v*
1930 v Backspaced characters remain visible on the screen in
1931 Insert mode. Without this flag the characters are
1932 erased from the screen right away. With this flag the
1933 screen newly typed text overwrites backspaced
1934 characters.
1935 *cpo-w*
1936 w When using "cw" on a blank character, only change one
1937 character and not all blanks until the start of the
1938 next word.
1939 *cpo-W*
1940 W Don't overwrite a readonly file. When omitted, ":w!"
1941 overwrites a readonly file, if possible.
1942 *cpo-x*
1943 x <Esc> on the command-line executes the command-line.
1944 The default in Vim is to abandon the command-line,
1945 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001946 *cpo-X*
1947 X When using a count with "R" the replaced text is
1948 deleted only once. Also when repeating "R" with "."
1949 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001950 *cpo-y*
1951 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001952 *cpo-Z*
1953 Z When using "w!" while the 'readonly' option is set,
1954 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001955 *cpo-!*
1956 ! When redoing a filter command, use the last used
1957 external command, whatever it was. Otherwise the last
1958 used -filter- command is used.
1959 *cpo-$*
1960 $ When making a change to one line, don't redisplay the
1961 line, but put a '$' at the end of the changed text.
1962 The changed text will be overwritten when you type the
1963 new text. The line is redisplayed if you type any
1964 command that moves the cursor from the insertion
1965 point.
1966 *cpo-%*
1967 % Vi-compatible matching is done for the "%" command.
1968 Does not recognize "#if", "#endif", etc.
1969 Does not recognize "/*" and "*/".
1970 Parens inside single and double quotes are also
1971 counted, causing a string that contains a paren to
1972 disturb the matching. For example, in a line like
1973 "if (strcmp("foo(", s))" the first paren does not
1974 match the last one. When this flag is not included,
1975 parens inside single and double quotes are treated
1976 specially. When matching a paren outside of quotes,
1977 everything inside quotes is ignored. When matching a
1978 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001979 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001980 This flag is also used for other features, such as
1981 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001982 *cpo--*
1983 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001984 it would go above the first line or below the last
1985 line. Without it the cursor moves to the first or
1986 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001987 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001988 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001989 *cpo-+*
1990 + When included, a ":write file" command will reset the
1991 'modified' flag of the buffer, even though the buffer
1992 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001993 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001994 * Use ":*" in the same way as ":@". When not included,
1995 ":*" is an alias for ":'<,'>", select the Visual area.
1996 *cpo-<*
1997 < Disable the recognition of special key codes in |<>|
1998 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001999 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002000 ":map X <Tab>" results in X being mapped to:
2001 '<' included: "<Tab>" (5 characters)
2002 '<' excluded: "^I" (^I is a real <Tab>)
2003 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002004 *cpo->*
2005 > When appending to a register, put a line break before
2006 the appended text.
2007
2008 POSIX flags. These are not included in the Vi default value, except
2009 when $VIM_POSIX was set on startup. |posix|
2010
2011 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002012 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002013 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002014 *cpo-&*
2015 & When ":preserve" was used keep the swap file when
2016 exiting normally while this buffer is still loaded.
2017 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002018 *cpo-\*
2019 \ Backslash in a [] range in a search pattern is taken
2020 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002021 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2022 '\' excluded: "/[ \-]" finds <Space> and '-'
2023 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002024 *cpo-/*
2025 / When "%" is used as the replacement string in a |:s|
2026 command, use the previous replacement string. |:s%|
2027 *cpo-{*
2028 { The |{| and |}| commands also stop at a "{" character
2029 at the start of a line.
2030 *cpo-.*
2031 . The ":chdir" and ":cd" commands fail if the current
2032 buffer is modified, unless ! is used. Vim doesn't
2033 need this, since it remembers the full path of an
2034 opened file.
2035 *cpo-bar*
2036 | The value of the $LINES and $COLUMNS environment
2037 variables overrule the terminal size values obtained
2038 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002039
Bram Moolenaar071d4272004-06-13 20:20:40 +00002040
2041 *'cscopepathcomp'* *'cspc'*
2042'cscopepathcomp' 'cspc' number (default 0)
2043 global
2044 {not available when compiled without the |+cscope|
2045 feature}
2046 {not in Vi}
2047 Determines how many components of the path to show in a list of tags.
2048 See |cscopepathcomp|.
2049
2050 *'cscopeprg'* *'csprg'*
2051'cscopeprg' 'csprg' string (default "cscope")
2052 global
2053 {not available when compiled without the |+cscope|
2054 feature}
2055 {not in Vi}
2056 Specifies the command to execute cscope. See |cscopeprg|.
2057 This option cannot be set from a |modeline| or in the |sandbox|, for
2058 security reasons.
2059
2060 *'cscopequickfix'* *'csqf'*
2061'cscopequickfix' 'csqf' string (default "")
2062 global
2063 {not available when compiled without the |+cscope|
2064 or |+quickfix| features}
2065 {not in Vi}
2066 Specifies whether to use quickfix window to show cscope results.
2067 See |cscopequickfix|.
2068
2069 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2070'cscopetag' 'cst' boolean (default off)
2071 global
2072 {not available when compiled without the |+cscope|
2073 feature}
2074 {not in Vi}
2075 Use cscope for tag commands. See |cscope-options|.
2076 NOTE: This option is reset when 'compatible' is set.
2077
2078 *'cscopetagorder'* *'csto'*
2079'cscopetagorder' 'csto' number (default 0)
2080 global
2081 {not available when compiled without the |+cscope|
2082 feature}
2083 {not in Vi}
2084 Determines the order in which ":cstag" performs a search. See
2085 |cscopetagorder|.
2086 NOTE: This option is set to 0 when 'compatible' is set.
2087
2088 *'cscopeverbose'* *'csverb'*
2089 *'nocscopeverbose'* *'nocsverb'*
2090'cscopeverbose' 'csverb' boolean (default off)
2091 global
2092 {not available when compiled without the |+cscope|
2093 feature}
2094 {not in Vi}
2095 Give messages when adding a cscope database. See |cscopeverbose|.
2096 NOTE: This option is reset when 'compatible' is set.
2097
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002098
2099 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2100'cursorcolumn' 'cuc' boolean (default off)
2101 local to window
2102 {not in Vi}
2103 {not available when compiled without the |+syntax|
2104 feature}
2105 Highlight the screen column of the cursor with CursorColumn
2106 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2107 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002108 If you only want the highlighting in the current window you can use
2109 these autocommands: >
2110 au WinLeave * set nocursorline nocursorcolumn
2111 au WinEnter * set cursorline cursorcolumn
2112<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002113
2114 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2115'cursorline' 'cul' boolean (default off)
2116 local to window
2117 {not in Vi}
2118 {not available when compiled without the |+syntax|
2119 feature}
2120 Highlight the screen line of the cursor with CursorLine
2121 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2122 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002123 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002124 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002125
2126
Bram Moolenaar071d4272004-06-13 20:20:40 +00002127 *'debug'*
2128'debug' string (default "")
2129 global
2130 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002131 These values can be used:
2132 msg Error messages that would otherwise be omitted will be given
2133 anyway.
2134 throw Error messages that would otherwise be omitted will be given
2135 anyway and also throw an exception and set |v:errmsg|.
2136 beep A message will be given when otherwise only a beep would be
2137 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002138 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002139 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2140 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002141
2142 *'define'* *'def'*
2143'define' 'def' string (default "^\s*#\s*define")
2144 global or local to buffer |global-local|
2145 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002146 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002147 pattern, just like for the "/" command. This option is used for the
2148 commands like "[i" and "[d" |include-search|. The 'isident' option is
2149 used to recognize the defined name after the match:
2150 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2151 See |option-backslash| about inserting backslashes to include a space
2152 or backslash.
2153 The default value is for C programs. For C++ this value would be
2154 useful, to include const type declarations: >
2155 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2156< When using the ":set" command, you need to double the backslashes!
2157
2158 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2159'delcombine' 'deco' boolean (default off)
2160 global
2161 {not in Vi}
2162 {only available when compiled with the |+multi_byte|
2163 feature}
2164 If editing Unicode and this option is set, backspace and Normal mode
2165 "x" delete each combining character on its own. When it is off (the
2166 default) the character along with its combining characters are
2167 deleted.
2168 Note: When 'delcombine' is set "xx" may work different from "2x"!
2169
2170 This is useful for Arabic, Hebrew and many other languages where one
2171 may have combining characters overtop of base characters, and want
2172 to remove only the combining ones.
2173
2174 *'dictionary'* *'dict'*
2175'dictionary' 'dict' string (default "")
2176 global or local to buffer |global-local|
2177 {not in Vi}
2178 List of file names, separated by commas, that are used to lookup words
2179 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2180 contain a list of words. This can be one word per line, or several
2181 words per line, separated by non-keyword characters (white space is
2182 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002183 When this option is empty, or an entry "spell" is present, spell
2184 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002185 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002186 after a comma are ignored, otherwise spaces are included in the file
2187 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002188 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002189 Where to find a list of words?
2190 - On FreeBSD, there is the file "/usr/share/dict/words".
2191 - In the Simtel archive, look in the "msdos/linguist" directory.
2192 - In "miscfiles" of the GNU collection.
2193 The use of |:set+=| and |:set-=| is preferred when adding or removing
2194 directories from the list. This avoids problems when a future version
2195 uses another default.
2196 Backticks cannot be used in this option for security reasons.
2197
2198 *'diff'* *'nodiff'*
2199'diff' boolean (default off)
2200 local to window
2201 {not in Vi}
2202 {not available when compiled without the |+diff|
2203 feature}
2204 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002205 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002206
2207 *'dex'* *'diffexpr'*
2208'diffexpr' 'dex' string (default "")
2209 global
2210 {not in Vi}
2211 {not available when compiled without the |+diff|
2212 feature}
2213 Expression which is evaluated to obtain an ed-style diff file from two
2214 versions of a file. See |diff-diffexpr|.
2215 This option cannot be set from a |modeline| or in the |sandbox|, for
2216 security reasons.
2217
2218 *'dip'* *'diffopt'*
2219'diffopt' 'dip' string (default "filler")
2220 global
2221 {not in Vi}
2222 {not available when compiled without the |+diff|
2223 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002224 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002225 All are optional. Items must be separated by a comma.
2226
2227 filler Show filler lines, to keep the text
2228 synchronized with a window that has inserted
2229 lines at the same position. Mostly useful
2230 when windows are side-by-side and 'scrollbind'
2231 is set.
2232
2233 context:{n} Use a context of {n} lines between a change
2234 and a fold that contains unchanged lines.
2235 When omitted a context of six lines is used.
2236 See |fold-diff|.
2237
2238 icase Ignore changes in case of text. "a" and "A"
2239 are considered the same. Adds the "-i" flag
2240 to the "diff" command if 'diffexpr' is empty.
2241
2242 iwhite Ignore changes in amount of white space. Adds
2243 the "-b" flag to the "diff" command if
2244 'diffexpr' is empty. Check the documentation
2245 of the "diff" command for what this does
2246 exactly. It should ignore adding trailing
2247 white space, but not leading white space.
2248
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002249 horizontal Start diff mode with horizontal splits (unless
2250 explicitly specified otherwise).
2251
2252 vertical Start diff mode with vertical splits (unless
2253 explicitly specified otherwise).
2254
2255 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2256 starting diff mode. Without this 2 is used.
2257
Bram Moolenaar071d4272004-06-13 20:20:40 +00002258 Examples: >
2259
2260 :set diffopt=filler,context:4
2261 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002262 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002263<
2264 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2265'digraph' 'dg' boolean (default off)
2266 global
2267 {not in Vi}
2268 {not available when compiled without the |+digraphs|
2269 feature}
2270 Enable the entering of digraphs in Insert mode with {char1} <BS>
2271 {char2}. See |digraphs|.
2272 NOTE: This option is reset when 'compatible' is set.
2273
2274 *'directory'* *'dir'*
2275'directory' 'dir' string (default for Amiga: ".,t:",
2276 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2277 for Unix: ".,~/tmp,/var/tmp,/tmp")
2278 global
2279 List of directory names for the swap file, separated with commas.
2280 - The swap file will be created in the first directory where this is
2281 possible.
2282 - Empty means that no swap file will be used (recovery is
2283 impossible!).
2284 - A directory "." means to put the swap file in the same directory as
2285 the edited file. On Unix, a dot is prepended to the file name, so
2286 it doesn't show in a directory listing. On MS-Windows the "hidden"
2287 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002288 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002289 put the swap file relative to where the edited file is. The leading
2290 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002291 - For Unix and Win32, if a directory ends in two path separators "//"
2292 or "\\", the swap file name will be built from the complete path to
2293 the file with all path separators substituted to percent '%' signs.
2294 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002295 - Spaces after the comma are ignored, other spaces are considered part
2296 of the directory name. To have a space at the start of a directory
2297 name, precede it with a backslash.
2298 - To include a comma in a directory name precede it with a backslash.
2299 - A directory name may end in an ':' or '/'.
2300 - Environment variables are expanded |:set_env|.
2301 - Careful with '\' characters, type one before a space, type two to
2302 get one in the option (see |option-backslash|), for example: >
2303 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2304< - For backwards compatibility with Vim version 3.0 a '>' at the start
2305 of the option is removed.
2306 Using "." first in the list is recommended. This means that editing
2307 the same file twice will result in a warning. Using "/tmp" on Unix is
2308 discouraged: When the system crashes you lose the swap file.
2309 "/var/tmp" is often not cleared when rebooting, thus is a better
2310 choice than "/tmp". But it can contain a lot of files, your swap
2311 files get lost in the crowd. That is why a "tmp" directory in your
2312 home directory is tried first.
2313 The use of |:set+=| and |:set-=| is preferred when adding or removing
2314 directories from the list. This avoids problems when a future version
2315 uses another default.
2316 This option cannot be set from a |modeline| or in the |sandbox|, for
2317 security reasons.
2318 {Vi: directory to put temp file in, defaults to "/tmp"}
2319
2320 *'display'* *'dy'*
2321'display' 'dy' string (default "")
2322 global
2323 {not in Vi}
2324 Change the way text is displayed. This is comma separated list of
2325 flags:
2326 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002327 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002328 last line that doesn't fit is replaced with "@" lines.
2329 uhex Show unprintable characters hexadecimal as <xx>
2330 instead of using ^C and ~C.
2331
2332 *'eadirection'* *'ead'*
2333'eadirection' 'ead' string (default "both")
2334 global
2335 {not in Vi}
2336 {not available when compiled without the +vertsplit
2337 feature}
2338 Tells when the 'equalalways' option applies:
2339 ver vertically, width of windows is not affected
2340 hor horizontally, height of windows is not affected
2341 both width and height of windows is affected
2342
2343 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2344'edcompatible' 'ed' boolean (default off)
2345 global
2346 Makes the 'g' and 'c' flags of the ":substitute" command to be
2347 toggled each time the flag is given. See |complex-change|. See
2348 also 'gdefault' option.
2349 Switching this option on is discouraged!
2350
2351 *'encoding'* *'enc'* *E543*
2352'encoding' 'enc' string (default: "latin1" or value from $LANG)
2353 global
2354 {only available when compiled with the |+multi_byte|
2355 feature}
2356 {not in Vi}
2357 Sets the character encoding used inside Vim. It applies to text in
2358 the buffers, registers, Strings in expressions, text stored in the
2359 viminfo file, etc. It sets the kind of characters which Vim can work
2360 with. See |encoding-names| for the possible values.
2361
2362 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002363 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002364 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002365 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002366
2367 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2368 "utf-8". Although care has been taken to allow different values of
2369 'encoding', "utf-8" is the natural choice for the environment and
2370 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002371 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002372 versions, and to avoid changing the encoding of newly created files
2373 without your knowledge (in case 'fileencodings' is empty).
2374
2375 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002376 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002377 iconv() or as specified with 'charconvert'.
2378
2379 Normally 'encoding' will be equal to your current locale. This will
2380 be the default if Vim recognizes your environment settings. If
2381 'encoding' is not set to the current locale, 'termencoding' must be
2382 set to convert typed and displayed text. See |encoding-table|.
2383
2384 When you set this option, it fires the |EncodingChanged| autocommand
2385 event so that you can set up fonts if necessary.
2386
2387 When the option is set, the value is converted to lowercase. Thus
2388 you can set it with uppercase values too. Underscores are translated
2389 to '-' signs.
2390 When the encoding is recognized, it is changed to the standard name.
2391 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2392 "iso-8859-2" and "utf8" becomes "utf-8".
2393
2394 Note: "latin1" is also used when the encoding could not be detected.
2395 This only works when editing files in the same encoding! When the
2396 actual character set is not latin1, make sure 'fileencoding' and
2397 'fileencodings' are empty. When conversion is needed, switch to using
2398 utf-8.
2399
2400 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2401 You don't notice this while editing, but it does matter for the
2402 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2403 setting 'encoding' to one of these values instead of utf-8 only has
2404 effect for encoding used for files when 'fileencoding' is empty.
2405
Bram Moolenaar661b1822005-07-28 22:36:45 +00002406 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2407 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002408
2409 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2410'endofline' 'eol' boolean (default on)
2411 local to buffer
2412 {not in Vi}
2413 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002414 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002415 option is automatically set when starting to edit a new file, unless
2416 the file does not have an <EOL> for the last line in the file, in
2417 which case it is reset. Normally you don't have to set or reset this
2418 option. When 'binary' is off the value is not used when writing the
2419 file. When 'binary' is on it is used to remember the presence of a
2420 <EOL> for the last line in the file, so that when you write the file
2421 the situation from the original file can be kept. But you can change
2422 it if you want to.
2423
2424 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2425'equalalways' 'ea' boolean (default on)
2426 global
2427 {not in Vi}
2428 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002429 splitting or closing a window. This also happens the moment the
2430 option is switched on. When off, splitting a window will reduce the
2431 size of the current window and leave the other windows the same. When
2432 closing a window the extra lines are given to the window next to it
2433 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002434 When mixing vertically and horizontally split windows, a minimal size
2435 is computed and some windows may be larger if there is room. The
2436 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002437 Changing the height and width of a window can be avoided by setting
2438 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002439
2440 *'equalprg'* *'ep'*
2441'equalprg' 'ep' string (default "")
2442 global or local to buffer |global-local|
2443 {not in Vi}
2444 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002445 the internal formatting functions are used; either 'lisp', 'cindent'
2446 or 'indentexpr'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002447 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002448 about including spaces and backslashes.
2449 This option cannot be set from a |modeline| or in the |sandbox|, for
2450 security reasons.
2451
2452 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2453'errorbells' 'eb' boolean (default off)
2454 global
2455 Ring the bell (beep or screen flash) for error messages. This only
2456 makes a difference for error messages, the bell will be used always
2457 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002458 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002459 screen flash or do nothing.
2460
2461 *'errorfile'* *'ef'*
2462'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2463 others: "errors.err")
2464 global
2465 {not in Vi}
2466 {not available when compiled without the |+quickfix|
2467 feature}
2468 Name of the errorfile for the QuickFix mode (see |:cf|).
2469 When the "-q" command-line argument is used, 'errorfile' is set to the
2470 following argument. See |-q|.
2471 NOT used for the ":make" command. See 'makeef' for that.
2472 Environment variables are expanded |:set_env|.
2473 See |option-backslash| about including spaces and backslashes.
2474 This option cannot be set from a |modeline| or in the |sandbox|, for
2475 security reasons.
2476
2477 *'errorformat'* *'efm'*
2478'errorformat' 'efm' string (default is very long)
2479 global or local to buffer |global-local|
2480 {not in Vi}
2481 {not available when compiled without the |+quickfix|
2482 feature}
2483 Scanf-like description of the format for the lines in the error file
2484 (see |errorformat|).
2485
2486 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2487'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2488 global
2489 {not in Vi}
2490 Function keys that start with an <Esc> are recognized in Insert
2491 mode. When this option is off, the cursor and function keys cannot be
2492 used in Insert mode if they start with an <Esc>. The advantage of
2493 this is that the single <Esc> is recognized immediately, instead of
2494 after one second. Instead of resetting this option, you might want to
2495 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2496 when 'esckeys' is off, you can still map anything, but the cursor keys
2497 won't work by default.
2498 NOTE: This option is set to the Vi default value when 'compatible' is
2499 set and to the Vim default value when 'compatible' is reset.
2500
2501 *'eventignore'* *'ei'*
2502'eventignore' 'ei' string (default "")
2503 global
2504 {not in Vi}
2505 {not available when compiled without the |+autocmd|
2506 feature}
2507 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002508 When set to "all" or when "all" is one of the items, all autocommand
2509 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002510 Otherwise this is a comma separated list of event names. Example: >
2511 :set ei=WinEnter,WinLeave
2512<
2513 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2514'expandtab' 'et' boolean (default off)
2515 local to buffer
2516 {not in Vi}
2517 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002518 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002519 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2520 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2521 NOTE: This option is reset when 'compatible' is set.
2522
2523 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2524'exrc' 'ex' boolean (default off)
2525 global
2526 {not in Vi}
2527 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2528 directory. If you switch this option on you should also consider
2529 setting the 'secure' option (see |initialization|). Using a local
2530 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2531 also see |.vimrc| and |gui-init|.
2532 This option cannot be set from a |modeline| or in the |sandbox|, for
2533 security reasons.
2534
2535 *'fileencoding'* *'fenc'* *E213*
2536'fileencoding' 'fenc' string (default: "")
2537 local to buffer
2538 {only available when compiled with the |+multi_byte|
2539 feature}
2540 {not in Vi}
2541 Sets the character encoding for the file of this buffer.
2542 When 'fileencoding' is different from 'encoding', conversion will be
2543 done when reading and writing the file.
2544 When 'fileencoding' is empty, the same value as 'encoding' will be
2545 used (no conversion when reading or writing a file).
2546 WARNING: Conversion can cause loss of information! When
2547 'encoding' is "utf-8" conversion is most likely done in a way
2548 that the reverse conversion results in the same text. When
2549 'encoding' is not "utf-8" some characters may be lost!
2550 See 'encoding' for the possible values. Additionally, values may be
2551 specified that can be handled by the converter, see
2552 |mbyte-conversion|.
2553 When reading a file 'fileencoding' will be set from 'fileencodings'.
2554 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002555 'fileencoding', use the |++enc| argument. One exception: when
2556 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002557 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002558 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2559 When the option is set, the value is converted to lowercase. Thus
2560 you can set it with uppercase values too. '_' characters are
2561 replaced with '-'. If a name is recognized from the list for
2562 'encoding', it is replaced by the standard name. For example
2563 "ISO8859-2" becomes "iso-8859-2".
2564 When this option is set, after starting to edit a file, the 'modified'
2565 option is set, because the file would be different when written.
2566 If you do this in a modeline, you might want to set 'nomodified' to
2567 avoid this.
2568 This option can not be changed when 'modifiable' is off.
2569
2570 *'fe'*
2571 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002572 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002573 old short name was 'fe', which is no longer used.
2574
2575 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002576'fileencodings' 'fencs' string (default: "ucs-bom",
2577 "ucs-bom,utf-8,default,latin1" when
2578 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002579 global
2580 {only available when compiled with the |+multi_byte|
2581 feature}
2582 {not in Vi}
2583 This is a list of character encodings considered when starting to edit
2584 an existing file. When a file is read, Vim tries to use the first
2585 mentioned character encoding. If an error is detected, the next one
2586 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002587 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002588 an empty string, which means the value of 'encoding' is used.
2589 WARNING: Conversion can cause loss of information! When
2590 'encoding' is "utf-8" (or one of the other Unicode variants)
2591 conversion is most likely done in a way that the reverse
2592 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002593 "utf-8" some non-ASCII characters may be lost! You can use
2594 the |++bad| argument to specify what is done with characters
2595 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002596 For an empty file or a file with only ASCII characters most encodings
2597 will work and the first entry of 'fileencodings' will be used (except
2598 "ucs-bom", which requires the BOM to be present). If you prefer
2599 another encoding use an BufReadPost autocommand event to test if your
2600 preferred encoding is to be used. Example: >
2601 au BufReadPost * if search('\S', 'w') == 0 |
2602 \ set fenc=iso-2022-jp | endif
2603< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2604 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002605 When the |++enc| argument is used then the value of 'fileencodings' is
2606 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002607 Note that 'fileencodings' is not used for a new file, the global value
2608 of 'fileencoding' is used instead. You can set it with: >
2609 :setglobal fenc=iso-8859-2
2610< This means that a non-existing file may get a different encoding than
2611 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002612 The special value "ucs-bom" can be used to check for a Unicode BOM
2613 (Byte Order Mark) at the start of the file. It must not be preceded
2614 by "utf-8" or another Unicode encoding for this to work properly.
2615 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2616 because Vim cannot detect an error, thus the encoding is always
2617 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002618 The special value "default" can be used for the encoding from the
2619 environment. This is the default value for 'encoding'. It is useful
2620 when 'encoding' is set to "utf-8" and your environment uses a
2621 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002622 When 'encoding' is "utf-8" and a file contains an illegal byte
2623 sequence it won't be recognized as UTF-8. You can use the |8g8|
2624 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002625 WRONG VALUES: WHAT'S WRONG:
2626 latin1,utf-8 "latin1" will always be used
2627 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2628 file
2629 cp1250,latin1 "cp1250" will always be used
2630 If 'fileencodings' is empty, 'fileencoding' is not modified.
2631 See 'fileencoding' for the possible values.
2632 Setting this option does not have an effect until the next time a file
2633 is read.
2634
2635 *'fileformat'* *'ff'*
2636'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2637 Unix default: "unix",
2638 Macintosh default: "mac")
2639 local to buffer
2640 {not in Vi}
2641 This gives the <EOL> of the current buffer, which is used for
2642 reading/writing the buffer from/to a file:
2643 dos <CR> <NL>
2644 unix <NL>
2645 mac <CR>
2646 When "dos" is used, CTRL-Z at the end of a file is ignored.
2647 See |file-formats| and |file-read|.
2648 For the character encoding of the file see 'fileencoding'.
2649 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2650 works like it was set to "unix'.
2651 This option is set automatically when starting to edit a file and
2652 'fileformats' is not empty and 'binary' is off.
2653 When this option is set, after starting to edit a file, the 'modified'
2654 option is set, because the file would be different when written.
2655 This option can not be changed when 'modifiable' is off.
2656 For backwards compatibility: When this option is set to "dos",
2657 'textmode' is set, otherwise 'textmode' is reset.
2658
2659 *'fileformats'* *'ffs'*
2660'fileformats' 'ffs' string (default:
2661 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2662 Vim Unix: "unix,dos",
2663 Vim Mac: "mac,unix,dos",
2664 Vi Cygwin: "unix,dos",
2665 Vi others: "")
2666 global
2667 {not in Vi}
2668 This gives the end-of-line (<EOL>) formats that will be tried when
2669 starting to edit a new buffer and when reading a file into an existing
2670 buffer:
2671 - When empty, the format defined with 'fileformat' will be used
2672 always. It is not set automatically.
2673 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002674 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002675 'fileformats' name will be used when a file is read into an existing
2676 buffer, no matter what 'fileformat' for that buffer is set to.
2677 - When more than one name is present, separated by commas, automatic
2678 <EOL> detection will be done when reading a file. When starting to
2679 edit a file, a check is done for the <EOL>:
2680 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2681 'fileformat' is set to "dos".
2682 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002683 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002684 preceding <CR>, "unix" is preferred over "dos".
2685 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2686 This means that "mac" is only chosen when "unix" is not present,
2687 or when no <NL> is found in the file, and when "dos" is not
2688 present, or no <CR><NL> is present in the file.
2689 Also if "unix" was first chosen, but the first <CR> is before
2690 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2691 the file, then 'fileformat' is set to "mac".
2692 4. If 'fileformat' is still not set, the first name from
2693 'fileformats' is used.
2694 When reading a file into an existing buffer, the same is done, but
2695 this happens like 'fileformat' has been set appropriately for that
2696 file only, the option is not changed.
2697 When 'binary' is set, the value of 'fileformats' is not used.
2698
2699 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2700 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2701 done:
2702 - When 'fileformats' is empty, there is no automatic detection. Dos
2703 format will be used.
2704 - When 'fileformats' is set to one or more names, automatic detection
2705 is done. This is based on the first <NL> in the file: If there is a
2706 <CR> in front of it, Dos format is used, otherwise Unix format is
2707 used.
2708 Also see |file-formats|.
2709 For backwards compatibility: When this option is set to an empty
2710 string or one format (no comma is included), 'textauto' is reset,
2711 otherwise 'textauto' is set.
2712 NOTE: This option is set to the Vi default value when 'compatible' is
2713 set and to the Vim default value when 'compatible' is reset.
2714
2715 *'filetype'* *'ft'*
2716'filetype' 'ft' string (default: "")
2717 local to buffer
2718 {not in Vi}
2719 {not available when compiled without the |+autocmd|
2720 feature}
2721 When this option is set, the FileType autocommand event is triggered.
2722 All autocommands that match with the value of this option will be
2723 executed. Thus the value of 'filetype' is used in place of the file
2724 name.
2725 Otherwise this option does not always reflect the current file type.
2726 This option is normally set when the file type is detected. To enable
2727 this use the ":filetype on" command. |:filetype|
2728 Setting this option to a different value is most useful in a modeline,
2729 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002730 Example, for in an IDL file:
2731 /* vim: set filetype=idl : */ ~
2732 |FileType| |filetypes|
2733 When a dot appears in the value then this separates two filetype
2734 names. Example:
2735 /* vim: set filetype=c.doxygen : */ ~
2736 This will use the "c" filetype first, then the "doxygen" filetype.
2737 This works both for filetype plugins and for syntax files. More than
2738 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002739 Do not confuse this option with 'osfiletype', which is for the file
2740 type that is actually stored with the file.
2741 This option is not copied to another buffer, independent of the 's' or
2742 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002743 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002744
2745 *'fillchars'* *'fcs'*
2746'fillchars' 'fcs' string (default "vert:|,fold:-")
2747 global
2748 {not in Vi}
2749 {not available when compiled without the |+windows|
2750 and |+folding| features}
2751 Characters to fill the statuslines and vertical separators.
2752 It is a comma separated list of items:
2753
2754 item default Used for ~
2755 stl:c ' ' or '^' statusline of the current window
2756 stlnc:c ' ' or '-' statusline of the non-current windows
2757 vert:c '|' vertical separators |:vsplit|
2758 fold:c '-' filling 'foldtext'
2759 diff:c '-' deleted lines of the 'diff' option
2760
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002761 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002762 "stlnc" the space will be used when there is highlighting, '^' or '-'
2763 otherwise.
2764
2765 Example: >
2766 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2767< This is similar to the default, except that these characters will also
2768 be used when there is highlighting.
2769
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002770 for "stl" and "stlnc" only single-byte values are supported.
2771
Bram Moolenaar071d4272004-06-13 20:20:40 +00002772 The highlighting used for these items:
2773 item highlight group ~
2774 stl:c StatusLine |hl-StatusLine|
2775 stlnc:c StatusLineNC |hl-StatusLineNC|
2776 vert:c VertSplit |hl-VertSplit|
2777 fold:c Folded |hl-Folded|
2778 diff:c DiffDelete |hl-DiffDelete|
2779
2780 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2781'fkmap' 'fk' boolean (default off) *E198*
2782 global
2783 {not in Vi}
2784 {only available when compiled with the |+rightleft|
2785 feature}
2786 When on, the keyboard is mapped for the Farsi character set.
2787 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002788 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789
2790 *'foldclose'* *'fcl'*
2791'foldclose' 'fcl' string (default "")
2792 global
2793 {not in Vi}
2794 {not available when compiled without the |+folding|
2795 feature}
2796 When set to "all", a fold is closed when the cursor isn't in it and
2797 its level is higher than 'foldlevel'. Useful if you want folds to
2798 automatically close when moving out of them.
2799
2800 *'foldcolumn'* *'fdc'*
2801'foldcolumn' 'fdc' number (default 0)
2802 local to window
2803 {not in Vi}
2804 {not available when compiled without the |+folding|
2805 feature}
2806 When non-zero, a column with the specified width is shown at the side
2807 of the window which indicates open and closed folds. The maximum
2808 value is 12.
2809 See |folding|.
2810
2811 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2812'foldenable' 'fen' boolean (default on)
2813 local to window
2814 {not in Vi}
2815 {not available when compiled without the |+folding|
2816 feature}
2817 When off, all folds are open. This option can be used to quickly
2818 switch between showing all text unfolded and viewing the text with
2819 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002820 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002821 'foldenable' is off.
2822 This option is set by commands that create a new fold or close a fold.
2823 See |folding|.
2824
2825 *'foldexpr'* *'fde'*
2826'foldexpr' 'fde' string (default: "0")
2827 local to window
2828 {not in Vi}
2829 {not available when compiled without the |+folding|
2830 or |+eval| feature}
2831 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002832 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002833
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002834 The expression may be evaluated in the |sandbox|, see
2835 |sandbox-option|.
2836
2837 It is not allowed to change text or jump to another window while
2838 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002839
2840 *'foldignore'* *'fdi'*
2841'foldignore' 'fdi' string (default: "#")
2842 local to window
2843 {not in Vi}
2844 {not available when compiled without the |+folding|
2845 feature}
2846 Used only when 'foldmethod' is "indent". Lines starting with
2847 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002848 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002849 The default "#" works well for C programs. See |fold-indent|.
2850
2851 *'foldlevel'* *'fdl'*
2852'foldlevel' 'fdl' number (default: 0)
2853 local to window
2854 {not in Vi}
2855 {not available when compiled without the |+folding|
2856 feature}
2857 Sets the fold level: Folds with a higher level will be closed.
2858 Setting this option to zero will close all folds. Higher numbers will
2859 close fewer folds.
2860 This option is set by commands like |zm|, |zM| and |zR|.
2861 See |fold-foldlevel|.
2862
2863 *'foldlevelstart'* *'fdls'*
2864'foldlevelstart' 'fdls' number (default: -1)
2865 global
2866 {not in Vi}
2867 {not available when compiled without the |+folding|
2868 feature}
2869 Sets 'foldlevel' when starting to edit another buffer in a window.
2870 Useful to always start editing with all folds closed (value zero),
2871 some folds closed (one) or no folds closed (99).
2872 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002873 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002874 ignores this option and closes all folds.
2875 It is also done before BufReadPre autocommands, to allow an autocmd to
2876 overrule the 'foldlevel' value for specific files.
2877 When the value is negative, it is not used.
2878
2879 *'foldmarker'* *'fmr'* *E536*
2880'foldmarker' 'fmr' string (default: "{{{,}}}")
2881 local to window
2882 {not in Vi}
2883 {not available when compiled without the |+folding|
2884 feature}
2885 The start and end marker used when 'foldmethod' is "marker". There
2886 must be one comma, which separates the start and end marker. The
2887 marker is a literal string (a regular expression would be too slow).
2888 See |fold-marker|.
2889
2890 *'foldmethod'* *'fdm'*
2891'foldmethod' 'fdm' string (default: "manual")
2892 local to window
2893 {not in Vi}
2894 {not available when compiled without the |+folding|
2895 feature}
2896 The kind of folding used for the current window. Possible values:
2897 |fold-manual| manual Folds are created manually.
2898 |fold-indent| indent Lines with equal indent form a fold.
2899 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2900 |fold-marker| marker Markers are used to specify folds.
2901 |fold-syntax| syntax Syntax highlighting items specify folds.
2902 |fold-diff| diff Fold text that is not changed.
2903
2904 *'foldminlines'* *'fml'*
2905'foldminlines' 'fml' number (default: 1)
2906 local to window
2907 {not in Vi}
2908 {not available when compiled without the |+folding|
2909 feature}
2910 Sets the minimum number of screen lines for a fold to be displayed
2911 closed. Also for manually closed folds.
2912 Note that this only has an effect of what is displayed. After using
2913 "zc" to close a fold, which is displayed open because it's smaller
2914 than 'foldminlines', a following "zc" may close a containing fold.
2915
2916 *'foldnestmax'* *'fdn'*
2917'foldnestmax' 'fdn' number (default: 20)
2918 local to window
2919 {not in Vi}
2920 {not available when compiled without the |+folding|
2921 feature}
2922 Sets the maximum nesting of folds for the "indent" and "syntax"
2923 methods. This avoids that too many folds will be created. Using more
2924 than 20 doesn't work, because the internal limit is 20.
2925
2926 *'foldopen'* *'fdo'*
2927'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2928 search,tag,undo")
2929 global
2930 {not in Vi}
2931 {not available when compiled without the |+folding|
2932 feature}
2933 Specifies for which type of commands folds will be opened, if the
2934 command moves the cursor into a closed fold. It is a comma separated
2935 list of items.
2936 item commands ~
2937 all any
2938 block "(", "{", "[[", "[{", etc.
2939 hor horizontal movements: "l", "w", "fx", etc.
2940 insert any command in Insert mode
2941 jump far jumps: "G", "gg", etc.
2942 mark jumping to a mark: "'m", CTRL-O, etc.
2943 percent "%"
2944 quickfix ":cn", ":crew", ":make", etc.
2945 search search for a pattern: "/", "n", "*", "gd", etc.
2946 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002947 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002948 tag jumping to a tag: ":ta", CTRL-T, etc.
2949 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002950 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002951 the |zv| command to the mapping to get the same effect.
2952 When a movement command is used for an operator (e.g., "dl" or "y%")
2953 this option is not used. This means the operator will include the
2954 whole closed fold.
2955 Note that vertical movements are not here, because it would make it
2956 very difficult to move onto a closed fold.
2957 In insert mode the folds containing the cursor will always be open
2958 when text is inserted.
2959 To close folds you can re-apply 'foldlevel' with the |zx| command or
2960 set the 'foldclose' option to "all".
2961
2962 *'foldtext'* *'fdt'*
2963'foldtext' 'fdt' string (default: "foldtext()")
2964 local to window
2965 {not in Vi}
2966 {not available when compiled without the |+folding|
2967 feature}
2968 An expression which is used to specify the text displayed for a closed
2969 fold. See |fold-foldtext|.
2970
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002971 The expression may be evaluated in the |sandbox|, see
2972 |sandbox-option|.
2973
2974 It is not allowed to change text or jump to another window while
2975 evaluating 'foldtext' |textlock|.
2976
Bram Moolenaar071d4272004-06-13 20:20:40 +00002977 *'formatoptions'* *'fo'*
2978'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2979 local to buffer
2980 {not in Vi}
2981 This is a sequence of letters which describes how automatic
2982 formatting is to be done. See |fo-table|. When the 'paste' option is
2983 on, no formatting is done (like 'formatoptions' is empty). Commas can
2984 be inserted for readability.
2985 To avoid problems with flags that are added in the future, use the
2986 "+=" and "-=" feature of ":set" |add-option-flags|.
2987 NOTE: This option is set to the Vi default value when 'compatible' is
2988 set and to the Vim default value when 'compatible' is reset.
2989
Bram Moolenaar86b68352004-12-27 21:59:20 +00002990 *'formatlistpat'* *'flp'*
2991'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
2992 local to buffer
2993 {not in Vi}
2994 A pattern that is used to recognize a list header. This is used for
2995 the "n" flag in 'formatoptions'.
2996 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00002997 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00002998 while still checking more characters. There must be a character
2999 following the pattern, when it matches the whole line it is handled
3000 like there is no match.
3001 The default recognizes a number, followed by an optional punctuation
3002 character and white space.
3003
Bram Moolenaar071d4272004-06-13 20:20:40 +00003004 *'formatprg'* *'fp'*
3005'formatprg' 'fp' string (default "")
3006 global
3007 {not in Vi}
3008 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003009 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003010 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003011 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003012 If the 'formatexpr' option is not empty it will be used instead.
3013 Otherwise, if 'formatprg' option is an empty string, the internal
3014 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003015 Environment variables are expanded |:set_env|. See |option-backslash|
3016 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003017 The expression may be evaluated in the |sandbox|, see
3018 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003019
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003020 *'formatexpr'* *'fex'*
3021'formatexpr' 'fex' string (default "")
3022 local to buffer
3023 {not in Vi}
3024 {not available when compiled without the |+eval|
3025 feature}
3026 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003027 operator. When this option is empty 'formatprg' is used.
3028
3029 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003030 The |v:count| variable holds the number of lines to be formatted.
3031 The |v:char| variable holds the character that is going to be
3032 inserted. This can be empty. Don't insert it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003033
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003034 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003035 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003036< This will invoke the mylang#Format() function in the
3037 autoload/mylang.vim file in 'runtimepath'. |autoload|
3038
3039 The expression is also evaluated when 'textwidth' is set and adding
3040 text beyond that limit. This happens under the same conditions as
3041 when internal formatting is used. Make sure the cursor is kept in the
3042 same spot relative to the text then! The |mode()| function will
3043 return "i" or "R" in this situation. When the function returns
3044 non-zero Vim will fall back to using the internal format mechanism.
3045
3046 The expression may be evaluated in the |sandbox|, see
3047 |sandbox-option|.
3048
3049 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003050'fsync' 'fs' boolean (default on)
3051 global
3052 {not in Vi}
3053 When on, the library function fsync() will be called after writing a
3054 file. This will flush a file to disk, ensuring that it is safely
3055 written even on filesystems which do metadata-only journaling. This
3056 will force the harddrive to spin up on Linux systems running in laptop
3057 mode, so it may be undesirable in some situations. Be warned that
3058 turning this off increases the chances of data loss after a crash. On
3059 systems without an fsync() implementation, this variable is always
3060 off.
3061 Also see 'swapsync' for controlling fsync() on swap files.
3062
Bram Moolenaar071d4272004-06-13 20:20:40 +00003063 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3064'gdefault' 'gd' boolean (default off)
3065 global
3066 {not in Vi}
3067 When on, the ":substitute" flag 'g' is default on. This means that
3068 all matches in a line are substituted instead of one. When a 'g' flag
3069 is given to a ":substitute" command, this will toggle the substitution
3070 of all or one match. See |complex-change|.
3071
3072 command 'gdefault' on 'gdefault' off ~
3073 :s/// subst. all subst. one
3074 :s///g subst. one subst. all
3075 :s///gg subst. all subst. one
3076
3077 NOTE: This option is reset when 'compatible' is set.
3078
3079 *'grepformat'* *'gfm'*
3080'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3081 global
3082 {not in Vi}
3083 Format to recognize for the ":grep" command output.
3084 This is a scanf-like string that uses the same format as the
3085 'errorformat' option: see |errorformat|.
3086
3087 *'grepprg'* *'gp'*
3088'grepprg' 'gp' string (default "grep -n ",
3089 Unix: "grep -n $* /dev/null",
3090 Win32: "findstr /n" or "grep -n",
3091 VMS: "SEARCH/NUMBERS ")
3092 global or local to buffer |global-local|
3093 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003094 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003095 and '#' characters, which are expanded like when used in a command-
3096 line. The placeholder "$*" is allowed to specify where the arguments
3097 will be included. Environment variables are expanded |:set_env|. See
3098 |option-backslash| about including spaces and backslashes.
3099 When your "grep" accepts the "-H" argument, use this to make ":grep"
3100 also work well with a single file: >
3101 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003102< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003103 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3104 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003105 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003106 apply equally to 'grepprg'.
3107 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3108 otherwise it's "grep -n".
3109 This option cannot be set from a |modeline| or in the |sandbox|, for
3110 security reasons.
3111
3112 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3113'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3114 ve:ver35-Cursor,
3115 o:hor50-Cursor,
3116 i-ci:ver25-Cursor/lCursor,
3117 r-cr:hor20-Cursor/lCursor,
3118 sm:block-Cursor
3119 -blinkwait175-blinkoff150-blinkon175",
3120 for MS-DOS and Win32 console:
3121 "n-v-c:block,o:hor50,i-ci:hor15,
3122 r-cr:hor30,sm:block")
3123 global
3124 {not in Vi}
3125 {only available when compiled with GUI enabled, and
3126 for MS-DOS and Win32 console}
3127 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003128 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003129 the height of the cursor can be changed. This can be done by
3130 specifying a block cursor, or a percentage for a vertical or
3131 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003132 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003133
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003134 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003135 mode-list and an argument-list:
3136 mode-list:argument-list,mode-list:argument-list,..
3137 The mode-list is a dash separated list of these modes:
3138 n Normal mode
3139 v Visual mode
3140 ve Visual mode with 'selection' "exclusive" (same as 'v',
3141 if not specified)
3142 o Operator-pending mode
3143 i Insert mode
3144 r Replace mode
3145 c Command-line Normal (append) mode
3146 ci Command-line Insert mode
3147 cr Command-line Replace mode
3148 sm showmatch in Insert mode
3149 a all modes
3150 The argument-list is a dash separated list of these arguments:
3151 hor{N} horizontal bar, {N} percent of the character height
3152 ver{N} vertical bar, {N} percent of the character width
3153 block block cursor, fills the whole character
3154 [only one of the above three should be present]
3155 blinkwait{N} *cursor-blinking*
3156 blinkon{N}
3157 blinkoff{N}
3158 blink times for cursor: blinkwait is the delay before
3159 the cursor starts blinking, blinkon is the time that
3160 the cursor is shown and blinkoff is the time that the
3161 cursor is not shown. The times are in msec. When one
3162 of the numbers is zero, there is no blinking. The
3163 default is: "blinkwait700-blinkon400-blinkoff250".
3164 These numbers are used for a missing entry. This
3165 means that blinking is enabled by default. To switch
3166 blinking off you can use "blinkon0". The cursor only
3167 blinks when Vim is waiting for input, not while
3168 executing a command.
3169 To make the cursor blink in an xterm, see
3170 |xterm-blink|.
3171 {group-name}
3172 a highlight group name, that sets the color and font
3173 for the cursor
3174 {group-name}/{group-name}
3175 Two highlight group names, the first is used when
3176 no language mappings are used, the other when they
3177 are. |language-mapping|
3178
3179 Examples of parts:
3180 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3181 block cursor with colors from the "nCursor"
3182 highlight group
3183 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3184 In Insert and Command-line Insert mode, use a
3185 30% vertical bar cursor with colors from the
3186 "iCursor" highlight group. Blink a bit
3187 faster.
3188
3189 The 'a' mode is different. It will set the given argument-list for
3190 all modes. It does not reset anything to defaults. This can be used
3191 to do a common setting for all modes. For example, to switch off
3192 blinking: "a:blinkon0"
3193
3194 Examples of cursor highlighting: >
3195 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3196 :highlight Cursor gui=NONE guifg=bg guibg=fg
3197<
3198 *'guifont'* *'gfn'*
3199 *E235* *E596* *E610* *E611*
3200'guifont' 'gfn' string (default "")
3201 global
3202 {not in Vi}
3203 {only available when compiled with GUI enabled}
3204 This is a list of fonts which will be used for the GUI version of Vim.
3205 In its simplest form the value is just one font name. When
3206 the font cannot be found you will get an error message. To try other
3207 font names a list can be specified, font names separated with commas.
3208 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003209
Bram Moolenaar05159a02005-02-26 23:04:13 +00003210 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3211 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003212
Bram Moolenaar071d4272004-06-13 20:20:40 +00003213 Spaces after a comma are ignored. To include a comma in a font name
3214 precede it with a backslash. Setting an option requires an extra
3215 backslash before a space and a backslash. See also
3216 |option-backslash|. For example: >
3217 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003218< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003219 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003220
3221 If none of the fonts can be loaded, Vim will keep the current setting.
3222 If an empty font list is given, Vim will try using other resource
3223 settings (for X, it will use the Vim.font resource), and finally it
3224 will try some builtin default which should always be there ("7x13" in
3225 the case of X). The font names given should be "normal" fonts. Vim
3226 will try to find the related bold and italic fonts.
3227
Bram Moolenaar05159a02005-02-26 23:04:13 +00003228 For Win32, GTK, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003229 :set guifont=*
3230< will bring up a font requester, where you can pick the font you want.
3231
3232 The font name depends on the GUI used. See |setting-guifont| for a
3233 way to set 'guifont' for various systems.
3234
Bram Moolenaar071d4272004-06-13 20:20:40 +00003235 For the GTK+ 2 GUI the font name looks like this: >
3236 :set guifont=Andale\ Mono\ 11
3237< That's all. XLFDs are no longer accepted.
Bram Moolenaar05159a02005-02-26 23:04:13 +00003238
3239 For Mac OSX you can use something like this: >
3240 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003241< Also see 'macatsui', it can help fix display problems.
3242 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003243 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003244 width). An exception is GTK 2: all fonts are accepted, but
3245 mono-spaced fonts look best.
3246
Bram Moolenaar071d4272004-06-13 20:20:40 +00003247 To preview a font on X11, you might be able to use the "xfontsel"
3248 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003249
Bram Moolenaar071d4272004-06-13 20:20:40 +00003250 For the Win32 GUI *E244* *E245*
3251 - takes these options in the font name:
3252 hXX - height is XX (points, can be floating-point)
3253 wXX - width is XX (points, can be floating-point)
3254 b - bold
3255 i - italic
3256 u - underline
3257 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003258 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003259 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3260 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3261 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003262 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263
3264 Use a ':' to separate the options.
3265 - A '_' can be used in the place of a space, so you don't need to use
3266 backslashes to escape the spaces.
3267 - Examples: >
3268 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3269 :set guifont=Andale_Mono:h7.5:w4.5
3270< See also |font-sizes|.
3271
3272 *'guifontset'* *'gfs'*
3273 *E250* *E252* *E234* *E597* *E598*
3274'guifontset' 'gfs' string (default "")
3275 global
3276 {not in Vi}
3277 {only available when compiled with GUI enabled and
3278 with the |+xfontset| feature}
3279 {not available in the GTK+ 2 GUI}
3280 When not empty, specifies two (or more) fonts to be used. The first
3281 one for normal English, the second one for your special language. See
3282 |xfontset|.
3283 Setting this option also means that all font names will be handled as
3284 a fontset name. Also the ones used for the "font" argument of the
3285 |:highlight| command.
3286 The fonts must match with the current locale. If fonts for the
3287 character sets that the current locale uses are not included, setting
3288 'guifontset' will fail.
3289 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3290 the comma-separated names are alternative names, one of which will be
3291 used. In 'guifontset' the whole string is one fontset name,
3292 including the commas. It is not possible to specify alternative
3293 fontset names.
3294 This example works on many X11 systems: >
3295 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3296<
3297 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3298'guifontwide' 'gfw' string (default "")
3299 global
3300 {not in Vi}
3301 {only available when compiled with GUI enabled}
3302 When not empty, specifies a comma-separated list of fonts to be used
3303 for double-width characters. The first font that can be loaded is
3304 used.
3305 Note: The size of these fonts must be exactly twice as wide as the one
3306 specified with 'guifont' and the same height.
3307
3308 All GUI versions but GTK+ 2:
3309
3310 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3311 'guifontset' is empty or invalid.
3312 When 'guifont' is set and a valid font is found in it and
3313 'guifontwide' is empty Vim will attempt to find a matching
3314 double-width font and set 'guifontwide' to it.
3315
3316 GTK+ 2 GUI only: *guifontwide_gtk2*
3317
3318 If set and valid, 'guifontwide' is always used for double width
3319 characters, even if 'encoding' is not set to "utf-8".
3320 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003321 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003322 font for characters not available in 'guifont'. Thus you do not need
3323 to set 'guifontwide' at all unless you want to override the choice
3324 made by Pango/Xft.
3325
3326 *'guiheadroom'* *'ghr'*
3327'guiheadroom' 'ghr' number (default 50)
3328 global
3329 {not in Vi} {only for GTK and X11 GUI}
3330 The number of pixels subtracted from the screen height when fitting
3331 the GUI window on the screen. Set this before the GUI is started,
3332 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003333 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003334 lines will be left for window decorations and other items on the
3335 screen. Set it to a negative value to allow windows taller than the
3336 screen.
3337
3338 *'guioptions'* *'go'*
3339'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003340 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003341 global
3342 {not in Vi}
3343 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003344 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003345 sequence of letters which describes what components and options of the
3346 GUI should be used.
3347 To avoid problems with flags that are added in the future, use the
3348 "+=" and "-=" feature of ":set" |add-option-flags|.
3349
3350 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003351 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003352 'a' Autoselect: If present, then whenever VISUAL mode is started,
3353 or the Visual area extended, Vim tries to become the owner of
3354 the windowing system's global selection. This means that the
3355 Visually highlighted text is available for pasting into other
3356 applications as well as into Vim itself. When the Visual mode
3357 ends, possibly due to an operation on the text, or when an
3358 application wants to paste the selection, the highlighted text
3359 is automatically yanked into the "* selection register.
3360 Thus the selection is still available for pasting into other
3361 applications after the VISUAL mode has ended.
3362 If not present, then Vim won't become the owner of the
3363 windowing system's global selection unless explicitly told to
3364 by a yank or delete operation for the "* register.
3365 The same applies to the modeless selection.
Bram Moolenaar02467872007-05-06 13:22:01 +00003366 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003367 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003368 applies to the modeless selection.
3369
3370 'guioptions' autoselect Visual autoselect modeless ~
3371 "" - -
3372 "a" yes yes
3373 "A" - yes
3374 "aA" yes yes
3375
Bram Moolenaar02467872007-05-06 13:22:01 +00003376 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003377 'c' Use console dialogs instead of popup dialogs for simple
3378 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003379 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003380 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003381 'guitablabel' can be used to change the text in the labels.
3382 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003383 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003384 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003385 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003386 'f' Foreground: Don't use fork() to detach the GUI from the shell
3387 where it was started. Use this for programs that wait for the
3388 editor to finish (e.g., an e-mail program). Alternatively you
3389 can use "gvim -f" or ":gui -f" to start the GUI in the
3390 foreground. |gui-fork|
3391 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003392 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003393 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003394 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3395 corner of the window. It's black&white on non-GTK, because of
3396 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar02467872007-05-06 13:22:01 +00003397 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003398 'm' Menu bar is present.
Bram Moolenaar02467872007-05-06 13:22:01 +00003399 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003400 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003401 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003402 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003403 file is sourced the system menu has already been loaded; the
3404 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar02467872007-05-06 13:22:01 +00003405 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003406 'g' Grey menu items: Make menu items that are not active grey. If
3407 'g' is not included inactive menu items are not shown at all.
3408 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003409 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003410 't' Include tearoff menu items. Currently only works for Win32,
3411 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003412 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003413 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003414 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003415 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003416 'r' Right-hand scrollbar is always present.
Bram Moolenaar02467872007-05-06 13:22:01 +00003417 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003418 'R' Right-hand scrollbar is present when there is a vertically
3419 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003420 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003421 'l' Left-hand scrollbar is always present.
Bram Moolenaar02467872007-05-06 13:22:01 +00003422 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003423 'L' Left-hand scrollbar is present when there is a vertically
3424 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003425 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003426 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3427 the longest visible line, or on the cursor line if the 'h'
3428 flag is included. |gui-horiz-scroll|
Bram Moolenaar02467872007-05-06 13:22:01 +00003429 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003430 'h' Limit horizontal scrollbar size to the length of the cursor
3431 line. Reduces computations. |gui-horiz-scroll|
3432
3433 And yes, you may even have scrollbars on the left AND the right if
3434 you really want to :-). See |gui-scrollbars| for more information.
3435
Bram Moolenaar02467872007-05-06 13:22:01 +00003436 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003437 'v' Use a vertical button layout for dialogs. When not included,
3438 a horizontal layout is preferred, but when it doesn't fit a
3439 vertical layout is used anyway.
Bram Moolenaar02467872007-05-06 13:22:01 +00003440 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003441 'p' Use Pointer callbacks for X11 GUI. This is required for some
3442 window managers. If the cursor is not blinking or hollow at
3443 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003444 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003445 removing it after the GUI has started has no effect.
Bram Moolenaar02467872007-05-06 13:22:01 +00003446 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003447 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003448
Bram Moolenaar02467872007-05-06 13:22:01 +00003449
Bram Moolenaar071d4272004-06-13 20:20:40 +00003450 *'guipty'* *'noguipty'*
3451'guipty' boolean (default on)
3452 global
3453 {not in Vi}
3454 {only available when compiled with GUI enabled}
3455 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3456 I/O to/from shell commands. See |gui-pty|.
3457
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003458 *'guitablabel'* *'gtl'*
3459'guitablabel' 'gtl' string (default empty)
3460 global
3461 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003462 {only available when compiled with GUI enabled and
3463 with the +windows feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003464 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003465 pages line. When empty and when the result is empty Vim will use a
3466 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003467
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003468 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003469 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003470
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003471 Only used when the GUI tab pages line is displayed. 'e' must be
3472 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3473 used.
3474
Bram Moolenaar57657d82006-04-21 22:12:41 +00003475 *'guitabtooltip'* *'gtt'*
3476'guitabtooltip' 'gtt' string (default empty)
3477 global
3478 {not in Vi}
3479 {only available when compiled with GUI enabled and
3480 with the +windows feature}
3481 When nonempty describes the text to use in a tooltip for the GUI tab
3482 pages line. When empty Vim will use a default tooltip.
3483 This option is otherwise just like 'guitablabel' above.
3484
Bram Moolenaar57657d82006-04-21 22:12:41 +00003485
Bram Moolenaar071d4272004-06-13 20:20:40 +00003486 *'helpfile'* *'hf'*
3487'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3488 (others) "$VIMRUNTIME/doc/help.txt")
3489 global
3490 {not in Vi}
3491 Name of the main help file. All distributed help files should be
3492 placed together in one directory. Additionally, all "doc" directories
3493 in 'runtimepath' will be used.
3494 Environment variables are expanded |:set_env|. For example:
3495 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003496 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003497 spaces and backslashes.
3498 This option cannot be set from a |modeline| or in the |sandbox|, for
3499 security reasons.
3500
3501 *'helpheight'* *'hh'*
3502'helpheight' 'hh' number (default 20)
3503 global
3504 {not in Vi}
3505 {not available when compiled without the +windows
3506 feature}
3507 Minimal initial height of the help window when it is opened with the
3508 ":help" command. The initial height of the help window is half of the
3509 current window, or (when the 'ea' option is on) the same as other
3510 windows. When the height is less than 'helpheight', the height is
3511 set to 'helpheight'. Set to zero to disable.
3512
3513 *'helplang'* *'hlg'*
3514'helplang' 'hlg' string (default: messages language or empty)
3515 global
3516 {only available when compiled with the |+multi_lang|
3517 feature}
3518 {not in Vi}
3519 Comma separated list of languages. Vim will use the first language
3520 for which the desired help can be found. The English help will always
3521 be used as a last resort. You can add "en" to prefer English over
3522 another language, but that will only find tags that exist in that
3523 language and not in the English help.
3524 Example: >
3525 :set helplang=de,it
3526< This will first search German, then Italian and finally English help
3527 files.
3528 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3529 try to find the tag in the current language before using this option.
3530 See |help-translated|.
3531
3532 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3533'hidden' 'hid' boolean (default off)
3534 global
3535 {not in Vi}
3536 When off a buffer is unloaded when it is |abandon|ed. When on a
3537 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3538 displayed in another window, it does not become hidden, of course.
3539 The commands that move through the buffer list sometimes make a buffer
3540 hidden although the 'hidden' option is off: When the buffer is
3541 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003542 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003543 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003544 This option is set for one command with ":hide {command}" |:hide|.
3545 WARNING: It's easy to forget that you have changes in hidden buffers.
3546 Think twice when using ":q!" or ":qa!".
3547
3548 *'highlight'* *'hl'*
3549'highlight' 'hl' string (default (as a single string):
3550 "8:SpecialKey,@:NonText,d:Directory,
3551 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3552 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003553 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003554 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3555 f:Folded,F:FoldColumn,A:DiffAdd,
3556 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003557 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003558 R:SpellRare,L:SpellLocal,
3559 +:Pmenu,=:PmenuSel,
3560 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003561 global
3562 {not in Vi}
3563 This option can be used to set highlighting mode for various
3564 occasions. It is a comma separated list of character pairs. The
3565 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003566 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003567 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3568 |hl-NonText| @ '~' and '@' at the end of the window and
3569 characters from 'showbreak'
3570 |hl-Directory| d directories in CTRL-D listing and other special
3571 things in listings
3572 |hl-ErrorMsg| e error messages
3573 h (obsolete, ignored)
3574 |hl-IncSearch| i 'incsearch' highlighting
3575 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3576 |hl-MoreMsg| m |more-prompt|
3577 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3578 |hl-LineNr| n line number for ":number" and ":#" commands
3579 |hl-Question| r |hit-enter| prompt and yes/no questions
3580 |hl-StatusLine| s status line of current window |status-line|
3581 |hl-StatusLineNC| S status lines of not-current windows
3582 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3583 |hl-VertSplit| c column used to separate vertically split windows
3584 |hl-Visual| v Visual mode
3585 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3586 Selection" Only X11 Gui's |gui-x11| and
3587 |xterm-clipboard|.
3588 |hl-WarningMsg| w warning messages
3589 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3590 |hl-Folded| f line used for closed folds
3591 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003592 |hl-DiffAdd| A added line in diff mode
3593 |hl-DiffChange| C changed line in diff mode
3594 |hl-DiffDelete| D deleted line in diff mode
3595 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003596 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003597 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003598 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003599 |hl-SpellRare| R rare word |spell|
3600 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003601 |hl-Pmenu| + popup menu normal line
3602 |hl-PmenuSel| = popup menu normal line
3603 |hl-PmenuSbar| x popup menu scrollbar
3604 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003605
3606 The display modes are:
3607 r reverse (termcap entry "mr" and "me")
3608 i italic (termcap entry "ZH" and "ZR")
3609 b bold (termcap entry "md" and "me")
3610 s standout (termcap entry "so" and "se")
3611 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003612 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003613 n no highlighting
3614 - no highlighting
3615 : use a highlight group
3616 The default is used for occasions that are not included.
3617 If you want to change what the display modes do, see |dos-colors|
3618 for an example.
3619 When using the ':' display mode, this must be followed by the name of
3620 a highlight group. A highlight group can be used to define any type
3621 of highlighting, including using color. See |:highlight| on how to
3622 define one. The default uses a different group for each occasion.
3623 See |highlight-default| for the default highlight groups.
3624
3625 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3626'hlsearch' 'hls' boolean (default off)
3627 global
3628 {not in Vi}
3629 {not available when compiled without the
3630 |+extra_search| feature}
3631 When there is a previous search pattern, highlight all its matches.
3632 The type of highlighting used can be set with the 'l' occasion in the
3633 'highlight' option. This uses the "Search" highlight group by
3634 default. Note that only the matching text is highlighted, any offsets
3635 are not applied.
3636 See also: 'incsearch' and |:match|.
3637 When you get bored looking at the highlighted matches, you can turn it
3638 off with |:nohlsearch|. As soon as you use a search command, the
3639 highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003640 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003641 When the search pattern can match an end-of-line, Vim will try to
3642 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003643 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003644 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003645 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003646 NOTE: This option is reset when 'compatible' is set.
3647
3648 *'history'* *'hi'*
3649'history' 'hi' number (Vim default: 20, Vi default: 0)
3650 global
3651 {not in Vi}
3652 A history of ":" commands, and a history of previous search patterns
3653 are remembered. This option decides how many entries may be stored in
3654 each of these histories (see |cmdline-editing|).
3655 NOTE: This option is set to the Vi default value when 'compatible' is
3656 set and to the Vim default value when 'compatible' is reset.
3657
3658 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3659'hkmap' 'hk' boolean (default off)
3660 global
3661 {not in Vi}
3662 {only available when compiled with the |+rightleft|
3663 feature}
3664 When on, the keyboard is mapped for the Hebrew character set.
3665 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3666 toggle this option. See |rileft.txt|.
3667 NOTE: This option is reset when 'compatible' is set.
3668
3669 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3670'hkmapp' 'hkp' boolean (default off)
3671 global
3672 {not in Vi}
3673 {only available when compiled with the |+rightleft|
3674 feature}
3675 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3676 This is useful if you have a non-Hebrew keyboard.
3677 See |rileft.txt|.
3678 NOTE: This option is reset when 'compatible' is set.
3679
3680 *'icon'* *'noicon'*
3681'icon' boolean (default off, on when title can be restored)
3682 global
3683 {not in Vi}
3684 {not available when compiled without the |+title|
3685 feature}
3686 When on, the icon text of the window will be set to the value of
3687 'iconstring' (if it is not empty), or to the name of the file
3688 currently being edited. Only the last part of the name is used.
3689 Overridden by the 'iconstring' option.
3690 Only works if the terminal supports setting window icons (currently
3691 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3692 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3693 builtin termcap).
3694 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003695 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003696 X11.
3697
3698 *'iconstring'*
3699'iconstring' string (default "")
3700 global
3701 {not in Vi}
3702 {not available when compiled without the |+title|
3703 feature}
3704 When this option is not empty, it will be used for the icon text of
3705 the window. This happens only when the 'icon' option is on.
3706 Only works if the terminal supports setting window icon text
3707 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3708 Does not work for MS Windows.
3709 When Vim was compiled with HAVE_X11 defined, the original icon will be
3710 restored if possible |X11|.
3711 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003712 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003713 'titlestring' for example settings.
3714 {not available when compiled without the |+statusline| feature}
3715
3716 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3717'ignorecase' 'ic' boolean (default off)
3718 global
3719 Ignore case in search patterns. Also used when searching in the tags
3720 file.
3721 Also see 'smartcase'.
3722 Can be overruled by using "\c" or "\C" in the pattern, see
3723 |/ignorecase|.
3724
3725 *'imactivatekey'* *'imak'*
3726'imactivatekey' 'imak' string (default "")
3727 global
3728 {not in Vi}
3729 {only available when compiled with |+xim| and
3730 |+GUI_GTK|}
3731 Specifies the key that your Input Method in X-Windows uses for
3732 activation. When this is specified correctly, vim can fully control
3733 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3734 You can't use this option to change the activation key, the option
3735 tells Vim what the key is.
3736 Format:
3737 [MODIFIER_FLAG-]KEY_STRING
3738
3739 These characters can be used for MODIFIER_FLAG (case is ignored):
3740 S Shift key
3741 L Lock key
3742 C Control key
3743 1 Mod1 key
3744 2 Mod2 key
3745 3 Mod3 key
3746 4 Mod4 key
3747 5 Mod5 key
3748 Combinations are allowed, for example "S-C-space" or "SC-space" are
3749 both shift+ctrl+space.
3750 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3751
3752 Example: >
3753 :set imactivatekey=S-space
3754< "S-space" means shift+space. This is the activation key for kinput2 +
3755 canna (Japanese), and ami (Korean).
3756
3757 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3758'imcmdline' 'imc' boolean (default off)
3759 global
3760 {not in Vi}
3761 {only available when compiled with the |+xim|
3762 |+multi_byte_ime| or |global-ime| feature}
3763 When set the Input Method is always on when starting to edit a command
3764 line, unless entering a search pattern (see 'imsearch' for that).
3765 Setting this option is useful when your input method allows entering
3766 English characters directly, e.g., when it's used to type accented
3767 characters with dead keys.
3768
3769 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3770'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3771 global
3772 {not in Vi}
3773 {only available when compiled with the |+xim|
3774 |+multi_byte_ime| or |global-ime| feature}
3775 When set the Input Method is never used. This is useful to disable
3776 the IM when it doesn't work properly.
3777 Currently this option is on by default for SGI/IRIX machines. This
3778 may change in later releases.
3779
3780 *'iminsert'* *'imi'*
3781'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3782 local to buffer
3783 {not in Vi}
3784 Specifies whether :lmap or an Input Method (IM) is to be used in
3785 Insert mode. Valid values:
3786 0 :lmap is off and IM is off
3787 1 :lmap is ON and IM is off
3788 2 :lmap is off and IM is ON
3789 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3790 or |global-ime|.
3791 To always reset the option to zero when leaving Insert mode with <Esc>
3792 this can be used: >
3793 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3794< This makes :lmap and IM turn off automatically when leaving Insert
3795 mode.
3796 Note that this option changes when using CTRL-^ in Insert mode
3797 |i_CTRL-^|.
3798 The value is set to 1 when setting 'keymap' to a valid keymap name.
3799 It is also used for the argument of commands like "r" and "f".
3800 The value 0 may not work correctly with Athena and Motif with some XIM
3801 methods. Use 'imdisable' to disable XIM then.
3802
3803 *'imsearch'* *'ims'*
3804'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3805 local to buffer
3806 {not in Vi}
3807 Specifies whether :lmap or an Input Method (IM) is to be used when
3808 entering a search pattern. Valid values:
3809 -1 the value of 'iminsert' is used, makes it look like
3810 'iminsert' is also used when typing a search pattern
3811 0 :lmap is off and IM is off
3812 1 :lmap is ON and IM is off
3813 2 :lmap is off and IM is ON
3814 Note that this option changes when using CTRL-^ in Command-line mode
3815 |c_CTRL-^|.
3816 The value is set to 1 when it is not -1 and setting the 'keymap'
3817 option to a valid keymap name.
3818 The value 0 may not work correctly with Athena and Motif with some XIM
3819 methods. Use 'imdisable' to disable XIM then.
3820
3821 *'include'* *'inc'*
3822'include' 'inc' string (default "^\s*#\s*include")
3823 global or local to buffer |global-local|
3824 {not in Vi}
3825 {not available when compiled without the
3826 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003827 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003828 pattern, just like for the "/" command (See |pattern|). The default
3829 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003830 "]I", "[d", etc.
3831 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003832 comes after the matched pattern. But if "\zs" appears in the pattern
3833 then the text matched from "\zs" to the end, or until "\ze" if it
3834 appears, is used as the file name. Use this to include characters
3835 that are not in 'isfname', such as a space. You can then use
3836 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003837 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003838
3839 *'includeexpr'* *'inex'*
3840'includeexpr' 'inex' string (default "")
3841 local to buffer
3842 {not in Vi}
3843 {not available when compiled without the
3844 |+find_in_path| or |+eval| feature}
3845 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003846 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003847 :set includeexpr=substitute(v:fname,'\\.','/','g')
3848< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003849
Bram Moolenaar071d4272004-06-13 20:20:40 +00003850 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003851 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003852 Also used for |<cfile>|.
3853
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003854 The expression may be evaluated in the |sandbox|, see
3855 |sandbox-option|.
3856
3857 It is not allowed to change text or jump to another window while
3858 evaluating 'includeexpr' |textlock|.
3859
Bram Moolenaar071d4272004-06-13 20:20:40 +00003860 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3861'incsearch' 'is' boolean (default off)
3862 global
3863 {not in Vi}
3864 {not available when compiled without the
3865 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003866 While typing a search command, show where the pattern, as it was typed
3867 so far, matches. The matched string is highlighted. If the pattern
3868 is invalid or not found, nothing is shown. The screen will be updated
3869 often, this is only useful on fast terminals.
3870 Note that the match will be shown, but the cursor will return to its
3871 original position when no match is found and when pressing <Esc>. You
3872 still need to finish the search command with <Enter> to move the
3873 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00003874 When compiled with the |+reltime| feature Vim only searches for about
3875 half a second. With a complicated pattern and/or a lot of text the
3876 match may not be found. This is to avoid that Vim hangs while you
3877 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003878 The highlighting can be set with the 'i' flag in 'highlight'.
3879 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00003880 CTRL-L can be used to add one character from after the current match
3881 to the command line.
3882 CTRL-R CTRL-W can be used to add the word at the end of the current
3883 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003884 NOTE: This option is reset when 'compatible' is set.
3885
3886 *'indentexpr'* *'inde'*
3887'indentexpr' 'inde' string (default "")
3888 local to buffer
3889 {not in Vi}
3890 {not available when compiled without the |+cindent|
3891 or |+eval| features}
3892 Expression which is evaluated to obtain the proper indent for a line.
3893 It is used when a new line is created, for the |=| operator and
3894 in Insert mode as specified with the 'indentkeys' option.
3895 When this option is not empty, it overrules the 'cindent' and
3896 'smartindent' indenting.
3897 When 'paste' is set this option is not used for indenting.
3898 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003899 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003900 when the expression is evaluated (but it may be moved around).
3901 The expression must return the number of spaces worth of indent. It
3902 can return "-1" to keep the current indent (this means 'autoindent' is
3903 used for the indent).
3904 Functions useful for computing the indent are |indent()|, |cindent()|
3905 and |lispindent()|.
3906 The evaluation of the expression must not have side effects! It must
3907 not change the text, jump to another window, etc. Afterwards the
3908 cursor position is always restored, thus the cursor may be moved.
3909 Normally this option would be set to call a function: >
3910 :set indentexpr=GetMyIndent()
3911< Error messages will be suppressed, unless the 'debug' option contains
3912 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003913 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003914 NOTE: This option is made empty when 'compatible' is set.
3915
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003916 The expression may be evaluated in the |sandbox|, see
3917 |sandbox-option|.
3918
3919 It is not allowed to change text or jump to another window while
3920 evaluating 'indentexpr' |textlock|.
3921
3922
Bram Moolenaar071d4272004-06-13 20:20:40 +00003923 *'indentkeys'* *'indk'*
3924'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3925 local to buffer
3926 {not in Vi}
3927 {not available when compiled without the |+cindent|
3928 feature}
3929 A list of keys that, when typed in Insert mode, cause reindenting of
3930 the current line. Only happens if 'indentexpr' isn't empty.
3931 The format is identical to 'cinkeys', see |indentkeys-format|.
3932 See |C-indenting| and |indent-expression|.
3933
3934 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3935'infercase' 'inf' boolean (default off)
3936 local to buffer
3937 {not in Vi}
3938 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00003939 'ignorecase' is also on, the case of the match is adjusted depending
3940 on the typed text. If the typed text contains a lowercase letter
3941 where the match has an upper case letter, the completed part is made
3942 lowercase. If the typed text has no lowercase letters and the match
3943 has a lowercase letter where the typed text has an uppercase letter,
3944 and there is a letter before it, the completed part is made uppercase.
3945 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003946
3947 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3948'insertmode' 'im' boolean (default off)
3949 global
3950 {not in Vi}
3951 Makes Vim work in a way that Insert mode is the default mode. Useful
3952 if you want to use Vim as a modeless editor. Used for |evim|.
3953 These Insert mode commands will be useful:
3954 - Use the cursor keys to move around.
3955 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3956 this is a mapping, it is executed as if 'insertmode' was off.
3957 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003958 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00003959 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
3960 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003961
3962 These items change when 'insertmode' is set:
3963 - when starting to edit of a file, Vim goes to Insert mode.
3964 - <Esc> in Insert mode is a no-op and beeps.
3965 - <Esc> in Normal mode makes Vim go to Insert mode.
3966 - CTRL-L in Insert mode is a command, it is not inserted.
3967 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3968 However, when <Esc> is used inside a mapping, it behaves like
3969 'insertmode' was not set. This was done to be able to use the same
3970 mappings with 'insertmode' set or not set.
3971 When executing commands with |:normal| 'insertmode' is not used.
3972
3973 NOTE: This option is reset when 'compatible' is set.
3974
3975 *'isfname'* *'isf'*
3976'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3977 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3978 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3979 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3980 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3981 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3982 global
3983 {not in Vi}
3984 The characters specified by this option are included in file names and
3985 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003986 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003987 Multi-byte characters 256 and above are always included, only the
3988 characters up to 255 are specified with this option.
3989 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003990 Think twice before adding white space to this option. Although a
3991 space may appear inside a file name, the effect will be that Vim
3992 doesn't know where a file name starts or ends when doing completion.
3993 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003994
3995 Note that on systems using a backslash as path separator, Vim tries to
3996 do its best to make it work as you would expect. That is a bit
3997 tricky, since Vi originally used the backslash to escape special
3998 characters. Vim will not remove a backslash in front of a normal file
3999 name character on these systems, but it will on Unix and alikes. The
4000 '&' and '^' are not included by default, because these are special for
4001 cmd.exe.
4002
4003 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004004 Each part can be a single character number or a range. A range is two
4005 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004006 decimal number between 0 and 255 or the ASCII character itself (does
4007 not work for digits). Example:
4008 "_,-,128-140,#-43" (include '_' and '-' and the range
4009 128 to 140 and '#' to 43)
4010 If a part starts with '^', the following character number or range
4011 will be excluded from the option. The option is interpreted from left
4012 to right. Put the excluded character after the range where it is
4013 included. To include '^' itself use it as the last character of the
4014 option or the end of a range. Example:
4015 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4016 If the character is '@', all characters where isalpha() returns TRUE
4017 are included. Normally these are the characters a to z and A to Z,
4018 plus accented characters. To include '@' itself use "@-@". Examples:
4019 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004020 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004021 "a-z,A-Z,@-@" All letters plus the '@' character.
4022 A comma can be included by using it where a character number is
4023 expected. Example:
4024 "48-57,,,_" Digits, comma and underscore.
4025 A comma can be excluded by prepending a '^'. Example:
4026 " -~,^,,9" All characters from space to '~', excluding
4027 comma, plus <Tab>.
4028 See |option-backslash| about including spaces and backslashes.
4029
4030 *'isident'* *'isi'*
4031'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4032 "@,48-57,_,128-167,224-235"
4033 otherwise: "@,48-57,_,192-255")
4034 global
4035 {not in Vi}
4036 The characters given by this option are included in identifiers.
4037 Identifiers are used in recognizing environment variables and after a
4038 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004039 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004040 option.
4041 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004042 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004043 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4044
4045 *'iskeyword'* *'isk'*
4046'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4047 "@,48-57,_,128-167,224-235"
4048 otherwise: "@,48-57,_,192-255"
4049 Vi default: "@,48-57,_")
4050 local to buffer
4051 {not in Vi}
4052 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004053 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004054 'isfname' for a description of the format of this option. For C
4055 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4056 For a help file it is set to all non-blank printable characters except
4057 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4058 command).
4059 When the 'lisp' option is on the '-' character is always included.
4060 NOTE: This option is set to the Vi default value when 'compatible' is
4061 set and to the Vim default value when 'compatible' is reset.
4062
4063 *'isprint'* *'isp'*
4064'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4065 "@,~-255"; otherwise: "@,161-255")
4066 global
4067 {not in Vi}
4068 The characters given by this option are displayed directly on the
4069 screen. It is also used for "\p" in a |pattern|. The characters from
4070 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4071 even when they are not included in 'isprint' or excluded. See
4072 'isfname' for a description of the format of this option.
4073
4074 Non-printable characters are displayed with two characters:
4075 0 - 31 "^@" - "^_"
4076 32 - 126 always single characters
4077 127 "^?"
4078 128 - 159 "~@" - "~_"
4079 160 - 254 "| " - "|~"
4080 255 "~?"
4081 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4082 displayed as <xx>, with the hexadecimal value of the byte.
4083 When 'display' contains "uhex" all unprintable characters are
4084 displayed as <xx>.
4085 The NonText highlighting will be used for unprintable characters.
4086 |hl-NonText|
4087
4088 Multi-byte characters 256 and above are always included, only the
4089 characters up to 255 are specified with this option. When a character
4090 is printable but it is not available in the current font, a
4091 replacement character will be shown.
4092 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4093 There is no option to specify these characters.
4094
4095 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4096'joinspaces' 'js' boolean (default on)
4097 global
4098 {not in Vi}
4099 Insert two spaces after a '.', '?' and '!' with a join command.
4100 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4101 Otherwise only one space is inserted.
4102 NOTE: This option is set when 'compatible' is set.
4103
4104 *'key'*
4105'key' string (default "")
4106 local to buffer
4107 {not in Vi}
4108 The key that is used for encrypting and decrypting the current buffer.
4109 See |encryption|.
4110 Careful: Do not set the key value by hand, someone might see the typed
4111 key. Use the |:X| command. But you can make 'key' empty: >
4112 :set key=
4113< It is not possible to get the value of this option with ":set key" or
4114 "echo &key". This is to avoid showing it to someone who shouldn't
4115 know. It also means you cannot see it yourself once you have set it,
4116 be careful not to make a typing error!
4117
4118 *'keymap'* *'kmp'* *E544*
4119'keymap' 'kmp' string (default "")
4120 local to buffer
4121 {not in Vi}
4122 {only available when compiled with the |+keymap|
4123 feature}
4124 Name of a keyboard mapping. See |mbyte-keymap|.
4125 Setting this option to a valid keymap name has the side effect of
4126 setting 'iminsert' to one, so that the keymap becomes effective.
4127 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004128 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004129
4130 *'keymodel'* *'km'*
4131'keymodel' 'km' string (default "")
4132 global
4133 {not in Vi}
4134 List of comma separated words, which enable special things that keys
4135 can do. These values can be used:
4136 startsel Using a shifted special key starts selection (either
4137 Select mode or Visual mode, depending on "key" being
4138 present in 'selectmode').
4139 stopsel Using a not-shifted special key stops selection.
4140 Special keys in this context are the cursor keys, <End>, <Home>,
4141 <PageUp> and <PageDown>.
4142 The 'keymodel' option is set by the |:behave| command.
4143
4144 *'keywordprg'* *'kp'*
4145'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4146 OS/2: "view /", VMS: "help")
4147 global or local to buffer |global-local|
4148 {not in Vi}
4149 Program to use for the |K| command. Environment variables are
4150 expanded |:set_env|. ":help" may be used to access the Vim internal
4151 help. (Note that previously setting the global option to the empty
4152 value did this, which is now deprecated.)
4153 When "man" is used, Vim will automatically translate a count for the
4154 "K" command to a section number. Also for "man -s", in which case the
4155 "-s" is removed when there is no count.
4156 See |option-backslash| about including spaces and backslashes.
4157 Example: >
4158 :set keywordprg=man\ -s
4159< This option cannot be set from a |modeline| or in the |sandbox|, for
4160 security reasons.
4161
4162 *'langmap'* *'lmap'* *E357* *E358*
4163'langmap' 'lmap' string (default "")
4164 global
4165 {not in Vi}
4166 {only available when compiled with the |+langmap|
4167 feature}
4168 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004169 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004170 inserted directly. When in command mode the 'langmap' option takes
4171 care of translating these special characters to the original meaning
4172 of the key. This means you don't have to change the keyboard mode to
4173 be able to execute Normal mode commands.
4174 This is the opposite of the 'keymap' option, where characters are
4175 mapped in Insert mode.
4176 This only works for 8-bit characters. The value of 'langmap' may be
4177 specified with multi-byte characters (e.g., UTF-8), but only the lower
4178 8 bits of each character will be used.
4179
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004180 Example (for Greek, in UTF-8): *greek* >
4181 :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 +00004182< Example (exchanges meaning of z and y for commands): >
4183 :set langmap=zy,yz,ZY,YZ
4184<
4185 The 'langmap' option is a list of parts, separated with commas. Each
4186 part can be in one of two forms:
4187 1. A list of pairs. Each pair is a "from" character immediately
4188 followed by the "to" character. Examples: "aA", "aAbBcC".
4189 2. A list of "from" characters, a semi-colon and a list of "to"
4190 characters. Example: "abc;ABC"
4191 Example: "aA,fgh;FGH,cCdDeE"
4192 Special characters need to be preceded with a backslash. These are
4193 ";", ',' and backslash itself.
4194
4195 This will allow you to activate vim actions without having to switch
4196 back and forth between the languages. Your language characters will
4197 be understood as normal vim English characters (according to the
4198 langmap mappings) in the following cases:
4199 o Normal/Visual mode (commands, buffer/register names, user mappings)
4200 o Insert/Replace Mode: Register names after CTRL-R
4201 o Insert/Replace Mode: Mappings
4202 Characters entered in Command-line mode will NOT be affected by
4203 this option. Note that this option can be changed at any time
4204 allowing to switch between mappings for different languages/encodings.
4205 Use a mapping to avoid having to type it each time!
4206
4207 *'langmenu'* *'lm'*
4208'langmenu' 'lm' string (default "")
4209 global
4210 {not in Vi}
4211 {only available when compiled with the |+menu| and
4212 |+multi_lang| features}
4213 Language to use for menu translation. Tells which file is loaded
4214 from the "lang" directory in 'runtimepath': >
4215 "lang/menu_" . &langmenu . ".vim"
4216< (without the spaces). For example, to always use the Dutch menus, no
4217 matter what $LANG is set to: >
4218 :set langmenu=nl_NL.ISO_8859-1
4219< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004220 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004221 If your $LANG is set to a non-English language but you do want to use
4222 the English menus: >
4223 :set langmenu=none
4224< This option must be set before loading menus, switching on filetype
4225 detection or syntax highlighting. Once the menus are defined setting
4226 this option has no effect. But you could do this: >
4227 :source $VIMRUNTIME/delmenu.vim
4228 :set langmenu=de_DE.ISO_8859-1
4229 :source $VIMRUNTIME/menu.vim
4230< Warning: This deletes all menus that you defined yourself!
4231
4232 *'laststatus'* *'ls'*
4233'laststatus' 'ls' number (default 1)
4234 global
4235 {not in Vi}
4236 The value of this option influences when the last window will have a
4237 status line:
4238 0: never
4239 1: only if there are at least two windows
4240 2: always
4241 The screen looks nicer with a status line if you have several
4242 windows, but it takes another screen line. |status-line|
4243
4244 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4245'lazyredraw' 'lz' boolean (default off)
4246 global
4247 {not in Vi}
4248 When this option is set, the screen will not be redrawn while
4249 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004250 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004251 update use |:redraw|.
4252
4253 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4254'linebreak' 'lbr' boolean (default off)
4255 local to window
4256 {not in Vi}
4257 {not available when compiled without the |+linebreak|
4258 feature}
4259 If on Vim will wrap long lines at a character in 'breakat' rather
4260 than at the last character that fits on the screen. Unlike
4261 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4262 it only affects the way the file is displayed, not its contents. The
4263 value of 'showbreak' is used to put in front of wrapped lines.
4264 This option is not used when the 'wrap' option is off or 'list' is on.
4265 Note that <Tab> characters after an <EOL> are mostly not displayed
4266 with the right amount of white space.
4267
4268 *'lines'* *E593*
4269'lines' number (default 24 or terminal height)
4270 global
4271 Number of lines of the Vim window.
4272 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004273 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004274 When Vim is running in the GUI or in a resizable window, setting this
4275 option will cause the window size to be changed. When you only want
4276 to use the size for the GUI, put the command in your |gvimrc| file.
4277 Vim limits the number of lines to what fits on the screen. You can
4278 use this command to get the tallest window possible: >
4279 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004280< Minimum value is 2, maximum value is 1000.
4281 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004282 When you set this option and Vim is unable to change the physical
4283 number of lines of the display, the display may be messed up.
4284
4285 *'linespace'* *'lsp'*
4286'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4287 global
4288 {not in Vi}
4289 {only in the GUI}
4290 Number of pixel lines inserted between characters. Useful if the font
4291 uses the full character cell height, making lines touch each other.
4292 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004293 With some fonts there can be too much room between lines (to have
4294 space for ascents and descents). Then it makes sense to set
4295 'linespace' to a negative value. This may cause display problems
4296 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004297
4298 *'lisp'* *'nolisp'*
4299'lisp' boolean (default off)
4300 local to buffer
4301 {not available when compiled without the |+lispindent|
4302 feature}
4303 Lisp mode: When <Enter> is typed in insert mode set the indent for
4304 the next line to Lisp standards (well, sort of). Also happens with
4305 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4306 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4307 better. Also see 'lispwords'.
4308 The '-' character is included in keyword characters. Redefines the
4309 "=" operator to use this same indentation algorithm rather than
4310 calling an external program if 'equalprg' is empty.
4311 This option is not used when 'paste' is set.
4312 {Vi: Does it a little bit differently}
4313
4314 *'lispwords'* *'lw'*
4315'lispwords' 'lw' string (default is very long)
4316 global
4317 {not in Vi}
4318 {not available when compiled without the |+lispindent|
4319 feature}
4320 Comma separated list of words that influence the Lisp indenting.
4321 |'lisp'|
4322
4323 *'list'* *'nolist'*
4324'list' boolean (default off)
4325 local to window
4326 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
4327 see the difference between tabs and spaces and for trailing blanks.
4328 Note that this will also affect formatting (set with 'textwidth' or
4329 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
4330 changing the way tabs are displayed.
4331
4332 *'listchars'* *'lcs'*
4333'listchars' 'lcs' string (default "eol:$")
4334 global
4335 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004336 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004337 settings.
4338 eol:c Character to show at the end of each line. When
4339 omitted, there is no extra character at the end of the
4340 line.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004341 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004342 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004343 fill the space that the tab normally occupies.
4344 "tab:>-" will show a tab that takes four spaces as
4345 ">---". When omitted, a tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004346 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004347 trailing spaces are blank.
4348 extends:c Character to show in the last column, when 'wrap' is
4349 off and the line continues beyond the right of the
4350 screen.
4351 precedes:c Character to show in the first column, when 'wrap'
4352 is off and there is text preceding the character
4353 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004354 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004355 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004356
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004357 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004358 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004359 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004360
4361 Examples: >
4362 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004363 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004364 :set lcs=extends:>,precedes:<
4365< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004366 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004367 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004368
4369 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4370'loadplugins' 'lpl' boolean (default on)
4371 global
4372 {not in Vi}
4373 When on the plugin scripts are loaded when starting up |load-plugins|.
4374 This option can be reset in your |vimrc| file to disable the loading
4375 of plugins.
4376 Note that using the "-u NONE" and "--noplugin" command line arguments
4377 reset this option. |-u| |--noplugin|
4378
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004379 *'macatsui'* *'nomacatsui'*
4380'macatsui' boolean (default on)
4381 global
4382 {only available in Mac GUI version}
4383 This is a workaround for when drawing doesn't work properly. When set
4384 and compiled with multi-byte support ATSUI text drawing is used. When
4385 not set ATSUI text drawing is not used. Switch this option off when
4386 you experience drawing problems. In a future version the problems may
4387 be solved and this option becomes obsolete. Therefore use this method
4388 to unset it: >
4389 if exists('&macatsui')
4390 set nomacatsui
4391 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004392< Another option to check if you have drawing problems is
4393 'termencoding'.
4394
Bram Moolenaar071d4272004-06-13 20:20:40 +00004395 *'magic'* *'nomagic'*
4396'magic' boolean (default on)
4397 global
4398 Changes the special characters that can be used in search patterns.
4399 See |pattern|.
4400 NOTE: To avoid portability problems with using patterns, always keep
4401 this option at the default "on". Only switch it off when working with
4402 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004403 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004404
4405 *'makeef'* *'mef'*
4406'makeef' 'mef' string (default: "")
4407 global
4408 {not in Vi}
4409 {not available when compiled without the |+quickfix|
4410 feature}
4411 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4412 and the |:grep| command.
4413 When it is empty, an internally generated temp file will be used.
4414 When "##" is included, it is replaced by a number to make the name
4415 unique. This makes sure that the ":make" command doesn't overwrite an
4416 existing file.
4417 NOT used for the ":cf" command. See 'errorfile' for that.
4418 Environment variables are expanded |:set_env|.
4419 See |option-backslash| about including spaces and backslashes.
4420 This option cannot be set from a |modeline| or in the |sandbox|, for
4421 security reasons.
4422
4423 *'makeprg'* *'mp'*
4424'makeprg' 'mp' string (default "make", VMS: "MMS")
4425 global or local to buffer |global-local|
4426 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004427 Program to use for the ":make" command. See |:make_makeprg|.
4428 This option may contain '%' and '#' characters, which are expanded to
4429 the current and alternate file name. |:_%| |:_#|
4430 Environment variables are expanded |:set_env|. See |option-backslash|
4431 about including spaces and backslashes.
4432 Note that a '|' must be escaped twice: once for ":set" and once for
4433 the interpretation of a command. When you use a filter called
4434 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004435 :set makeprg=gmake\ \\\|\ myfilter
4436< The placeholder "$*" can be given (even multiple times) to specify
4437 where the arguments will be included, for example: >
4438 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4439< This option cannot be set from a |modeline| or in the |sandbox|, for
4440 security reasons.
4441
4442 *'matchpairs'* *'mps'*
4443'matchpairs' 'mps' string (default "(:),{:},[:]")
4444 local to buffer
4445 {not in Vi}
4446 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaar02467872007-05-06 13:22:01 +00004447 other. Currently only single byte character pairs are allowed, and
4448 they must be different. The characters must be separated by a colon.
4449 The pairs must be separated by a comma. Example for including '<' and
4450 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004451 :set mps+=<:>
4452
4453< A more exotic example, to jump between the '=' and ';' in an
4454 assignment, useful for languages like C and Java: >
4455 :au FileType c,cpp,java set mps+==:;
4456
4457< For a more advanced way of using "%", see the matchit.vim plugin in
4458 the $VIMRUNTIME/macros directory. |add-local-help|
4459
4460 *'matchtime'* *'mat'*
4461'matchtime' 'mat' number (default 5)
4462 global
4463 {not in Vi}{in Nvi}
4464 Tenths of a second to show the matching paren, when 'showmatch' is
4465 set. Note that this is not in milliseconds, like other options that
4466 set a time. This is to be compatible with Nvi.
4467
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004468 *'maxcombine'* *'mco'*
4469'maxcombine' 'mco' number (default 2)
4470 global
4471 {not in Vi}
4472 {only available when compiled with the |+multi_byte|
4473 feature}
4474 The maximum number of combining characters supported for displaying.
4475 Only used when 'encoding' is "utf-8".
4476 The default is OK for most languages. Hebrew may require 4.
4477 Maximum value is 6.
4478 Even when this option is set to 2 you can still edit text with more
4479 combining characters, you just can't see them. Use |g8| or |ga|.
4480 See |mbyte-combining|.
4481
Bram Moolenaar071d4272004-06-13 20:20:40 +00004482 *'maxfuncdepth'* *'mfd'*
4483'maxfuncdepth' 'mfd' number (default 100)
4484 global
4485 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004486 {not available when compiled without the +eval
4487 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004488 Maximum depth of function calls for user functions. This normally
4489 catches endless recursion. When using a recursive function with
4490 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4491 more memory, there is the danger of failing when memory is exhausted.
4492 See also |:function|.
4493
4494 *'maxmapdepth'* *'mmd'* *E223*
4495'maxmapdepth' 'mmd' number (default 1000)
4496 global
4497 {not in Vi}
4498 Maximum number of times a mapping is done without resulting in a
4499 character to be used. This normally catches endless mappings, like
4500 ":map x y" with ":map y x". It still does not catch ":map g wg",
4501 because the 'w' is used before the next mapping is done. See also
4502 |key-mapping|.
4503
4504 *'maxmem'* *'mm'*
4505'maxmem' 'mm' number (default between 256 to 5120 (system
4506 dependent) or half the amount of memory
4507 available)
4508 global
4509 {not in Vi}
4510 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4511 limit is reached allocating extra memory for a buffer will cause
4512 other memory to be freed. Maximum value 2000000. Use this to work
4513 without a limit. Also see 'maxmemtot'.
4514
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004515 *'maxmempattern'* *'mmp'*
4516'maxmempattern' 'mmp' number (default 1000)
4517 global
4518 {not in Vi}
4519 Maximum amount of memory (in Kbyte) to use for pattern matching.
4520 Maximum value 2000000. Use this to work without a limit.
4521 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004522 When Vim runs into the limit it gives an error message and mostly
4523 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004524 Running into the limit often means that the pattern is very
4525 inefficient or too complex. This may already happen with the pattern
4526 "\(.\)*" on a very long line. ".*" works much better.
4527 Vim may run out of memory before hitting the 'maxmempattern' limit.
4528
Bram Moolenaar071d4272004-06-13 20:20:40 +00004529 *'maxmemtot'* *'mmt'*
4530'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4531 dependent) or half the amount of memory
4532 available)
4533 global
4534 {not in Vi}
4535 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004536 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004537 'maxmem'.
4538
4539 *'menuitems'* *'mis'*
4540'menuitems' 'mis' number (default 25)
4541 global
4542 {not in Vi}
4543 {not available when compiled without the |+menu|
4544 feature}
4545 Maximum number of items to use in a menu. Used for menus that are
4546 generated from a list of items, e.g., the Buffers menu. Changing this
4547 option has no direct effect, the menu must be refreshed first.
4548
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004549 *'mkspellmem'* *'msm'*
4550'mkspellmem' 'msm' string (default "460000,2000,500")
4551 global
4552 {not in Vi}
4553 {not available when compiled without the |+syntax|
4554 feature}
4555 Parameters for |:mkspell|. This tunes when to start compressing the
4556 word tree. Compression can be slow when there are many words, but
4557 it's needed to avoid running out of memory. The amount of memory used
4558 per word depends very much on how similar the words are, that's why
4559 this tuning is complicated.
4560
4561 There are three numbers, separated by commas:
4562 {start},{inc},{added}
4563
4564 For most languages the uncompressed word tree fits in memory. {start}
4565 gives the amount of memory in Kbyte that can be used before any
4566 compression is done. It should be a bit smaller than the amount of
4567 memory that is available to Vim.
4568
4569 When going over the {start} limit the {inc} number specifies the
4570 amount of memory in Kbyte that can be allocated before another
4571 compression is done. A low number means compression is done after
4572 less words are added, which is slow. A high number means more memory
4573 will be allocated.
4574
4575 After doing compression, {added} times 1024 words can be added before
4576 the {inc} limit is ignored and compression is done when any extra
4577 amount of memory is needed. A low number means there is a smaller
4578 chance of hitting the {inc} limit, less memory is used but it's
4579 slower.
4580
4581 The languages for which these numbers are important are Italian and
4582 Hungarian. The default works for when you have about 512 Mbyte. If
4583 you have 1 Gbyte you could use: >
4584 :set mkspellmem=900000,3000,800
4585< If you have less than 512 Mbyte |:mkspell| may fail for some
4586 languages, no matter what you set 'mkspellmem' to.
4587
Bram Moolenaar071d4272004-06-13 20:20:40 +00004588 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004589'modeline' 'ml' boolean (Vim default: on (off for root),
4590 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004591 local to buffer
4592 *'modelines'* *'mls'*
4593'modelines' 'mls' number (default 5)
4594 global
4595 {not in Vi}
4596 If 'modeline' is on 'modelines' gives the number of lines that is
4597 checked for set commands. If 'modeline' is off or 'modelines' is zero
4598 no lines are checked. See |modeline|.
4599 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4600 set and to the Vim default value when 'compatible' is reset.
4601
4602 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4603'modifiable' 'ma' boolean (default on)
4604 local to buffer
4605 {not in Vi} *E21*
4606 When off the buffer contents cannot be changed. The 'fileformat' and
4607 'fileencoding' options also can't be changed.
4608 Can be reset with the |-M| command line argument.
4609
4610 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4611'modified' 'mod' boolean (default off)
4612 local to buffer
4613 {not in Vi}
4614 When on, the buffer is considered to be modified. This option is set
4615 when:
4616 1. A change was made to the text since it was last written. Using the
4617 |undo| command to go back to the original text will reset the
4618 option. But undoing changes that were made before writing the
4619 buffer will set the option again, since the text is different from
4620 when it was written.
4621 2. 'fileformat' or 'fileencoding' is different from its original
4622 value. The original value is set when the buffer is read or
4623 written. A ":set nomodified" command also resets the original
4624 values to the current values and the 'modified' option will be
4625 reset.
4626 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4627 will be ignored.
4628
4629 *'more'* *'nomore'*
4630'more' boolean (Vim default: on, Vi default: off)
4631 global
4632 {not in Vi}
4633 When on, listings pause when the whole screen is filled. You will get
4634 the |more-prompt|. When this option is off there are no pauses, the
4635 listing continues until finished.
4636 NOTE: This option is set to the Vi default value when 'compatible' is
4637 set and to the Vim default value when 'compatible' is reset.
4638
4639 *'mouse'* *E538*
4640'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4641 global
4642 {not in Vi}
4643 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004644 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4645 sysmouse and Linux console with gpm). For using the mouse in the
4646 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647 The mouse can be enabled for different modes:
4648 n Normal mode
4649 v Visual mode
4650 i Insert mode
4651 c Command-line mode
4652 h all previous modes when editing a help file
4653 a all previous modes
4654 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004655 Normally you would enable the mouse in all four modes with: >
4656 :set mouse=a
4657< When the mouse is not enabled, the GUI will still use the mouse for
4658 modeless selection. This doesn't move the text cursor.
4659
4660 See |mouse-using|. Also see |'clipboard'|.
4661
4662 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004663 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004664 the mouse buttons can still be used by keeping the shift key pressed.
4665 Also see the 'clipboard' option.
4666
4667 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4668'mousefocus' 'mousef' boolean (default off)
4669 global
4670 {not in Vi}
4671 {only works in the GUI}
4672 The window that the mouse pointer is on is automatically activated.
4673 When changing the window layout or window focus in another way, the
4674 mouse pointer is moved to the window with keyboard focus. Off is the
4675 default because it makes using the pull down menus a little goofy, as
4676 a pointer transit may activate a window unintentionally.
4677
4678 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4679'mousehide' 'mh' boolean (default on)
4680 global
4681 {not in Vi}
4682 {only works in the GUI}
4683 When on, the mouse pointer is hidden when characters are typed.
4684 The mouse pointer is restored when the mouse is moved.
4685
4686 *'mousemodel'* *'mousem'*
4687'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4688 global
4689 {not in Vi}
4690 Sets the model to use for the mouse. The name mostly specifies what
4691 the right mouse button is used for:
4692 extend Right mouse button extends a selection. This works
4693 like in an xterm.
4694 popup Right mouse button pops up a menu. The shifted left
4695 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004696 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004697 popup_setpos Like "popup", but the cursor will be moved to the
4698 position where the mouse was clicked, and thus the
4699 selected operation will act upon the clicked object.
4700 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004701 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004702 course, that right clicking outside a selection will
4703 end Visual mode.
4704 Overview of what button does what for each model:
4705 mouse extend popup(_setpos) ~
4706 left click place cursor place cursor
4707 left drag start selection start selection
4708 shift-left search word extend selection
4709 right click extend selection popup menu (place cursor)
4710 right drag extend selection -
4711 middle click paste paste
4712
4713 In the "popup" model the right mouse button produces a pop-up menu.
4714 You need to define this first, see |popup-menu|.
4715
4716 Note that you can further refine the meaning of buttons with mappings.
4717 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4718 selection (because that's handled in the GUI code directly).
4719
4720 The 'mousemodel' option is set by the |:behave| command.
4721
4722 *'mouseshape'* *'mouses'* *E547*
4723'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004724 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004725 global
4726 {not in Vi}
4727 {only available when compiled with the |+mouseshape|
4728 feature}
4729 This option tells Vim what the mouse pointer should look like in
4730 different modes. The option is a comma separated list of parts, much
4731 like used for 'guicursor'. Each part consist of a mode/location-list
4732 and an argument-list:
4733 mode-list:shape,mode-list:shape,..
4734 The mode-list is a dash separated list of these modes/locations:
4735 In a normal window: ~
4736 n Normal mode
4737 v Visual mode
4738 ve Visual mode with 'selection' "exclusive" (same as 'v',
4739 if not specified)
4740 o Operator-pending mode
4741 i Insert mode
4742 r Replace mode
4743
4744 Others: ~
4745 c appending to the command-line
4746 ci inserting in the command-line
4747 cr replacing in the command-line
4748 m at the 'Hit ENTER' or 'More' prompts
4749 ml idem, but cursor in the last line
4750 e any mode, pointer below last window
4751 s any mode, pointer on a status line
4752 sd any mode, while dragging a status line
4753 vs any mode, pointer on a vertical separator line
4754 vd any mode, while dragging a vertical separator line
4755 a everywhere
4756
4757 The shape is one of the following:
4758 avail name looks like ~
4759 w x arrow Normal mouse pointer
4760 w x blank no pointer at all (use with care!)
4761 w x beam I-beam
4762 w x updown up-down sizing arrows
4763 w x leftright left-right sizing arrows
4764 w x busy The system's usual busy pointer
4765 w x no The system's usual 'no input' pointer
4766 x udsizing indicates up-down resizing
4767 x lrsizing indicates left-right resizing
4768 x crosshair like a big thin +
4769 x hand1 black hand
4770 x hand2 white hand
4771 x pencil what you write with
4772 x question big ?
4773 x rightup-arrow arrow pointing right-up
4774 w x up-arrow arrow pointing up
4775 x <number> any X11 pointer number (see X11/cursorfont.h)
4776
4777 The "avail" column contains a 'w' if the shape is available for Win32,
4778 x for X11.
4779 Any modes not specified or shapes not available use the normal mouse
4780 pointer.
4781
4782 Example: >
4783 :set mouseshape=s:udsizing,m:no
4784< will make the mouse turn to a sizing arrow over the status lines and
4785 indicate no input when the hit-enter prompt is displayed (since
4786 clicking the mouse has no effect in this state.)
4787
4788 *'mousetime'* *'mouset'*
4789'mousetime' 'mouset' number (default 500)
4790 global
4791 {not in Vi}
4792 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4793 time in msec between two mouse clicks for the second click to be
4794 recognized as a multi click.
4795
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004796 *'mzquantum'* *'mzq'*
4797'mzquantum' 'mzq' number (default 100)
4798 global
4799 {not in Vi}
4800 {not available when compiled without the |+mzscheme|
4801 feature}
4802 The number of milliseconds between polls for MzScheme threads.
4803 Negative or zero value means no thread scheduling.
4804
Bram Moolenaar071d4272004-06-13 20:20:40 +00004805 *'nrformats'* *'nf'*
4806'nrformats' 'nf' string (default "octal,hex")
4807 local to buffer
4808 {not in Vi}
4809 This defines what bases Vim will consider for numbers when using the
4810 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4811 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004812 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004813 incremented or decremented. This is useful for a list with a
4814 letter index a), b), etc.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004815 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004816 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004817 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004818 considered to be hexadecimal. Example: Using CTRL-X on
4819 "0x100" results in "0x0ff".
4820 Numbers which simply begin with a digit in the range 1-9 are always
4821 considered decimal. This also happens for numbers that are not
4822 recognized as octal or hex.
4823
4824 *'number'* *'nu'* *'nonumber'* *'nonu'*
4825'number' 'nu' boolean (default off)
4826 local to window
4827 Print the line number in front of each line. When the 'n' option is
4828 excluded from 'cpoptions' a wrapped line will not use the column of
4829 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004830 The 'numberwidth' option can be used to set the room used for the line
4831 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004832 When a long, wrapped line doesn't start with the first character, '-'
4833 characters are put before the number.
4834 See |hl-LineNr| for the highlighting used for the number.
4835
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004836 *'numberwidth'* *'nuw'*
4837'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4838 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004839 {not in Vi}
4840 {only available when compiled with the |+linebreak|
4841 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004842 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00004843 when the 'number' option is set or printing lines with a line number.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004844 Since one space is always between the number and the text, there is
4845 one less character for the number itself.
4846 The value is the minimum width. A bigger width is used when needed to
4847 fit the highest line number in the buffer. Thus with the Vim default
4848 of 4 there is room for a line number up to 999. When the buffer has
4849 1000 lines five columns will be used.
4850 The minimum value is 1, the maximum value is 10.
4851 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4852
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004853 *'omnifunc'* *'ofu'*
4854'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00004855 local to buffer
4856 {not in Vi}
4857 {not available when compiled without the +eval
4858 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00004859 This option specifies a function to be used for Insert mode omni
4860 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00004861 See |complete-functions| for an explanation of how the function is
4862 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00004863 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00004864 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00004865
4866
Bram Moolenaar02467872007-05-06 13:22:01 +00004867 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00004868'opendevice' 'odev' boolean (default off)
4869 global
4870 {not in Vi}
4871 {only for MS-DOS, MS-Windows and OS/2}
4872 Enable reading and writing from devices. This may get Vim stuck on a
4873 device that can be opened but doesn't actually do the I/O. Therefore
4874 it is off by default.
4875 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
4876 result in editing a device.
4877
4878
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00004879 *'operatorfunc'* *'opfunc'*
4880'operatorfunc' 'opfunc' string (default: empty)
4881 global
4882 {not in Vi}
4883 This option specifies a function to be called by the |g@| operator.
4884 See |:map-operator| for more info and an example.
4885
4886 This option cannot be set from a |modeline| or in the |sandbox|, for
4887 security reasons.
4888
4889
Bram Moolenaar071d4272004-06-13 20:20:40 +00004890 *'osfiletype'* *'oft'* *E366*
4891'osfiletype' 'oft' string (RISC-OS default: "Text",
4892 others default: "")
4893 local to buffer
4894 {not in Vi}
4895 {only available when compiled with the |+osfiletype|
4896 feature}
4897 Some operating systems store extra information about files besides
4898 name, datestamp and permissions. This option contains the extra
4899 information, the nature of which will vary between systems.
4900 The value of this option is usually set when the file is loaded, and
4901 use to set the file type when file is written.
4902 It can affect the pattern matching of the automatic commands.
4903 |autocmd-osfiletypes|
4904
4905 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00004906'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004907 global
4908 Specifies the nroff macros that separate paragraphs. These are pairs
4909 of two letters (see |object-motions|).
4910
4911 *'paste'* *'nopaste'*
4912'paste' boolean (default off)
4913 global
4914 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004915 Put Vim in Paste mode. This is useful if you want to cut or copy
4916 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004917 unexpected effects.
4918 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004919 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004920 knows about pasting and will mostly do the right thing without 'paste'
4921 being set. The same is true for a terminal where Vim handles the
4922 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004923 This option is reset when starting the GUI. Thus if you set it in
4924 your .vimrc it will work in a terminal, but not in the GUI. Setting
4925 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4926 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004927 When the 'paste' option is switched on (also when it was already on):
4928 - mapping in Insert mode and Command-line mode is disabled
4929 - abbreviations are disabled
4930 - 'textwidth' is set to 0
4931 - 'wrapmargin' is set to 0
4932 - 'autoindent' is reset
4933 - 'smartindent' is reset
4934 - 'softtabstop' is set to 0
4935 - 'revins' is reset
4936 - 'ruler' is reset
4937 - 'showmatch' is reset
4938 - 'formatoptions' is used like it is empty
4939 These options keep their value, but their effect is disabled:
4940 - 'lisp'
4941 - 'indentexpr'
4942 - 'cindent'
4943 NOTE: When you start editing another file while the 'paste' option is
4944 on, settings from the modelines or autocommands may change the
4945 settings again, causing trouble when pasting text. You might want to
4946 set the 'paste' option again.
4947 When the 'paste' option is reset the mentioned options are restored to
4948 the value before the moment 'paste' was switched from off to on.
4949 Resetting 'paste' before ever setting it does not have any effect.
4950 Since mapping doesn't work while 'paste' is active, you need to use
4951 the 'pastetoggle' option to toggle the 'paste' option with some key.
4952
4953 *'pastetoggle'* *'pt'*
4954'pastetoggle' 'pt' string (default "")
4955 global
4956 {not in Vi}
4957 When non-empty, specifies the key sequence that toggles the 'paste'
4958 option. This is like specifying a mapping: >
4959 :map {keys} :set invpaste<CR>
4960< Where {keys} is the value of 'pastetoggle'.
4961 The difference is that it will work even when 'paste' is set.
4962 'pastetoggle' works in Insert mode and Normal mode, but not in
4963 Command-line mode.
4964 Mappings are checked first, thus overrule 'pastetoggle'. However,
4965 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4966 this: >
4967 :map <F10> :set paste<CR>
4968 :map <F11> :set nopaste<CR>
4969 :imap <F10> <C-O>:set paste<CR>
4970 :imap <F11> <nop>
4971 :set pastetoggle=<F11>
4972< This will make <F10> start paste mode and <F11> stop paste mode.
4973 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4974 mode everything is inserted literally, except the 'pastetoggle' key
4975 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004976 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004977
4978 *'pex'* *'patchexpr'*
4979'patchexpr' 'pex' string (default "")
4980 global
4981 {not in Vi}
4982 {not available when compiled without the |+diff|
4983 feature}
4984 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004985 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004986
4987 *'patchmode'* *'pm'* *E206*
4988'patchmode' 'pm' string (default "")
4989 global
4990 {not in Vi}
4991 When non-empty the oldest version of a file is kept. This can be used
4992 to keep the original version of a file if you are changing files in a
4993 source distribution. Only the first time that a file is written a
4994 copy of the original file will be kept. The name of the copy is the
4995 name of the original file with the string in the 'patchmode' option
4996 appended. This option should start with a dot. Use a string like
4997 ".org". 'backupdir' must not be empty for this to work (Detail: The
4998 backup file is renamed to the patchmode file after the new file has
4999 been successfully written, that's why it must be possible to write a
5000 backup file). If there was no file to be backed up, an empty file is
5001 created.
5002 When the 'backupskip' pattern matches, a patchmode file is not made.
5003 Using 'patchmode' for compressed files appends the extension at the
5004 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5005 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005006 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005007
5008 *'path'* *'pa'* *E343* *E345* *E347*
5009'path' 'pa' string (default on Unix: ".,/usr/include,,"
5010 on OS/2: ".,/emx/include,,"
5011 other systems: ".,,")
5012 global or local to buffer |global-local|
5013 {not in Vi}
5014 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005015 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5016 provided that the file being searched for has a relative path (not
5017 starting with "/", "./" or "../"). The directories in the 'path'
5018 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005019 - Use commas to separate directory names: >
5020 :set path=.,/usr/local/include,/usr/include
5021< - Spaces can also be used to separate directory names (for backwards
5022 compatibility with version 3.0). To have a space in a directory
5023 name, precede it with an extra backslash, and escape the space: >
5024 :set path=.,/dir/with\\\ space
5025< - To include a comma in a directory name precede it with an extra
5026 backslash: >
5027 :set path=.,/dir/with\\,comma
5028< - To search relative to the directory of the current file, use: >
5029 :set path=.
5030< - To search in the current directory use an empty string between two
5031 commas: >
5032 :set path=,,
5033< - A directory name may end in a ':' or '/'.
5034 - Environment variables are expanded |:set_env|.
5035 - When using |netrw.vim| URLs can be used. For example, adding
5036 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005037 - Search upwards and downwards in a directory tree using "*", "**" and
5038 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005039 {not available when compiled without the |+path_extra| feature}
5040 - Careful with '\' characters, type two to get one in the option: >
5041 :set path=.,c:\\include
5042< Or just use '/' instead: >
5043 :set path=.,c:/include
5044< Don't forget "." or files won't even be found in the same directory as
5045 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005046 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005047 it is something like 256 or 1024 characters.
5048 You can check if all the include files are found, using the value of
5049 'path', see |:checkpath|.
5050 The use of |:set+=| and |:set-=| is preferred when adding or removing
5051 directories from the list. This avoids problems when a future version
5052 uses another default. To remove the current directory use: >
5053 :set path-=
5054< To add the current directory use: >
5055 :set path+=
5056< To use an environment variable, you probably need to replace the
5057 separator. Here is an example to append $INCL, in which directory
5058 names are separated with a semi-colon: >
5059 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5060< Replace the ';' with a ':' or whatever separator is used. Note that
5061 this doesn't work when $INCL contains a comma or white space.
5062
5063 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5064'preserveindent' 'pi' boolean (default off)
5065 local to buffer
5066 {not in Vi}
5067 When changing the indent of the current line, preserve as much of the
5068 indent structure as possible. Normally the indent is replaced by a
5069 series of tabs followed by spaces as required (unless |'expandtab'| is
5070 enabled, in which case only spaces are used). Enabling this option
5071 means the indent will preserve as many existing characters as possible
5072 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005073 'expandtab' does not apply to the preserved white space, a Tab remains
5074 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005075 NOTE: When using ">>" multiple times the resulting indent is a mix of
5076 tabs and spaces. You might not like this.
5077 NOTE: 'preserveindent' is reset when 'compatible' is set.
5078 Also see 'copyindent'.
5079 Use |:retab| to clean up white space.
5080
5081 *'previewheight'* *'pvh'*
5082'previewheight' 'pvh' number (default 12)
5083 global
5084 {not in Vi}
5085 {not available when compiled without the |+windows| or
5086 |+quickfix| feature}
5087 Default height for a preview window. Used for |:ptag| and associated
5088 commands. Used for |CTRL-W_}| when no count is given.
5089
5090 *'previewwindow'* *'nopreviewwindow'*
5091 *'pvw'* *'nopvw'* *E590*
5092'previewwindow' 'pvw' boolean (default off)
5093 local to window
5094 {not in Vi}
5095 {not available when compiled without the |+windows| or
5096 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005097 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005098 set. It's normally not set directly, but by using one of the commands
5099 |:ptag|, |:pedit|, etc.
5100
5101 *'printdevice'* *'pdev'*
5102'printdevice' 'pdev' string (default empty)
5103 global
5104 {not in Vi}
5105 {only available when compiled with the |+printer|
5106 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005107 The name of the printer to be used for |:hardcopy|.
5108 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005109 This option cannot be set from a |modeline| or in the |sandbox|, for
5110 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005111
Bram Moolenaar8299df92004-07-10 09:47:34 +00005112 *'printencoding'* *'penc'*
5113'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005114 global
5115 {not in Vi}
5116 {only available when compiled with the |+printer|
5117 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005118 Sets the character encoding used when printing.
5119 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005120
5121 *'printexpr'* *'pexpr'*
5122'printexpr' 'pexpr' String (default: see below)
5123 global
5124 {not in Vi}
5125 {only available when compiled with the |+printer|
5126 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005127 Expression used to print the PostScript produced with |:hardcopy|.
5128 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005129
Bram Moolenaar8299df92004-07-10 09:47:34 +00005130 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005131'printfont' 'pfn' string (default "courier")
5132 global
5133 {not in Vi}
5134 {only available when compiled with the |+printer|
5135 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005136 The name of the font that will be used for |:hardcopy|.
5137 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005138
5139 *'printheader'* *'pheader'*
5140'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5141 global
5142 {not in Vi}
5143 {only available when compiled with the |+printer|
5144 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005145 The format of the header produced in |:hardcopy| output.
5146 See |pheader-option|.
5147
5148 *'printmbcharset'* *'pmbcs'*
5149'printmbcharset' 'pmbcs' string (default "")
5150 global
5151 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005152 {only available when compiled with the |+printer|,
5153 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005154 The CJK character set to be used for CJK output from |:hardcopy|.
5155 See |pmbcs-option|.
5156
5157 *'printmbfont'* *'pmbfn'*
5158'printmbfont' 'pmbfn' string (default "")
5159 global
5160 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005161 {only available when compiled with the |+printer|,
5162 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005163 List of font names to be used for CJK output from |:hardcopy|.
5164 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005165
5166 *'printoptions'* *'popt'*
5167'printoptions' 'popt' string (default "")
5168 global
5169 {not in Vi}
5170 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005171 List of items that control the format of the output of |:hardcopy|.
5172 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005173
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005174 *'prompt'* *'noprompt'*
5175'prompt' boolean (default on)
5176 global
5177 When on a ":" prompt is used in Ex mode.
5178
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005179 *'pumheight'* *'ph'*
5180'pumheight' 'ph' number (default 0)
5181 global
5182 {not available when compiled without the
5183 |+insert_expand| feature}
5184 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005185 Determines the maximum number of items to show in the popup menu for
5186 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005187 |ins-completion-menu|.
5188
5189
Bram Moolenaar677ee682005-01-27 14:41:15 +00005190 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005191'quoteescape' 'qe' string (default "\")
5192 local to buffer
5193 {not in Vi}
5194 The characters that are used to escape quotes in a string. Used for
5195 objects like a', a" and a` |a'|.
5196 When one of the characters in this option is found inside a string,
5197 the following character will be skipped. The default value makes the
5198 text "foo\"bar\\" considered to be one string.
5199
Bram Moolenaar071d4272004-06-13 20:20:40 +00005200 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5201'readonly' 'ro' boolean (default off)
5202 local to buffer
5203 If on, writes fail unless you use a '!'. Protects you from
5204 accidentally overwriting a file. Default on when Vim is started
5205 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005206 When using ":w!" the 'readonly' option is reset for the current
5207 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005208 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005209 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005210
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005211 *'redrawtime'* *'rdt'*
5212'redrawtime' 'rdt' number (default 2000)
5213 global
5214 {not in Vi}
5215 {only available when compiled with the |+reltime|
5216 feature}
5217 The time in milliseconds for redrawing the display. This applies to
5218 searching for patterns for 'hlsearch' and |:match| highlighting.
5219 When redrawing takes more than this many milliseconds no further
5220 matches will be highlighted. This is used to avoid that Vim hangs
5221 when using a very complicated pattern.
5222
Bram Moolenaar071d4272004-06-13 20:20:40 +00005223 *'remap'* *'noremap'*
5224'remap' boolean (default on)
5225 global
5226 Allows for mappings to work recursively. If you do not want this for
5227 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005228 NOTE: To avoid portability problems with Vim scripts, always keep
5229 this option at the default "on". Only switch it off when working with
5230 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005231
5232 *'report'*
5233'report' number (default 2)
5234 global
5235 Threshold for reporting number of lines changed. When the number of
5236 changed lines is more than 'report' a message will be given for most
5237 ":" commands. If you want it always, set 'report' to 0.
5238 For the ":substitute" command the number of substitutions is used
5239 instead of the number of lines.
5240
5241 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5242'restorescreen' 'rs' boolean (default on)
5243 global
5244 {not in Vi} {only in Windows 95/NT console version}
5245 When set, the screen contents is restored when exiting Vim. This also
5246 happens when executing external commands.
5247
5248 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5249 options in your .vimrc. To disable restoring:
5250 set t_ti= t_te=
5251 To enable restoring (for an xterm):
5252 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5253 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5254
5255 *'revins'* *'ri'* *'norevins'* *'nori'*
5256'revins' 'ri' boolean (default off)
5257 global
5258 {not in Vi}
5259 {only available when compiled with the |+rightleft|
5260 feature}
5261 Inserting characters in Insert mode will work backwards. See "typing
5262 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5263 command in Insert mode, when 'allowrevins' is set.
5264 NOTE: This option is reset when 'compatible' or 'paste' is set.
5265
5266 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5267'rightleft' 'rl' boolean (default off)
5268 local to window
5269 {not in Vi}
5270 {only available when compiled with the |+rightleft|
5271 feature}
5272 When on, display orientation becomes right-to-left, i.e., characters
5273 that are stored in the file appear from the right to the left.
5274 Using this option, it is possible to edit files for languages that
5275 are written from the right to the left such as Hebrew and Arabic.
5276 This option is per window, so it is possible to edit mixed files
5277 simultaneously, or to view the same file in both ways (this is
5278 useful whenever you have a mixed text file with both right-to-left
5279 and left-to-right strings so that both sets are displayed properly
5280 in different windows). Also see |rileft.txt|.
5281
5282 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
5283'rightleftcmd' 'rlc' string (default "search")
5284 local to window
5285 {not in Vi}
5286 {only available when compiled with the |+rightleft|
5287 feature}
5288 Each word in this option enables the command line editing to work in
5289 right-to-left mode for a group of commands:
5290
5291 search "/" and "?" commands
5292
5293 This is useful for languages such as Hebrew, Arabic and Farsi.
5294 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5295
5296 *'ruler'* *'ru'* *'noruler'* *'noru'*
5297'ruler' 'ru' boolean (default off)
5298 global
5299 {not in Vi}
5300 {not available when compiled without the
5301 |+cmdline_info| feature}
5302 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005303 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005304 text in the file is shown on the far right:
5305 Top first line is visible
5306 Bot last line is visible
5307 All first and last line are visible
5308 45% relative position in the file
5309 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005310 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005311 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005312 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005313 this option takes precedence over 'ruler' and 'rulerformat'
5314 If the number of characters displayed is different from the number of
5315 bytes in the text (e.g., for a TAB or a multi-byte character), both
5316 the text column (byte number) and the screen column are shown,
5317 separated with a dash.
5318 For an empty line "0-1" is shown.
5319 For an empty buffer the line number will also be zero: "0,0-1".
5320 This option is reset when the 'paste' option is set.
5321 If you don't want to see the ruler all the time but want to know where
5322 you are, use "g CTRL-G" |g_CTRL-G|.
5323 NOTE: This option is reset when 'compatible' is set.
5324
5325 *'rulerformat'* *'ruf'*
5326'rulerformat' 'ruf' string (default empty)
5327 global
5328 {not in Vi}
5329 {not available when compiled without the |+statusline|
5330 feature}
5331 When this option is not empty, it determines the content of the ruler
5332 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005333 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005334 The default ruler width is 17 characters. To make the ruler 15
5335 characters wide, put "%15(" at the start and "%)" at the end.
5336 Example: >
5337 :set rulerformat=%15(%c%V\ %p%%%)
5338<
5339 *'runtimepath'* *'rtp'* *vimfiles*
5340'runtimepath' 'rtp' string (default:
5341 Unix: "$HOME/.vim,
5342 $VIM/vimfiles,
5343 $VIMRUNTIME,
5344 $VIM/vimfiles/after,
5345 $HOME/.vim/after"
5346 Amiga: "home:vimfiles,
5347 $VIM/vimfiles,
5348 $VIMRUNTIME,
5349 $VIM/vimfiles/after,
5350 home:vimfiles/after"
5351 PC, OS/2: "$HOME/vimfiles,
5352 $VIM/vimfiles,
5353 $VIMRUNTIME,
5354 $VIM/vimfiles/after,
5355 $HOME/vimfiles/after"
5356 Macintosh: "$VIM:vimfiles,
5357 $VIMRUNTIME,
5358 $VIM:vimfiles:after"
5359 RISC-OS: "Choices:vimfiles,
5360 $VIMRUNTIME,
5361 Choices:vimfiles/after"
5362 VMS: "sys$login:vimfiles,
5363 $VIM/vimfiles,
5364 $VIMRUNTIME,
5365 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005366 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005367 global
5368 {not in Vi}
5369 This is a list of directories which will be searched for runtime
5370 files:
5371 filetype.vim filetypes by file name |new-filetype|
5372 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005373 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005374 colors/ color scheme files |:colorscheme|
5375 compiler/ compiler files |:compiler|
5376 doc/ documentation |write-local-help|
5377 ftplugin/ filetype plugins |write-filetype-plugin|
5378 indent/ indent scripts |indent-expression|
5379 keymap/ key mapping files |mbyte-keymap|
5380 lang/ menu translations |:menutrans|
5381 menu.vim GUI menus |menu.vim|
5382 plugin/ plugin scripts |write-plugin|
5383 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005384 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005385 syntax/ syntax files |mysyntaxfile|
5386 tutor/ files for vimtutor |tutor|
5387
5388 And any other file searched for with the |:runtime| command.
5389
5390 The defaults for most systems are setup to search five locations:
5391 1. In your home directory, for your personal preferences.
5392 2. In a system-wide Vim directory, for preferences from the system
5393 administrator.
5394 3. In $VIMRUNTIME, for files distributed with Vim.
5395 *after-directory*
5396 4. In the "after" directory in the system-wide Vim directory. This is
5397 for the system administrator to overrule or add to the distributed
5398 defaults (rarely needed)
5399 5. In the "after" directory in your home directory. This is for
5400 personal preferences to overrule or add to the distributed defaults
5401 or system-wide settings (rarely needed).
5402
5403 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5404 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005405 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005406 wildcards.
5407 See |:runtime|.
5408 Example: >
5409 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5410< This will use the directory "~/vimruntime" first (containing your
5411 personal Vim runtime files), then "/mygroup/vim" (shared between a
5412 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5413 files).
5414 You probably should always include $VIMRUNTIME somewhere, to use the
5415 distributed runtime files. You can put a directory before $VIMRUNTIME
5416 to find files which replace a distributed runtime files. You can put
5417 a directory after $VIMRUNTIME to find files which add to distributed
5418 runtime files.
5419 This option cannot be set from a |modeline| or in the |sandbox|, for
5420 security reasons.
5421
5422 *'scroll'* *'scr'*
5423'scroll' 'scr' number (default: half the window height)
5424 local to window
5425 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5426 set to half the number of lines in the window when the window size
5427 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005428 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005429 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5430 the number of screen lines instead of file lines, makes a difference
5431 when lines wrap}
5432
5433 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5434'scrollbind' 'scb' boolean (default off)
5435 local to window
5436 {not in Vi}
5437 {not available when compiled without the |+scrollbind|
5438 feature}
5439 See also |scroll-binding|. When this option is set, the current
5440 window scrolls as other scrollbind windows (windows that also have
5441 this option set) scroll. This option is useful for viewing the
5442 differences between two versions of a file, see 'diff'.
5443 See |'scrollopt'| for options that determine how this option should be
5444 interpreted.
5445 This option is mostly reset when splitting a window to edit another
5446 file. This means that ":split | edit file" results in two windows
5447 with scroll-binding, but ":split file" does not.
5448
5449 *'scrolljump'* *'sj'*
5450'scrolljump' 'sj' number (default 1)
5451 global
5452 {not in Vi}
5453 Minimal number of lines to scroll when the cursor gets off the
5454 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5455 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005456 When set to a negative number from -1 to -100 this is used as the
5457 percentage of the window height. Thus -50 scrolls half the window
5458 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005459 NOTE: This option is set to 1 when 'compatible' is set.
5460
5461 *'scrolloff'* *'so'*
5462'scrolloff' 'so' number (default 0)
5463 global
5464 {not in Vi}
5465 Minimal number of screen lines to keep above and below the cursor.
5466 This will make some context visible around where you are working. If
5467 you set it to a very large value (999) the cursor line will always be
5468 in the middle of the window (except at the start or end of the file or
5469 when long lines wrap).
5470 For scrolling horizontally see 'sidescrolloff'.
5471 NOTE: This option is set to 0 when 'compatible' is set.
5472
5473 *'scrollopt'* *'sbo'*
5474'scrollopt' 'sbo' string (default "ver,jump")
5475 global
5476 {not available when compiled without the |+scrollbind|
5477 feature}
5478 {not in Vi}
5479 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005480 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5481 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005482 The following words are available:
5483 ver Bind vertical scrolling for 'scrollbind' windows
5484 hor Bind horizontal scrolling for 'scrollbind' windows
5485 jump Applies to the offset between two windows for vertical
5486 scrolling. This offset is the difference in the first
5487 displayed line of the bound windows. When moving
5488 around in a window, another 'scrollbind' window may
5489 reach a position before the start or after the end of
5490 the buffer. The offset is not changed though, when
5491 moving back the 'scrollbind' window will try to scroll
5492 to the desired position when possible.
5493 When now making that window the current one, two
5494 things can be done with the relative offset:
5495 1. When "jump" is not included, the relative offset is
5496 adjusted for the scroll position in the new current
5497 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005498 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005499 2. When "jump" is included, the other windows are
5500 scrolled to keep the same relative offset. When
5501 going back to the other window, it still uses the
5502 same relative offset.
5503 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005504 When 'diff' mode is active there always is vertical scroll binding,
5505 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005506
5507 *'sections'* *'sect'*
5508'sections' 'sect' string (default "SHNHH HUnhsh")
5509 global
5510 Specifies the nroff macros that separate sections. These are pairs of
5511 two letters (See |object-motions|). The default makes a section start
5512 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5513
5514 *'secure'* *'nosecure'* *E523*
5515'secure' boolean (default off)
5516 global
5517 {not in Vi}
5518 When on, ":autocmd", shell and write commands are not allowed in
5519 ".vimrc" and ".exrc" in the current directory and map commands are
5520 displayed. Switch it off only if you know that you will not run into
5521 problems, or when the 'exrc' option is off. On Unix this option is
5522 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005523 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005524 'secure' at the end of your ~/.vimrc then.
5525 This option cannot be set from a |modeline| or in the |sandbox|, for
5526 security reasons.
5527
5528 *'selection'* *'sel'*
5529'selection' 'sel' string (default "inclusive")
5530 global
5531 {not in Vi}
5532 This option defines the behavior of the selection. It is only used
5533 in Visual and Select mode.
5534 Possible values:
5535 value past line inclusive ~
5536 old no yes
5537 inclusive yes yes
5538 exclusive yes no
5539 "past line" means that the cursor is allowed to be positioned one
5540 character past the line.
5541 "inclusive" means that the last character of the selection is included
5542 in an operation. For example, when "x" is used to delete the
5543 selection.
5544 Note that when "exclusive" is used and selecting from the end
5545 backwards, you cannot include the last character of a line, when
5546 starting in Normal mode and 'virtualedit' empty.
5547
5548 The 'selection' option is set by the |:behave| command.
5549
5550 *'selectmode'* *'slm'*
5551'selectmode' 'slm' string (default "")
5552 global
5553 {not in Vi}
5554 This is a comma separated list of words, which specifies when to start
5555 Select mode instead of Visual mode, when a selection is started.
5556 Possible values:
5557 mouse when using the mouse
5558 key when using shifted special keys
5559 cmd when using "v", "V" or CTRL-V
5560 See |Select-mode|.
5561 The 'selectmode' option is set by the |:behave| command.
5562
5563 *'sessionoptions'* *'ssop'*
5564'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005565 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005566 global
5567 {not in Vi}
5568 {not available when compiled without the +mksession
5569 feature}
5570 Changes the effect of the |:mksession| command. It is a comma
5571 separated list of words. Each word enables saving and restoring
5572 something:
5573 word save and restore ~
5574 blank empty windows
5575 buffers hidden and unloaded buffers, not just those in windows
5576 curdir the current directory
5577 folds manually created folds, opened/closed folds and local
5578 fold options
5579 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005580 and contain at least one lowercase letter. Only
5581 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005582 help the help window
5583 localoptions options and mappings local to a window or buffer (not
5584 global values for local options)
5585 options all options and mappings (also global values for local
5586 options)
5587 resize size of the Vim window: 'lines' and 'columns'
5588 sesdir the directory in which the session file is located
5589 will become the current directory (useful with
5590 projects accessed over a network from different
5591 systems)
5592 slash backslashes in file names replaced with forward
5593 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005594 tabpages all tab pages; without this only the current tab page
5595 is restored, so that you can make a session for each
5596 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005597 unix with Unix end-of-line format (single <NL>), even when
5598 on Windows or DOS
5599 winpos position of the whole Vim window
5600 winsize window sizes
5601
5602 Don't include both "curdir" and "sesdir".
5603 When "curdir" nor "sesdir" is included, file names are stored with
5604 absolute paths.
5605 "slash" and "unix" are useful on Windows when sharing session files
5606 with Unix. The Unix version of Vim cannot source dos format scripts,
5607 but the Windows version of Vim can source unix format scripts.
5608
5609 *'shell'* *'sh'* *E91*
5610'shell' 'sh' string (default $SHELL or "sh",
5611 MS-DOS and Win32: "command.com" or
5612 "cmd.exe", OS/2: "cmd")
5613 global
5614 Name of the shell to use for ! and :! commands. When changing the
5615 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5616 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005617 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005618 See |option-backslash| about including spaces and backslashes.
5619 Environment variables are expanded |:set_env|.
5620 If the name of the shell contains a space, you might need to enclose
5621 it in quotes. Example: >
5622 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5623< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005624 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005625 "-f" is not inside the quotes, because it is not part of the command
5626 name. And Vim automagically recognizes the backslashes that are path
5627 separators.
5628 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5629 variable to change the way external commands are executed. See the
5630 libc.inf file of DJGPP.
5631 Under MS-Windows, when the executable ends in ".com" it must be
5632 included. Thus setting the shell to "command.com" or "4dos.com"
5633 works, but "command" and "4dos" do not work for all commands (e.g.,
5634 filtering).
5635 For unknown reasons, when using "4dos.com" the current directory is
5636 changed to "C:\". To avoid this set 'shell' like this: >
5637 :set shell=command.com\ /c\ 4dos
5638< This option cannot be set from a |modeline| or in the |sandbox|, for
5639 security reasons.
5640
5641 *'shellcmdflag'* *'shcf'*
5642'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5643 does not contain "sh" somewhere: "/c")
5644 global
5645 {not in Vi}
5646 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5647 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5648 systems, the default is set according to the value of 'shell', to
5649 reduce the need to set this option by the user. It's not used for
5650 OS/2 (EMX figures this out itself). See |option-backslash| about
5651 including spaces and backslashes. See |dos-shell|.
5652 This option cannot be set from a |modeline| or in the |sandbox|, for
5653 security reasons.
5654
5655 *'shellpipe'* *'sp'*
5656'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5657 global
5658 {not in Vi}
5659 {not available when compiled without the |+quickfix|
5660 feature}
5661 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005662 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005663 including spaces and backslashes.
5664 The name of the temporary file can be represented by "%s" if necessary
5665 (the file name is appended automatically if no %s appears in the value
5666 of this option).
5667 For the Amiga and MS-DOS the default is ">". The output is directly
5668 saved in a file and not echoed to the screen.
5669 For Unix the default it "| tee". The stdout of the compiler is saved
5670 in a file and echoed to the screen. If the 'shell' option is "csh" or
5671 "tcsh" after initializations, the default becomes "|& tee". If the
5672 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5673 "2>&1| tee". This means that stderr is also included.
5674 The initialization of this option is done after reading the ".vimrc"
5675 and the other initializations, so that when the 'shell' option is set
5676 there, the 'shellpipe' option changes automatically, unless it was
5677 explicitly set before.
5678 When 'shellpipe' is set to an empty string, no redirection of the
5679 ":make" output will be done. This is useful if you use a 'makeprg'
5680 that writes to 'makeef' by itself. If you want no piping, but do
5681 want to include the 'makeef', set 'shellpipe' to a single space.
5682 Don't forget to precede the space with a backslash: ":set sp=\ ".
5683 In the future pipes may be used for filtering and this option will
5684 become obsolete (at least for Unix).
5685 This option cannot be set from a |modeline| or in the |sandbox|, for
5686 security reasons.
5687
5688 *'shellquote'* *'shq'*
5689'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5690 contains "sh" somewhere: "\"")
5691 global
5692 {not in Vi}
5693 Quoting character(s), put around the command passed to the shell, for
5694 the "!" and ":!" commands. The redirection is kept outside of the
5695 quoting. See 'shellxquote' to include the redirection. It's
5696 probably not useful to set both options.
5697 This is an empty string by default. Only known to be useful for
5698 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5699 or bash, where it should be "\"". The default is adjusted according
5700 the value of 'shell', to reduce the need to set this option by the
5701 user. See |dos-shell|.
5702 This option cannot be set from a |modeline| or in the |sandbox|, for
5703 security reasons.
5704
5705 *'shellredir'* *'srr'*
5706'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5707 global
5708 {not in Vi}
5709 String to be used to put the output of a filter command in a temporary
5710 file. See also |:!|. See |option-backslash| about including spaces
5711 and backslashes.
5712 The name of the temporary file can be represented by "%s" if necessary
5713 (the file name is appended automatically if no %s appears in the value
5714 of this option).
5715 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5716 or "zsh" during initializations, the default becomes ">&". If the
5717 'shell' option is "sh", "ksh" or "bash" the default becomes
5718 ">%s 2>&1". This means that stderr is also included.
5719 For Win32, the Unix checks are done and additionally "cmd" is checked
5720 for, which makes the default ">%s 2>&1". Also, the same names with
5721 ".exe" appended are checked for.
5722 The initialization of this option is done after reading the ".vimrc"
5723 and the other initializations, so that when the 'shell' option is set
5724 there, the 'shellredir' option changes automatically unless it was
5725 explicitly set before.
5726 In the future pipes may be used for filtering and this option will
5727 become obsolete (at least for Unix).
5728 This option cannot be set from a |modeline| or in the |sandbox|, for
5729 security reasons.
5730
5731 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5732'shellslash' 'ssl' boolean (default off)
5733 global
5734 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5735 When set, a forward slash is used when expanding file names. This is
5736 useful when a Unix-like shell is used instead of command.com or
5737 cmd.exe. Backward slashes can still be typed, but they are changed to
5738 forward slashes by Vim.
5739 Note that setting or resetting this option has no effect for some
5740 existing file names, thus this option needs to be set before opening
5741 any file for best results. This might change in the future.
5742 'shellslash' only works when a backslash can be used as a path
5743 separator. To test if this is so use: >
5744 if exists('+shellslash')
5745<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005746 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5747'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5748 global
5749 {not in Vi}
5750 When on, use temp files for shell commands. When off use a pipe.
5751 When using a pipe is not possible temp files are used anyway.
5752 Currently a pipe is only supported on Unix. You can check it with: >
5753 :if has("filterpipe")
5754< The advantage of using a pipe is that nobody can read the temp file
5755 and the 'shell' command does not need to support redirection.
5756 The advantage of using a temp file is that the file type and encoding
5757 can be detected.
5758 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5759 |FilterWritePost| autocommands event are not triggered when
5760 'shelltemp' is off.
5761
Bram Moolenaar071d4272004-06-13 20:20:40 +00005762 *'shelltype'* *'st'*
5763'shelltype' 'st' number (default 0)
5764 global
5765 {not in Vi} {only for the Amiga}
5766 On the Amiga this option influences the way how the commands work
5767 which use a shell.
5768 0 and 1: always use the shell
5769 2 and 3: use the shell only to filter lines
5770 4 and 5: use shell only for ':sh' command
5771 When not using the shell, the command is executed directly.
5772
5773 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5774 1 and 3: use "shell cmd" to start external commands
5775
5776 *'shellxquote'* *'sxq'*
5777'shellxquote' 'sxq' string (default: "";
5778 for Win32, when 'shell' contains "sh"
5779 somewhere: "\""
5780 for Unix, when using system(): "\"")
5781 global
5782 {not in Vi}
5783 Quoting character(s), put around the command passed to the shell, for
5784 the "!" and ":!" commands. Includes the redirection. See
5785 'shellquote' to exclude the redirection. It's probably not useful
5786 to set both options.
5787 This is an empty string by default. Known to be useful for
5788 third-party shells when using the Win32 version, such as the MKS Korn
5789 Shell or bash, where it should be "\"". The default is adjusted
5790 according the value of 'shell', to reduce the need to set this option
5791 by the user. See |dos-shell|.
5792 This option cannot be set from a |modeline| or in the |sandbox|, for
5793 security reasons.
5794
5795 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5796'shiftround' 'sr' boolean (default off)
5797 global
5798 {not in Vi}
5799 Round indent to multiple of 'shiftwidth'. Applies to > and <
5800 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5801 a multiple of 'shiftwidth' (this is Vi compatible).
5802 NOTE: This option is reset when 'compatible' is set.
5803
5804 *'shiftwidth'* *'sw'*
5805'shiftwidth' 'sw' number (default 8)
5806 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005807 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005808 |'cindent'|, |>>|, |<<|, etc.
5809
5810 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005811'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5812 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005813 global
5814 {not in Vi}
5815 This option helps to avoid all the |hit-enter| prompts caused by file
5816 messages, for example with CTRL-G, and to avoid some other messages.
5817 It is a list of flags:
5818 flag meaning when present ~
5819 f use "(3 of 5)" instead of "(file 3 of 5)"
5820 i use "[noeol]" instead of "[Incomplete last line]"
5821 l use "999L, 888C" instead of "999 lines, 888 characters"
5822 m use "[+]" instead of "[Modified]"
5823 n use "[New]" instead of "[New File]"
5824 r use "[RO]" instead of "[readonly]"
5825 w use "[w]" instead of "written" for file write message
5826 and "[a]" instead of "appended" for ':w >> file' command
5827 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5828 "[unix format]" and "[mac]" instead of "[mac format]".
5829 a all of the above abbreviations
5830
5831 o overwrite message for writing a file with subsequent message
5832 for reading a file (useful for ":wn" or when 'autowrite' on)
5833 O message for reading a file overwrites any previous message.
5834 Also for quickfix message (e.g., ":cn").
5835 s don't give "search hit BOTTOM, continuing at TOP" or "search
5836 hit TOP, continuing at BOTTOM" messages
5837 t truncate file message at the start if it is too long to fit
5838 on the command-line, "<" will appear in the left most column.
5839 Ignored in Ex mode.
5840 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005841 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005842 Ignored in Ex mode.
5843 W don't give "written" or "[w]" when writing a file
5844 A don't give the "ATTENTION" message when an existing swap file
5845 is found.
5846 I don't give the intro message when starting Vim |:intro|.
5847
5848 This gives you the opportunity to avoid that a change between buffers
5849 requires you to hit <Enter>, but still gives as useful a message as
5850 possible for the space available. To get the whole message that you
5851 would have got with 'shm' empty, use ":file!"
5852 Useful values:
5853 shm= No abbreviation of message.
5854 shm=a Abbreviation, but no loss of information.
5855 shm=at Abbreviation, and truncate message when necessary.
5856
5857 NOTE: This option is set to the Vi default value when 'compatible' is
5858 set and to the Vim default value when 'compatible' is reset.
5859
5860 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5861'shortname' 'sn' boolean (default off)
5862 local to buffer
5863 {not in Vi, not in MS-DOS versions}
5864 Filenames are assumed to be 8 characters plus one extension of 3
5865 characters. Multiple dots in file names are not allowed. When this
5866 option is on, dots in file names are replaced with underscores when
5867 adding an extension (".~" or ".swp"). This option is not available
5868 for MS-DOS, because then it would always be on. This option is useful
5869 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5870 or crossdos. When running the Win32 GUI version under Win32s, this
5871 option is always on by default.
5872
5873 *'showbreak'* *'sbr'* *E595*
5874'showbreak' 'sbr' string (default "")
5875 global
5876 {not in Vi}
5877 {not available when compiled without the |+linebreak|
5878 feature}
5879 String to put at the start of lines that have been wrapped. Useful
5880 values are "> " or "+++ ".
5881 Only printable single-cell characters are allowed, excluding <Tab> and
5882 comma (in a future version the comma might be used to separate the
5883 part that is shown at the end and at the start of a line).
5884 The characters are highlighted according to the '@' flag in
5885 'highlight'.
5886 Note that tabs after the showbreak will be displayed differently.
5887 If you want the 'showbreak' to appear in between line numbers, add the
5888 "n" flag to 'cpoptions'.
5889
5890 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5891'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5892 off)
5893 global
5894 {not in Vi}
5895 {not available when compiled without the
5896 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00005897 Show (partial) command in the last line of the screen. Set this
5898 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005899 In Visual mode the size of the selected area is shown:
5900 - When selecting characters within a line, the number of characters.
5901 - When selecting more than one line, the number of lines.
5902 - When selecting a block, the size in screen characters: linesxcolumns.
5903 NOTE: This option is set to the Vi default value when 'compatible' is
5904 set and to the Vim default value when 'compatible' is reset.
5905
5906 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5907'showfulltag' 'sft' boolean (default off)
5908 global
5909 {not in Vi}
5910 When completing a word in insert mode (see |ins-completion|) from the
5911 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005912 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005913 matched a C function, you can see a template for what arguments are
5914 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00005915 Note that this doesn't work well together with having "longest" in
5916 'completeopt', because the completion from the search pattern may not
5917 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005918
5919 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5920'showmatch' 'sm' boolean (default off)
5921 global
5922 When a bracket is inserted, briefly jump to the matching one. The
5923 jump is only done if the match can be seen on the screen. The time to
5924 show the match can be set with 'matchtime'.
5925 A Beep is given if there is no match (no matter if the match can be
5926 seen or not). This option is reset when the 'paste' option is set.
5927 When the 'm' flag is not included in 'cpoptions', typing a character
5928 will immediately move the cursor back to where it belongs.
5929 See the "sm" field in 'guicursor' for setting the cursor shape and
5930 blinking when showing the match.
5931 The 'matchpairs' option can be used to specify the characters to show
5932 matches for. 'rightleft' and 'revins' are used to look for opposite
5933 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005934 Also see the matchparen plugin for highlighting the match when moving
5935 around |pi_paren.txt|.
5936 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005937
5938 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5939'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5940 global
5941 If in Insert, Replace or Visual mode put a message on the last line.
5942 Use the 'M' flag in 'highlight' to set the type of highlighting for
5943 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005944 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005945 doesn't mean XIM is really active, especially when 'imactivatekey' is
5946 not set.
5947 NOTE: This option is set to the Vi default value when 'compatible' is
5948 set and to the Vim default value when 'compatible' is reset.
5949
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00005950 *'showtabline'* *'stal'*
5951'showtabline' 'stal' number (default 1)
5952 global
5953 {not in Vi}
5954 {not available when compiled without the +windows
5955 feature}
5956 The value of this option specifies when the line with tab page labels
5957 will be displayed:
5958 0: never
5959 1: only if there are at least two tab pages
5960 2: always
5961 This is both for the GUI and non-GUI implementation of the tab pages
5962 line.
5963 See |tab-page| for more information about tab pages.
5964
Bram Moolenaar071d4272004-06-13 20:20:40 +00005965 *'sidescroll'* *'ss'*
5966'sidescroll' 'ss' number (default 0)
5967 global
5968 {not in Vi}
5969 The minimal number of columns to scroll horizontally. Used only when
5970 the 'wrap' option is off and the cursor is moved off of the screen.
5971 When it is zero the cursor will be put in the middle of the screen.
5972 When using a slow terminal set it to a large number or 0. When using
5973 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5974 commands.
5975
5976 *'sidescrolloff'* *'siso'*
5977'sidescrolloff' 'siso' number (default 0)
5978 global
5979 {not in Vi}
5980 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005981 right of the cursor if 'nowrap' is set. Setting this option to a
5982 value greater than 0 while having |'sidescroll'| also at a non-zero
5983 value makes some context visible in the line you are scrolling in
5984 horizontally (except at beginning of the line). Setting this option
5985 to a large value (like 999) has the effect of keeping the cursor
5986 horizontally centered in the window, as long as one does not come too
5987 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005988 NOTE: This option is set to 0 when 'compatible' is set.
5989
5990 Example: Try this together with 'sidescroll' and 'listchars' as
5991 in the following example to never allow the cursor to move
5992 onto the "extends" character:
5993
5994 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5995 :set sidescrolloff=1
5996
5997
5998 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5999'smartcase' 'scs' boolean (default off)
6000 global
6001 {not in Vi}
6002 Override the 'ignorecase' option if the search pattern contains upper
6003 case characters. Only used when the search pattern is typed and
6004 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006005 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006006 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6007 recalling the search pattern from history and hitting <Enter>.
6008 NOTE: This option is reset when 'compatible' is set.
6009
6010 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6011'smartindent' 'si' boolean (default off)
6012 local to buffer
6013 {not in Vi}
6014 {not available when compiled without the
6015 |+smartindent| feature}
6016 Do smart autoindenting when starting a new line. Works for C-like
6017 programs, but can also be used for other languages. 'cindent' does
6018 something like this, works better in most cases, but is more strict,
6019 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
6020 'indentexpr' is a more advanced alternative.
6021 Normally 'autoindent' should also be on when using 'smartindent'.
6022 An indent is automatically inserted:
6023 - After a line ending in '{'.
6024 - After a line starting with a keyword from 'cinwords'.
6025 - Before a line starting with '}' (only with the "O" command).
6026 When typing '}' as the first character in a new line, that line is
6027 given the same indent as the matching '{'.
6028 When typing '#' as the first character in a new line, the indent for
6029 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006030 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006031 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6032 When using the ">>" command, lines starting with '#' are not shifted
6033 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006034 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006035 is set smart indenting is disabled.
6036
6037 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6038'smarttab' 'sta' boolean (default off)
6039 global
6040 {not in Vi}
6041 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006042 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6043 <BS> will delete a 'shiftwidth' worth of space at the start of the
6044 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006045 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006046 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6047 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006048 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006049 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006050 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006051 NOTE: This option is reset when 'compatible' is set.
6052
6053 *'softtabstop'* *'sts'*
6054'softtabstop' 'sts' number (default 0)
6055 local to buffer
6056 {not in Vi}
6057 Number of spaces that a <Tab> counts for while performing editing
6058 operations, like inserting a <Tab> or using <BS>. It "feels" like
6059 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6060 used. This is useful to keep the 'ts' setting at its standard value
6061 of 8, while being able to edit like it is set to 'sts'. However,
6062 commands like "x" still work on the actual characters.
6063 When 'sts' is zero, this feature is off.
6064 'softtabstop' is set to 0 when the 'paste' option is set.
6065 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6066 spaces is minimized by using <Tab>s.
6067 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6068 set.
6069 NOTE: This option is set to 0 when 'compatible' is set.
6070
Bram Moolenaar217ad922005-03-20 22:37:15 +00006071 *'spell'* *'nospell'*
6072'spell' boolean (default off)
6073 local to window
6074 {not in Vi}
6075 {not available when compiled without the |+syntax|
6076 feature}
6077 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006078 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006079
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006080 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006081'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006082 local to buffer
6083 {not in Vi}
6084 {not available when compiled without the |+syntax|
6085 feature}
6086 Pattern to locate the end of a sentence. The following word will be
6087 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006088 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006089 When this check is not wanted make this option empty.
6090 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006091 Be careful with special characters, see |option-backslash| about
6092 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006093 To set this option automatically depending on the language, see
6094 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006095
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006096 *'spellfile'* *'spf'*
6097'spellfile' 'spf' string (default empty)
6098 local to buffer
6099 {not in Vi}
6100 {not available when compiled without the |+syntax|
6101 feature}
6102 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006103 commands. It must end in ".{encoding}.add". You need to include the
6104 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006105 *E765*
6106 It may also be a comma separated list of names. A count before the
6107 |zg| and |zw| commands can be used to access each. This allows using
6108 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006109 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006110 you: Using the first directory in 'runtimepath' that is writable. If
6111 there is no "spell" directory yet it will be created. For the file
6112 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006113 ignoring the region.
6114 The resulting ".spl" file will be used for spell checking, it does not
6115 have to appear in 'spelllang'.
6116 Normally one file is used for all regions, but you can add the region
6117 name if you want to. However, it will then only be used when
6118 'spellfile' is set to it, for entries in 'spelllang' only files
6119 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006120 This option cannot be set from a |modeline| or in the |sandbox|, for
6121 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006122
Bram Moolenaar217ad922005-03-20 22:37:15 +00006123 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006124'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006125 local to buffer
6126 {not in Vi}
6127 {not available when compiled without the |+syntax|
6128 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006129 A comma separated list of word list names. When the 'spell' option is
6130 on spellchecking will be done for these languages. Example: >
6131 set spelllang=en_us,nl,medical
6132< This means US English, Dutch and medical words are recognized. Words
6133 that are not recognized will be highlighted.
6134 The word list name must not include a comma or dot. Using a dash is
6135 recommended to separate the two letter language name from a
6136 specification. Thus "en-rare" is used for rare English words.
6137 A region name must come last and have the form "_xx", where "xx" is
6138 the two-letter, lower case region name. You can use more than one
6139 region by listing them: "en_us,en_ca" supports both US and Canadian
6140 English, but not words specific for Australia, New Zealand or Great
6141 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006142 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006143 As a special case the name of a .spl file can be given as-is. The
6144 first "_xx" in the name is removed and used as the region name
6145 (_xx is an underscore, two letters and followed by a non-letter).
6146 This is mainly for testing purposes. You must make sure the correct
6147 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006148 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006149 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6150 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006151 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006152
Bram Moolenaar98692072006-02-04 00:57:42 +00006153 If the |spellfile.vim| plugin is active and you use a language name
6154 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6155 will ask you if you want to download the file.
6156
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006157 After this option has been set successfully, Vim will source the files
6158 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006159 up to the first comma, dot or underscore.
6160 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006161
6162
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006163 *'spellsuggest'* *'sps'*
6164'spellsuggest' 'sps' string (default "best")
6165 global
6166 {not in Vi}
6167 {not available when compiled without the |+syntax|
6168 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006169 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006170 the |spellsuggest()| function. This is a comma-separated list of
6171 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006172
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006173 best Internal method that works best for English. Finds
6174 changes like "fast" and uses a bit of sound-a-like
6175 scoring to improve the ordering.
6176
6177 double Internal method that uses two methods and mixes the
6178 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006179 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006180 word. That only works when the language specifies
6181 sound folding. Can be slow and doesn't always give
6182 better results.
6183
6184 fast Internal method that only checks for simple changes:
6185 character inserts/deletes/swaps. Works well for
6186 simple typing mistakes.
6187
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006188 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006189 Not used for |spellsuggest()|. The number of
6190 suggestions is never more than the value of 'lines'
6191 minus two.
6192
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006193 file:{filename} Read file {filename}, which must have two columns,
6194 separated by a slash. The first column contains the
6195 bad word, the second column the suggested good word.
6196 Example:
6197 theribal/terrible ~
6198 Use this for common mistakes that do not appear at the
6199 top of the suggestion list with the internal methods.
6200 Lines without a slash are ignored, use this for
6201 comments.
6202 The file is used for all languages.
6203
6204 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6205 trouble with spaces. |v:val| holds the badly spelled
6206 word. The expression must evaluate to a List of
6207 Lists, each with a suggestion and a score.
6208 Example:
6209 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006210 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006211 internal methods use. A lower score is better.
6212 This may invoke |spellsuggest()| if you temporarily
6213 set 'spellsuggest' to exclude the "expr:" part.
6214 Errors are silently ignored, unless you set the
6215 'verbose' option to a non-zero value.
6216
6217 Only one of "best", "double" or "fast" may be used. The others may
6218 appear several times in any order. Example: >
6219 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6220<
6221 This option cannot be set from a |modeline| or in the |sandbox|, for
6222 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006223
6224
Bram Moolenaar071d4272004-06-13 20:20:40 +00006225 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6226'splitbelow' 'sb' boolean (default off)
6227 global
6228 {not in Vi}
6229 {not available when compiled without the +windows
6230 feature}
6231 When on, splitting a window will put the new window below the current
6232 one. |:split|
6233
6234 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6235'splitright' 'spr' boolean (default off)
6236 global
6237 {not in Vi}
6238 {not available when compiled without the +vertsplit
6239 feature}
6240 When on, splitting a window will put the new window right of the
6241 current one. |:vsplit|
6242
6243 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6244'startofline' 'sol' boolean (default on)
6245 global
6246 {not in Vi}
6247 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006248 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006249 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006250 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006251 with a linewise operator, with "%" with a count and to buffer changing
6252 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6253 only has a line number, e.g., ":25" or ":+".
6254 In case of buffer changing commands the cursor is placed at the column
6255 where it was the last time the buffer was edited.
6256 NOTE: This option is set when 'compatible' is set.
6257
6258 *'statusline'* *'stl'* *E540* *E541* *E542*
6259'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006260 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006261 {not in Vi}
6262 {not available when compiled without the |+statusline|
6263 feature}
6264 When nonempty, this option determines the content of the status line.
6265 Also see |status-line|.
6266
6267 The option consists of printf style '%' items interspersed with
6268 normal text. Each status line item is of the form:
6269 %-0{minwid}.{maxwid}{item}
6270 All fields except the {item} is optional. A single percent sign can
6271 be given as "%%". Up to 80 items can be specified.
6272
Bram Moolenaar238a5642006-02-21 22:12:05 +00006273 When the option starts with "%!" then it is used as an expression,
6274 evaluated and the result is used as the option value. Example: >
6275 :set statusline=%!MyStatusLine()
6276< The result can contain %{} items that will be evaluated too.
6277
6278 When there is error while evaluating the option then it will be made
6279 empty to avoid further errors. Otherwise screen updating would loop.
6280
Bram Moolenaar071d4272004-06-13 20:20:40 +00006281 Note that the only effect of 'ruler' when this option is set (and
6282 'laststatus' is 2) is controlling the output of |CTRL-G|.
6283
6284 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006285 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006286 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006287 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006288 minwid Minimum width of the item, padding as set by '-' & '0'.
6289 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006290 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006291 on the left for text items. Numeric items will be
6292 shifted down to maxwid-2 digits followed by '>'number
6293 where number is the amount of missing digits, much like
6294 an exponential notation.
6295 item A one letter code as described below.
6296
6297 Following is a description of the possible statusline items. The
6298 second character in "item" is the type:
6299 N for number
6300 S for string
6301 F for flags as described below
6302 - not applicable
6303
6304 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006305 f S Path to the file in the buffer, as typed or relative to current
6306 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006307 F S Full path to the file in the buffer.
6308 t S File name (tail) of file in the buffer.
6309 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
6310 M F Modified flag, text is ",+" or ",-".
6311 r F Readonly flag, text is " [RO]".
6312 R F Readonly flag, text is ",RO".
6313 h F Help buffer flag, text is " [help]".
6314 H F Help buffer flag, text is ",HLP".
6315 w F Preview window flag, text is " [Preview]".
6316 W F Preview window flag, text is ",PRV".
6317 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
6318 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6319 {not available when compiled without |+autocmd| feature}
6320 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6321 being used: "<keymap>"
6322 n N Buffer number.
6323 b N Value of byte under cursor.
6324 B N As above, in hexadecimal.
6325 o N Byte number in file of byte under cursor, first byte is 1.
6326 Mnemonic: Offset from start of file (with one added)
6327 {not available when compiled without |+byte_offset| feature}
6328 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006329 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006330 l N Line number.
6331 L N Number of lines in buffer.
6332 c N Column number.
6333 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006334 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006335 p N Percentage through file in lines as in |CTRL-G|.
6336 P S Percentage through file of displayed window. This is like the
6337 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006338 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006339 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006340 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006341 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006342 ( - Start of item group. Can be used for setting the width and
6343 alignment of a section. Must be followed by %) somewhere.
6344 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006345 T N For 'tabline': start of tab page N label. Use %T after the last
6346 label. This information is used for mouse clicks.
6347 X N For 'tabline': start of close tab N label. Use %X after the
6348 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6349 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006350 < - Where to truncate line if too long. Default is at the start.
6351 No width fields allowed.
6352 = - Separation point between left and right aligned items.
6353 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006354 # - Set highlight group. The name must follow and then a # again.
6355 Thus use %#HLname# for highlight group HLname. The same
6356 highlighting is used, also for the statusline of non-current
6357 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006358 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006359 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006360 The difference between User{N} and StatusLine will be applied
6361 to StatusLineNC for the statusline of non-current windows.
6362 The number N must be between 1 and 9. See |hl-User1..9|
6363
6364 Display of flags are controlled by the following heuristic:
6365 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006366 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00006367 with a space it is assumed that it wants to separate itself from
6368 anything but other flags. That is: A leading comma is removed if the
6369 preceding character stems from plaintext. A leading space is removed
Bram Moolenaar582fd852005-03-28 20:58:01 +00006370 if the preceding character stems from another active flag. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006371 make a nice display when flags are used like in the examples below.
6372
Bram Moolenaar582fd852005-03-28 20:58:01 +00006373 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006374 not set) and a minwid is not set for the group, the whole group will
6375 become empty. This will make a group like the following disappear
6376 completely from the statusline when none of the flags are set. >
6377 :set statusline=...%(\ [%M%R%H]%)...
6378<
6379 Beware that an expression is evaluated each and every time the status
6380 line is displayed. The current buffer and current window will be set
6381 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006382 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006383 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006384 real current buffer.
6385
6386 The 'statusline' option may be evaluated in the |sandbox|, see
6387 |sandbox-option|.
6388
6389 It is not allowed to change text or jump to another window while
6390 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006391
6392 If the statusline is not updated when you want it (e.g., after setting
6393 a variable that's used in an expression), you can force an update by
6394 setting an option without changing its value. Example: >
6395 :let &ro = &ro
6396
6397< A result of all digits is regarded a number for display purposes.
6398 Otherwise the result is taken as flag text and applied to the rules
6399 described above.
6400
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006401 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006402 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6403 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6404
6405 Examples:
6406 Emulate standard status line with 'ruler' set >
6407 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6408< Similar, but add ASCII value of char under the cursor (like "ga") >
6409 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6410< Display byte count and byte value, modified flag in red. >
6411 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6412 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6413< Display a ,GZ flag if a compressed file is loaded >
6414 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6415< In the |:autocmd|'s: >
6416 :let b:gzflag = 1
6417< And: >
6418 :unlet b:gzflag
6419< And define this function: >
6420 :function VarExists(var, val)
6421 : if exists(a:var) | return a:val | else | return '' | endif
6422 :endfunction
6423<
6424 *'suffixes'* *'su'*
6425'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6426 global
6427 {not in Vi}
6428 Files with these suffixes get a lower priority when multiple files
6429 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006430 suffixes. Spaces after the comma are ignored. A dot is also seen as
6431 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006432 separator, precede it with a backslash (see |option-backslash| about
6433 including spaces and backslashes).
6434 See 'wildignore' for completely ignoring files.
6435 The use of |:set+=| and |:set-=| is preferred when adding or removing
6436 suffixes from the list. This avoids problems when a future version
6437 uses another default.
6438
6439 *'suffixesadd'* *'sua'*
6440'suffixesadd' 'sua' string (default "")
6441 local to buffer
6442 {not in Vi}
6443 {not available when compiled without the
6444 |+file_in_path| feature}
6445 Comma separated list of suffixes, which are used when searching for a
6446 file for the "gf", "[I", etc. commands. Example: >
6447 :set suffixesadd=.java
6448<
6449 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6450'swapfile' 'swf' boolean (default on)
6451 local to buffer
6452 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006453 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006454 swapfile is not wanted for a specific buffer. For example, with
6455 confidential information that even root must not be able to access.
6456 Careful: All text will be in memory:
6457 - Don't use this for big files.
6458 - Recovery will be impossible!
6459 A swapfile will only be present when |'updatecount'| is non-zero and
6460 'swapfile' is set.
6461 When 'swapfile' is reset, the swap file for the current buffer is
6462 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6463 non-zero, a swap file is immediately created.
6464 Also see |swap-file| and |'swapsync'|.
6465
6466 This option is used together with 'bufhidden' and 'buftype' to
6467 specify special kinds of buffers. See |special-buffers|.
6468
6469 *'swapsync'* *'sws'*
6470'swapsync' 'sws' string (default "fsync")
6471 global
6472 {not in Vi}
6473 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006474 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006475 When this option is empty parts of the swap file may be in memory and
6476 not written to disk. When the system crashes you may lose more work.
6477 On Unix the system does a sync now and then without Vim asking for it,
6478 so the disadvantage of setting this option off is small. On some
6479 systems the swap file will not be written at all. For a unix system
6480 setting it to "sync" will use the sync() call instead of the default
6481 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006482 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006483
6484 *'switchbuf'* *'swb'*
6485'switchbuf' 'swb' string (default "")
6486 global
6487 {not in Vi}
6488 This option controls the behavior when switching between buffers.
6489 Possible values (comma separated list):
6490 useopen If included, jump to the first open window that
6491 contains the specified buffer (if there is one).
6492 Otherwise: Do not examine other windows.
6493 This setting is checked with |quickfix| commands, when
6494 jumping to errors (":cc", ":cn", "cp", etc.). It is
6495 also used in all buffer related split commands, for
6496 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006497 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006498 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006499 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006500 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006501 Supported in |quickfix| commands that display errors.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006502 newtab Like "split", but open a new tab page. Overrules
6503 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006504
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006505 *'synmaxcol'* *'smc'*
6506'synmaxcol' 'smc' number (default 3000)
6507 local to buffer
6508 {not in Vi}
6509 {not available when compiled without the |+syntax|
6510 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006511 Maximum column in which to search for syntax items. In long lines the
6512 text after this column is not highlighted and following lines may not
6513 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006514 This helps to avoid very slow redrawing for an XML file that is one
6515 long line.
6516 Set to zero to remove the limit.
6517
Bram Moolenaar071d4272004-06-13 20:20:40 +00006518 *'syntax'* *'syn'*
6519'syntax' 'syn' string (default empty)
6520 local to buffer
6521 {not in Vi}
6522 {not available when compiled without the |+syntax|
6523 feature}
6524 When this option is set, the syntax with this name is loaded, unless
6525 syntax highlighting has been switched off with ":syntax off".
6526 Otherwise this option does not always reflect the current syntax (the
6527 b:current_syntax variable does).
6528 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006529 not automatically recognized. Example, in an IDL file:
6530 /* vim: set syntax=idl : */ ~
6531 When a dot appears in the value then this separates two filetype
6532 names. Example:
6533 /* vim: set syntax=c.doxygen : */ ~
6534 This will use the "c" syntax first, then the "doxygen" syntax.
6535 Note that the second one must be prepared to be loaded as an addition,
6536 otherwise it will be skipped. More than one dot may appear.
6537 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006538 :set syntax=OFF
6539< To switch syntax highlighting on according to the current value of the
6540 'filetype' option: >
6541 :set syntax=ON
6542< What actually happens when setting the 'syntax' option is that the
6543 Syntax autocommand event is triggered with the value as argument.
6544 This option is not copied to another buffer, independent of the 's' or
6545 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006546 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006547
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006548 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006549'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006550 global
6551 {not in Vi}
6552 {not available when compiled without the +windows
6553 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006554 When nonempty, this option determines the content of the tab pages
6555 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006556 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006557
6558 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006559 option and only when there is no GUI tab line. When 'e' is in
6560 'guioptions' and the GUI supports a tab line 'guitablabel' is used
6561 instead.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006562
6563 The value is evaluated like with 'statusline'. You can use
6564 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006565 the text to be displayed. Use "%1T" for the first label, "%2T" for
6566 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006567
6568 Keep in mind that only one of the tab pages is the current one, others
6569 are invisible and you can't jump to their windows.
6570
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006571
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006572 *'tabpagemax'* *'tpm'*
6573'tabpagemax' 'tpm' number (default 10)
6574 global
6575 {not in Vi}
6576 {not available when compiled without the +windows
6577 feature}
6578 Maximum number of tab pages to be opened by the |-p| command line
6579 argument or the ":tab all" command. |tabpage|
6580
6581
6582 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006583'tabstop' 'ts' number (default 8)
6584 local to buffer
6585 Number of spaces that a <Tab> in the file counts for. Also see
6586 |:retab| command, and 'softtabstop' option.
6587
6588 Note: Setting 'tabstop' to any other value than 8 can make your file
6589 appear wrong in many places (e.g., when printing it).
6590
6591 There are four main ways to use tabs in Vim:
6592 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6593 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006594 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006595 behave like a tab appears every 4 (or 3) characters.
6596 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6597 'expandtab'. This way you will always insert spaces. The
6598 formatting will never be messed up when 'tabstop' is changed.
6599 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006600 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601 works when using Vim to edit the file.
6602 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6603 'noexpandtab'. This should then work (for initial indents only)
6604 for any tabstop setting that people use. It might be nice to have
6605 tabs after the first non-blank inserted as spaces if you do this
6606 though. Otherwise aligned comments will be wrong when 'tabstop' is
6607 changed.
6608
6609 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6610'tagbsearch' 'tbs' boolean (default on)
6611 global
6612 {not in Vi}
6613 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006614 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006615 searching makes searching for a tag a LOT faster, but a linear search
6616 will find more tags if the tags file wasn't properly sorted.
6617 Vim normally assumes that your tags files are sorted, or indicate that
6618 they are not sorted. Only when this is not the case does the
6619 'tagbsearch' option need to be switched off.
6620
6621 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006622 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006623 certain files, or retry all files with a linear search. When
6624 'tagbsearch' is off, only a linear search is done.
6625
6626 Linear searching is done anyway, for one file, when Vim finds a line
6627 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006628 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006629< [The whitespace before and after the '0' must be a single <Tab>]
6630
6631 When a binary search was done and no match was found in any of the
6632 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6633 instead of a normal tag name, a retry is done with a linear search.
6634 Tags in unsorted tags files, and matches with different case will only
6635 be found in the retry.
6636
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006637 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006638 linear search can be avoided for the 'ignorecase' case. Use a value
6639 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6640 case-fold sorted with the -f switch to "sort" in most unices, as in
6641 the command: "sort -f -o tags tags". For "Exuberant ctags" version
6642 5.3 or higher the -f or --fold-case-sort switch can be used for this
6643 as well. Note that case must be folded to uppercase for this to work.
6644
6645 When 'tagbsearch' is off, tags searching is slower when a full match
6646 exists, but faster when no full match exists. Tags in unsorted tags
6647 files may only be found with 'tagbsearch' off.
6648 When the tags file is not sorted, or sorted in a wrong way (not on
6649 ASCII byte value), 'tagbsearch' should be off, or the line given above
6650 must be included in the tags file.
6651 This option doesn't affect commands that find all matching tags (e.g.,
6652 command-line completion and ":help").
6653 {Vi: always uses binary search in some versions}
6654
6655 *'taglength'* *'tl'*
6656'taglength' 'tl' number (default 0)
6657 global
6658 If non-zero, tags are significant up to this number of characters.
6659
6660 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6661'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6662 global
6663 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006664 If on and using a tags file in another directory, file names in that
6665 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006666 NOTE: This option is set to the Vi default value when 'compatible' is
6667 set and to the Vim default value when 'compatible' is reset.
6668
6669 *'tags'* *'tag'* *E433*
6670'tags' 'tag' string (default "./tags,tags", when compiled with
6671 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6672 global or local to buffer |global-local|
6673 Filenames for the tag command, separated by spaces or commas. To
6674 include a space or comma in a file name, precede it with a backslash
6675 (see |option-backslash| about including spaces and backslashes).
6676 When a file name starts with "./", the '.' is replaced with the path
6677 of the current file. But only when the 'd' flag is not included in
6678 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6679 |tags-option|.
6680 "*", "**" and other wildcards can be used to search for tags files in
6681 a directory tree. See |file-searching|. {not available when compiled
6682 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006683 The |tagfiles()| function can be used to get a list of the file names
6684 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006685 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6686 files are also supported. They are automatically recognized. The
6687 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6688 differences are ignored (MS-Windows). |emacs-tags|
6689 The use of |:set+=| and |:set-=| is preferred when adding or removing
6690 file names from the list. This avoids problems when a future version
6691 uses another default.
6692 {Vi: default is "tags /usr/lib/tags"}
6693
6694 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6695'tagstack' 'tgst' boolean (default on)
6696 global
6697 {not in all versions of Vi}
6698 When on, the |tagstack| is used normally. When off, a ":tag" or
6699 ":tselect" command with an argument will not push the tag onto the
6700 tagstack. A following ":tag" without an argument, a ":pop" command or
6701 any other command that uses the tagstack will use the unmodified
6702 tagstack, but does change the pointer to the active entry.
6703 Resetting this option is useful when using a ":tag" command in a
6704 mapping which should not change the tagstack.
6705
6706 *'term'* *E529* *E530* *E531*
6707'term' string (default is $TERM, if that fails:
6708 in the GUI: "builtin_gui"
6709 on Amiga: "amiga"
6710 on BeOS: "beos-ansi"
6711 on Mac: "mac-ansi"
6712 on MiNT: "vt52"
6713 on MS-DOS: "pcterm"
6714 on OS/2: "os2ansi"
6715 on Unix: "ansi"
6716 on VMS: "ansi"
6717 on Win 32: "win32")
6718 global
6719 Name of the terminal. Used for choosing the terminal control
6720 characters. Environment variables are expanded |:set_env|.
6721 For example: >
6722 :set term=$TERM
6723< See |termcap|.
6724
6725 *'termbidi'* *'tbidi'*
6726 *'notermbidi'* *'notbidi'*
6727'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6728 global
6729 {not in Vi}
6730 {only available when compiled with the |+arabic|
6731 feature}
6732 The terminal is in charge of Bi-directionality of text (as specified
6733 by Unicode). The terminal is also expected to do the required shaping
6734 that some languages (such as Arabic) require.
6735 Setting this option implies that 'rightleft' will not be set when
6736 'arabic' is set and the value of 'arabicshape' will be ignored.
6737 Note that setting 'termbidi' has the immediate effect that
6738 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6739 This option is reset when the GUI is started.
6740 For further details see |arabic.txt|.
6741
6742 *'termencoding'* *'tenc'*
6743'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6744 Macintosh GUI: "macroman")
6745 global
6746 {only available when compiled with the |+multi_byte|
6747 feature}
6748 {not in Vi}
6749 Encoding used for the terminal. This specifies what character
6750 encoding the keyboard produces and the display will understand. For
6751 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00006752 display). Except for the Mac when 'macatsui' is off, then
6753 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006754 In the Win32 console version the default value is the console codepage
6755 when it differs from the ANSI codepage.
6756 *E617*
6757 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6758 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6759 Any attempts to set a different value will be rejected, and an error
6760 message is shown.
6761 For the Win32 GUI 'termencoding' is not used for typed characters,
6762 because the Win32 system always passes Unicode characters.
6763 When empty, the same encoding is used as for the 'encoding' option.
6764 This is the normal value.
6765 Not all combinations for 'termencoding' and 'encoding' are valid. See
6766 |encoding-table|.
6767 The value for this option must be supported by internal conversions or
6768 iconv(). When this is not possible no conversion will be done and you
6769 will probably experience problems with non-ASCII characters.
6770 Example: You are working with the locale set to euc-jp (Japanese) and
6771 want to edit a UTF-8 file: >
6772 :let &termencoding = &encoding
6773 :set encoding=utf-8
6774< You need to do this when your system has no locale support for UTF-8.
6775
6776 *'terse'* *'noterse'*
6777'terse' boolean (default off)
6778 global
6779 When set: Add 's' flag to 'shortmess' option (this makes the message
6780 for a search that hits the start or end of the file not being
6781 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6782 shortens a lot of messages}
6783
6784 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6785'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6786 global
6787 {not in Vi}
6788 This option is obsolete. Use 'fileformats'.
6789 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6790 set to the default value for the current system. When 'textauto' is
6791 reset, 'fileformats' is made empty.
6792 NOTE: This option is set to the Vi default value when 'compatible' is
6793 set and to the Vim default value when 'compatible' is reset.
6794
6795 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6796'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6797 others: default off)
6798 local to buffer
6799 {not in Vi}
6800 This option is obsolete. Use 'fileformat'.
6801 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6802 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6803 "unix".
6804
6805 *'textwidth'* *'tw'*
6806'textwidth' 'tw' number (default 0)
6807 local to buffer
6808 {not in Vi}
6809 Maximum width of text that is being inserted. A longer line will be
6810 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006811 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6812 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006813 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00006814 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006815 NOTE: This option is set to 0 when 'compatible' is set.
6816
6817 *'thesaurus'* *'tsr'*
6818'thesaurus' 'tsr' string (default "")
6819 global or local to buffer |global-local|
6820 {not in Vi}
6821 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006822 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006823 the file should contain words with similar meaning, separated by
6824 non-keyword characters (white space is preferred). Maximum line
6825 length is 510 bytes.
6826 To obtain a file to be used here, check out the wordlist FAQ at
6827 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006828 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006829 after a comma are ignored, otherwise spaces are included in the file
6830 name. See |option-backslash| about using backslashes.
6831 The use of |:set+=| and |:set-=| is preferred when adding or removing
6832 directories from the list. This avoids problems when a future version
6833 uses another default.
6834 Backticks cannot be used in this option for security reasons.
6835
6836 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6837'tildeop' 'top' boolean (default off)
6838 global
6839 {not in Vi}
6840 When on: The tilde command "~" behaves like an operator.
6841 NOTE: This option is reset when 'compatible' is set.
6842
6843 *'timeout'* *'to'* *'notimeout'* *'noto'*
6844'timeout' 'to' boolean (default on)
6845 global
6846 *'ttimeout'* *'nottimeout'*
6847'ttimeout' boolean (default off)
6848 global
6849 {not in Vi}
6850 These two options together determine the behavior when part of a
6851 mapped key sequence or keyboard code has been received:
6852
6853 'timeout' 'ttimeout' action ~
6854 off off do not time out
6855 on on or off time out on :mappings and key codes
6856 off on time out on key codes
6857
6858 If both options are off, Vim will wait until either the complete
6859 mapping or key sequence has been received, or it is clear that there
6860 is no mapping or key sequence for the received characters. For
6861 example: if you have mapped "vl" and Vim has received 'v', the next
6862 character is needed to see if the 'v' is followed by an 'l'.
6863 When one of the options is on, Vim will wait for about 1 second for
6864 the next character to arrive. After that the already received
6865 characters are interpreted as single characters. The waiting time can
6866 be changed with the 'timeoutlen' option.
6867 On slow terminals or very busy systems timing out may cause
6868 malfunctioning cursor keys. If both options are off, Vim waits
6869 forever after an entered <Esc> if there are key codes that start
6870 with <Esc>. You will have to type <Esc> twice. If you do not have
6871 problems with key codes, but would like to have :mapped key
6872 sequences not timing out in 1 second, set the 'ttimeout' option and
6873 reset the 'timeout' option.
6874
6875 NOTE: 'ttimeout' is reset when 'compatible' is set.
6876
6877 *'timeoutlen'* *'tm'*
6878'timeoutlen' 'tm' number (default 1000)
6879 global
6880 {not in all versions of Vi}
6881 *'ttimeoutlen'* *'ttm'*
6882'ttimeoutlen' 'ttm' number (default -1)
6883 global
6884 {not in Vi}
6885 The time in milliseconds that is waited for a key code or mapped key
6886 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6887 when part of a command has been typed.
6888 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6889 different timeout value for key codes is desired set 'ttimeoutlen' to
6890 a non-negative number.
6891
6892 ttimeoutlen mapping delay key code delay ~
6893 < 0 'timeoutlen' 'timeoutlen'
6894 >= 0 'timeoutlen' 'ttimeoutlen'
6895
6896 The timeout only happens when the 'timeout' and 'ttimeout' options
6897 tell so. A useful setting would be >
6898 :set timeout timeoutlen=3000 ttimeoutlen=100
6899< (time out on mapping after three seconds, time out on key codes after
6900 a tenth of a second).
6901
6902 *'title'* *'notitle'*
6903'title' boolean (default off, on when title can be restored)
6904 global
6905 {not in Vi}
6906 {not available when compiled without the |+title|
6907 feature}
6908 When on, the title of the window will be set to the value of
6909 'titlestring' (if it is not empty), or to:
6910 filename [+=-] (path) - VIM
6911 Where:
6912 filename the name of the file being edited
6913 - indicates the file cannot be modified, 'ma' off
6914 + indicates the file was modified
6915 = indicates the file is read-only
6916 =+ indicates the file is read-only and modified
6917 (path) is the path of the file being edited
6918 - VIM the server name |v:servername| or "VIM"
6919 Only works if the terminal supports setting window titles
6920 (currently Amiga console, Win32 console, all GUI versions and
6921 terminals with a non- empty 't_ts' option - these are Unix xterm and
6922 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6923 *X11*
6924 When Vim was compiled with HAVE_X11 defined, the original title will
6925 be restored if possible. The output of ":version" will include "+X11"
6926 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6927 works for the icon name |'icon'|.
6928 But: When Vim was started with the |-X| argument, restoring the title
6929 will not work (except in the GUI).
6930 If the title cannot be restored, it is set to the value of 'titleold'.
6931 You might want to restore the title outside of Vim then.
6932 When using an xterm from a remote machine you can use this command:
6933 rsh machine_name xterm -display $DISPLAY &
6934 then the WINDOWID environment variable should be inherited and the
6935 title of the window should change back to what it should be after
6936 exiting Vim.
6937
6938 *'titlelen'*
6939'titlelen' number (default 85)
6940 global
6941 {not in Vi}
6942 {not available when compiled without the |+title|
6943 feature}
6944 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006945 title. When the title is longer, only the end of the path name is
6946 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006947 Using a percentage makes this adapt to the width of the window. But
6948 it won't work perfectly, because the actual number of characters
6949 available also depends on the font used and other things in the title
6950 bar. When 'titlelen' is zero the full path is used. Otherwise,
6951 values from 1 to 30000 percent can be used.
6952 'titlelen' is also used for the 'titlestring' option.
6953
6954 *'titleold'*
6955'titleold' string (default "Thanks for flying Vim")
6956 global
6957 {not in Vi}
6958 {only available when compiled with the |+title|
6959 feature}
6960 This option will be used for the window title when exiting Vim if the
6961 original title cannot be restored. Only happens if 'title' is on or
6962 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006963 This option cannot be set from a |modeline| or in the |sandbox|, for
6964 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006965 *'titlestring'*
6966'titlestring' string (default "")
6967 global
6968 {not in Vi}
6969 {not available when compiled without the |+title|
6970 feature}
6971 When this option is not empty, it will be used for the title of the
6972 window. This happens only when the 'title' option is on.
6973 Only works if the terminal supports setting window titles (currently
6974 Amiga console, Win32 console, all GUI versions and terminals with a
6975 non-empty 't_ts' option).
6976 When Vim was compiled with HAVE_X11 defined, the original title will
6977 be restored if possible |X11|.
6978 When this option contains printf-style '%' items, they will be
6979 expanded according to the rules used for 'statusline'.
6980 Example: >
6981 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6982 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6983< The value of 'titlelen' is used to align items in the middle or right
6984 of the available space.
6985 Some people prefer to have the file name first: >
6986 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6987< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006988 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006989 separating space only when needed.
6990 NOTE: Use of special characters in 'titlestring' may cause the display
6991 to be garbled (e.g., when it contains a CR or NL character).
6992 {not available when compiled without the |+statusline| feature}
6993
6994 *'toolbar'* *'tb'*
6995'toolbar' 'tb' string (default "icons,tooltips")
6996 global
6997 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6998 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006999 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007000 possible values are:
7001 icons Toolbar buttons are shown with icons.
7002 text Toolbar buttons shown with text.
7003 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007004 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007005 tooltips Tooltips are active for toolbar buttons.
7006 Tooltips refer to the popup help text which appears after the mouse
7007 cursor is placed over a toolbar button for a brief moment.
7008
7009 If you want the toolbar to be shown with icons as well as text, do the
7010 following: >
7011 :set tb=icons,text
7012< Motif and Athena cannot display icons and text at the same time. They
7013 will show icons if both are requested.
7014
7015 If none of the strings specified in 'toolbar' are valid or if
7016 'toolbar' is empty, this option is ignored. If you want to disable
7017 the toolbar, you need to set the 'guioptions' option. For example: >
7018 :set guioptions-=T
7019< Also see |gui-toolbar|.
7020
7021 *'toolbariconsize'* *'tbis'*
7022'toolbariconsize' 'tbis' string (default "small")
7023 global
7024 {not in Vi}
7025 {only in the GTK+ 2 GUI}
7026 Controls the size of toolbar icons. The possible values are:
7027 tiny Use tiny toolbar icons.
7028 small Use small toolbar icons (default).
7029 medium Use medium-sized toolbar icons.
7030 large Use large toolbar icons.
7031 The exact dimensions in pixels of the various icon sizes depend on
7032 the current theme. Common dimensions are large=32x32, medium=24x24,
7033 small=20x20 and tiny=16x16.
7034
7035 If 'toolbariconsize' is empty, the global default size as determined
7036 by user preferences or the current theme is used.
7037
7038 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7039'ttybuiltin' 'tbi' boolean (default on)
7040 global
7041 {not in Vi}
7042 When on, the builtin termcaps are searched before the external ones.
7043 When off the builtin termcaps are searched after the external ones.
7044 When this option is changed, you should set the 'term' option next for
7045 the change to take effect, for example: >
7046 :set notbi term=$TERM
7047< See also |termcap|.
7048 Rationale: The default for this option is "on", because the builtin
7049 termcap entries are generally better (many systems contain faulty
7050 xterm entries...).
7051
7052 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7053'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7054 sun-cmd, screen, rxvt, dtterm or
7055 iris-ansi; also on when running Vim in
7056 a DOS console)
7057 global
7058 {not in Vi}
7059 Indicates a fast terminal connection. More characters will be sent to
7060 the screen for redrawing, instead of using insert/delete line
7061 commands. Improves smoothness of redrawing when there are multiple
7062 windows and the terminal does not support a scrolling region.
7063 Also enables the extra writing of characters at the end of each screen
7064 line for lines that wrap. This helps when using copy/paste with the
7065 mouse in an xterm and other terminals.
7066
7067 *'ttymouse'* *'ttym'*
7068'ttymouse' 'ttym' string (default depends on 'term')
7069 global
7070 {not in Vi}
7071 {only in Unix and VMS, doesn't work in the GUI; not
7072 available when compiled without |+mouse|}
7073 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007074 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007075 *xterm-mouse*
7076 xterm xterm-like mouse handling. The mouse generates
7077 "<Esc>[Mscr", where "scr" is three bytes:
7078 "s" = button state
7079 "c" = column plus 33
7080 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007081 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007082 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007083 xterm2 Works like "xterm", but with the xterm reporting the
7084 mouse position while the mouse is dragged. This works
7085 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007086 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007087 work. See below for how Vim detects this
7088 automatically.
7089 *netterm-mouse*
7090 netterm NetTerm mouse handling. The mouse generates
7091 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7092 for the row and column.
7093 *dec-mouse*
7094 dec DEC terminal mouse handling. The mouse generates a
7095 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007096 This is also available for an Xterm, if it was
7097 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007098 *jsbterm-mouse*
7099 jsbterm JSB term mouse handling.
7100 *pterm-mouse*
7101 pterm QNX pterm mouse handling.
7102
7103 The mouse handling must be enabled at compile time |+mouse_xterm|
7104 |+mouse_dec| |+mouse_netterm|.
7105 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7106 recognized, if enabled at compile time. DEC terminal mouse codes
7107 are recognized if enabled at compile time, and 'ttymouse' is not
7108 "xterm" (because the xterm and dec mouse codes conflict).
7109 This option is automatically set to "xterm", when the 'term' option is
7110 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7111 or "xterm2" already. The main use of this option is to set it to
7112 "xterm", when the terminal name doesn't start with "xterm", but it can
7113 handle xterm mouse codes.
7114 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007115 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007116 feature and if |t_RV| is set to the escape sequence to request the
7117 xterm version number. Otherwise "xterm2" must be set explicitly.
7118 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7119 t_RV to an empty string: >
7120 :set t_RV=
7121<
7122 *'ttyscroll'* *'tsl'*
7123'ttyscroll' 'tsl' number (default 999)
7124 global
7125 Maximum number of lines to scroll the screen. If there are more lines
7126 to scroll the window is redrawn. For terminals where scrolling is
7127 very slow and redrawing is not slow this can be set to a small number,
7128 e.g., 3, to speed up displaying.
7129
7130 *'ttytype'* *'tty'*
7131'ttytype' 'tty' string (default from $TERM)
7132 global
7133 Alias for 'term', see above.
7134
7135 *'undolevels'* *'ul'*
7136'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7137 Win32 and OS/2)
7138 global
7139 {not in Vi}
7140 Maximum number of changes that can be undone. Since undo information
7141 is kept in memory, higher numbers will cause more memory to be used
7142 (nevertheless, a single change can use an unlimited amount of memory).
7143 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7144 itself: >
7145 set ul=0
7146< But you can also get Vi compatibility by including the 'u' flag in
7147 'cpoptions', and still be able to use CTRL-R to repeat undo.
7148 Set to a negative number for no undo at all: >
7149 set ul=-1
7150< This helps when you run out of memory for a single change.
7151 Also see |undo-two-ways|.
7152
7153 *'updatecount'* *'uc'*
7154'updatecount' 'uc' number (default: 200)
7155 global
7156 {not in Vi}
7157 After typing this many characters the swap file will be written to
7158 disk. When zero, no swap file will be created at all (see chapter on
7159 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7160 Vim with the "-n" option, see |startup|. When editing in readonly
7161 mode this option will be initialized to 10000.
7162 The swapfile can be disabled per buffer with |'swapfile'|.
7163 When 'updatecount' is set from zero to non-zero, swap files are
7164 created for all buffers that have 'swapfile' set. When 'updatecount'
7165 is set to zero, existing swap files are not deleted.
7166 Also see |'swapsync'|.
7167 This option has no meaning in buffers where |'buftype'| is "nofile"
7168 or "nowrite".
7169
7170 *'updatetime'* *'ut'*
7171'updatetime' 'ut' number (default 4000)
7172 global
7173 {not in Vi}
7174 If this many milliseconds nothing is typed the swap file will be
7175 written to disk (see |crash-recovery|). Also used for the
7176 |CursorHold| autocommand event.
7177
7178 *'verbose'* *'vbs'*
7179'verbose' 'vbs' number (default 0)
7180 global
7181 {not in Vi, although some versions have a boolean
7182 verbose option}
7183 When bigger than zero, Vim will give messages about what it is doing.
7184 Currently, these messages are given:
7185 >= 1 When the viminfo file is read or written.
7186 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007187 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007188 >= 8 Files for which a group of autocommands is executed.
7189 >= 9 Every executed autocommand.
7190 >= 12 Every executed function.
7191 >= 13 When an exception is thrown, caught, finished, or discarded.
7192 >= 14 Anything pending in a ":finally" clause.
7193 >= 15 Every executed Ex command (truncated at 200 characters).
7194
7195 This option can also be set with the "-V" argument. See |-V|.
7196 This option is also set by the |:verbose| command.
7197
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007198 When the 'verbosefile' option is set then the verbose messages are not
7199 displayed.
7200
7201 *'verbosefile'* *'vfile'*
7202'verbosefile' 'vfile' string (default empty)
7203 global
7204 {not in Vi}
7205 When not empty all messages are written in a file with this name.
7206 When the file exists messages are appended.
7207 Writing to the file ends when Vim exits or when 'verbosefile' is made
7208 empty.
7209 Setting 'verbosefile' to a new value is like making it empty first.
7210 The difference with |:redir| is that verbose messages are not
7211 displayed when 'verbosefile' is set.
7212
Bram Moolenaar071d4272004-06-13 20:20:40 +00007213 *'viewdir'* *'vdir'*
7214'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7215 "$VIM/vimfiles/view",
7216 for Unix: "~/.vim/view",
7217 for Macintosh: "$VIM:vimfiles:view"
7218 for VMS: "sys$login:vimfiles/view"
7219 for RiscOS: "Choices:vimfiles/view")
7220 global
7221 {not in Vi}
7222 {not available when compiled without the +mksession
7223 feature}
7224 Name of the directory where to store files for |:mkview|.
7225 This option cannot be set from a |modeline| or in the |sandbox|, for
7226 security reasons.
7227
7228 *'viewoptions'* *'vop'*
7229'viewoptions' 'vop' string (default: "folds,options,cursor")
7230 global
7231 {not in Vi}
7232 {not available when compiled without the +mksession
7233 feature}
7234 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007235 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007236 word save and restore ~
7237 cursor cursor position in file and in window
7238 folds manually created folds, opened/closed folds and local
7239 fold options
7240 options options and mappings local to a window or buffer (not
7241 global values for local options)
7242 slash backslashes in file names replaced with forward
7243 slashes
7244 unix with Unix end-of-line format (single <NL>), even when
7245 on Windows or DOS
7246
7247 "slash" and "unix" are useful on Windows when sharing view files
7248 with Unix. The Unix version of Vim cannot source dos format scripts,
7249 but the Windows version of Vim can source unix format scripts.
7250
7251 *'viminfo'* *'vi'* *E526* *E527* *E528*
7252'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
7253 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
7254 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
7255 for others: '20,<50,s10,h)
7256 global
7257 {not in Vi}
7258 {not available when compiled without the |+viminfo|
7259 feature}
7260 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007261 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007262 separated list of parameters, each consisting of a single character
7263 identifying the particular parameter, followed by a number or string
7264 which specifies the value of that parameter. If a particular
7265 character is left out, then the default value is used for that
7266 parameter. The following is a list of the identifying characters and
7267 the effect of their value.
7268 CHAR VALUE ~
7269 ! When included, save and restore global variables that start
7270 with an uppercase letter, and don't contain a lowercase
7271 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007272 and "_K_L_M" are not. Only String and Number types are
7273 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007274 " Maximum number of lines saved for each register. Old name of
7275 the '<' item, with the disadvantage that you need to put a
7276 backslash before the ", otherwise it will be recognized as the
7277 start of a comment!
7278 % When included, save and restore the buffer list. If Vim is
7279 started with a file name argument, the buffer list is not
7280 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007281 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007282 without a file name and buffers for help files are not written
7283 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007284 When followed by a number, the number specifies the maximum
7285 number of buffers that are stored. Without a number all
7286 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007287 ' Maximum number of previously edited files for which the marks
7288 are remembered. This parameter must always be included when
7289 'viminfo' is non-empty.
7290 Including this item also means that the |jumplist| and the
7291 |changelist| are stored in the viminfo file.
7292 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007293 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007294 patterns are also saved. When not included, the value of
7295 'history' is used.
7296 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007297 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007298 < Maximum number of lines saved for each register. If zero then
7299 registers are not saved. When not included, all lines are
7300 saved. '"' is the old name for this item.
7301 Also see the 's' item below: limit specified in Kbyte.
7302 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007303 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007304 c When included, convert the text in the viminfo file from the
7305 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007306 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007307 f Whether file marks need to be stored. If zero, file marks ('0
7308 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007309 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007310 cursor position (when exiting or when doing ":wviminfo").
7311 h Disable the effect of 'hlsearch' when loading the viminfo
7312 file. When not included, it depends on whether ":nohlsearch"
7313 has been used since the last search command.
7314 n Name of the viminfo file. The name must immediately follow
7315 the 'n'. Must be the last one! If the "-i" argument was
7316 given when starting Vim, that file name overrides the one
7317 given here with 'viminfo'. Environment variables are expanded
7318 when opening the file, not when setting the option.
7319 r Removable media. The argument is a string (up to the next
7320 ','). This parameter can be given several times. Each
7321 specifies the start of a path for which no marks will be
7322 stored. This is to avoid removable media. For MS-DOS you
7323 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7324 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7325 ignored. Maximum length of each 'r' argument is 50
7326 characters.
7327 s Maximum size of an item in Kbyte. If zero then registers are
7328 not saved. Currently only applies to registers. The default
7329 "s10" will exclude registers with more than 10 Kbyte of text.
7330 Also see the '<' item above: line count limit.
7331
7332 Example: >
7333 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7334<
7335 '50 Marks will be remembered for the last 50 files you
7336 edited.
7337 <1000 Contents of registers (up to 1000 lines each) will be
7338 remembered.
7339 s100 Registers with more than 100 Kbyte text are skipped.
7340 :0 Command-line history will not be saved.
7341 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7342 no / Since '/' is not specified, the default will be used,
7343 that is, save all of the search history, and also the
7344 previous search and substitute patterns.
7345 no % The buffer list will not be saved nor read back.
7346 no h 'hlsearch' highlighting will be restored.
7347
7348 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7349 load the contents of the file, this is not done automatically.
7350
7351 This option cannot be set from a |modeline| or in the |sandbox|, for
7352 security reasons.
7353
7354 *'virtualedit'* *'ve'*
7355'virtualedit' 've' string (default "")
7356 global
7357 {not in Vi}
7358 {not available when compiled without the
7359 |+virtualedit| feature}
7360 A comma separated list of these words:
7361 block Allow virtual editing in Visual block mode.
7362 insert Allow virtual editing in Insert mode.
7363 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007364 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007365
Bram Moolenaar071d4272004-06-13 20:20:40 +00007366 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007367 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007368 of the line. Useful for selecting a rectangle in Visual mode and
7369 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007370 "onemore" is not the same, it will only allow moving the cursor just
7371 after the last character of the line. This makes some commands more
7372 consistent. Previously the cursor was always past the end of the line
7373 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007374 break some plugins or Vim scripts. For example because |l| can move
7375 the cursor after the last character. Use with care!
7376 Using the |$| command will move to the last character in the line, not
7377 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007378 It doesn't make sense to combine "all" with "onemore", but you will
7379 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007380
7381 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7382'visualbell' 'vb' boolean (default off)
7383 global
7384 {not in Vi}
7385 Use visual bell instead of beeping. The terminal code to display the
7386 visual bell is given with 't_vb'. When no beep or flash is wanted,
7387 use ":set vb t_vb=".
7388 Note: When the GUI starts, 't_vb' is reset to its default value. You
7389 might want to set it again in your |gvimrc|.
7390 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7391 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7392 where 40 is the time in msec.
7393 Does not work on the Amiga, you always get a screen flash.
7394 Also see 'errorbells'.
7395
7396 *'warn'* *'nowarn'*
7397'warn' boolean (default on)
7398 global
7399 Give a warning message when a shell command is used while the buffer
7400 has been changed.
7401
7402 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7403'weirdinvert' 'wiv' boolean (default off)
7404 global
7405 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007406 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007407 It is provided for backwards compatibility with version 4.x.
7408 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7409 vice versa. Has no effect when the GUI is running.
7410
7411 *'whichwrap'* *'ww'*
7412'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7413 global
7414 {not in Vi}
7415 Allow specified keys that move the cursor left/right to move to the
7416 previous/next line when the cursor is on the first/last character in
7417 the line. Concatenate characters to allow this for these keys:
7418 char key mode ~
7419 b <BS> Normal and Visual
7420 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007421 h "h" Normal and Visual (not recommended)
7422 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007423 < <Left> Normal and Visual
7424 > <Right> Normal and Visual
7425 ~ "~" Normal
7426 [ <Left> Insert and Replace
7427 ] <Right> Insert and Replace
7428 For example: >
7429 :set ww=<,>,[,]
7430< allows wrap only when cursor keys are used.
7431 When the movement keys are used in combination with a delete or change
7432 operator, the <EOL> also counts for a character. This makes "3h"
7433 different from "3dh" when the cursor crosses the end of a line. This
7434 is also true for "x" and "X", because they do the same as "dl" and
7435 "dh". If you use this, you may also want to use the mapping
7436 ":map <BS> X" to make backspace delete the character in front of the
7437 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007438 When 'l' is included and it is used after an operator at the end of a
7439 line then it will not move to the next line. This makes "dl", "cl",
7440 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007441 NOTE: This option is set to the Vi default value when 'compatible' is
7442 set and to the Vim default value when 'compatible' is reset.
7443
7444 *'wildchar'* *'wc'*
7445'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7446 global
7447 {not in Vi}
7448 Character you have to type to start wildcard expansion in the
7449 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007450 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007451 The character is not recognized when used inside a macro. See
7452 'wildcharm' for that.
7453 Although 'wc' is a number option, you can set it to a special key: >
7454 :set wc=<Esc>
7455< NOTE: This option is set to the Vi default value when 'compatible' is
7456 set and to the Vim default value when 'compatible' is reset.
7457
7458 *'wildcharm'* *'wcm'*
7459'wildcharm' 'wcm' number (default: none (0))
7460 global
7461 {not in Vi}
7462 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007463 recognized when used inside a macro. You can find "spare" command-line
7464 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007465 you'll never actually type 'wildcharm', just use it in mappings that
7466 automatically invoke completion mode, e.g.: >
7467 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007468 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007469< Then after typing :ss you can use CTRL-P & CTRL-N.
7470
7471 *'wildignore'* *'wig'*
7472'wildignore' 'wig' string (default "")
7473 global
7474 {not in Vi}
7475 {not available when compiled without the |+wildignore|
7476 feature}
7477 A list of file patterns. A file that matches with one of these
7478 patterns is ignored when completing file or directory names.
7479 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7480 Also see 'suffixes'.
7481 Example: >
7482 :set wildignore=*.o,*.obj
7483< The use of |:set+=| and |:set-=| is preferred when adding or removing
7484 a pattern from the list. This avoids problems when a future version
7485 uses another default.
7486
7487 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7488'wildmenu' 'wmnu' boolean (default off)
7489 global
7490 {not in Vi}
7491 {not available if compiled without the |+wildmenu|
7492 feature}
7493 When 'wildmenu' is on, command-line completion operates in an enhanced
7494 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7495 the possible matches are shown just above the command line, with the
7496 first match highlighted (overwriting the status line, if there is
7497 one). Keys that show the previous/next match, such as <Tab> or
7498 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7499 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7500 specified. "longest" and "list" do not start "wildmenu" mode.
7501 If there are more matches than can fit in the line, a ">" is shown on
7502 the right and/or a "<" is shown on the left. The status line scrolls
7503 as needed.
7504 The "wildmenu" mode is abandoned when a key is hit that is not used
7505 for selecting a completion.
7506 While the "wildmenu" is active the following keys have special
7507 meanings:
7508
7509 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7510 <Down> - in filename/menu name completion: move into a
7511 subdirectory or submenu.
7512 <CR> - in menu completion, when the cursor is just after a
7513 dot: move into a submenu.
7514 <Up> - in filename/menu name completion: move up into
7515 parent directory or parent menu.
7516
7517 This makes the menus accessible from the console |console-menus|.
7518
7519 If you prefer the <Left> and <Right> keys to move the cursor instead
7520 of selecting a different match, use this: >
7521 :cnoremap <Left> <Space><BS><Left>
7522 :cnoremap <Right> <Space><BS><Right>
7523<
7524 The "WildMenu" highlighting is used for displaying the current match
7525 |hl-WildMenu|.
7526
7527 *'wildmode'* *'wim'*
7528'wildmode' 'wim' string (Vim default: "full")
7529 global
7530 {not in Vi}
7531 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007532 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007533 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007534 first part specifies the behavior for the first use of 'wildchar',
7535 The second part for the second use, etc.
7536 These are the possible values for each part:
7537 "" Complete only the first match.
7538 "full" Complete the next full match. After the last match,
7539 the original string is used and then the first match
7540 again.
7541 "longest" Complete till longest common string. If this doesn't
7542 result in a longer string, use the next part.
7543 "longest:full" Like "longest", but also start 'wildmenu' if it is
7544 enabled.
7545 "list" When more than one match, list all matches.
7546 "list:full" When more than one match, list all matches and
7547 complete first match.
7548 "list:longest" When more than one match, list all matches and
7549 complete till longest common string.
7550 When there is only a single match, it is fully completed in all cases.
7551
7552 Examples: >
7553 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007554< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007555 :set wildmode=longest,full
7556< Complete longest common string, then each full match >
7557 :set wildmode=list:full
7558< List all matches and complete each full match >
7559 :set wildmode=list,full
7560< List all matches without completing, then each full match >
7561 :set wildmode=longest,list
7562< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007563 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007564
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007565 *'wildoptions'* *'wop'*
7566'wildoptions' 'wop' string (default "")
7567 global
7568 {not in Vi}
7569 {not available when compiled without the |+wildignore|
7570 feature}
7571 A list of words that change how command line completion is done.
7572 Currently only one word is allowed:
7573 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007574 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007575 is displayed per line. Often used tag kinds are:
7576 d #define
7577 f function
7578 Also see |cmdline-completion|.
7579
Bram Moolenaar071d4272004-06-13 20:20:40 +00007580 *'winaltkeys'* *'wak'*
7581'winaltkeys' 'wak' string (default "menu")
7582 global
7583 {not in Vi}
7584 {only used in Win32, Motif, GTK and Photon GUI}
7585 Some GUI versions allow the access to menu entries by using the ALT
7586 key in combination with a character that appears underlined in the
7587 menu. This conflicts with the use of the ALT key for mappings and
7588 entering special characters. This option tells what to do:
7589 no Don't use ALT keys for menus. ALT key combinations can be
7590 mapped, but there is no automatic handling. This can then be
7591 done with the |:simalt| command.
7592 yes ALT key handling is done by the windowing system. ALT key
7593 combinations cannot be mapped.
7594 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007595 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007596 keys can be mapped.
7597 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7598 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007599 This option is not used for <F10>; on Win32 and with GTK <F10> will
7600 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007601
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007602 *'window'* *'wi'*
7603'window' 'wi' number (default screen height - 1)
7604 global
7605 Window height. Do not confuse this with the height of the Vim window,
7606 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007607 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7608 value is smaller than 'lines' minus one. The screen will scroll
7609 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007610 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7611 in a much smarter way, taking care of wrapping lines.
7612 When resizing the Vim window, the value is smaller than 1 or more than
7613 or equal to 'lines' it will be set to 'lines' minus 1.
7614 {Vi also uses the option to specify the number of displayed lines}
7615
Bram Moolenaar071d4272004-06-13 20:20:40 +00007616 *'winheight'* *'wh'* *E591*
7617'winheight' 'wh' number (default 1)
7618 global
7619 {not in Vi}
7620 {not available when compiled without the +windows
7621 feature}
7622 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007623 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007624 focus goes to a window that is smaller, its size is increased, at the
7625 cost of the height of other windows.
7626 Set 'winheight' to a small number for normal editing.
7627 Set it to 999 to make the current window fill most of the screen.
7628 Other windows will be only 'winminheight' high. This has the drawback
7629 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
7630 to create only two windows, set the option after startup is done,
7631 using the |VimEnter| event: >
7632 au VimEnter * set winheight=999
7633< Minimum value is 1.
7634 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007635 height of the current window.
7636 'winheight' applies to the current window. Use 'winminheight' to set
7637 the minimal height for other windows.
7638
7639 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7640'winfixheight' 'wfh' boolean (default off)
7641 local to window
7642 {not in Vi}
7643 {not available when compiled without the +windows
7644 feature}
7645 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007646 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
7647 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007648 The height may be changed anyway when running out of room.
7649
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007650 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7651'winfixwidth' 'wfw' boolean (default off)
7652 local to window
7653 {not in Vi}
7654 {not available when compiled without the +windows
7655 feature}
7656 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007657 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007658 The width may be changed anyway when running out of room.
7659
Bram Moolenaar071d4272004-06-13 20:20:40 +00007660 *'winminheight'* *'wmh'*
7661'winminheight' 'wmh' number (default 1)
7662 global
7663 {not in Vi}
7664 {not available when compiled without the +windows
7665 feature}
7666 The minimal height of a window, when it's not the current window.
7667 This is a hard minimum, windows will never become smaller.
7668 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7669 status bar) if necessary. They will return to at least one line when
7670 they become active (since the cursor has to have somewhere to go.)
7671 Use 'winheight' to set the minimal height of the current window.
7672 This option is only checked when making a window smaller. Don't use a
7673 large number, it will cause errors when opening more than a few
7674 windows. A value of 0 to 3 is reasonable.
7675
7676 *'winminwidth'* *'wmw'*
7677'winminwidth' 'wmw' number (default 1)
7678 global
7679 {not in Vi}
7680 {not available when compiled without the +vertsplit
7681 feature}
7682 The minimal width of a window, when it's not the current window.
7683 This is a hard minimum, windows will never become smaller.
7684 When set to zero, windows may be "squashed" to zero columns (i.e. just
7685 a vertical separator) if necessary. They will return to at least one
7686 line when they become active (since the cursor has to have somewhere
7687 to go.)
7688 Use 'winwidth' to set the minimal width of the current window.
7689 This option is only checked when making a window smaller. Don't use a
7690 large number, it will cause errors when opening more than a few
7691 windows. A value of 0 to 12 is reasonable.
7692
7693 *'winwidth'* *'wiw'* *E592*
7694'winwidth' 'wiw' number (default 20)
7695 global
7696 {not in Vi}
7697 {not available when compiled without the +vertsplit
7698 feature}
7699 Minimal number of columns for the current window. This is not a hard
7700 minimum, Vim will use fewer columns if there is not enough room. If
7701 the current window is smaller, its size is increased, at the cost of
7702 the width of other windows. Set it to 999 to make the current window
7703 always fill the screen. Set it to a small number for normal editing.
7704 The width is not adjusted after one of the commands to change the
7705 width of the current window.
7706 'winwidth' applies to the current window. Use 'winminwidth' to set
7707 the minimal width for other windows.
7708
7709 *'wrap'* *'nowrap'*
7710'wrap' boolean (default on)
7711 local to window
7712 {not in Vi}
7713 This option changes how text is displayed. It doesn't change the text
7714 in the buffer, see 'textwidth' for that.
7715 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007716 displaying continues on the next line. When off lines will not wrap
7717 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007718 moved to a part that is not shown, the screen will scroll
7719 horizontally.
7720 The line will be broken in the middle of a word if necessary. See
7721 'linebreak' to get the break at a word boundary.
7722 To make scrolling horizontally a bit more useful, try this: >
7723 :set sidescroll=5
7724 :set listchars+=precedes:<,extends:>
7725< See 'sidescroll', 'listchars' and |wrap-off|.
7726
7727 *'wrapmargin'* *'wm'*
7728'wrapmargin' 'wm' number (default 0)
7729 local to buffer
7730 Number of characters from the right window border where wrapping
7731 starts. When typing text beyond this limit, an <EOL> will be inserted
7732 and inserting continues on the next line.
7733 Options that add a margin, such as 'number' and 'foldcolumn', cause
7734 the text width to be further reduced. This is Vi compatible.
7735 When 'textwidth' is non-zero, this option is not used.
7736 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7737 and less usefully}
7738
7739 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7740'wrapscan' 'ws' boolean (default on) *E384* *E385*
7741 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007742 Searches wrap around the end of the file. Also applies to |]s| and
7743 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007744
7745 *'write'* *'nowrite'*
7746'write' boolean (default on)
7747 global
7748 {not in Vi}
7749 Allows writing files. When not set, writing a file is not allowed.
7750 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007751 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007752 argument. Filtering text is still possible, even though this requires
7753 writing a temporary file.
7754
7755 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7756'writeany' 'wa' boolean (default off)
7757 global
7758 Allows writing to any file with no need for "!" override.
7759
7760 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7761'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7762 otherwise)
7763 global
7764 {not in Vi}
7765 Make a backup before overwriting a file. The backup is removed after
7766 the file was successfully written, unless the 'backup' option is
7767 also on. Reset this option if your file system is almost full. See
7768 |backup-table| for another explanation.
7769 When the 'backupskip' pattern matches, a backup is not made anyway.
7770 NOTE: This option is set to the default value when 'compatible' is
7771 set.
7772
7773 *'writedelay'* *'wd'*
7774'writedelay' 'wd' number (default 0)
7775 global
7776 {not in Vi}
7777 The number of microseconds to wait for each character sent to the
7778 screen. When non-zero, characters are sent to the terminal one by
7779 one. For MS-DOS pcterm this does not work. For debugging purposes.
7780
7781 vim:tw=78:ts=8:ft=help:norl: